参数命名规约

1.请求参数类型

1.请求参数不论有几个，统一用对象包装。

请求参数名称结尾为Request

2.参数格式化

参数格式化统一放在DTO等参数对象中，对象中提供format方法。

业务逻辑代码在调用该参数对象时,先进行format方法调用。

3.参数校验

参数校验统一放在DTO等参数对象中，优先使用注解校验，注解不满足情况下，在对象中提供validate方法。如有错误，直接抛出异常。

业务逻辑代码在调用该对象参数时，如需校验参数，进行validate方法调用。

@Data
public class XxxRequest{
    private Long id;
    private String name;
    private List<String> address;
    //参数格式化
    public void format(){
        if(StringUtils.isNotBlank(name)){
             name=name.trim();
        }
    }
    //参数校验
    public void validate(){
        if(address==null || address.size==0){
           throw new BizException(code,message);
        }
    }
}

2.返回参数类型

返回参数不论有几个，统一用对象包装

名称结尾为Response

@Data
public class XxxResponse{
    private Long id;
    private String name;
    private List<String> address;
}

3.参数命名

参数命名要见名知义，易读。