天天看点

java编程规范笔记(一)

1. 命名风格

    代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束

    代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式

    类名使用UpperCamelCase风格,必须遵从驼峰形式

    方法名、参数名、成员变量、局部变量都统一遵从驼峰形式

    常量命名全部大写,单词间用下划线隔开

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

    包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式

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

    各层命名规约:

      A) Service/DAO层方法命名规约

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

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

        3) 获取统计值的方法用count做前缀。

        4) 插入的方法用save/insert做前缀。

        5) 删除的方法用remove/delete做前缀。

        6) 修改的方法用update做前缀。

PO 持久对象,数据;

BO 业务对象,封装对象、复杂对象 ,里面可能包含多个类;

DTO 传输对象,前端调用时传输 ;

VO 表现对象,前端界面展示。

  B) 领域模型命名规约

    1) 数据对象:xxxDO,xxx即为数据表名。

    2) 数据传输对象:xxxDTO,xxx为业务领域相关的名称。

    3) 展示对象:xxxVO,xxx一般为网页名称。

    4) POJO是DO/DTO/BO/VO的统称,禁止命名成xxxPOJO。