java代码规范

在 Java 项目中使代码规范且美观，可以从以下几个方面入手：

1. 遵循统一的代码风格

• 使用一致的缩进：推荐使用 4 个空格进行缩进，避免使用 Tab 键。
• 大括号位置：遵循 K&R 风格，即左大括号放在行尾，右大括号单独一行。

if (condition) {// 代码块
} else {// 代码块
}

2. 采用有意义的命名

• 类名：使用大驼峰命名法（UpperCamelCase），如UserService。
• 方法名：使用小驼峰命名法（lowerCamelCase），如getUserById。
• 变量名：避免使用单字母命名，如userId比id更具可读性。

3. 控制代码长度

• 方法长度：单个方法尽量不超过 50 行，保持功能单一。
• 类长度：一个类的代码最好控制在 300 行以内，避免 "上帝类"。

4. 合理使用注释

• 类注释：说明类的功能和设计意图。
• 方法注释：使用 Javadoc 格式，说明参数、返回值和异常。

/*** 根据用户ID获取用户信息* @param userId 用户ID* @return 用户对象* @throws UserNotFoundException 当用户不存在时抛出此异常*/
public User getUserById(Long userId) throws UserNotFoundException {// 方法实现
}

5. 使用代码格式化工具

• IDE 自带工具：如 IntelliJ IDEA 的Ctrl + Alt + L（Windows/Linux）或Cmd + Opt + L（Mac）。
• Checkstyle：配置规则文件（如 Google Java Style）进行代码检查。

6. 依赖管理与包结构

• Maven/Gradle：使用依赖管理工具统一版本。
• 包结构：按功能模块划分，如com.example.project.controller。

7. 代码质量工具

• SonarQube：检测代码异味和潜在问题。
• SpotBugs：静态代码分析工具，发现常见 bug。

8. 设计模式与代码复用

• 避免重复代码：提取公共逻辑到工具类或基类。
• 使用设计模式：如工厂模式、单例模式等，增强代码可维护性。

9. 异常处理

• 避免空 catch 块：至少记录日志。
• 抛出特定异常：避免使用通用的Exception。

10. 单元测试

• JUnit + Mockito：编写单元测试，确保代码正确性。