Get请求中使用@Validated进行参数校验方案汇总

    get请求都是key-value形式的表单提交,没有请求体,但是能否使用Hibernate Validator使用注解进行校验.答案是肯定的,下面说两种常用的校验方式.
首先说一下案例使用场景:
    根据卡类型与卡项类型查询对应的关联的会员卡信息,传递的参数有type:卡项类型:1.期限卡;2.次卡;3.储值卡(仅会员卡拥有);cardType:卡类型:1.期限卡;2.次数卡;3.存储卡.当然实际场景会比现在的请求参数个数还多,仅以上面为例说明.
    1.直接在请求方法中对参数实现注解校验

@Validated
@RestController
public class StaffUserController {
	public ResultVo<List<StaffCardInfoVo>> findStaffCardList(@NotNull(message = "卡项类型参数不允许为空")
                                                                   @Range(min = 1,max = 2,message = "卡类型:1.会员卡;2.体验卡,卡类型参数不合法!") Integer type,
                                                                   @NotNull(message = "卡类型参数不允许为空")
                                                                   @Range(min = 1,max = 3,message = "卡类型:1.期限卡;2.次数卡;3.存储卡,卡类型参数不合法!") Integer cardType){
        List<StaffCardInfoVo> staffCardList = staffUserService.findStaffCardList(type,cardType);
        return ResultVoUtil.success(staffCardListByType);
    }
}    

请求异常信息:

    注意对请求单个参数进行校验,需要在控制层加@Validated;如果请求参数很多的情况下,按照这种方式进行注解校验就会很冗余,并且不符合开发规范.所以就有下面的校验处理方案.
    2.使用对象方式进行接收参数,请求对象中添加注解校验

  public ResultVo<List<StaffCardInfoVo>> findStaffCardList(@Validated StaffCardDto staffCardDto){
        List<StaffCardInfoVo> staffCardListByType = staffUserService.findStaffCardList(staffCardDto);
        return ResultVoUtil.success(staffCardListByType);
    }

对象注解校验处理:

public class StaffCardDto  {

    @ApiModelProperty(value = "卡项类型:1.期限卡;2.次卡;3.储值卡(仅会员卡拥有)",example = "1",dataType = "integer")
    @NotNull(message = "卡项类型参数不允许为空")
    @Range(min = 1,max = 2,message = "卡类型:1.会员卡;2.体验卡,卡类型参数不合法!")
    private Integer type;

    @ApiModelProperty(value = "卡类型:1.期限卡;2.次数卡;3.存储卡",example = "2",dataType = "integer")
    @NotNull(message = "卡类型参数不允许为空")
    @Range(min = 1,max = 3,message = "卡类型:1.期限卡;2.次数卡;3.存储卡,卡类型参数不合法!")
    private Integer cardType;
    // 省略get/set
}

请求异常信息:

    @Valid与@Validated区别：后者是前者的补充,前者能做的后者都能做,并且后者支持分组、级联操作等.所以在请求对象前面加@Valid同样生效.
    Hibernate Validator校验相关内容可以参考:
    springboot中注解校验@Valid@Validated(亲测有效);
    springboot中注解校验@Valid@Validated失效场景汇总(持续更新);
    springboot中@Vlidated注解校验源码;