Java编程规范

简单描述一下Java编程规范

方法命名

1.获取单个对象的方法用get作前缀

例如：查询单个用户getStudent,按照ID查询单个用户getStudentById。

2.获取多个对象的方法list作前缀

例如：按照IDS查询多个用户，listStudentByIds。

3.获取统计值的方法用count作前缀

例如:统计全量用户，countUser。

4.插入的方法用save作前缀

例如：新增用户,saveUser

5.删除的方法用remove作前缀

例如：删除用户，removeUser

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

例如：修改用户，updateUser

领域模型命名规范

1.数据对象

xxxDo，xxx即为数据表名

2.数据传输对象

xxxDTO,xxx为业务领域相关的名称

3.展示对象

xxxVO,xxx一般为网页名称

4.注意事项

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

API路径规范

1.Get方法尽量把ID等变量放到路径上

例如：获取指定用户的信息

/user/{id}

2.多个不可分割的单词，使用中划线拼接

例如：用户验证码接口

/user/verify-code

3.参数使用驼峰拼写

例如：获取指定用户购买的指定商品

/order/{productId}

4.指定集合的复数名称

例如：获取所有用户列表的接口

/users

5.不使用动词定义URL

错误示例：

/update/user

或者

get/user

正确应该通过HTTP方法方语义来定义URL的行为

比如获取用户：

GET /user/{id}

添加用户：

POST /user

修改用户

PUT /user

6.对非资源URL使用动词

如果有一个接口，并不是CRUD操作，这种情况可以使用动词

例如：向用户发送邮件接口

/user/{id}/send-mail

7.在嵌套资源的URL中使用关系

获取指定订单的所有商品列表

1.GET /orger/{id}/products

获取指定订单中所有指定商品信息

GET /order/{orderId}/product/{productId}