java项目开发规范

java项目开发规范

代码方面

1. 注释：使用规范注释。类名上具有该类的功能、开发员的文档注释，特殊含义字段单独注释
2. 代码修改后，注释内容也要做出相应修改。保持一致性
3. 命名规范：类名大驼峰，方法名和字段名 小驼峰。最好做到见名知意
4. 具有相同功能的代码最好放在一起：如高级查询，查询所有
5. 如果需要循环拼接字符，使用StringBuilder的append方法进行拼接
6. controller层中接受增删查改请求：发送请求时：请求路径格式进行统一

post -- 新增  *   put -- 修改  *   delete -- 删除  *   get --查询  *   patch --多条查询/高级查询

7. 在数据库中某些数字代表状态：0–中间状态(如：待审核)，正数(1)–积极(如:审核成功)，负数（-1）–消极信息(审核失败)
8. 数据库中没有设置关联关系，大家在mapper.xml中使用外连接进行手动关联查询。如果太过麻烦，则关联上
9. 各层命名规约：
   A) Service/DAO 层方法命名规约
   1） 获取单个对象的方法用 get 做前缀。
   2） 获取多个对象的方法用 list 做前缀。
   3） 获取统计值的方法用 count 做前缀。
   4） 插入的方法用 save/insert 做前缀。
   5） 删除的方法用 remove/delete 做前缀。
   6） 修改的方法用 update 做前缀。
   10 待续

交流方面

1. 大家在提交或者更新svn数据时，打上日志。提交有冲突时，互相协商
2. 有些功能设计不合理时，及时提出进行讨论。
3. 数据库字段如果设计不合理，及时提出进行修改。
4. 数据库如果字段修改了后，及时通知小组其它人员
5. bug如果1个多小时没有解决，及时求助
6. 对目前功能需求不够了解，及时提出进行讨论
7. 多交流，多帮助
8. 待续