java编码规范

### Java编码规范详解 #### 一、概述 Java编码规范是开发者在编写Java程序时遵循的一套标准，目的是为了提高代码的可读性和可维护性。本文档详细介绍了Java编码规范的各项规则及其应用示例。 #### 二、文件命名与编码 **2.1 源文件** - **文件名**: 源文件应以其最顶层的类名来命名，注意区分大小写。 - **文件编码**: 使用UTF-8编码格式。 **2.2 许可证或版权信息** - 如果源文件包含许可证或版权信息，则应将其放置在文件的最前面。 **2.3 Package语句** - `package`语句不换行。 **2.4 Import语句** - `import`语句位于`package`语句之后，避免使用通配符(`*`)，每一行只包含一条`import`语句。 **2.5 顶级类** - 一个源文件中只能有一个顶级类声明。 **2.6 方法成员排序** - 成员方法应按照某种逻辑顺序排列，而非简单地添加到类的末尾。 **2.7 命名规则** - **驼峰命名法**: 包括大驼峰命名法(UpperCamelCase)和小驼峰命名法(LowerCamelCase)。 - **大驼峰命名法**: 每个单词的首字母大写。 - **小驼峰命名法**: 第一个单词首字母小写，后续单词首字母大写。 - **去除非ASCII字符**: 保持名称为纯ASCII码，移除单引号等特殊字符。 #### 三、命名规范 **3.1 Java源文件的命名** - 文件名必须与其中定义的公共类名完全一致。 **3.2 Package的命名** - 全部使用小写字母。 - 示例: - 错误: `com.MyCompany` - 正确: `com.mycompany` **3.3 类的命名** - 名称使用名词，遵循大驼峰命名法，首字母大写。 - 示例: - 错误: `ComMyClass` - 正确: `MyClass` **3.4 接口的命名** - 接口名称也是名词，首字母大写，并以“I”开头。 - 示例: - 错误: `InterfaceMy` - 正确: `IMyInterface` **3.5 方法的命名** - 方法名一般为动词或动词短语，使用小驼峰命名法。 - 示例: - 错误: `getCustomerData` - 正确: `getCustomerData` **3.6 常量的命名** - 全部使用大写字母，单词之间用下划线连接。 - 示例: - 错误: `my_constant` - 正确: `MY_CONSTANT` **3.7 变量的命名** - **普通变量**: 遵循小驼峰命名法。 - 示例: - 错误: `MyVariable` - 正确: `myVariable` - **约定变量**: 在循环中使用的临时变量。 - 示例: - 正确: `i`, `j`, `k` (用于整数) `c`, `d`, `e` (用于字符) **3.8 方法参数的命名** - 应使用有意义的名称，遵循小驼峰命名法。如果参数不可修改，建议使用`final`修饰符。 - 示例: - 正确: `public void doSomething(final String name)` #### 四、样式结构 **4.1 整体样式** **4.1.1 缩进和对齐** - 缩进: 当一行代码逻辑上高于下一行时，下一行需缩进一个单位。 - 示例: - 正确: `if (condition) { doSomething(); }` - 对齐: 处于同一逻辑层级的语句应对齐。 - 示例: - 正确: `if (condition) { doSomething(); } else { doOtherThing(); }` **4.1.2 行宽** - 代码行不应超过120个字符，超出部分应适当换行。 - 示例: - 错误: `String veryLongVariableName = "This is a very long string that exceeds the maximum line width";` - 正确: `String veryLongVariableName = "This is a very long string " + "that exceeds the maximum line width";` **4.1.3 断行规则** - 在逗号后换行。 - 示例: - 正确: `public void doSomething(String param1, String param2, String param3) { ... }` - 在操作符前换行。 - 示例: - 正确: `if (condition &&\n anotherCondition) { ... }` - 换行后应与断行处的前一层级对齐。 - 示例: - 错误: `if (condition &&\n anotherCondition) { ... }` - 正确: `if (condition &&\n anotherCondition) { ... }` - 尽量选择较高层次的地方进行换行。 - 示例: - 错误: `String veryLongVariableName = "This is a very long string that exceeds the maximum line width";` - 正确: `String veryLongVariableName = "This is a very long string " + "that exceeds the maximum line width";` - 如果换行后的行超过120个字符，使用双倍缩进代替对齐。 - 示例: - 错误: `if (condition &&\n anotherCondition &&\n thirdCondition) { ... }` - 正确: `if (condition &&\n anotherCondition &&\n thirdCondition) { ... }` **4.1.4 空白的使用** - 关键字和括号之间使用空格。 - 示例: - 正确: `if (condition) { ... }` - 参数列表中的逗号后应使用空格。 - 示例: - 正确: `public void doSomething(String param1, String param2) { ... }` - 二元运算符周围使用空格。 - 示例: - 正确: `int result = a + b;` - 强制类型转换后使用空格。 - 示例: - 正确: `(String) object;` - 左括号右侧和右括号左侧不能有空格。 - 示例: - 错误: `if ( condition ) { ... }` - 正确: `if (condition) { ... }` - 方法名与参数列表的左括号之间不能有空格。 - 示例: - 错误: `public void doSomething (String param1) { ... }` - 正确: `public void doSomething(String param1) { ... }` - 一元操作符与操作数之间不加空格。 - 示例: - 错误: `- number` - 正确: `-number` **4.1.5 空白行的使用** - 在源文件的不同片段之间使用两个空白行（非强制性）。 - 示例: - 正确: ```java // 版权声明 ... package com.example; import java.util.Date; ``` - 在两个方法声明之间使用一个空白行。 - 示例: - 正确: ```java public void method1() { // ... } public void method2() { // ... } ``` - 方法内的局部变量与第一条语句之间使用一个空白行（建议）。 - 示例: - 正确: ```java public void doSomething() { String name = "John"; System.out.println(name); } ``` - 块注释或单行注释之前使用一个空白行（建议）。 - 示例: - 正确: ```java public void doSomething() { // ... // 计算数据 int result = a + b; } ``` - 在方法内逻辑段之间使用一个空白行（建议）。 - 示例: - 正确: ```java public void doSomething() { // 初始化变量 int a = 1; int b = 2; // 计算结果 int result = a + b; } ``` **4.2 注释** - 本文档关于注释的部分尚未完成，将在后续补充。 以上是Java编码规范的主要内容。遵循这些规范可以显著提高代码的质量，使得代码更加整洁、易于阅读和维护。