阿里巴巴开发手册编程规约读后感

阿里巴巴开发手册编程规约读后感

​ 码出高效，码出质量

编程规约

命名规范

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

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

• 杜绝完全不规范的缩写，避免望文不知义。

  // 反例
  _name/$name/name_/name$
  // 反例
  AbstractClass
  //“缩写”命名成 
  AbsClass
  

包、类、方法命名

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

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

• 接口类中的方法和属性不要加任何修饰符号

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

  // 包名
  com.bao.objo
  // 类名 
  UpperCamelCase
  // 抽象类
  AbstractUpperCamelCase
  // 异常类
  UpperCamelCaseException
  // 测试类
  UpperCamelCaseTest 
  

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

• 模块、接口、类、方法使用了设计模式，在命名时体现出具体模式。

• 对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部

  的实现类用 Impl 的后缀与接口区别。如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able 的形式）。

对象命名

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

• 中括号是数组类型的一部分，数组定义如下：String[] args;

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

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

Service/DAO 层方法命名规约

1. 获取单个对象的方法用 get 做前缀。
2. 获取多个对象的方法用 list 做前缀。
3. 获取统计值的方法用 count 做前缀。
4. 插入的方法用 save/insert 做前缀。
5. 删除的方法用 remove/delete 做前缀。
6. 修改的方法用 update 做前缀。

领域模型命名规约

1. 数据对象：xxxDO，xxx 即为数据表名。
2. 数据传输对象：xxxDTO，xxx 为业务领域相关的名称。
<