Code Review 代码规范

1.编码常规项

• 代码是否内存泄漏，是否UI成红色，是否性能低下，是否会形成crash
• 各种异常逻辑是否处理
• 代码能够工作么？它有没有实现预期的功能，逻辑是否正确等。
• 所有的代码是否简单易懂？
• 代码符合你所遵循的编程规范么？这通常包括大括号的位置，变量名和函数名，行的长度，缩进，格式和注释。
• 是否存在多余的或是重复的代码？
• 代码是否尽可能的模块化了？
• 是否有可以被替换的全局变量？
• 是否有被注释掉的代码？
• 循环是否设置了长度和正确的终止条件？
• 是否有可以被库函数替代的代码？
• 是否有可以删除的日志或调试代码？

2.代码规范

• Service/DAO层方法命名规约

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

2）获取多个对象的方法用list做前缀。

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

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

说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。正例：枚举名字为ProcessStatusEnum的成员名称：SUCCESS/ UNKOWN_REASON。

• 采用4个空格缩进，禁止使用tab字符。

说明：如果使用tab缩进，必须设置1个tab为4个空格。IDEA设置tab为4个空格时，请勿勾选Use tab character；而在eclipse中，必须勾选insert spaces for tabs。

• 建表规约

1.【强制】表达是与否概念的字段，必须使用is_xxx的方式命名，数据类型是unsignedtinyint（1表示是，0表示否）。

说明：任何字段如果为非负数，必须是unsigned。正例：表达逻辑删除的字段名is_deleted，1表示删除，0表示未删除。

2.【强制】表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。

说明：MySQL在Windows下不区分大小写，但在Linux下默认是区分大小写。因此，数据库名、表名、字段名，都不允许出现任何大写字母，避免节外生枝。正例：aliyun_admin，rdc_config，level3_name反例：AliyunAdmin，rdcConfig，level_3_name

3.【强制】表名不使用复数名词。

说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于DO类名也是单数形式，符合表达习惯。

4.【强制】禁用保留字，如desc、range、match、delayed等，请参考MySQL官方保留字。

5.【强制】主键索引名为pk_字段名；唯一索引名为uk_字段名；普通索引名则为idx_字段名。说明：pk_ 即primary key；uk_ 即uniquekey；idx_ 即index的简称。

6.【强制】小数类型为decimal，禁止使用float和double。说明：float和double在存储的时候，存在精度损失的问题，很可能在值的比较时，得到不正确的结果。如果存储的数据范围超过decimal的范围，建议将数据拆成整数和小数分开存储。

7.【强制】如果存储的字符串长度几乎相等，使用char定长字符串类型。

8.【强制】varchar是可变长字符串，不预先分配存储空间，长度不要超过5000，如果存储长度大于此值，定义字段类型为text，独立出来一张表，用主键来对应，避免影响其它字段索引效率。

9.【强制】表必备三字段：id, gmt_create, gmt_modified。说明：其中id必为主键，类型为unsigned bigint、单表时自增、步长为1。gmt_create, gmt_modified的类型均为date_time类型，前者现在时表示主动创建，后者过去分词表示被动更新。

10.【推荐】表的命名最好是加上“业务名称_表的作用”。正例：alipay_task/ force_project/ trade_config

12.【推荐】如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。

13.【推荐】字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循：1）不是频繁修改的字段。2）不是varchar超长字段，更不能是text字段。正例：商品类目名称使用频率高，字段长度短，名称基本一成不变，可在相关联的表中冗余存储类目名称，避免关联查询。

15.【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度

 

安装Alibaba Java Code Guidelines插件

可以通过直接通过Jetbrians官方仓库安装，由于网络关系，这里选择手工安装方式

1）、下载最新版本「Alibaba Java Coding Guidelines插件」

http://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines/versions

2）、IntelliJ IDEA → Preference→Plugins，选择「install Plugin from Disk...」完成后，选择重启IntelliJ IDEA。