文章目录
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 / AO / PO / UID 等。
正例:
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.
【强制】
POJO 类中的任何布尔类型的变量,都不要加 is 前缀,否则部分框架解析会引起序列化错误。
说明:
在本文 MySQL 规约中的建表约定第一条,表达是与否的值采用 is_xxx 的命名方式,所以,需要在 <resultMap>设置从 is_xxx 到 xxx 的映射关系。
反例:
定
义为基本数据类型 Boolean isDeleted 的属性,它的方法也是 isDeleted(),框架在反向解析的时候,“误以为
”对应的属性名称是 deleted,导致属性获取不到,进而抛出异常。
9.
【强制】
包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用
单数
形式,但是类名如果有复数含义,类名可以使用复数形式。 </