Java 编码规范

好的编码规范让代码易读、易维护、不易出错。

学完本章你将： 掌握命名、异常处理、资源管理原则。

命名规范

java

// ✅ 正确的命名
public class UserService {}           // 类名：大驼峰 PascalCase
private String userName;              // 变量：小驼峰 camelCase
public static final int MAX_SIZE = 100; // 常量：全大写
public void getUserById(long id) {}   // 方法：小驼峰

// ❌ 错误示范
// public class user_service {}       // 类名不要下划线
// private String UserName;           // 变量不要大写开头
// public void GetUser() {}           // 方法不要大写开头

异常处理

java

// ✅ 精确捕获
try {
    riskyOperation();
} catch (FileNotFoundException e) {
    // 处理文件不存在
} catch (IOException e) {
    // 处理其他 IO 错误
}

// ❌ 吞掉异常
try {
    riskyOperation();
} catch (Exception e) {
    // 什么都不做 —— 最坏的实践！
}

// ❌ 不要捕获了又 throw
try {
    // ...
} catch (Exception e) {
    throw e; // 无意义，不如不捕获
}

资源管理

java

// ✅ try-with-resources
try (Connection conn = getConnection();
     PreparedStatement stmt = conn.prepareStatement(sql);
     ResultSet rs = stmt.executeQuery()) {
    while (rs.next()) {
        process(rs);
    }
}
// 自动关闭，无需 finally

// ❌ 手动管理
Connection conn = null;
try {
    conn = getConnection();
    // ...
} finally {
    if (conn != null) conn.close(); // 容易忘写或写错
}

总结清单

原则	做法
命名清晰	类名名词、方法名动词
方法短小	每个方法不超过 30 行
单一职责	一个类只做一件事
不可变优先	尽量用 final、不可变对象
组合优于继承	优先使用组合复用代码
常量代替魔法数	`MAX_SIZE` 而不是 `100`

Java 编码规范

Java 编码规范

命名规范

异常处理

资源管理

总结清单

🛠️ 学完试试这些工具