代码规范

 

变量命名规范
变量命名分为前后端传值与后端内部变量命名：

前后端传值应该注意以下几点：

统一命名：新增接口，应该统一使用下划线格式。

避免冗余字段：每次在新增接口字段时，注意是否已经存在同一个含义的字段，保持命名一致，不要同时存在”user_name”，”username”,"tel_phone","tel_number"多种同义字段。

注释清晰（重要）：每个接口/字段都需要有详细的描述信息，很多时候接口体现业务逻辑，是团队中很重要的文档沉淀，同时，详细的接口文档，可以帮助新人快速熟悉业务。

后端内部变量命名:

所有命名不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

命名应该以有意义的英文单词组成或者国际通用的名称。不能有拼音与英文单词混合使用。

方法名、参数名、成员变量、局部变量都统一使用小驼峰风格，必须遵从驼峰形式。

常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚

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

类文件规范

类名应该使用大驼峰命名风格，但以下情形例外：DO / BO / DTO / VO/ AO/ PO/ UID等。

抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。

避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可读性降低。

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

方法命名规范

Service/DAO层方法命名规约
1）获取单个对象的方法用get做前缀。
2）获取多个对象的方法用List结尾。
3）获取统计值的方法用count做结尾。
4）插入的方法用save/insert做前缀。
5）删除的方法用remove/delete做前缀。
6）修改的方法用update做前缀。
7）根据Map对象查询时，以ByParams为结尾。