JAVA 编程规范

来源:互联网 发布:刮骨疗伤是真的吗 知乎 编辑:程序博客网 时间:2024/06/07 10:44

类、接口、变量、方法、参数命名采用驼峰命名规则,如 updateUserById(int userId)
常量命名全部大写,单词间用下划线隔开
抽象类命名使用 Abstract 开头,如AbstractPerson
异常类命名使用 Exception 结尾,如CustomException
测试类 命名以它要测试的类的名称开始,以 Test 结尾CallServiceTest
测试方法名以test开头,如:testUpdateUser(User user)
枚举类名使用 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开
线程名使用Thread-开头,如Thread-ExtensionStatus

代码命名规范(各层命名)

A) Service/DAO(Mapper)层方法命名
1) 单个查询的方法名用 get做前缀 ,如 getUserById(int id)
2) 获取多个对象的方法名用 list 做前缀 ,如 listUserByGender(int gender)
3) 获取统计值的方法名用 count 做前缀,如 countAllUser()
4) 插入的方法用 save/ insert 做前缀 ,如 saveUser(User user) 或 insertUser(User user)
5) 删除的方法用 remove/delete 做前缀 ,如 removeUserById(int userId) 或modifyUserById(int userId)
6) 修改的方法用 update/modify 做前缀 ,如 updateUserByLoginId(String loginId)
B) 分层模型命名
1) 展示对象:xxxVO
2) 业务层对象xxxBO,禁止命名成 xxxPOJO