【软件开发规范篇】JAVA后端开发编码命名规范

作者介绍：本人笔名姑苏老陈，从事JAVA开发工作十多年了，带过大学刚毕业的实习生，也带过技术团队。最近有个朋友的表弟，马上要大学毕业了，想从事JAVA开发工作，但不知道从何处入手。于是，产生了写一个博客专栏想法，介绍当前互联网企业JAVA项目开发如何快速入门。

本文收录于《30天企业JAVA项目开发实战入门》专栏，该专栏内容以当前互联网软件企业中的项目实战为线索，介绍企业JAVA项目开发中涉及到的开发流程、技术、工具、规范要求等等。帮助想从事JAVA开发的大学生或新人，更快的、更好的入门JAVA后端开发工作。

一、前言

现在的软件项目都是团队多人合作一起开发，软件架构的复杂性也需要协同开发完成，如何高效地协同呢？

无规矩不成方圆，无规范难以协同。对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式一起做事，提升协作效率，降低沟通成本。

所以，本文介绍一下在JAVA开发编码过程中，给JAVA类、JAVA接口、JAVA变量等等如何命名，可以遵循的一些工作规范。

二、规范内容

其中，关于JAVA代码中类的命名、接口命名、方法命名、变量命名、常量命名，具体约定如下：

1. 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

   反例：_name /   name / $name / name_ / name$ / name 
   

2. 【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，纯拼音命名方式更要避免采用。

   正例：ali / alibaba / taobao / cainiao/ aliyun/ youku / hangzhou 等国际通用的名称，可视同英文。 
   
   反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
   

3. 【强制】类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO 等。

   正例：ForceCode	/	UserDO	/	HtmlDTO	/	XmlService	/	TcpUdpDeal / TaPromotion
   
   反例：forcecode	/	UserDo	/	HTMLDto	/	XMLService	/	TCPUDPDeal / TAPromotion
   

4. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格。

   正例： localValue / getHttpMessage() / inputUserId
   

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

   正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
   
   反例：MAX_COUNT / EXPIRED_TIME
   

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

7. 【推荐】类型与中括号紧挨相连来表示数组。

   正例：定义整形数组 int[] arrayDemo;
   
   反例：在 main 参数中，使用 String args[]来定义。
   

8. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。

   正例：应用工具类包名为 com.alibaba.ei.kunlun.aap.util、类名为 MessageUtils（此规则参考 spring 的框架结构）
   

9. 【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可读性降低。
   说明：子类、父类成员变量名相同，即使是 public 类型的变量也是能够通过编译，而局部变量在同一方法内的不同代码块中同名也是合法的，但是要避免使用。对于非 setter/getter 的参数名称也要避免与成员变量名称相同。

   反例：
   
   public class ConfusingName { public int stock;
   
   // 非 setter/getter 的参数名称，不允许与本类成员变量同名
   public void get(String alibaba) { if (condition) {
   final int money = 666;
   // ...
   }
   
   for (int i = 0; i < 10; i++) {
   // 在同一方法体中，不允许与其它代码块中的 money 命名相同
   final int money = 15978;
   // ...
   }
   }
   }
   
   class Son extends ConfusingName {
   // 不允许与父类的成员变量名称相同
   public int stock;
   }
   

10. 【强制】杜绝完全不规范的缩写，避免望文不知义。

    反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。
    

11. 【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达。

    正例：在 JDK 中，对某个对象引用的 volatile 字段进行原子更新的类名为：AtomicReferenceFieldUpdater。
    
    反例：常见的方法内变量为 int a;的定义方式。
    

12. 【推荐】在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。

    正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
    
    反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD
    

13. 【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，确定与接口方法相关，并且是整个应用的基础常量。

    正例：接口方法签名 void commit();  接口基础常量 String COMPANY = "alibaba";
    
    反例：接口方法定义 public abstract void f();
    

    说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。

14. 【强制】接口和实现类的命名，对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用Impl 的后缀与接口区别。

    正例：CacheServiceImpl 实现 CacheService 接口。
    

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

    正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON。
    

16. 【参考】各层命名规约

(A)	Service/DAO 层方法命名规约：
    1）	获取单个对象的方法用 get 做前缀。
    2）	获取多个对象的方法用 list 做前缀，复数结尾，如：listObjects。
    3）	获取统计值的方法用 count 做前缀。 
    4） 插入的方法用 save/insert 做前缀。 
    5） 删除的方法用 remove/delete 做前缀。 
    6） 修改的方法用 update 做前缀。
    7）补充：分页查询用page做前缀；导出用export做前缀；导入用import做前缀；返回布尔值用is做前缀；校验用check做前缀；填充用fill做前缀；

(B)	领域模型命名规约：
	1）	数据对象：xxxDO，xxx 即为数据表名。备注：DataObject的缩写，跟数据库表一 一对应。
	2）	数据传输对象：xxxDTO，xxx 为业务领域相关的名称。
备注：Data Transfer Object 的缩写，通常用于不同服务或服务不同分层之间的数据传输。 
	3）	展示对象：xxxVO，xxx 一般为网页名称。
备注：Value Object/View Object - 值对象/视图对象，用于展示层，它的作用是把某个指定页面（或组件）的所有数据封装起来，对应整个界面的值。
	4）	POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。
	5）	补充：业务对象：xxxBO，xxx一般为业务的名称。Business Object 的缩写，在设计上属于被服务层业务流程调用的对象。

三、总结

最后，在搭建JAVA项目框架结构时，应用命名规范、模块的划分、目录（包）的命名，都非常重要。如果做的足够好，导入项目代码后可能只需要10分钟就可以大概了解系统结构。

这里以某某商城项目为例，

比如工程应用名称格式为前缀公司名称jd+项目名称mall，比如：后端工程命名为jd-mall-cloud, 苹果端工程命名为jd-mall-ios-client, 安卓端工程命名为jd-mall-anroid-client, H5前端工程命名为jd-mall-webview；

比如包命名，一般为com+公司名称+项目名称，比如com.jd.mall;

比如模块的划分，统一定义好有哪些主要的业务模块，采用统一英文名称，比如商品goods，订单order，用户user，购物车cart，搜索search；

本文参考资料：

• 阿里云官方知乎：https://www.zhihu.com/org/a-li-yun-97-77
• 阿里云开发者官方社区：https://developer.aliyun.com/
• 阿里开发者官方CSDN社区：https://blog.csdn.net/alitech2017?type=blog
• 阿里云云栖号CSDN：https://blog.csdn.net/yunqiinsight/category_10231626.html
• 阿里巴巴技术团队发布的《JAVA开发手册》泰山版
• 阿里云开发者官方微信公众号

如果您对文章中内容有疑问，欢迎在评论区进行留言，我会尽量抽时间给您回复。如果文章对您有帮助，欢迎点赞、收藏。您的点赞，是对我最大的支持和鼓励，谢谢 :-）