文档章节

阿里强制要求的21条Java开发规范,可以避免很多坑

天王盖地虎626
 天王盖地虎626
发布于 01/20 09:19
字数 2100
阅读 35
收藏 23

1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成本,直接用类名来访问即可。

2. 【强制】所有的覆写方法,必须加@Override注解。 说明:getObject()与get0bject()的问题。一个是字母的O,一个是数字的0,加@Override可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编译报错。

3. 【强制】相同参数类型,相同业务含义,才可以使用Java的可变参数,避免使用Object。 说明:可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程) 正例:public List<User> listUsers(String type, Long... ids) {...}

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

5. 【强制】不能使用过时的类或方法。 说明:java.net.URLDecoder 中的方法decode(String encodeStr) 这个方法已经过时,应该使用双参数decode(String source, String encode)。接口提供方既然明确是过时接口,那么有义务同时提供新的接口;作为调用方来说,有义务去考证过时方法的新实现是什么。

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

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

8. 关于基本数据类型与包装数据类型的使用标准如下: 1) 【强制】所有的POJO类属性必须使用包装数据类型。 2) 【强制】RPC方法的返回值和参数必须使用包装数据类型。 3) 【推荐】所有的局部变量使用基本数据类型。 说明:POJO类属性没有初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何NPE问题,或者入库检查,都由使用者来保证。 正例:数据库的查询结果可能是null,因为自动拆箱,用基本数据类型接收有NPE风险。 反例:比如显示成交总额涨跌情况,即正负x%,x为基本数据类型,调用的RPC服务,调用不成功时,返回的是默认值,页面显示为0%,这是不合理的,应该显示成中划线。所以包装数据类型的null值,能够表示额外的信息,如:远程调用失败,异常退出。

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

10. 【强制】序列化类新增属性时,请不要修改serialVersionUID字段,避免反序列失败;如果完全不兼容升级,避免反序列化混乱,那么请修改serialVersionUID值。 说明:注意serialVersionUID不一致会抛出序列化运行时异常。

11. 【强制】构造方法里面禁止加入任何业务逻辑,如果有初始化逻辑,请放在init方法中。

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

13. 【强制】禁止在 POJO类中,同时存在对应属性 xxx的 isXxx()和 getXxx()方法。 说明: 框架在调用属性 xxx

14. 【推荐】使用索引访问用String的split方法得到的数组时,需做最后一个分隔符后有无内容的检查,否则会有抛IndexOutOfBoundsException的风险。

说明:

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

15. 【推荐】当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起,便于阅读,此条规则优先于第16条规则。

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

17. 【推荐】setter方法中,参数名称与类成员变量名称一致,this.成员名 = 参数名。在getter/setter方法中,不要增加业务逻辑,增加排查问题的难度。 反例:

public Integer getData() {
 if (condition) {
 return this.data + 100;
 } else {
 return this.data - 100;
 }
 }

18. 【推荐】循环体内,字符串的连接方式,使用StringBuilder的append方法进行扩展。 说明:下例中,反编译出的字节码文件显示每次循环都会new出一个StringBuilder对象,然后进行append操作,最后通过toString方法返回String对象,造成内存资源浪费。

反例:

String str = "start";
for (int i = 0; i < 100; i++) {
 str = str + "hello";
}

19. 【推荐】final可以声明类、成员变量、方法、以及本地变量,下列情况使用final关键字:

1) 不允许被继承的类,如:String类。
 2) 不允许修改引用的域对象。 
3) 不允许被重写的方法,如:POJO类的setter方法。
4) 不允许运行过程中重新赋值的局部变量。 5) 避免上下文重复使用一个变量,使用final描述可以强制重新定义一个变量,方便更好地进行

20. 【推荐】慎用Object的clone方法来拷贝对象。 说明:对象的clone方法默认是浅拷贝,若想实现深拷贝需要重写clone方法实现域对象的深度遍历式拷贝。

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

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成员方法或成员变量,删除一下,不得手心冒点汗吗?变量像自己的小孩,尽量在自己的视线内,变量作用域太大,无限制的到处跑,那么你会担心的。

