读阿里的Java编码规约正式版小结

基本的知识就不说了,总结一些值得注意和参考的要点

1. 类命名遵循驼峰命名方式,对于BO,VO,DO,DTO 特殊含义的需全部大写;

2.抽象类以Abstract或Base开头;

3.数组的定义格式是 String[] args,而不是String []args;

4.POJO类中布尔类型的变量,都不要加is,否则部分框架解析会引起序列化错误;

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

正例:应用工具类包名为com.alibaba.open.util、类名为MessageUtils

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

public class LoginProxy;

public class ResourceObserver;

7.接口和实现类的命名有两套规则:

1)【强制】对于Service和DAO类,基于SOA的理念,暴露出来的服务一定是接口,内部

的实现类用Impl的后缀与接口区别。正例:CacheServiceImpl实现CacheService接口。

2)【推荐】 如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able的形式)。正例:AbstractTranslator实现Translatable。

8.【参考】各层命名规约:

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。

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

cache.put(key,value);

10.long或者Long初始赋值时,必须使用大写的L,不能是小写的l,小写容易跟数字1混淆,造成误解。

11.不要使用一个常量类维护所有常量,应该按常量功能进行归类,分开维护。如:缓存

相关的常量放在类:CacheConsts下;系统配置相关的常量放在类:ConfigConsts下

12.【强制】缩进采用4个空格,禁止使用tab字符。

13.如果使用tab缩进,必须设置1个tab为4个空格。IDEA设置tab为4个空格时,

请勿勾选Use tab character,而在eclipse中,必须勾选

insert spaces for tabs

14.IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式,

不要使用windows格式

15.所有的覆写方法,必须加@Override注解。

16.不能使用过时的类或方法。

17.推荐使用java.util.Objects#equals(JDK7引入的工具类),使用equals方法时,把常量放前面

18.关于基本数据类型与包装数据类型的使用标准如下:

1)所有的POJO类属性必须使用包装数据类型。

2)RPC方法的返回值和参数必须使用包装数据类型。

3)所有的局部变量【推荐】使用基本数据类型。

说明:POJO类属性没有初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何

NPE问题,或者入库检查,都由使用者来保证。

19.【强制】定义DO/DTO/VO等POJO类时,不要设定任何属性默认值。反例:POJO类的gmtCreate默认值为new Date();但是这个属性在数据提取时并没有置入具

体值,在更新其它字段时又附带更新了此字段,导致创建时间被修改成当前时间。

20.【强制】序列化类新增属性时,请不要修改serialVersionUID字段,避免反序列失败;如

果完全不兼容升级,避免反序列化混乱,那么请修改serialVersionUID值。

说明:注意serialVersionUID不一致会抛出序列化运行时异常。

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

22.【推荐】使用索引访问用String的split方法得到的数组时,需做最后一个分隔符后有无

内容的检查,否则会有抛IndexOutOfBoundsException的风险。

说明:

String str = "a,b,c,,";

String[] ary = str.split(",");//预期大于3,结果是3System.out.println(ary.length);

23.【推荐】final可提高程序响应效率,声明成final的情况:1)不需要重新赋值的变量,包括类属性、局部变量。

2)对象参数前加final,表示不允许修改引用的指向。

3)类方法确定不允许被重写

24.【推荐】慎用Object的clone方法来拷贝对象。

说明:对象的clone方法默认是浅拷贝,若想实现深拷贝需要重写clone方法实现属性对象

的拷贝。

25.【推荐】类成员与方法访问控制从严:

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的成员变量,删除一下,不得手心冒点汗吗?变量像自己的小孩,尽量在自己的视

线内,变量作用域太大,如果无限制的到处跑,那么你会担心的。

26.【强制】使用集合转数组的方法,必须使用集合的toArray(T[] array),传入的是类型完全

一样的数组,大小就是list.size()。

反例:直接使用toArray无参方法存在问题,此方法返回值只能是Object[]类,若强转其它

类型数组将出现ClassCastException错误。

正例:

List list = new ArrayList(2);list.add("guan");

list.add("bao");

String[] array = new String[list.size()];array = list.toArray(array);

说明:使用toArray带参方法,入参分配的数组空间不够大时,toArray方法内部将重新分配

内存空间,并返回新数组地址;如果数组元素大于实际所需,下标为[ list.size() ]的数组

元素将被置为null,其它数组元素保持原值,因此最好将方法入参数组大小定义与集合元素

个数一致。

27.【强制】不要在foreach循环里进行元素的remove/add操作。remove元素请使用Iterator

方式,如果并发操作,需要对Iterator对象加锁。

28.【推荐】集合初始化时,尽量指定集合初始值大小。

29.使用entrySet遍历Map类集合KV,而不是keySet方式进行遍历。

说明:keySet其实是遍历了2次,一次是转为Iterator对象,另一次是从hashMap中取出key所对应的value。而entrySet只是遍历了一次就把key和value都放到了entry中,效

率更高。如果是JDK8,使用Map.foreach方法。

正例:values()返回的是V值集合,是一个list集合对象;keySet()返回的是K值集合,是

一个Set集合对象;entrySet()返回的是K-V值组合集合。

30.由于HashMap的干扰,很多人认为ConcurrentHashMap是可以置入null值,注意存储null值时会抛出NPE异常

