Controller层接口参数校验统一处理 |
您所在的位置：网站首页 › token不允许为空 › Controller层接口参数校验统一处理 |
|
背景
一般的controller层接口都要做参数校验的，最起码的空判断都是要做的。以前的写法就是一堆 if 判空堆在一起，空了就想改进一下，看看有没有什么更好的方法。然后就查到了有校验注解 @Validated ，在此记录使用方法。 使用总结来说就是对非空字段用对应注解标记，然后在全局统一异常处理中对参数校验异常统一处理。 POST请求 @PostMapping("/submit") @ApiOperation(value = "提交") public MyResult submit(@Validated @Requestbody User user) { // 业务逻辑 } @Data public class User { @NotBlank(message = "昵称不允许为空") private String name; @NotBlank(message = "编号不允许为空") private String code; } GET请求@Validated 要声明在类上 @Validated @Slf4j @RestController @RequestMapping("/user") @Api(value = "/用户相关接口", description = "用户相关接口") public class UserController { @GetMapping("/submit") @ApiOperation(value = "提交") public MyResult submit(@NotBlank(message = "昵称不允许为空") @RequestParam("name") String name, @NotBlank(message = "编号不允许为空") @RequestParam("code") String code) { // 业务逻辑 } } 校验提示统一处理 @RestControllerAdvice public class GlobalExceptionHandler { /** * 参数统一校验异常 * @param e * @return */ @ExceptionHandler(MethodArgumentNotValidException.class) @ResponseStatus(HttpStatus.OK) public MyResult paramExceptionHandler(MethodArgumentNotValidException e) { return new MyResult(ResultCodes.PARAMETER_IS_NULL, e.getBindingResult().getFieldError().getDefaultMessage()); } } 分组校验主要用于如下场景，实体中的同一个字段，在不同的业务场景下校验规则不同。比如id，insert场景可为空，update场景不可为空。这个时候就可以用不同的group标记校验场景了。有两种方式 方式一：不同的业务场景是不同的接口 @Data public class User { @NotNull(message = "id不允许为空", groups = InsertGroup.class) private Long id; @NotBlank(message = "昵称不允许为空") private String name; @NotBlank(message = "编号不允许为空") private String code; } @PostMapping("/submit") @ApiOperation(value = "提交") public MyResult submit(@Validated(InsertGroup.class) @Requestbody User user) { // 业务逻辑 } 方式二：不同的业务场景是同一个接口 @Data public class User { @NotNull(message = "id不允许为空", groups = InsertGroup.class) private Long id; @NotBlank(message = "昵称不允许为空") private String name; @NotBlank(message = "编号不允许为空") private String code; }import javax.validation.Validator; @Autowired private Validator validator; @PostMapping("/submit") @ApiOperation(value = "提交") public MyResult submit(@Requestbody User user, @RequestParam("type") String type) { // 校验 HashSet validResSet = null; if ("insert".equals(type)) { validResSet = validator.validate(user, InsertGroup.class); } else { validResSet = validator.validate(user); } // validResSet不为空的话，即校验未通过，validResSet中是校验未通过的信息 // 业务逻辑 } 其他 目前只是简单使用，其他细节可以看看参考链接，大佬写得很详细，对比了好多文章，这篇比较清晰全面，感谢分享～ 参考一起来学SpringBoot（十七）优雅的参数校验 springmvc使用@Validated注解进行参数验证时，当一个实体类需要多种验证方式，指定在什么情况下使用验证规则 spring @validated校验,分组校验,自定义校验 Spring Validation最佳实践及其实现原理，参数校验没那么简单！ |
今日新闻 |
点击排行 |
|
推荐新闻 |
图片新闻 |
|
专题文章 |
| CopyRight 2018-2019 实验室设备网 版权所有 win10的实时保护怎么永久关闭 |