Java命名规范

Java 命名规范

是一组指导原则，用于在编写 Java 代码时为类、接口、方法、变量等标识符命名。这些规范不是强制性的，但遵守它们可以使代码更具可读性和易于维护。

1.包名命名规范

• 包名通常使用小写字母，并使用点（.）分隔单词。

• 每个包名称的部分应该是单个名词，并且应该与项目或组织的域名称相对应。

• 常见的顶级域名前缀包括 com、org、net、edu、gov、cn 等。

• 示例：

  package com.example.myapp;
  package org.springframework.boot;
  

2. 类命名规范

• 类名应该是名词，并且使用驼峰命名法（CamelCase），其中每个单词的首字母大写（除了第一个单词）。

• 如果类名由多个单词组成，每个单词的首字母都应该大写。

• 类名应该简洁且描述性强，能够清楚地表明类的用途。

• 如果类是抽象的，通常会在类名前加上 Abstract 前缀。

• 示例：

  public class MyClass {
  }
  
  public class ShoppingCart {
  }
  
  public abstract class AbstractDAO {
  }
  

3. 接口命名规范

• 接口名通常使用形容词或名词，并使用驼峰命名法。

• 接口名通常以 er 结尾，以表示它是一个可以执行某项操作的实体。

• 如果接口表示一种能力或特性，可以使用 able 或 ible 结尾。

• 示例：

  public interface Runnable {
  }
  
  public interface ActionListener {
  }
  
  public interface Serializable {
  }
  

4. 方法命名规范

• 方法名应该使用动词或动词短语，并且使用驼峰命名法。

• 方法名应该简洁且描述其操作。

• 如果方法返回当前对象的引用，可以使用 this 或 self 作为前缀。

• 示例：

  public void actionPerformed(ActionEvent e) {
  }
  
  public int calculateTotalPrice() {
  }
  
  public MyClass clone() {
  }
  

5. 变量命名规范

• 变量名应该使用驼峰命名法，但通常首字母小写。

• 变量名应该简洁且具有描述性。

• 常量名应该全部大写，并且使用下划线分隔单词。

• 示例：

  int myVariable;
  String anotherVariable;
  
  final int MAX_VALUE = 100;
  

6. 常量命名规范

• 常量名应该全部大写，并且使用下划线分隔单词。
• 常量通常在类中定义，并使用 static final 修饰。

7. 异常类命名规范

• 异常类名通常以 Exception 结尾，并使用驼峰命名法。

遵守这些命名规范可以提高代码的可读性和可维护性，并使其他开发者更容易理解和使用你的代码。