31.【参考】合理利用好集合的有序性(sort)和稳定性(order),避免集合的无序性(unsort)和

不稳定性(unorder)带来的负面影响。说明:稳定性指集合每次遍历的元素次序是一定的。有序性是指遍历的结果是按某种比较规则

依次排列的。如:ArrayList是order/unsort;HashMap是unorder/unsort;TreeSet是order/sort。

32.【参考】利用Set元素唯一的特性,可以快速对一个集合进行去重操作,避免使用List的contains方法进行遍历、对比、去重操作

33.【强制】线程池不允许使用Executors去创建,而是通过ThreadPoolExecutor的方式,这样

的处理方式让写的同学更加明确线程池的运行规则,规避资源耗尽的风险。说明:Executors返回的线程池对象的弊端如下:

1)FixedThreadPool和SingleThreadPool:

允许的请求队列长度为Integer.MAX_VALUE,可能会堆积大量的请求,从而导致OOM。

2)CachedThreadPool和ScheduledThreadPool:

允许的创建线程数量为Integer.MAX_VALUE,可能会创建大量的线程,从而导致OOM。

34.【参考】方法中需要进行参数校验的场景:

1)调用频次低的方法。

2)执行时间开销很大的方法,参数校验时间几乎可以忽略不计,但如果因为参数错误导致

中间执行回退,或者错误,那得不偿失。

——禁止用于商业用途,违者必究——15/34

阿里巴巴Java开发手册3)需要极高稳定性和可用性的方法。

4)对外提供的开放接口,不管是RPC/API/HTTP接口。5) 敏感权限入口。

35.【强制】方法内部单行注释,在被注释语句上方另起一行,使用//注释。方法内部多行注释使用/* */注释,注意与代码对齐。

36.类、类属性、类方法的注释必须使用Javadoc规范,使用/**内容*/格式,不得使用//xxx方式。

37.【强制】在使用正则表达式时,利用好其预编译功能,可以有效加快正则匹配速度。说明:不要在方法体内定义:Pattern pattern=Pattern.compile(规则);

38.【强制】获取当前毫秒数System.currentTimeMillis();而不是new Date().getTime();

说明:如果想获取更加精确的纳秒级时间值,用System.nanoTime()。在JDK8中,针对统计

时间等场景,推荐使用Instant类。

39.【强制】捕获异常是为了处理它,不要捕获了却什么都不处理而抛弃之,如果不想处理它,请将该异常抛给它的调用者。最外层的业务使用者,必须处理异常,将其转化为用户可以理解的内容

40.【强制】不能在finally块中使用return,finally块中的return返回后方法结束执行,不

会再执行try块中的return语句

41.【推荐】方法的返回值可以为null,不强制返回空集合,或者空对象等,必须添加注释充分说明什么情况下会返回null值。调用方需要进行null判断防止NPE问题。说明:本规约明确防止NPE是调用者的责任。即使被调用方法返回空集合或者空对象,对调用者来说,也并非高枕无忧,必须考虑到远程调用失败,运行时异常等场景返回null的情况。

42.【推荐】防止NPE,是程序员的基本修养,注意NPE产生的场景:

1)返回类型为包装数据类型,有可能是null,返回int值时注意判空。

反例:public int f(){return Integer对象};如果为null,自动解箱抛NPE。2)数据库的查询结果可能为null。

3)集合里的元素即使isNotEmpty,取出的数据元素也可能为null。

4)远程调用返回对象,一律要求进行NPE判断。

5)对于Session中获取的数据,建议NPE检查,避免空指针。

6)级联调用obj.getA().getB().getC();一连串调用,易产生NPE。

43.【推荐】在代码中使用“抛异常”还是“返回错误码”,对于公司外的http/api开放接口必须

使用“错误码”;而应用内部推荐异常抛出;跨应用间RPC调用优先考虑使用Result方式,封

装isSuccess、“错误码”、“错误简短信息”。

说明:关于RPC方法返回方式使用Result方式的理由:

1)使用抛异常返回方式,调用方如果没有捕获到就会产生运行时错误。

2)如果不加栈信息,只是new自定义异常,加入自己的理解的error message,对于调用

端解决问题的帮助不会太多。如果加了栈信息,在频繁调用出错的情况下,数据序列化和传输的性能损耗也是问题。

44.【强制】应用中不可直接使用日志系统(Log4j、Logback)中的API,而应依赖使用日志框架

SLF4J中的API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

private static final Logger logger = LoggerFactory.getLogger(Abc.class);

45.【推荐】给JVM设置-XX:+HeapDumpOnOutOfMemoryError参数,让JVM碰到OOM场景时输出dump信息。

说明:OOM的发生是有概率的,甚至有规律地相隔数月才出现一例,出现时的现场信息对查错非常有价值。

46.【强制】表单、AJAX提交必须执行CSRF安全过滤。

说明:CSRF(Cross-site request forgery)跨站请求伪造是一类常见编程漏洞。对于存在CSRF漏洞的应用/网站,攻击者可以事先构造好URL,只要受害者用户一访问,后台便在用户

不知情情况下对数据库中用户参数进行相应修改。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,723评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,003评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,512评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,825评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,874评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,841评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,812评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,582评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,033评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,309评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,450评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,158评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,789评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,409评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,609评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,440评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,357评论 2 352

推荐阅读更多精彩内容