Java代码规范的核心是提升可读性、可维护性和团队协作效率,强调命名见名知意、格式统一(4空格缩进、运算符空格、大括号不换行)、注释重意图而非操作、方法单一职责(≤20行)、类聚焦单一业务、避免深层嵌套并善用卫语句。

Java代码规范的核心是提升可读性、可维护性和团队协作效率,不是追求形式上的完美,而是让别人(包括未来的自己)能快速理解逻辑、安全修改、顺畅排查问题。
命名要见名知意,不缩写不模糊
变量、方法、类名必须准确表达用途,避免单字母(如a、tmp)、拼音(如yonghu)、过度缩写(如usrMgrSvc)。
- 类名用大驼峰,名词为主:UserService、OrderRepository
- 方法名用小驼峰,动词开头:calculateTotalPrice()、isValidEmail()
- 常量全大写加下划线:MAX_RETRY_COUNT、DEFAULT_TIMEOUT_MS
- 布尔变量/方法优先用is、has、can开头:isActive、hasPermission()
格式统一,空格与换行讲逻辑
缩进统一用4个空格(非Tab),运算符前后、逗号后、冒号后加空格;大括号不换行(Egyptian风格),if/for/while后必须有大括号,即使只有一行。
- ✅ 正确:if (user != null && user.isActive()) {
sendWelcomeEmail(user);
} - ❌ 错误:if(user!=null&&user.isActive()) sendWelcomeEmail(user);
- 方法参数多时分行对齐,每参数独占一行,右括号与左括号垂直对齐
注释重意图,不重操作
不解释“代码在做什么”(代码自己会说),而说明“为什么这么做”或“有什么隐含约束”。Javadoc用于public类和方法,内部逻辑复杂处用单行//注释。
立即学习“Java免费学习笔记(深入)”;
- ✅ 好注释:// 使用BigDecimal避免浮点精度丢失,因金额计算要求严格
- ❌ 差注释:// 将price转为BigDecimal
- 禁止无意义注释:// 初始化用户对象、// 循环遍历列表
- Javadoc中@params、@return、@throws需完整,且与实际一致
结构清晰,单一职责优先
一个方法只做一件事,长度控制在20行以内;一个类聚焦一个业务概念;避免长参数列表(超4个建议封装为DTO或Builder);重复逻辑必须抽取为私有方法。
- 把校验、处理、返回拆成独立步骤,而非堆在一个方法里
- 条件分支过深(if嵌套超3层)考虑卫语句提前退出:if (input == null) throw new IllegalArgumentException();
- 使用final修饰不变的局部变量、方法参数(尤其lambda中),增强可读与线程安全暗示










