Java开发规范（参照阿里规范改编）.pdfVIP

Java开发规范（参照阿⾥规范改编） JAVA 开发规范 v1.0.0 2021/08/27 本篇规范基于阿⾥巴巴、华为的开发⼿册，补充了⼀些细节。 规范不是为了约束和禁锢⼤家的创造⼒，⽽是为了帮助⼤家能够在正确的道路上，尽可能的避免踩坑和跑偏。 规范可以让我们⽆论单枪匹马还是与众⼈同⾏的时候都能得⼼应⼿。 规范可以让我们在⾯对⽇益变态的需求和做代码接盘侠的时候，更优雅从容。 ⼀、编程规范 1、好代码的原则 我们参考 Kent Beck 的简单设计四原则来指导我们的如何写出优秀的代码，如何有效地判断我们的代码是优秀的。 通过所有测试（Passes its tests）：强调的是外部需求，这是代码实现最重要的 尽可能消除重复 (Minimizes duplication)：代码的模块架构设计，保证代码的正交性，保证代码更容易修改 尽可能清晰表达 (Maximizes clarity)：代码的可阅读性，保证代码是容易阅读的 更少代码元素 (Has fewer elements)：保证代码是简洁的，在简洁和表达⼒之间，我们更看重表达⼒ 以上四个原则的重要程度依次降低，这组定义被称做简单设计原则。 2、命名规范 2-1、项⽬命名规范 全部采⽤⼩写⽅式，以中划线分隔。 正例：mall-management-system / order-service-client / user-api 反例：mall_management-system / mallManagementSystem / orderServiceClient 2-2、模块命名风格（多模块项⽬） 模块名称：{项⽬名称}-{模块名称} 模块名称简洁体现职责 模块名字作为模块组件的名称（即maven中的标签） 2-3、包命名规范 包名不应该⽤来表达模块完整的意思，包名应该仅⽤作与同包下的其他包做区分。 但尽可能使⽤单个单词命名，如果单个单词⽆法正确表达，可采⽤.分割，实在不⾏可采⽤全部单词⼩写（参考的sprin 命名） 2-4、类命名规范 类名使⽤ UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：DO / BO / DTO / VO / AO ； 抽象类命名使⽤ Abstract 或 Base 开头； 异常类命名使⽤ Exception 结尾； 测试类命名以它要测试的类的名称开始，以 Test 结尾； 如果使⽤到了设计模式，建议在类名中体现出具体模式； 枚举类名建议带上 Enum 后缀，枚举成员名称需要全⼤写，单词间⽤下划线隔开。 正例： 1MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例： 1macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion 3、TODO/FIXME 规范 TODO/TBD(to be determined) 注释⼀般⽤来描述已知待改进、待补充的修改点,并且加上作者名称。 FIXME 注释⼀般⽤来描述已知缺陷，它们都应该有统⼀风格，⽅便⽂本搜索统⼀处理。如： 1// TODO author-name: 补充XX处理 2// FIXME author-name: XX缺陷 4、⽅法参数规范 ⽆论是 亦或是其他的代码，每个⽅法最多 个参数，如果超出 个参数的话，要封装成 对象。 controller，service，manager，dao 3 3 javabean 1. ⽅便他⼈调⽤，降低出错⼏率。尤其是当参数是同⼀种类型，仅仅依靠顺序区分，稍有不慎便是灾难性后果，⽽且排查起来也极其恶 ⼼。 2. 保持代码整洁、清晰度。当⼀个个⽅法⾥充斥着⼀堆堆参数的时候，再坚强的⼈，也会⾝⼼疲惫。 反例： 1 /** 2 * 使⽤证书加密数据⼯具⽅法 3 * 4 * @param param 5 * @param password 加密密码 6 * @param priCert 私钥 7 * @param pubCert 公钥 8 *