包括 方法命名,变量命名,常量命名等。
1 参考驼峰命名法。(必须)
2 参考阿里巴巴开发手册
接口描述了一个功能的输入输出。后续开发实现这个接口,能确保输入输出格式符合要求。
举例(报警接口):
1 没有定义接口。
2 入参出参不明确,导致很难看出入参。
3 controller层,不写业务代码。
定义参考如下方式:
按照详细设计中的步骤去编写。
正常思路
1 入参校验
根据业务需求来,把每个异常情况,定义一个错误码和错误信息,统一存放。
示例:
发生指定情况,抛出指定异常即可。
2 业务处理
3 封装出参
1 定义好DO对象和数据库 一一对应。
2 尽量使用单表查询,返回DO,原则不要超过3个表联查。
3 在Service层将DO转成DTO。
1 直接调用Service接口,不做任何业务处理。
目前放入权限校验暂时在此处完成。
主要是CMQ,短信,手机,PC,app
1 统一定义入参XXXReqDTO,出参XXXRespDTO。
1 格式: #禅道任务号# 相关描述
参考如下:
2 勾选如下内容: