命名规范

1、工程中的所有包名统一小写。

• com.bytter.xxx

• 2、所有编程相关的变量命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。

3、所有编程相关的变量命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。

4、类名使用大驼峰（UpperCamelCase）风格，必须遵从大驼峰形式，但以下情形例外：(领域模型的相关命名)DO / DTO / VO 等。

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

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

 7、数组定义如下：String[] args，严禁使用 String args[] 的方式来定义。

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

 

9、各层方法命名：

java

1. A) Service/Dao 层方法命名
2. 1) 获取单个对象的方法用 get 做前缀。
3. 2) 获取多个对象的方法用 list 做前缀。
4. 3) 获取统计值的方法用 count 做前缀。
5. 4) 插入的方法用 save 做前缀。
6. 5) 删除的方法用 delete 做前缀。
7. 6) 修改的方法用 update 做前缀。
8. 7) 批量的方法用 batch 做前缀。
9. B) 领域模型命名
10. 1) 数据对象:xxx,xxx 即为数据表名，此对象也为实体类。
11. 2) 数据传输对象:xxxDTO,xxx 为业务领域相关的名称，用于接口层的数据传输。
12. 3) 展示对象:xxxVO,xxx 一般为网页名称。
13. 4) POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO。

10、常量定义：

     1、long 或者 Long 初始赋值时,必须使用大写的 L,不能是小写的 l,小写容易跟数字 1 混淆,造成误解。

     2、不要使用一个常量类维护所有常量,应该按常量功能进行归类,分开维护。

11、代码风格规范

1、在导入工程或新建工程时，务必确保整个工程中的所有文件为UTF-8编码。

2、代码使用 tab 缩进（一个tab等于4个空格宽度）。

3、大括号的使用约定。如果是大括号内为空,则简洁地写成{},不需要换行;如果是非空代码块则:

• 1) 左大括号前不换行。
• 2) 左大括号后换行。
• 3) 右大括号前换行。
• 4) 右大括号后还有 else 等代码则不换行;表示终止右大括号后必须换行。

4、if/else/for/while/do 语句中哪怕只有一行代码，也必须要加上大括号。

5、if/for/while/switch/do 等保留字与左右括号之间都必须加空格。

6、任何运算符左右必须加一个空格。

7、方法参数在定义和传入时,多个参数逗号后边必须加空格。

8、方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。