企业官网建设流程全解析

命名规范

0.新统一返回结果：ActionResult

字段：

• code：200 成功，其它数字失败；
• message：对外友好提示（给最终用户看，如"系统繁忙，请稍后重试"）；
• exception：完整异常信息（用户新增要求）——给程序员排查问题用，存异常类名 + message + 堆栈；成功时为 null；
• data：返回数据；
• time：响应时间字符串（如 2020-06-16 09:38:06）。

成功示例：

{"code":200,"data":{"aaa":"1"},"message":"成功","exception":null,"time":"2020-06-16 09:38:06"}

失败示例（message 友好提示 + exception 供排查）：

{"code":500,"data":null,"message":"系统繁忙，请稍后重试","exception":"java.lang.NullPointerException: xxx [含完整堆栈多行]","time":"2020-06-16 09:38:06"}

提供静态构造：ActionResult.success(data) / ActionResult.success() / ActionResult.fail(message) / ActionResult.fail(code, message) / ActionResult.fail(code, message,
exception)；time 自动填充。

1.统一返回结果：ActionResult

{"code":200,// 200成功，其他数字均为失败"data":{},// 具体返回数据"message":"string",// 描述"time":"string"// 时间}示例：{"message":"成功","code":200,"data":{"aaa":"2020061600066","bbb":"2020-06-16"},"time":"2020-06-16 09:38:06"}分页示例：{"message":"成功","code":200,"data":{"totalRecordCount":2009,// 总记录数"totalPageCount":201,// 总页数"data":[// 分页数据{"id":1,"aaa":"HOS001","bbb":"med001","ccc":"spe001"}],"pageNo":1,// 第几页"pageSize":10,// 每页显示的条数"query":{// 查询参数"query":null,"sort":null,"sortCode":null,"pageNo":1,"pageSize":10,"columns":null,"sortByDefault":true,"includeDeleted":false,"startRow":1,"endRow":10,"startRowBegin0":0},"positionInTotalRecordCount":1,// 根据pageNo和pageSize计算当前页第一条记录在总结果集中的位置,序号从1开始."nextPage":2,// 下一页"prePage":1,// 上一页"hasNext":true,// 是否有下一页，true有false无"hasPre":false// 是否有上一页，true有false无},"time":"2020-06-1610:40:50

2. 方法名规范

注：基本的增删改查，只需要标注请求类型即可

@RestController@RequestMapping("/org")publicclassBaseOrgController{/** * 新增 */@PostMappingpublicActionResultsaveOrg(){}/** * 修改 */@PutMappingpublicActionResultupdateOrg(){}/** * 删除 */@DeleteMappingpublicActionResultdeleteOrg(){}/** * 根据id查找 */@GetMappingpublicActionResultgetOrg(){}}

建议Controller、Service、Mapper层方法名统一

2.1 新增的方法用 save做前缀

@PostMapping("/save")publicActionResultsaveUser(){}方法名：saveXXX()XXX一般为去掉统一前缀的实体名 url:如：/save,url建议与方法名一致（去掉统一前缀，和实体名） 请求类型：Post

2.2修改的方法用 update 做前缀

@PutMapping("/update")publicActionResultupdateUser(UserDTOuser){}方法名：updateXXX()XXX一般为去掉统一前缀的实体名 url:如：/update,url建议与方法名一致（去掉统一前缀，和实体名） 请求类型：Put@PutMapping("/update/name")publicActionResultupdateUserByName(UserDTOuser){}方法名：updateXXXByFFF()XXX一般为去掉统一前缀的实体名,FFF一般为更新条件 url:如：/update/name,url建议与方法名一致（去掉统一前缀，和实体名）。若条件过多可转为业务描述，如/updateForBusiness 请求类型：Put

2.3删除的方法用 delete 做前缀

@DeleteMapping("/delete")publicActionResultdeleteUser(){}方法名：deleteXXX()XXX一般为去掉统一前缀的实体名 url:如：/delete,url建议与方法名一致（去掉统一前缀，和实体名） 请求类型：Delete@DeleteMapping("/delete/name")publicActionResultdeleteUserByName(Stringname){}方法名：deleteXXXByFFF()XXX一般为去掉统一前缀的实体名,FFF一般为删除条件 url:如：/delete/name,url建议与方法名一致（去掉统一前缀，和实体名）。若条件过多可转为业务描述，如/deleteForBusiness 请求类型：Delete

2.4获取单个对象的方法用 get 做前缀

@GetMapping("/get")publicActionResultgetUser(){}方法名：getXXX()XXX一般为去掉统一前缀的实体名 url:如：/get,url建议与方法名一致（去掉统一前缀，和实体名） 请求类型：Get@GetMapping("/get/name")publicActionResultgetUser(UserDTOuser){}方法名：getXXXByFFF()XXX一般为去掉统一前缀的实体名,FFF一般为查询条件 url:如：/getByName,url建议与方法名一致（去掉统一前缀，和实体名）,若条件过多可转为业务描述，如/getForBusiness 请求类型：Get

2.5获取多个对象的方法用 list 做前缀，复数结尾，如：listUsers

@PostMapping("/list")publicActionResultlistUsers(){}方法名：listXXX()XXX一般为去掉统一前缀的实体名 url:如：/list,url建议与方法名一致（去掉统一前缀，和实体名） 请求类型：Post@PostMapping("/list/name")publicActionResultlistUsersByName(UserDTOuser){}方法名：listXXXByFFF()XXX一般为去掉统一前缀的实体名,FFF一般为查询条件 url:如：/listByName,url建议与方法名一致（去掉统一前缀，和实体名）,若条件过多可转为业务描述，如/listForBusiness 请求类型：Post

2.6获取统计值的方法用 count 做前缀

@PostMapping("/count")publicActionResultcountUser(){}方法名：countXXX()XXX一般为去掉统一前缀的实体名 url:如：/count,url建议与方法名一致（去掉统一前缀，和实体名） 请求类型：Post@PostMapping("/count/name")publicActionResultcountUserByName(Stringname){}方法名：countXXXByFFF()XXX一般为去掉统一前缀的实体名,FFF一般为统计条件 url:如：/countByName,url建议与方法名一致（去掉统一前缀，和实体名）,若条件过多可转为业务描述，如/countForBusiness 请求类型：Post

2.7 分页的方法用 page 做前缀，复数结尾，如：pageUsers

@PostMapping("/page")publicActionResultpageUsers(){}方法名：pageXXX()XXX一般为去掉统一前缀的实体名 url:如：/page,url建议与方法名一致（去掉统一前缀，和实体名） 请求类型：Post@PostMapping("/page/name")publicActionResultpageUsersByName(UserDTOuser){}方法名：pageXXXByFFF()XXX一般为去掉统一前缀的实体名,FFF一般为分页条件 url:如：/pageByName,url建议与方法名一致（去掉统一前缀，和实体名）,若条件过多可转为业务描述，如/pageForBusiness 请求类型：Post