第七章·API（应用程序编程接口）

API（应用程序编程接口）

概念

指的是Java Application Programming Interface，它是Java平台的核心组成部分，提供了一系列预先定义好的类和接口，供开发者在编写Java应用程序时使用

---

API文档官方参考地址：https://docs.oracle.com/javase/8/docs/api/

---

原理

API通常可以看作是一组编程语言中的函数和方法，它们提供了一种访问软件系统中各种功能和数据的标准化方式。这些函数和方法遵循一定的规范，允许开发者调用特定的功能或从数据库中获取特定的数据。

---

API包含的内容

模块–>包–>程序–>文档

---

组成

API通常由一组类，接口，异常，方法,参数，返回值，文档组成

---

API的优点

• 简化数据访问和交互：通过API，开发者可以直接请求返回JSON或XML格式的数据，无需通过数据库连接器等中间软件。
• 提高应用程序的可扩展性：API的设计允许系统以模块化的方式构建，易于扩展和调整。
• 支持多平台和集成：API支持不同的平台和技术栈之间的集成，增加了解耦的好处。
• 改善应用程序的用户体验：API可以打造出更好的用户体验，如通过API聚合数据来加强搜索功能。

---

文档注释与注解

---

常用注解

Java中的文档注解（常见于Javadoc）：
@deprecated：标记一个类或成员已被弃用，不建议使用。
@param：描述方法的参数。
@return：描述方法的返回值。
@throws：描述方法可能抛出的异常。
@version：定义文档的版本信息。
@author：定义文档的作者信息。
@description 或 @summary：提供类或方法的简短描述。
@see 或 @link：提供一个到其他类或方法的链接或引用。
@implSpec 或 @implNote：提供实现规范或实现备注信息。
JavaScript中的JSDoc风格注解：
在JavaScript中，JSDoc是一种流行的工具，用于从注释生成文档。常用的JSDoc注解包括：

@description：描述模块、类或函数的用途和行为。
@param {String} 参数名：描述函数的参数类型和作用。
@returns {类型}：描述函数的返回值类型。
@throws {类型}：描述函数可能抛出的错误类型。
@example：提供代码示例说明函数的使用方式。
@default：设置默认值。
@property {类型}：描述对象的属性类型和用途。

---

package 文档注释与注解;
/**
 * 文档注释，只用于类上，方法上，常量上
 * 文档注释可以使用javadoc命令生产手册
 * 在类上使用于解释当前类的整体功能是什么
 *
 *@author 千羽    作者
 * @version 1.0      版本号
 * @see java.lang.String   参考参见
 * @since jdk1.8    始于哪个版本（当前类的最低运行版本）
 **/

public class 注释与注解 {
    /**
     * 是sayHello方法中的问候语
     */
    public static final String INFO="你好";

    /**
     * 对给定的用户生成问候语
     * @param name   给定的用户的名字    parameter：参数
     * @return   返回的是一个字符串，生成的问候语
     */
    public String sayHello(String name){
        return INFO+name;
    }

    public static void main(String[] args) {
        System.out.println(new 注释与注解().sayHello("千羽"));
    }
}

---

注释（三种方式）

单行注释使用//注释内容
多行注释使用/*注释内容*/
文档注释使用/**注释内容*/

Java常用类

字符串类，核心类，包装类，数学计算类，工具类，日期时间类，输入输出类，集合类