0. 问题引入
在接口开发中,我们时常要对前端传递过来的参数进行检验,例如‘不能为空’、‘不能为Null’、‘类型只能是1、2、3中的一种’、‘长度需在6-10之间’等等,如果有参数不满足则直接返回,并将相应报错信息告知前端。
对此,我们一般都是这么写:
if (StringUtils.isBlank(businInfo.getOrganizeId())) {
logger.error("更新手机唯一号接口:必要参数organizeId为空");
response.setCode(CodeConst.COMMON.PARAM_ERROR);
response.setMessage(CodeConst.COMMON.PARAM_ERROR_MESSAGE);
return JsonUtils.toJson(response);
}
if (StringUtils.isBlank(businInfo.getStaffId())) {
logger.error("更新手机唯一号接口:必要参数staffId为空");
response.setCode(CodeConst.COMMON.PARAM_ERROR);
response.setMessage(CodeConst.COMMON.PARAM_ERROR_MESSAGE);
return JsonUtils.toJson(response);
}
像这样的代码会大量存在,但是又不可避免的要写,那么如何简化这部分工作呢?
1. 现有的解决方案
- 使用Hibernate Validator
简单概括就是:在成员变量上加@NotBlank、@NotNull、@Length等注解,然后在Controller方法中的形式参数上加@Valid @RequestBody来校验参数。例如(代码已做简化):
-- ActivityDTO.java
@Data
public class ActivityDTO {
@NotBlank