文档介绍：JAVA开发编程规范建议
目录
JAVA开发编程规范建议 1
目录 2
第一章编程规范 3
(一)命名规范 3
(二)常量定义 5
(三)格式规范 6
(四)OOP 规范 8
(五)集合处理 11
(六)并发处理 14
(七)控制语句 16
(八)注释规范 18
(九)其它 19
二、异常日志 20
(一)异常处理 20
(二) 日志规范 21
三、工程规范 23
(一)二方库规范 23
(三)服务器规范 24
五、安全规范 25
六接口(服务)规范 26
编程规范
(一)命名规范
●代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。反例:name / name / $Object / name / name$ / Object$
●代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式也要避免采用。
反例: DaZhePromotion [打折] / getPingfenByName()[评分] / int 某变量= 3
正例: alibaba / taobao / youku / hangzhou等国际通用的名称,可视同英文。
●类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:(领域模型的相关命名)DO / BO / DTO / VO 等。
正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal/ TaPromotion
反例:macroPolo / UserDo / XMLService / TCPUDPDeal/ TAPromotion
●方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从驼峰形式。
正例: localValue / getHttpMessage()/ inputUserId
●常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。正例: MAX_STOCK_COUNT
反例: MAX_COUNT
●抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始,以 Test 结尾。
●中括号是数组类型的一部分,数组定义如下:String[] args;
反例:请勿使用Stringargs[]的方式来定义。
●POJO 类中布尔类型的变量,都不要加is,否则部分框架解析会引起序列化错误。反例:定义为基本数据类型 ess;的属性,它的方法也是 ess(),RPC 框架在反向解析的时候,“以为”对应的属性名称是 ess,导致属性获取不到,进而抛出异常。
●包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
正例:.、类名为 MessageUtils(此规则参考 spring 的框架结构)
●杜绝完全不规范的缩写,避免望文不知义。
反例: AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随意缩写严重降低了代码的可阅读性。
【推荐】如果使用到了设计模式,建议在类名中体现出具体模式。说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计思想。正例:lass OrderFactory;
public class LoginProxy; public class ResourceObserver;
【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量。
正例:接口方法签名:void f();
接口基础常量表示:PANY = "alibaba";
反例:接口方法定义:public abstract void f();
说明:JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值的默认实现。
接口和实现类的命名有两套规则:
●对于Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用 Impl 的后缀与接口区别。
正例:CacheServiceImpl 实现 CacheService 接口。
【推荐】如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able 的形式)。正例:Abst