Java代码规范

### Java代码规范详解 #### 一、概述 本篇文章旨在详细介绍一份个人整理的Java代码规范，这份规范结合了Google的编码规范以及作者所在公司的特定需求。尽管这份文档提供了较为全面的指导原则，但它并不是强制性的标准，而是为开发团队提供了一个参考框架。 #### 二、前言 本规范是基于Google的Java编程风格规范而建立的，当且仅当Java源文件符合此文档中的规定时，才能被认为遵循了Google的Java编程风格。 ##### 2.1 术语说明 - **Class**：在本文档中，“class”一词可以指代普通的类、枚举类、接口或@interface类型的类。 - **Comment**：此处所指的“comment”特指实现注释（implementation comments），而非文档注释（Javadoc）。 ##### 2.2 指南说明 本文档中的示例代码仅供参考，并非强制执行的标准样式。尽管示例代码遵循Google编程风格，但这些示例的格式并不是唯一正确的呈现方式。因此，示例中的格式不应被视为强制性规则。 #### 三、源文件基础 ##### 3.1 文件名 - **命名规则**：源文件的名称应与其最顶层的类名相同，区分大小写，扩展名为`.java`。 ##### 3.2 文件编码 - **编码格式**：源文件必须使用UTF-8编码格式。 ##### 3.3 特殊字符 ###### 3.3.1 空白字符 - **允许使用的空白字符**：除行结束符外，仅允许使用ASCII水平空格字符（0x20）作为源文件中的空白字符。 - **转义处理**：字符串中的其他空白字符需进行转义处理。 - **制表符**：制表符不得用于缩进。 ###### 3.3.2 特殊转义序列 - **转义字符**：对于具有特殊转义序列的字符（如`\b`,`\t`,`\n`,`\f`,`\r`,`\"`,`\'`,及`\`），应使用其对应的转义序列，而非八进制或Unicode转义。 ###### 3.3.3 非ASCII字符 - **Unicode字符**：对于非ASCII字符，使用实际的Unicode字符或其等效的Unicode转义符号，具体取决于哪种形式更能提高代码的可读性和理解性。 #### 四、源文件结构 源文件的结构包括以下几个部分： - **许可证或版权信息**：如果适用，则位于文件开头。 - **package语句**：位于文件的第二行，不允许换行。 - **import语句**：不允许使用通配符，每个import语句独占一行，且按指定顺序排列。 - **顶级类声明**：一个文件只能包含一个顶级类。 ##### 4.1 许可证或版权信息 - **位置**：如果文件包含了许可证或版权信息，则应放在文件的最前面。 ##### 4.2 package语句 - **格式**：package语句应写在一行中，不受列限制约束。 ##### 4.3 import语句 ###### 4.3.1 不使用通配符 - **禁止**：严禁使用通配符形式的import语句，如`import java.util.*;`。 ###### 4.3.2 不换行 - **格式**：import语句不能换行，每个import语句独占一行。 ###### 4.3.3 顺序与间距 - **顺序**：import语句分为若干组，每组间用一个空行隔开。具体顺序为：静态导入、com.google导入（仅当源文件位于com.google包下）、第三方包、java包、javax包。 - **排序**：每个组内的import语句按字典序排列，组内不空行。 ##### 4.4 类声明 ###### 4.4.1 只有一个顶级类声明 - **规则**：每个顶级类都应位于一个与其同名的源文件中（含.java后缀）。特殊情况是`package-info.java`文件，其中没有对应的类。 ###### 4.4.2 类成员顺序 - **逻辑排序**：类成员的排序对学习新类的人非常重要，但并不存在唯一通用的排序法则。重要的是，每个类应以某种逻辑顺序对其成员进行排序。 #### 五、总结 通过本篇文档，我们可以了解到一个详细的Java代码规范。它不仅涉及了文件的基础信息（如文件名、编码格式、特殊字符的处理等），还包括了源文件的整体结构布局（如许可证信息、package语句、import语句、类声明等）。这份规范旨在帮助开发团队提高代码的可读性和一致性，从而提高项目的整体质量和维护性。