java编程规范 在线_Java编程规范 - osc_jb1iajxc的个人空间 - OSCHINA - 中文开源技术交流社区...

前言：此文来自阿里巴巴的Java编程规范，在这里记录一下自己以前有疏忽的编程规范。

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

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

三、如果使用到了设计模式，建议在类名中体现出具体模式。 说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。 正例：public class OrderFactory; public class LoginProxy; public class ResourceObserver;

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

五、枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。 说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。 正例：枚举名字：DealStatusEnum，成员名称：SUCCESS / UNKOWN_REASON。

六、各层命名规约： 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一般为网页名称。 4) POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO。

七、不允许任何魔法值(即未经定义的常量)直接出现在代码中。 反例： String key = "Id#taobao_" + tradeId; cache.put(key, value);

八、不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。如：缓存相关的常量放在类：CacheConsts下；系统配置相关的常量放在类：ConfigConsts下。 说明：大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。

九、

缩进采用4个空格，禁止使用tab字符。

说明： 如果使用 tab 缩进，必须设置 缩进，必须设置 缩进，必须设置 缩进，必须设置 缩进，必须设置 缩进，必须设置 1个 tab 为 4个空格。 IDEA 设置 tab 为 4个空格时， 请勿勾选 Use tab character ；而在 eclipse 中，必须勾选 insert spaces for tabs 。

十、IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式，不要使用windows格式。

十一、外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加@Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。

十二、Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。 正例： "test".equals(object); 反例： object.equals("test"); 说明：推荐使用java.util.Objects#equals (JDK7引入的工具类)

十三、所有的相同类型的包装类对象之间值的比较，全部使用equals方法比较。 说明：对于Integer var = ? 在-128至127范围内的赋值，Integer对象是在IntegerCache.cache产生，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equals方法进行判断。

十四、关于基本数据类型与包装数据类型的使用标准如下： 1) 【强制】所有的POJO类属性必须使用包装数据类型。 2) 【强制】RPC方法的返回值和参数必须使用包装数据类型。 3) 【推荐】所有的局部变量使用基本数据类型。 说明：POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，或者入库检查，都由使用者来保证。 正例：数据库的查询结果可能是null，因为自动拆箱，用基本数据类型接收有NPE风险。

反例：比如显示成交总额涨跌情况，即正负x%，x为基本数据类型，调用的RPC服务，调用不成功时，返回的是默认值，页面显示：0%，这是不合理的，应该显示成中划线-。所以包装数据类型的null值，能够表示额外的信息，如：远程调用失败，异常退出。

十五、定义DO/DTO/VO等POJO类时，不要设定任何属性默认值。 反例：POJO类的gmtCreate默认值为new Date();但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

十六、构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。

十七、POJO类必须写toString方法。使用IDE的中工具：source> generate toString时，如果继承了另一个POJO类，注意在前面加一下super.toString。 说明：在方法执行抛出异常时，可以直接调用POJO的toString()方法打印其属性值，便于排查问题。

十八、类内方法定义顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter方法。 说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为方法信息价值较低，所有Service和DAO的getter/setter方法放在类体最后。

十九、(不绝对看具体情况)setter方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在getter/setter方法中，不要增加业务逻辑，增加排查问题的难度。

二十、final可以声明类、成员变量、方法、以及本地变量，下列情况使用final关键字： 1) 不允许被继承的类，如：String类。 2) 不允许修改引用的域对象，如：POJO类的域变量。 3) 不允许被重写的方法，如：POJO类的setter方法。 4) 不允许运行过程中重新赋值的局部变量。 5) 避免上下文重复使用一个变量，使用final描述可以强制重新定义一个变量，方便更好地进行重构。

二十一、类成员与方法访问控制从严： 1) 如果不允许外部直接通过new来创建对象，那么构造方法必须是private。 2) 工具类不允许有public或default构造方法。 3) 类非static成员变量并且与子类共享，必须是protected。 4) 类非static成员变量并且仅在本类使用，必须是private。 5) 类static成员变量如果仅在本类使用，必须是private。 6) 若是static成员变量，必须考虑是否为final。 7) 类成员方法只供类内部调用，必须是private。 8) 类成员方法只对继承类公开，那么限制为protected。 说明：任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。思考：如果是一个private的方法，想删除就删除，可是一个public的service方法，或者一个public的成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，如果无限制的到处跑，那么你会担心的。

二十二、待续。。