命名规约

1.【强制】 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。

反例: name / \_name / $Object / name_ / name$ / Object$

2.【强制】 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。

说明: 正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式 也要避免采用。

正例: monda / dayi / youku / hangzhou 等国际通用的名称,可视同英文。

反例: DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

3.【强制】 类名使用 UpperCamelCase 风格,必须遵从驼峰形式。

正例: MarcoPolo / UserDao / XmlService / TcpUdpDeal / TaPromotion

反例: macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

4.【强制】 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从 驼峰形式。

正例: localValue / getHttpMessage() / inputUserId

5.【强制】 常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。

正例: MAX_STOCK_COUNT

反例: MAX_COUNT

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

7.【强制】中括号是数组类型的一部分,数组定义如下:String[] args;

反例: 使用String args[]的方式来定义。

8.【强制】 POJO 类中布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误。

反例: 定义为基本数据类型Boolean isDeleted;的属性,它的方法也是isDeleted(),框架在反向解析的时候,“以为”对应的属性名称是 deleted,导致属性获取不到,进而抛出异 常。

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

正例: 应用工具类包名为com.alibaba.open.util、类名为MessageUtils(此规则参考 spring 的框架结构)

10.【强制】 杜绝完全不规范的缩写,避免望文不知义。

反例: AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类 随意缩写严重降低了代码的可阅读性。

常用词简写:

全称 简写
argument arg
buffer buf
compare cmp
configuration cfg
context ctx
error err
hexadecimal hex
initialize init
maximum max
message msg
minimum min
multiplex mux
operating system os
parameter param
previous prev
register reg
synchronize sync

11.【强制】 如果使用到了设计模式,需要在类名中体现出具体模式。

说明: 将设计模式体现在名字中,有利于阅读者快速理解架构设计思想。 比如使用了工厂模式,name类名就要出现类似 Factory 的字眼。

正例:

public class OrderFactory;
public class LoginProxy; 
public class ResourceObserver;

12.【强制】 接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁性,并加上有效的 Javadoc 注释。不要在接口里定义变量,但是允许在接口中定义整个应用的基础常量。

13.接口和实现类的命名有两套规则:

  • 于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部 的实现类用 Impl 的后缀与接口区别。

正例: CacheServiceImpl 实现 CacheService 接口。

  • 如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able 的形式)。

正例: AbstractTranslator 实现 Translatable。

14.【强制】 枚举类需要带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。

说明: 枚举其实就是特殊的常量类,且构造方法被默认强制是私有。

正例: 枚举名字:DealStatusEnum,成员名称:SUCCESS / UNKOWN_REASON。

15.【强制】各层命名规约,controller 层, service 层, dao 层的命名需要以 业务名称 + 层名称 来命名

正例: UserController / UserService / UserDao

A) Service/DAO 层方法命名规约 1. 获取单个对象的方法用 get 做前缀。 2. 获取多个对象的方法用 list 做前缀。 3. 获取统计值的方法用 count 做前缀。 4. 添加的方法用 add 做前缀,addUser(User user)。 5. 修改的方法用 update 做前缀,updateUser(User user)。 6. 删除的方法用 delete 做前缀, deleteUser()。 7. 返回布尔值的方法用 is 做前缀, isValidate()。 8. 执行某项具体的业务使用 do 做前缀,如:

//注册收集信息的页面是 register() 方法
public String register(HttpServlet request) {
    //do something
}
//那么具体执行注册动作则需要使用 doRegister
public String register(HttpServlet request) {
    //do something
}

//审核
public String check(HttpServlet request) {
    //do something
}

//审核操作
public String doCheck(HttpServlet request) {
    //do something
}

B) 领域模型命名规约 1. 数据对象:Xxx,xxx即为数据表名。 2. 数据传输对象:xxxDto,xxx为业务领域相关的名称。 3. 展示对象:xxxVo,xxx一般为网页名称。 4. POJO是DO/DTO/BO/VO的统称,禁止命名成xxxPOJO。

16.【强制】 接口的命名不需要用 I 开头,接口的方法命名遵循普通类的命名的驼峰形式,接口的实现类放入 impl 包中。

17.【强制】 配置文件分开开发、测试及生产环境,命名遵循以下原则:

  • 开发环境:项目.dev.properties
  • 测试环境:项目.test.properties
  • 生产环境:项目.prod.properties
© Monda 2017 all right reserved,powered by Gitbook最后更新时间: 2017-08-07 22:08:23

results matching ""

    No results matching ""