章节 内容
0 前言 目的 总体原则 约定 范围 例外
1 命名 标识符 包名 类、枚举和接口 方法 常量 非常量字段
2 注释 Javadoc 文件头 方法头 代码 注释的语言
3 排版格式 文件 大括号 缩进 行内容 行宽 换行 空白 枚举 变量 数组 switch语句 注解 注释 修饰符
4 变量和类型 变量 类型
5 方法 方法设计 方法参数与返回值
6 类和接口 类 接口
7 异常和日志 异常 日志
8 编程实践 多线程并发 运算和表达式 控制语句 序列化 泛型 其他特性 性能 资源管理 可移植性 国际化
附录 参考 贡献者
前言
目的
优秀的代码不仅仅是正确的，还应该是简洁、可维护、可靠、可测试、高效、可移植的。 编程是一种创造性的工作。本规范用于引导软件开发人员好的编程习惯，编写出风格一致、容易阅读、高质量的Clean Code，从而提升产品竞争力软件研发效率。
代码总体原则和其他语言编程一样，Java编程遵循通用原则：
1. 清晰第一。清晰性是易于维护、易于重构的程序必需具备的特征。
2. 简洁为美。简洁就是易于理解并且易于实现。
3. 风格一致。相比个人习惯，所有人共享同一种风格带来的好处，远远超出为统一而付出的代价。
除此之外，Java编程还应该注意以下方面：
1. 正确使用Java 面向对象技术使得程序结构清晰、简单，提高了代码的重用性，但又隐藏了很多内部实现细节，不小心会误入陷阱。使用许多JAVA特性时，要注意正确使用。比如：多线程并发、泛型、装箱数据类型、异常处理、对象克隆等。2. 符合Java惯用法 Java的设计原则是可读性、简单性、广泛性、兼容性。注重开发者效率、程序性能、安全性、可靠性。
3. 面向对象设计 Java是典型的面向对象编程语言，软件工程界有许多好的OOP原则，例如SOLID，迪米特法则，Shalloway原则(去冗余)、好莱坞原则，组合/聚合复用原则，创建与使用分离原则，CQRS等，有利于写出大规模的、可维护、可扩展的代码。
约定
规则：编程时必须遵守的约定。
建议：编程时必须加以考虑的约定。
说明：对此规则/建议进行必要的解释。
示例：对此规则/建议从好、不好两个方面给出例子。
本规范适用的JDK版本，不特别说明均为1.7以上版本适用。
例外
无论是'规则'还是'建议'，都必须理解该条目这么规定的原因，并努力遵守。 但是，有些规则和建议可能会有例外。
在不违背总体原则，经过充分考虑，有充足的理由的前提下，可以适当违背规范中约定。 例外破坏了代码的一致性，请尽量避免。'规则'的例外应该是极少的。
下列情况，应风格一致性原则优先：
修改开源代码、第三方代码时，应该遵守开源代码、第三方代码已有规范，保持风格统一。
直接基于Android原生操作系统接口界面的软件，如Android Framework，保持与安卓风格统一。
苏公安网备 32011402010933号