本文转载自:https://www.toutiao.com/a6648051046264341000/?tt_from=weixin&utm_campaign=client_share&wxshare_co...

共有 人打赏支持
天王盖地虎626
粉丝 22
博文 222
码字总数 7329
作品 0
南京
私信 提问
新增16条设计规约!阿里巴巴Java开发手册(详尽版)开放下载!

《阿里巴巴Java开发手册》是阿里内部Java工程师所遵循的开发规范,涵盖编程规约、单元测试规约、异常日志规约、MySQL规约、工程规约、安全规约等,这是近万名阿里Java技术精英的经验总结,并...

山哥在这里
2018/06/05
0
0
我有礼品你有故事吗 —— Java 开发规约勾起了你什么样的回忆?

那哥们写的类名首字母居然没大写? 变量名是用下横杠分隔还是驼峰状呢? ON! HashMap 的并发操作导致死循环了! 维护别人写的恶心代码shi简直有想重构的冲动…… 你在 Java 开发时是否遇到过...

两味真火
2017/02/28
3.6K
25
《阿里巴巴Java开发手册》2018年完整资料下载!

无规矩不成方圆,无规范不能协作。 《阿里巴巴Java开发手册》(以下简称《手册》)是阿里内部Java工程师所遵循的开发规范,涵盖编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程规...

阿里云云栖社区
2018/10/24
0
0
阿里获邀加入 JCP ,参与制定 Java 全球标准和技术规范

2018年5月17日,作为唯一中国代表,阿里巴巴获邀加入 Java 全球管理组织 Java Community Process (JCP) 的最高执行委员会。此次获得执行委员会席位,让中国企业首次加入到 Java 全球标准的制...

王练
2018/05/17
5.5K
88
阿里巴巴宣布连任Java全球管理组织席位

最受开发者欢迎的Java有了新动态。11月23日,阿里巴巴宣布连任Java 全球管理组织JCP最高执行委员会委员,任期从2018年12月4号开始,为期两年。这意味将有更多中国开发者的声音被引入 Java 规...

辽元
2018/11/24
0
0

没有更多内容

加载失败,请刷新页面

加载更多

Spring Cloud 入门教程9、服务限流/API限流(Zuul+RateLimiter)

一、前言 1、什么是RateLimiter、Spring Cloud Zuul RateLimiter? RateLimiter是Google开源的实现了令牌桶算法的限流工具(速率限制器)。http://ifeve.com/guava-ratelimiter/ Spring Clou...

吴伟祥
2分钟前
0
0
win10多人同时远程桌面连接 教程

win10多人同时远程桌面连接 教程 1 新建用户 右键“此电脑”->管理->本地用户和组 右键“用户”->新用户 点击【创建】按钮,即可完成用户创建。 2 添加远程桌面用户 右键“此电脑”->属性->远...

linjin200
13分钟前
0
0
本地运行Kmeans算法

参考资料链接:https://github.com/CraigCovey/spark-examples/blob/f8182a6736fd5293dfa03b023eb1423363ba6041/spark-1_6/scala/clustering/kmeans/kmeans_clustering_main.scala packag......

KYO4321
13分钟前
0
0
超长干货 | Kubernetes命名空间详解

K8s使用命名空间的概念帮助解决集群中在管理对象时的复杂性问题。在本文中,会讨论命名空间的工作原理,介绍常用实例,并分享如何使用命名空间来管理K8s对象。最后,介绍名为projects的Ranch...

RancherLabs
16分钟前
0
0
Syncfusion教程:在Xamarin.Forms中创建数据输入表单 (4)

下载Essential Studio for Xamarin最新版本 Essential Studio for Xamarin是全面的Xamarin.iOS、Xamarin.Android和Xamarin.Forms组件套包,包含最快的图表和网格。 分段控制不定开关 在进一步...

电池盒
16分钟前
0
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部