代码规范很重要

# 前言

代码规范很重要，当你的代码不规范时，后续做维护的人可能根本不懂，造成不必要的误会，并且基本的代码规范很体现一个人的专业基础水平，所以还是把代码规范起来吧。

---

1.代码命名中不能参杂下划线，以及美元符号
反例：XX / XX / $XX/XX$
2.代码命名中不允许出现中文拼音和中文拼音与英文混用的情况。
反例：(查询/删除)chaxun/shanchu
3.类命名使用大写驼峰（UpperCamelCase），但出现DO/BO/DTO/VO/AO/PO/UID例外。
反例：userEntity
正确：UserEntity
4.方法名.参数名.成员变量.局部变量都使用小写驼峰风格（lowerCamelCase）
反例：UserEntity
正确：userEntity
5.常量命名单词都要大写，并用下划线隔开，且单词不能简写。
6.抽象类要以Abstract或者Base开头,异常类要以Exception结尾，测试类以测试的类命名并以Test结尾
7.定义数组时类型和中括号紧挨一起
8.POJO类中的任何布尔类型都不能以is_xxx前缀，会出现部分序列化错误
解释：MySQL建表约束中规定表达式是否采用is_xxx的命名方式，所以在设置is_xxx到莫表的映射关系
列如：is_deleted属性，方法是isDeleted，框架反向解析时，’误以为‘属性名是Deleted，导致解析错误。抛出异常。
9.包名在点分隔符之间有且只有一个自然语义的英文单词，包名统一使用单数形式，类名可以使用复数形式
10.避免在子类父类的成员变量中，或者不同代码块中局部变量出现完全相同的命名，使可理解性降低。
11.杜绝完全不规范的缩写，推荐定义变量时,写完整的单词
12.在常量和变量命名时，把类型的名称放在词尾（提高辨识度）
13.如果模块、接口、方法使用了设计模式，在命名是需要体现具体的设计模式。
14.在接口中的方法和属性不要加任何修饰符，如果一定要定义变量，必须和接口方法相关，并且是整个应用的基本常量
15.接口和实现类有两套规则
（1）对于Service和DAO类，基于SOA理念，暴露出现的服务一定是接口，内部的实现类用Impl的后缀与接口区别
（2）如果是形容能力的接口名称，取对应的形容词为接口名（通常是-able的形容词）
16.枚举类名带上Enum后缀，枚举成员名称需要全大写，并且用下划线隔开。（枚举是特殊的常量类）
17.各层命名约束
（1）Service/DAO曾命名约束
（1.1）获取单个对象用get做前缀
（1.2）获取多个对象用list做前缀，复数结尾（listObjects）
（1.3）获取统计值count做前缀
（1.4）插入的方法save/insert做前缀
（1.5）删除的方法delete/remove做前缀
（1.6）修改方法update做前缀
（2）领域模型命名
（2.1）数据对象：xxxxDO ,xxx表示表名
（2.2）数据传输对象：xxxDTO,xxx为业务领域相关名称
（2.3）展示对象：xxxVO,xxx一般为网页名称
（2.4）POJO是DO/DTO/BO/VO统称，禁止命名XXXPOJO