方法命名规范v_1.0.0

命名规范公司团队版本时间苏夏未来苏夏未来v_1.0.02020.06.290.新统一返回结果ActionResult字段code200 成功其它数字失败message对外友好提示给最终用户看如系统繁忙请稍后重试exception完整异常信息用户新增要求——给程序员排查问题用存异常类名 message 堆栈成功时为 nulldata返回数据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:502. 方法名规范注基本的增删改查只需要标注请求类型即可RestControllerRequestMapping(/org)publicclassBaseOrgController{/** * 新增 */PostMappingpublicActionResultsaveOrg(){}/** * 修改 */PutMappingpublicActionResultupdateOrg(){}/** * 删除 */DeleteMappingpublicActionResultdeleteOrg(){}/** * 根据id查找 */GetMappingpublicActionResultgetOrg(){}}建议Controller、Service、Mapper层方法名统一2.1 新增的方法用 save做前缀PostMapping(/save)publicActionResultsaveUser(){}方法名saveXXX()XXX一般为去掉统一前缀的实体名 url:如/save,url建议与方法名一致去掉统一前缀和实体名 请求类型Post2.2修改的方法用 update 做前缀PutMapping(/update)publicActionResultupdateUser(UserDTOuser){}方法名updateXXX()XXX一般为去掉统一前缀的实体名 url:如/update,url建议与方法名一致去掉统一前缀和实体名 请求类型PutPutMapping(/update/name)publicActionResultupdateUserByName(UserDTOuser){}方法名updateXXXByFFF()XXX一般为去掉统一前缀的实体名,FFF一般为更新条件 url:如/update/name,url建议与方法名一致去掉统一前缀和实体名。若条件过多可转为业务描述如/updateForBusiness 请求类型Put2.3删除的方法用 delete 做前缀DeleteMapping(/delete)publicActionResultdeleteUser(){}方法名deleteXXX()XXX一般为去掉统一前缀的实体名 url:如/delete,url建议与方法名一致去掉统一前缀和实体名 请求类型DeleteDeleteMapping(/delete/name)publicActionResultdeleteUserByName(Stringname){}方法名deleteXXXByFFF()XXX一般为去掉统一前缀的实体名,FFF一般为删除条件 url:如/delete/name,url建议与方法名一致去掉统一前缀和实体名。若条件过多可转为业务描述如/deleteForBusiness 请求类型Delete2.4获取单个对象的方法用 get 做前缀GetMapping(/get)publicActionResultgetUser(){}方法名getXXX()XXX一般为去掉统一前缀的实体名 url:如/get,url建议与方法名一致去掉统一前缀和实体名 请求类型GetGetMapping(/get/name)publicActionResultgetUser(UserDTOuser){}方法名getXXXByFFF()XXX一般为去掉统一前缀的实体名,FFF一般为查询条件 url:如/getByName,url建议与方法名一致去掉统一前缀和实体名,若条件过多可转为业务描述如/getForBusiness 请求类型Get2.5获取多个对象的方法用 list 做前缀复数结尾如listUsersPostMapping(/list)publicActionResultlistUsers(){}方法名listXXX()XXX一般为去掉统一前缀的实体名 url:如/list,url建议与方法名一致去掉统一前缀和实体名 请求类型PostPostMapping(/list/name)publicActionResultlistUsersByName(UserDTOuser){}方法名listXXXByFFF()XXX一般为去掉统一前缀的实体名,FFF一般为查询条件 url:如/listByName,url建议与方法名一致去掉统一前缀和实体名,若条件过多可转为业务描述如/listForBusiness 请求类型Post2.6获取统计值的方法用 count 做前缀PostMapping(/count)publicActionResultcountUser(){}方法名countXXX()XXX一般为去掉统一前缀的实体名 url:如/count,url建议与方法名一致去掉统一前缀和实体名 请求类型PostPostMapping(/count/name)publicActionResultcountUserByName(Stringname){}方法名countXXXByFFF()XXX一般为去掉统一前缀的实体名,FFF一般为统计条件 url:如/countByName,url建议与方法名一致去掉统一前缀和实体名,若条件过多可转为业务描述如/countForBusiness 请求类型Post2.7 分页的方法用 page 做前缀复数结尾如pageUsersPostMapping(/page)publicActionResultpageUsers(){}方法名pageXXX()XXX一般为去掉统一前缀的实体名 url:如/page,url建议与方法名一致去掉统一前缀和实体名 请求类型PostPostMapping(/page/name)publicActionResultpageUsersByName(UserDTOuser){}方法名pageXXXByFFF()XXX一般为去掉统一前缀的实体名,FFF一般为分页条件 url:如/pageByName,url建议与方法名一致去掉统一前缀和实体名,若条件过多可转为业务描述如/pageForBusiness 请求类型Post