前言

Github:https://github.com/HealerJean

博客:http://blog.healerjean.com

1、方法、实体名字:

小米
manager dao 层
queryBeanSingle
queryBeanPage
queryBeanList
queryBeanPageLike
queryBeanListLike

saveBean/addBean

1.1、查询

1.1.1、单个记录查询

场景 查询数据库 不查询数据库
简单条件属性查询 findBeanNameBy getBeanNameSingleBy
复杂条件查询单个记录 findBeanName getBeanName

1.1.2、多个记录查询

场景 查询数据库 不查询数据库
简单条件属性查询 qureyBeanNameBy dataBeanNameBy
分页 qureyBeanNamePage、qureyBeanNamePageLike dataBeanNamePage、dataBeanNamePageLike
集合 qureyBeanNameList 、qureyBeanNameListLike dataBeanNameList、dataBeanNameListLike

2、接口请求 rquest/response

场景    
请求data ReqRecordData  
返回单个实体 RspRecordModel  
返回结果的data为 RspRecordList  

WX20190213-180740

3、注释规范

3.1、方法注释

/**
     * 根据合同模板生成合同初始pdf文件,讲合同状态设置为待确认状态
     * 1、数据校验
     *  1.1、基本数据校验
     *  1.2、校验合同模板是否存在
     *  1.3、校验签署人是否完整
     *  1.4、校验签署方是否真实有效
     * 2、把合同签署各方的信息和模板取出,将变量更替,生成word和pdf
     * 4、保存签署人信息
     * 5、合同初始化日志保存
     * 6、删除临时文件
     */
void createContractByTeamplate(ContractDTO contractDTO) 

4、日志和异常规范

4.1、日志规范

参见我的另一篇 博客 Log

4.1、工具类异常

public class UrlEncodeUtil {

    public String encode(String text){
        try {
            return URLEncoder.encode(text,"gbk" );
        }catch (UnsupportedEncodingException e) {
            throw new RuntimeException("{}加密失败", text,e);
        }catch (Exception e){
            throw new RuntimeException("{}加密失败,text, e);
        }
    }
}

ContactAuthor