java命名规范有感

Posted 2020-08-26 戴林甫

一、 注（）里的内容是自己的吐槽

二、 命名规约

1. 不能以下划线或美元符开始和结尾。反例：_name,$name,name_,name$.（我就从来没这样用过）
2. 不能使用拼音和英文组合方式命名。更不能以拼音命名（英语烂，有时犯过此类错误）
3. 类名遵守驼峰规则（已遵守）
4. 方法名，参数名，成员变量名，局部变量名统一lowerCamelCase格式（已遵守）
5. 常量大写，单词间用下划线分隔，而且要表达清楚意思，长点都可以（已遵守）
6. 抽象类命名使用Abstract或Base，异常名以Exception结尾，测试类名以类名+Test结尾（之前没这么写过）
7. 数组定义采用String[] args 格式（一直都是这样）
8. Pojo类的boolean变量不能is开头，因为部分框架不能解析（已遵守）
9. 包名小写，且仅有一个自然语义的英文单词（我的理解是只能一个单词）。包名是单数形式（已遵守）
10. 杜绝完全不规范的缩写（已遵守）
11. 如果使用了设计模式，在类名中体现出具体格式，如OrderFactory，LoginProxy。（已遵守）
12. 接口类的方法和属性不能加任何修饰符，包括public。保持代码的整洁性。加上有效的javadoc注释。尽量不要在接口中定义变量。除非跟接口方法有关。（以前都添加public，以后改正）
13. Service和dao类的实现类用impl后缀和接口区别（已遵守）
14. 枚举类名建议带上Enum后缀。
15. 15.【参考】各层命名规约：
    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。