本文主要是介绍JSR303校验及统一异常处理,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
一、JSR303校验
使用场景:需要对实体类中的字段进行校验时,可以用303校验方法。
具体步骤:
1、给实体类中的属性加注解。如@NotNull
等,具体可参照javax.validation.constraints
包下的注解。
2、开启验证。在需要开启验证的Controller
中传入实体类参数的地方添加@Validated
或者Valid
注解。可参照代码:
@PostMapping("/saveBrand")public OriginResponseBody insertBrand(@Validated @RequestBody PmsBrand pmsBrand, BindingResult bindingResult)
二、自定义303校验异常返回信息
使用场景:原始303校验失败后,返回的信息可能不符合我们期望形式,在这种情况下,可自定义异常返回体。
具体步骤:
1、在上述Controller
代码中的实体类参数后,添加BindingResult
对象,该类中的方法可以获取303校验失败的具体信息
。
2、通过BindingResult
对象获取想要的信息后,将其传入到自定义的返回体中,就可以按照预期返回体结构将303校验信息返回给前端了。
三、统一异常处理
使用场景:当多个Controller需要进行303校验时,可能会使用同一段代码来处理303校验失败的信息,在这种情况下,可以使用同一异常处理来集中处理303校验错误。
优点:
1、可以按照自己想要的格式返回给前端。
2、不需要每次都写同一段代码处理303校验信息,实现统一异常处理。
1、具体步骤:
只需要定义一个异常拦截器
-----用于拦截Controller中捕获的异常。
@Slf4j
@RestControllerAdvice(basePackages = "com.huang.gulimall.controller")
public class ExceptionHandler {@org.springframework.web.bind.annotation.ExceptionHandler(value = MethodArgumentNotValidException.class)public OriginResponseBody exceptionHandler1(MethodArgumentNotValidException e) {log.error("异常信息:{},异常类:{}", e.getMessage(), e.getClass());BindingResult bindingResult = e.getBindingResult();List<FieldError> fieldErrors = bindingResult.getFieldErrors();Map<Object, Object> map = new HashMap<>();for (FieldError i : fieldErrors) {map.put(i.getField(), i.getDefaultMessage());}return Response.SelfResponse(400, map);}
}
说明:
1、RestControllerAdvice:表明拦截异常后,返回的是Json字符串。basePackages表示扫面这个包下的异常。
2、ExceptionHandler:拦截的异常类型。内部参数表示拦截包下哪种类型的异常。
3、方法:传入要处理的异常类,获取异常信息,并返回,返回体可以是自己定义的。
四、303分组校验
应用场景:实体类中的
一个字段
不同情况下有不同校验规则
,就可使用分组校验。
具体步骤:
1、在某个字段中添加不同校验注解,并指定group
属性。
@ApiModelProperty("品牌id")@TableId(value = "brand_id", type = IdType.AUTO)@NotBlank(message = "修改时brandId必输", groups = {UpdateBrand.class})@Null(message = "添加时brandId为空",groups = {AddBrand.class})private Long brandId;
说明:brandId字段有两个校验规则,分别为
@NotBlank
和@Null
,这两个校验规则在不同情况下使用,因此给这两个注解都指定了groups
属性,用于区分不同情况下使用不同校验规则。
特别注意
:由于groups属性需要的类型是Class<?>[]--接口的数组
,因此首先需要创建不同的接口(如这里的UpdateBrand.class和AddBrand.class,这里必须是接口,不能是类,不然会报错
),主要用来区分不同场景,接口里可以是空的。
2、Controller类中添加@Validated(value = {AddBrand.class}
注解,用于指定验证某个分组的规则。
public OriginResponseBody insertBrand(@RequestBody @Validated(value = {AddBrand.class}) PmsBrand pmsBrand)
说明:只要字段校验注解的groups属性中包含@Validated里指定的名字,该校验规则就会被激活,且只会激活@Validated(value = {AddBrand.class}里指定的校验规则,其他的不会校验。
这篇关于JSR303校验及统一异常处理的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!