阿里巴巴 Java 编码规范最佳实践

概述

最近在实际项目中使用 p3c for eclipse 插件进行检测，发现项目中有不少不符合 “阿里巴巴 Java 编码规范” 的代码，现在已经由之前的 2000+ 个优化到 500 个以内了（还需要继续努力优化），这里就优化的过程中遇到的难点已经实践中的经验进行分享。

如何使用插件

eclipse 中可以安装 p3c 插件，可以参考官方的教程进行安装：https://github.com/alibaba/p3c/blob/master/eclipse-plugin/README_cn.md

如何优化代码

使用插件进行代码检测之后可以看到 Blocker、Critical、Major 三种级别信息，其中 Blocker 为最高级别，Major 为最低级别，如果需要优化的代码比较多的话，可以按照从高到低、从简到难到顺序进行优化。

在优化代码的过程中的一些典型的案例这里一一分享给大家

【Blocker】所有的包装类对象之间值的比较，全部使用equals方法比较

优化建议：如果是从数据库中查询出来的对象进行比较的话，重写对象的 equals 方法，方法内部使用 ID 进行比较，外部调用 equals 进行比较即可，一般情况下数据库中 ID 相同的对象就可以认为是一个对象了

【Major】不允许任何魔法值（即未经定义的常量）直接出现在代码中

优化建议：这一条规范在我们的项目中是最容易犯的，这也是容易偷懒不按照规范来进行编码的地方之一。例如我们判断身份证长度为 15 或 18 位，一般进行 if (length == 15 || length == 18) ，像银行卡长度等之类的都会用到这些数字，最好的方式是定义一个全局的常量来规范这些身份证长度、银行卡长度等，这样解决不规范的代码的同时还方便阅读代码。

手机号正则表达式验证、HTTP 请求成功响应码 200、一周 7 天、编码集字符串（例如：UTF-8）、换行符、逗号分隔符等，这些均可以定义为全局变量方便整个项目使用。

如果后端需要返回一些错误提示等，我们可以定义全局的提示 Language.java 或者使用不同的 Exception 进行错误返回。