在项目开发过程中，开发团队最好遵守一套相同的约定，这样对成员间互相理解代码和代码库管理都很有帮助。以下列出我能想到的一些方面，随时补充和整理：

命名

JSP文件名称：减号分隔，如“my-page.jsp”

URL里query param键名：全小写，下划线分隔，如：“category_id”

request对象的attribute中的键名：驼峰式，如“myUser”

json里使用的键名：驼峰式（方便jackson自动转换），如“userName”

数据库表名：以t_开头，全小写，下划线分隔，如：“t_user”（有前缀方便在代码里查找）

数据库列名：以f_开头，全小写，下划线分隔，如：“f_create_time”（有前缀方便在代码里查找）

字典表键名：驼峰式（与json键名相同习惯），如“requireInviteCode”

注：驼峰式里如果有缩写词，只保留第一个字母大写，例如userId里的“ID”。

接口

尽量符合Restful的要求，即：GET用于获取信息，POST用于创建资源，PUT用于创建或修改资源，DELETE用于删除资源。

参考链接：

• HTTP/1.1, part 2: Message Semantics
• PUT vs POST in REST
• Are GET And POST Enough To Create RESTful Services?

表单参数校验

在Service层中完成，Controller对象只负责将参数传递给Service对象。如果有参数不符合要求，Service对象抛出自定义异常，然后统一处理。

对象创建时间

很多业务对象有createTime属性，我们约定这个属性在Service层的create()方法中生成，值为系统当前时间。

代码格式化

在IDE里，设置自动格式化参数为每行最多120个字符，对comment不进行格式化。