阿里巴巴Java开发规范学习笔记

建议直接看阿里巴巴Java开发规范
百度网盘链接：https://pan.baidu.com/s/1vfAaBYDac-FntF_IUx69nw
提取码：6bm2

一、编程规约

（一）命名风格

1、POJO类中布尔类型变量不要加is，否则部分框架解析会引起序列化错误。
注意：MySQL表达是否的值采用is_xxx的形式，所以需要在设置is_xxx到xxx的映射关系。
2、避免子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，会降低可读性。
3、杜绝完全不规范的缩写，避免望文不知义。为了达到代码自解释的目的，命名时使用尽量完整的单词组合表达其意。
4、常量与变量的命名时，表示类型的名词放在词尾。
5、接口类中的方法和属性不加任何修饰符，并加上有效的Javadoc注释，尽量不在接口里定义变量。
6、Service和Dao——>Impl后缀实现
形容能力的接口名称，通常是-able的形容词。
7、枚举类带上Enum后缀，成员名称大写，下划线分隔。
8、数据对象：xxxDO/数据表名，数据传输对象：xxxDTO/业务领域相关的名称，展示对象：xxxVO，网页名称，POJO是DO/DTO/BO/VO的统称，禁止命名xxxPOJO。

（二）常量定义

1、不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。
2、long或Long赋值时，数字后用L，避免与数字1混淆。
3、如果变量值仅在一个固定范围内变化用enum类型来定义。

（三）代码格式

1、 左小括号和字符之间不出现空格； 同样，右小括号和字符之间也不出现空格；而左大括号前需要空格。
2、 if/for/while/switch/do 等保留字与括号之间都必须加空格 。
3、 任何二目、 三目运算符的左右两边都需要加一个空格 。
4、换行规则：（1）第二行相对第一行缩进4个空格，后面行和第二行齐；
（2）运算符和下文一起换行；
（3）方法调用的点和下文一起换行，
（4）方法参数换行在逗号之后进行；
（5）括号前不要换行。
5、IDE的换行符用Unix格式。
6、单个方法总行数不超过80行，不包括注释。
7、 不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。

（四）OOP规约

1、静态变量或方法直接用类名访问。
2、Object的equals容易抛出空指针异常，应该用常量或者确定有值的对象来调用equals。
3、所有整型包装类对象之间值的比较，全部使用equals方法比较。
说明：说明： 对于 Integer var = ? 在-128 至 127 范围内的赋值， Integer 对象是在 IntegerCache.cache 产生，会复用已有对象，这个区间内的 Integer 值可以直接使用“==”进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals 方法进行判断。

4、浮点数之间的等值判断，基本数据不能用“==”，包装类数据不能用equals。
采用：（1）指定在某个误差范围内，即认为相等；（2）使用BigDecimal来定义值。

未完待续。。。