API

82 阅读3分钟

什么是API:API(Application Programming Interface) :应用程序编程接口

举例

我想编写一个机器人踢足球的程序,那么程序就要向机器人发出向前跑、向后跑、射门、抢球等各种命令。 如果我自己来编写呢,就会比较麻烦,因为机器人不是我设计的。
所以,为了方便其他的开发者使用机器人, 机器人厂商呢就会提供一些用于控制机器人的类,这些类中会定义好操作机器人各种动作的方法。
有了这些类之后,开发一个机器人踢足球的程序就会非常的方便了。 其实,这些类就是机器人厂商提供给开发者的应用程序编程接口,而这些类我们称之为:API

Java API :指的就是 JDK 中提供的各种功能的 Java类

如何使用帮助文档

帮助文档的使用流程:
  • 打开帮助文档
  • 找到索引选项,输入要学习的API,然后回车
  • 看类所在包:因为java.lang包下的类在使用的时候不需要导包
  • 看类的描述:这样我们就知道了类是干什么的
  • 看类的构造方法:这样我们就可以创建对象了
  • 看类的成员方法:这样我们就可以通过这些方法完成某些功能了

文档打开后,找到索引这里,下面有一个输入框,在这个框框里输入我们要学习的API image.png 这里,我们拿字符串类做一个说明:在这个框框里面我们输入:String,然后一回车,看到一个新的界面 这个界面中,就是关于String相关的知识了。 image.png

接着,我们来说一下,在学习一个API的时候,我们重点要看四个地方:

第一个地方:看类所在的包

image.png 为什么要看这里呢,因为java.lang包下的类,我们是可以直接使用的,不需要导包。 其他包下的类,我们都是要导包后才能使用的。很明显,String类在使用的时候,我们是不需要导包的。

第二个地方:看类的描述

也就是看这里,这里一般描述了类是干什么的 image.png 比如说:String类表示字符串。 Java程序中的所有字符串文字(例如"abc" )都实现为此类的实例。 告诉了我们String就是用来表示字符串的类,直接写一个字符串数据:abc就是String类的一个对象。

第三个地方:看类的构造方法

image.png 往下滑,这就是String类的构造方法,为什么要看构造方法呢?
因为我们在使用一个类的时候,其实使用的是该类的对象,而创建对象,我们是需要通过构造方法实现的,所以,我们得看看它提供了哪些构造方法。

第四个地方:看 类的成员方法

image.png 这是我们学习一个API的重点,我们之所以学习一个API,重点就是为了使用该API来完成某些功能。
而API的功能,都是通过一个个方法实现的,所以我们重点得看看类的成员方法。往下滑,这就是String提供的成员 方法,有很多。
而一个方法,我们重点又看什么呢?回到第一个方法,我们说一下: image.png

  • 先看描述,通过描述,我们就知道了方法是干什么的。
  • 再看方法名和参数,这样我们就知道调用哪个方法,以及参数的类型和个数。
  • 最后,我们看返回值类型,这样我们就知道调用该方法后,最终给我们返回了一个什么类型结果
  • 通过这些步骤,我们就知道了所学习的API该如何使用了,然后就可以到IDEA中去使用API了。