阿里巴巴代码规范

Posted 2022-12-02 frankzone

一.编程规约

 1.命名风格‘

　　1.代码中的命名不能以下划线或美元符号开始 也不能以下划线或者美元符号结束；

　　2.代码中的命名不能是拼音或者英文混合，尽量不要使用纯拼音

　　3.类名驼峰原则 UserManagerServiceImpl （第一个word首字母大写）

　　4.方法驼峰原则 addUserInfo（第一个word首字母小写）

　　5.常量名全部大写 单词之间用_隔开

　　6.抽象类 使用 Abstract 和 Base 开头  异常类使用Exception结尾 测试类以测试的类的名字为开头 以Test为结尾

　　7.数组定义 String[] args 

　　8.POJO类 及普通的Java beans 中的布尔型常量 定义的时候 命名不要以is开头 例如isSure等

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

　　10.杜绝 完全不规范的缩写 例如 Contribution  缩写成Cont

　　11.为了保证代码良好的可阅性 尽可能使用完整的单词来表达其意

　　12.如果模块 接口 类 中使用了设计模式 应该在命名中体现设计模式 提高可阅性

　　13.接口类的方法和属性 不要添加任何 修饰符号 （public也不要加）保持代码的简洁性 加上有效的java doc 注释 ，尽量不要在接口中定义变量  如果必须 则一定是与接口方法有关  且一定跟整个应用有关

　　14.接口和实现类

　　　　1.强制 对于Service 和 Dao类 基于SOA(面向服务架构)的理念  暴露出来的一定是接口 内部的实现类 用Impl的后缀 与接口区别

　　　　2.如果是形容能力的接口名称 取对应的形容词做接口名（通常是able形式） 如AbstractTranslator实现 TransLatable

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

　　16.Service/Dao层方法命名公约

　　　　A. Service/Dao层

　　　　　　1.获取单个对象用 get做前缀

　　　　　　2.获取多个对象用list做前缀

　　　　　　3.获取统计值用count做前缀

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

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

　　　　　　6.修改的方法用update做前缀

　　　　B.领域模型命名规约

　　　　　　1.数据对象： xxxDO xxx一般为数据表名

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

　　　　　　3.展示对象：xxxVO xxx一般为网页名称

　　　　　　4.POJO是DO/DTO/BO/VO的统称 禁止命名为 xxxPOJO