小白该如何看java官方API文档

浏览器安装翻译插件

• 因为java的文档大部分都是英文的，所以建议在浏览器上安装插件，如：沉浸式翻译等，阅读文档是打开插件，中英文对照阅读，既可以避免翻译不准确无法对照原文阅读，又可以避免偶尔有单词不知道词意的情况。
• 附：插件链接：沉浸式翻译 - 网页翻译插件 | PDF翻译 | 免费 - Microsoft Edge Addons
• 翻译时，最好选择ai翻译，效果会更好

官方文档网址

• 首先去oracle官网找到Java17的文档，JDK 17 文档 - 首页 --- JDK 17 Documentation - Home，该链接是Java17的文档中心，里面有各种文档，如：API文档、JDK文档、JVM指南、安全编码指南等。
• 要看的是javaAPI文档，如下图所示点击进入：

文档的导航栏

• 进入文档后映入眼帘的是最上面的导航栏，其中这四个标签为层级关系是一组的，由高到低，分别是从概述->模块->包->类->类中被谁使用，黄框表示当前在那一层
  • 只能从前往后依次选择，或者从后往前依次选择
  • OVERVIEW（概览）： 整个 API 的总体介绍，包括版本信息、设计目标、使用方法等。 - 通常是进入文档后的第一页，帮助你了解整体结构。
  • MODULE（模块）： 对应 Java 9 引入的模块化系统（JPMS），展示所有 Java 模块（如 java.base、java.sql等）。点击可查看某个模块包含哪些包和类。
  • PACKAGE（包）： 按包名组织类，比如 java.util、java.io等。每个包下会列出所有包含的类、接口、枚举等。
  • CLASS（类）： 最核心的部分，展示所有类、接口、枚举、注解的详细说明。包括继承关系、字段、方法、构造函数、使用示例等。
  • USE（用法）： 显示某个类或接口是如何被其他类使用的（即“谁用了我”）。适合了解类的上下文关联和依赖关系。
• 也可以使用搜索框搜索想要阅读的类、接口或者包
• 可以通过PREVIEW(预览)、NEW(最新)、DEPRECATED(已弃用),来浏览API的最新动态，以便对项目进行开发和维护
  • PREVIEW（预览特性）：出当前版本中标记为“预览”的新功能或 API，这些 API 可能还在试验阶段，未来可能变更或移除，不保证稳定性。
  • NEW（新增内容）：对比前一版本，列出本版本中新增加或改进的 API 和功能，适合从旧版本升级到新版本时快速定位变化点。
  • DEPRECATED（已弃用）：标记那些不再推荐使用、未来可能被移除的 API，通常会有替代方案的提示，要避免在新代码中继续使用。
• 而TREE(树)、INDEX(索引)，则可以帮助开发者快速追溯到各种类
  • TREE（继承树）：以树状结构展示类之间的继承关系（父类和子类），方便从父类追溯到所有子类，或从子类回溯到根类（如 Object）。
  • INDEX（索引）：按字母顺序排列所有类、方法、字段等，支持快速查找,类似于字典，输入关键词可直接跳转到对应文档。

文档阅读

• 当找需要找的类后，就需要阅读类中的信息，这里以String类为例，当我们进入类的文档后，会有一个二级索引导航，分为两部分SUMMARY（概要）和DETAIL（详细），两个区域分别对应有：NESTED（嵌套类），FIELD（字段），CONSTR（构造函数，Constructor 缩写），METHOD（方法），一般我习惯先到SUMMARY（概要）区域找到我想要了解的api之后在点击跳转到DETAIL（详细）区域查看
  • NESTED（嵌套类） ：展示当前类内部定义的嵌套类（包括静态嵌套类、非静态内部类、局部类、匿名类等）。例如，HashMap内部可能有 Entry嵌套类，这里会列出所有嵌套类的基本信息（类名、类型、简要描述）。
  • FIELD（字段） ：展示当前类的所有字段（成员变量），包括public/protected/private修饰的字段，以及继承自父类的字段。列出字段的名称、类型、修饰符、简要说明（比如 String value这种形式）。
  • CONSTR（构造函数，Constructor 缩写） ：展示当前类的所有构造函数（构造方法），包括默认构造器、带参数的构造器。列出构造器的参数列表、修饰符、简要说明（比如 String(StringBuffer buffer)就是 String类的一个构造函数）。
  • METHOD（方法） ：展示当前类的所有方法（实例方法、静态方法、继承自父类的方法）。列出方法的返回类型、方法名、参数列表、修饰符、简要说明（比如 length()方法会显示 int length()）。

• 找到方法查看方法详情