Java代码规范

Java代码规范

现代软件行业的高速发展对开发者的综合素质要求越来越高，因为不仅是编程知识点，其它维度的知识点也会影响到软件的最终交付质量。比如：数据库的表结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险；工程结构混乱导致后续维护艰难；没有鉴权的漏洞代码易被黑客攻击等等。以 Java 开发者为中心视角，划分为编程规约、异常日志、单元测试、安全规约、工程结构、MySQL 数据库六个维度，再根据内容特征，细分成若干二级子目录。根据约束力强弱及故障敏感性，规约依次分为强制、推荐、参考三大类。对于规约条目的延伸信息中，“说明”对内容做了适当扩展和解释；“正例”提倡什么样的编码和实现方式；“反例”说明需要提防的雷区，以及真实的错误案例。

尤其是对于未步入社会还在为未来努力奋斗的一群有理想的青年，对于编程语言的理解和应用，从学习时就养成一种良好的书写习惯是非常必要的。可想而知，一个不能养成良好习惯的开发者，在项目交接的过程中会造成多少不必要的事情，还会对未来事业的发展造成一定的影响，没有养成良好的Java代码书写规范，你的代码在别人眼里就是一对无效代码，可读性非常差。

俗话说：“无规矩不成方圆”。无论在各行各业，规矩起着非常重要的作用，对于Java开发人员甚至是从事开发工作的所有人都是非常有必要的。我是一名大学生，学习的专业是软件工程专业，在平时的实验和实训中深深感觉到书写代码时的良好习惯决定了一个人的性格和对这个专业的喜爱程度。 当你看别人代码时，有时候会感觉到力不从心，不知从何处下手，对于代码规范的欠缺，说实话，看类似这种类型的代码，给人一种恶心晕眩的感觉，功能实现了，但自己要知道，写出来的东西不仅仅是让自己看，应该让大多数学习开发的人员能够明白你所书写代码的意思和原理。Java代码的书写(无论是什么编程语言)完成就好比是你所要完成的一项艺术品，你一定不会想让这件艺术品看起来非常糟糕，甚至可能你自己本人也觉得自己都看不下去。不仅仅自己欣赏，也要让别人能够欣赏！这才是编程意义的所在。

自今年阿里巴巴推出《Java开发手册》，我马上下载查看了内容，而且有幸能获得该书作者多隆签名的《阿里巴巴Java开发手册》，深深认识到代码书写规范的重要性。现在，我想给大家分享一下相关的规范。

一 、编程规约 编程规约

( ( 一) ) 命名 命名风格

风格1. 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。反例： _name / __name / $Object / name_ / name$ / Object$

2. 【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。正例： alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。反例： DaZhePromotion [ 打折 ] / getPingfenByName() [ 评分 ] / int 某变量 = 3

3. 【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外： DO / BO /DTO / VO / AO正例： MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion反例： macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

4. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。正例： localValue / getHttpMessage() / inputUserId

5. 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。正例： MAX _ STOCK _ COUNT反例： MAX _ COUNT

6. 【强制】抽象类命名使用 Abstract 或 Base 开头 ； 异常类命名使用 Exception 结尾 ； 测试类命名以它要测试的类的名称开始，以 Test 结尾。

7. 【强制】中括号是数组类型的一部分，数组定义如下： String[] args;反例：使用 String args[] 的方式来定义

8. 【强制】 POJO 类中布尔类型的变量，都不要加 is ，否则部分框架解析会引起序列化错误。反例：定义为基本数据类型 Boolean isDeleted； 的属性，它的方法也是 isDeleted() ， RPC框架在反向解析的时候，“以为”对应的属性名称是 deleted ，导致属性获取不到，进而抛出异常。

9. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。正例： 应用工具类包名为 com . alibaba . open . util 、类名为 MessageUtils（ 此规则参考spring 的框架结构 ）

10. 【强制】杜绝完全不规范的缩写，避免望文不知义。反例： AbstractClass “缩写”命名成 AbsClass；condition “缩写”命名成 condi ，此类随意缩写严重降低了代码的可阅读性。

11. 【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。正例：从远程仓库拉取代码的类命名为 PullCodeFromRemoteRepository。反例：变量 int a; 的随意命名方式。

12. 【推荐】如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式。说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。正例： public class OrderFactory;public class LoginProxy;public class ResourceObserver;

13. 【推荐】接口类中的方法和属性不要加任何修饰符号 （public 也不要加 ） ，保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。正例：接口方法签名： void f();接口基础常量表示： String COMPANY = " alibaba " ;反例：接口方法定义： public abstract void f();说明： JDK 8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。

14. 接口和实现类的命名有两套规则：1 ） 【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl 的后缀与接口区别。正例： CacheServiceImpl 实现 CacheService 接口。2 ） 【推荐】 如果是形容能力的接口名称，取对应的形容词做接口名 （ 通常是– able 的形式 ） 。正例： AbstractTranslator 实现 Translatable 。

15. 【参考】枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。正例：枚举名字为 ProcessStatusEnum 的 成员名称： SUCCESS / UNKOWN _ REASON 。

16. 【参考】各层命名规约：A) Service / DAO 层方法命名规约1 ） 获取单个对象的方法用 get 做前缀。2 ） 获取多个对象的方法用 list 做前缀。3 ） 获取统计值的方法用 count 做前缀。4 ） 插入的方法用 save/insert 做前缀。5 ） 删除的方法用 remove/delete 做前缀。6 ） 修改的方法用 update 做前缀。B) 领域模型命名规约1 ） 数据对象： xxxDO ， xxx 即为数据表名。2 ） 数据传输对象： xxxDTO ， xxx 为业务领域相关的名称。3 ） 展示对象： xxxVO ， xxx 一般为网页名称。