阿里java代码规范手册 阿里 java 规范

为什么阿里工程师代码写的好？看看他的代码规范就知道了

曾经与一位从阿里出来的Java工程师一起工作过一段时间，他的技术说不上非常厉害， 但是，他的代码写的的非常好，凡是他做的功能很少出现Bug 。我就很好奇，于是经常向他请教一些代码设计的原则，然后他告诉了我阿里Java手册。并且，他将这个手册进行了修改，也成为了我司Java程序员的开发手册。 这篇文章就让我们看一看这个手册中比较重要的原则。

成都网站制作、网站设计、外贸网站建设的开发，更需要了解用户，从用户角度来建设网站，获得较好的用户体验。创新互联多年互联网经验，见的多，沟通容易、能帮助客户提出的运营建议。作为成都一家网络公司，打造的就是网站建设产品直销的概念。选择创新互联，不只是建站，我们把建站作为产品，不断的更新、完善，让每位来访用户感受到浩方产品的价值服务。

【强制】 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

反例：_name / __name / $name / name_ / name$ / name__

【强制】 类型与中括号紧挨相连来表示数组。

正例：定义整形数组 int[] arrayDemo; 反例：在 main 参数中，使用 String args[]来定义。

【强制】 POJO 类中布尔类型变量都不要加 is 前缀，否则部分框架解析会引起序列化错误。

说明：表达是与否的值采用 is_xxx 的命名方式，所以，需要在 设置从 is_xxx 到 xxx 的映射关系。

反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()， RPC 框架在反向解 析的时候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。

【推荐】 在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。

【推荐】 接口类中的方法和属性不要加任何修饰符号(public 也不要加)，保持代码的简洁 性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定 是与接口方法相关，并且是整个应用的基础常量。

正例:接口方法签名 void commit();

接口基础常量 String COMPANY = "alibaba";

反例:接口方法定义 public abstract void f();

说明:JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。

【参考】 枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。

说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有。

正例:枚举名字为 ProcessStatusEnum 的成员名称:SUCCESS / UNKNOWN_REASON。

【参考】 各层命名规约:

1) 获取单个对象的方法用 get 做前缀。

2) 获取多个对象的方法用 list 做前缀，复数形式结尾如:listObjects。 3) 获取统计值的方法用 count 做前缀。

4) 插入的方法用 save/insert 做前缀。

5) 删除的方法用 remove/delete 做前缀。

6) 修改的方法用 update 做前缀。

1) 数据对象:xxxDO，xxx 即为数据表名。

2) 数据传输对象:xxxDTO，xxx 为业务领域相关的名称。

3) 展示对象:xxxVO，xxx 一般为网页名称。

4) POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

【强制】 不允许任何魔法值(即未经预先定义的常量)直接出现在代码中。

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

【强制】 相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。

说明：可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程)

【强制】 所有整型包装类对象之间值的比较，全部使用equals方法比较。

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

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

说明： POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值 ，任何 NPE 问题，或 者入库检查，都由使用者来保证。

正例：数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。

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

【强制】 POJO 类必须写 toString 方法。

使用 IDE 中的工具:source generate toString 时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。

说明： 在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排查问题。

【强制】 关于hashCode和equals的处理，遵循如下规则：

说明：String 已覆写 hashCode 和 equals 方法，所以我们可以愉快地使用 String 对象作为 key 来使用。

【强制】 线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。

说明：线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销，解决资源不足的问 题。 如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。

【强制】 线程池不允许使用Executors去创建，而是通过ThreadPoolExecutor的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。

以上规范在设计代码中，是比较重要的原则。如果编写代码的过程中，可以依照以上原则，那代码的可读性和可维护性将大大提升

idea阿里巴巴规范插件报错

等级调到Inspactions。idea是阿里巴巴所研发的代码规范插件，idea阿里巴巴规范插件报错等级调到Inspactions即可，规范基于《阿里巴巴Java开发手册》，在IntelliJ IDEA的插件管理中直接搜索Alibaba Java Coding Guidelines即可。

eclipse alibaba代码规范插件怎么使用

在开发中，好的编程风格可以提升团队合作能力，提升开发的效率，但是每个人都有自己的编程习惯，如何能够将大家的编程风格统一，这个在团队中也很重要;

在Java编程中，阿里出版过一套关于Java的开发规范手册，我们可以在开发中按照这一套手册来进行开发，但是手册的内容比较多，因此阿里也专门提供了一套编码规范的插件，可以将插件安装到我们的开发环境中提升开发效率。

IDEA中阿里编码规范的安装：

1. 进入File-Setting

2.选择Plugins选项

3.在Plugins页面选择Marketplace选项，然后输入ali，会将ali相关的插件列出来

选择Alibaba Java Coding Guidelins进行安装，安装完成之后，需要重新启动IDEA，插件才可以生效。

之后的开发中，如果我们的编码有不规范的地方，IDEA就会有相应的提示。

或者我们可以在页面中右击鼠标右键，在弹出的列表中选择编码规约扫描，就可以将扫描结果列出来。

扫描之后结果会在下方列出来，比如未增加创建者信息，不允许任何魔法值等，并会详细定位到代码位置，而且也会详细介绍原因并且给出正确的代码示例。

由于阿里是我们国内的企业，因此阿里规范插件给我们提示的时候，也会按照中文的方式给我们提示，对于英语不好的人来说，方便了很多。

使用阿里规范的时候，也可以和Git进行组合一起操作，就是当我们选择提交代码的时候，可以将检查规范的选项勾选，这样在提交的时候，如果有不规范的代码，IDEA就会提示我们是否确认要提交。

无法查找到插件解决办法：

有时候我们在搜索插件的时候，由于网络原因，经常性的搜索不到插件，这时候我们就需要离线进行安装插件;

首先我们需要先到IDEA官网查找我们需要的插件信息：

输入我们想要安装的插件信息进行搜索，查找到之后选择进入插件详情页面

在详情页中我们可以选择不同版本的插件进行下载，将插件下载好之后我们就可以在我们IDEA中离线进行安装插件了;

离线安装插件的过程是在插件页面选择installed旁边的按钮，选择Install Plugin From Disk;之后在自己电脑上选择刚才下载的插件，就可以离线进行安装了，安装好之后同样需要重新启动IDEA插件才可以生效。

除了阿里代码规范之外，我们也可以选择其他的代码规范插件，比如SonarLint，其实开发中不论是用哪种插件，都是为了让我们养成好的编程风格，因此，在编程中，我们要养成良好的编程风格，不搞特殊，这样才能提升开发的效率。

以上就是关于代码规范插件怎么使用的讲解，更多关于java编程方面的问题可以看下这个视频教程：网页链接，希望我的回答能帮到你。