统一返回统一异常参数校验集成

小咪咪 2023-09-28 18:29 2阅读 0赞

[使用hibernate-validator实现进入controller前完成参数优雅校验][hibernate-validator_controller]  
一 统一返回结果

## 1.1 IResult ##

/**
     * 定义返回数据结构
     * @author xlwang
     */
    public interface IResult {
        
        /**
         * 获取状态码
         *
         * @return 状态码
         */
        Integer getCode();
    
        /**
         * 获取消息体
         *
         * @return 消息体
         */
        String getMessage();
    }

## 1.2 ResultEnum ##

/**
     * 常用结果的枚举
     */
    public enum ResultEnum implements IResult {
        
        SUCCESS(200, "成功"),
        VALIDATE_FAILED(400, "参数错误"),
        COMMON_FAILED(500, "系统错误"),
        FORBIDDEN(2004, "没有权限访问资源");
    
        private Integer code;
        private String message;
    
        //省略get、set方法和构造方法
    
        @Override
        public Integer getCode() {
        
            return code;
        }
    
        public void setCode(Integer code) {
        
            this.code = code;
        }
    
        @Override
        public String getMessage() {
        
            return message;
        }
    
        public void setMessage(String message) {
        
            this.message = message;
        }
    
        ResultEnum(Integer code, String message) {
        
            this.code = code;
            this.message = message;
        }
    
    }

## 1.3 Result ##

/**
     * 统一返回数据结构
     * @author xlwang
     */
    @Data
    @NoArgsConstructor
    @AllArgsConstructor
    public class Result<T> {
        
        private Integer status;
        private String message;
        private T data;
    
        public static <T> Result<T> success(T data) {
        
            return new Result<>(ResultEnum.SUCCESS.getCode(), ResultEnum.SUCCESS.getMessage(), data);
        }
    
        public static <T> Result<T> success(String message, T data) {
        
            return new Result<>(ResultEnum.SUCCESS.getCode(), message, data);
        }
    
        public static Result<?> failed() {
        
            return new Result<>(ResultEnum.COMMON_FAILED.getCode(), ResultEnum.COMMON_FAILED.getMessage(), null);
        }
    
        public static Result<?> failed(String message) {
        
            return new Result<>(ResultEnum.COMMON_FAILED.getCode(), message, null);
        }
    
        public static Result<?> failed(IResult errorResult) {
        
            return new Result<>(errorResult.getCode(), errorResult.getMessage(), null);
        }
    
        public static Result<?> failed(Integer code, String message) {
        
            return new Result<>(code, message, null);
        }
    
        public static <T> Result<T> instance(Integer code, String message, T data) {
        
            Result<T> result = new Result<>();
            result.setStatus(code);
            result.setMessage(message);
            result.setData(data);
            return result;
        }
    }

# 使用ResponseBodyAdvice统一处理controller返回的结果，包装结果 #

/**
     * 如果引入了swagger或knife4j的文档生成组件，这里需要仅扫描自己项目的包，否则文档无法正常生成
     * @author xlwang
     */
    @RestControllerAdvice(basePackages = "com.wxl52d41")
    public class ResponseResult implements ResponseBodyAdvice<Object> {
        
        @Override
        public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        
            // 如果不需要进行封装的，可以添加一些校验手段，比如添加标记排除的注解
            return true;
        }
    
    
        @Override
        public Object beforeBodyWrite(Object body, MethodParameter returnType,
                                      MediaType selectedContentType,
                                      Class<? extends HttpMessageConverter<?>> selectedConverterType,
                                      ServerHttpRequest request, ServerHttpResponse response) {
        
            // 提供一定的灵活度，如果body已经被包装了，就不进行包装
            if (body instanceof Result) {
        
                return body;
            }
            return Result.success(body);
        }
    }

经过这样改造，既能实现对 Controller 返回的数据进行统一包装，又不需要对原有代码进行大量的改动

# 自定义异常与统一异常 #

1.  抛出的异常不够具体，只是简单地把错误信息放到了 Exception 中
2.  抛出异常后，Controller 不能具体地根据异常做出反馈
3.  虽然做了参数自动校验，但是异常返回结构和正常返回结构不一致

自定义异常是为了后面统一拦截异常时，对业务中的异常有更加细颗粒度的区分，拦截时针对不同的异常作出不同的响应  
而统一拦截异常的目的一个是为了可以与前面定义下来的统一包装返回结构能对应上，另一个是我们希望无论系统发生什么异常，Http 的状态码都要是 200 ，尽可能由业务来区分系统的异

//自定义异常
    public class BusinessException extends RuntimeException {
        
        public BusinessException(String message) {
        
            super(message);
        }
    }
    
    /**
     * 自定义异常
     */
    public class ForbiddenException extends RuntimeException {
        
    
        public ForbiddenException(String message) {
        
            super(message);
        }
    
        public ForbiddenException(Throwable cause) {
        
            super(cause);
        }
    
        public ForbiddenException(String message, Throwable cause) {
        
            super(message, cause);
        }
    
    }
    
    
    
    
    /**
     * 统一拦截异常
     * @author xlwang
     */
    @RestControllerAdvice
    @Slf4j
    public class ControllerExceptionHandler {
        
    
        /**
         * 捕获 自定 异常
         */
        @ExceptionHandler({
        BusinessException.class})
        public Result<?> handleBusinessException(BusinessException ex) {
        
            log.error(ex.getMessage(), ex);
            return Result.failed(ex.getMessage());
        }
        /**
         * 捕获 参数缺失异常
         */
        @ExceptionHandler({
        MissingServletRequestParameterException.class})
        public Result<?> handleMissingServletRequestParameterException(MissingServletRequestParameterException ex) {
        
            log.error(ex.getMessage(), ex);
            return Result.failed(ResultEnum.VALIDATE_FAILED.getCode(), ex.getMessage());
        }
    
        /**
         * 捕获 {@code ForbiddenException} 异常
         */
        @ExceptionHandler({
        ForbiddenException.class})
        public Result<?> handleForbiddenException(ForbiddenException ex) {
        
            log.error(ex.getMessage(), ex);
            return Result.failed(ResultEnum.FORBIDDEN);
        }
    
        /**
         * {@code @RequestBody} 参数校验不通过时抛出的异常处理
         */
        @ExceptionHandler({
        MethodArgumentNotValidException.class})
        public Result<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
        
            log.error(ex.getMessage(), ex);
            String msg =  ex.getBindingResult().getFieldErrors().stream()
                    .map(f -> f == null ? "null" : f.getField() + ": " + f.getDefaultMessage())
                    .collect(Collectors.joining(", "));
            if (StringUtils.hasText(msg)) {
        
                return Result.failed(ResultEnum.VALIDATE_FAILED.getCode(), msg);
            }
            return Result.failed(ResultEnum.VALIDATE_FAILED);
        }
    
        /**
         * {@code @PathVariable} 和 {@code @RequestParam} 参数校验不通过时抛出的异常处理
         */
        @ExceptionHandler({
        ConstraintViolationException.class})
        public Result<?> handleConstraintViolationException(ConstraintViolationException ex) {
        
            log.error(ex.getMessage(), ex);
            if (StringUtils.hasText(ex.getMessage())) {
        
                return Result.failed(ResultEnum.VALIDATE_FAILED.getCode(), ex.getMessage());
            }
            return Result.failed(ResultEnum.VALIDATE_FAILED);
        }
    
        /**
         * 顶级异常捕获并统一处理，当其他异常无法处理时候选择使用
         */
        @ExceptionHandler({
        Exception.class})
        public Result<?> handle(Exception ex) {
        
            log.error(ex.getMessage(), ex);
            return Result.failed(ResultEnum.COMMON_FAILED);
        }
    
    }

# 参数校验 #

`Java API` 的规范 `JSR303` 定义了校验的标准 `validation-api` ，其中一个比较出名的实现是 `hibernate validation` ，`spring validation` 是对其的二次封装，常用于 `SpringMVC` 的参数自动校验，参数校验的代码就不需要再与业务逻辑代码进行耦合了  
**依赖**

<dependency>
                <groupId>org.hibernate.validator</groupId>
                <artifactId>hibernate-validator</artifactId>
                <version>6.2.3.Final</version>
            </dependency>

## @PathVariable 和 @RequestParam 参数校验 ##

`Get` 请求的参数接收一般依赖这两个注解，但是处于 url 有长度限制和代码的可维护性，超过 5 个参数尽量用实体来传参  
对 `@PathVariable` 和 @`RequestParam` 参数进行校验需要在入参声明约束的注解  
如果校验失败，会抛出 `ConstraintViolationException`异常

![在这里插入图片描述][28ff112a690545bf8b09672b0cd08d70.png]  
![在这里插入图片描述][397de4966a5b49a89701430d6e199026.png]

## @RequestBody ##

package com.wxl52d41.vo;
    
    
    import com.wxl52d41.validator.InsertValidator;
    import com.wxl52d41.validator.TelephoneNumber;
    import com.wxl52d41.validator.UpdateValidator;
    import lombok.Data;
    
    import javax.validation.constraints.*;
    
    /**
     * @author wxl
     * @version 1.0.0
     * @ClassName User.java
     * @Description TODO
     * @createTime 2022年02月26日 20:58:00
     */
    @Data
    public class User {
        
    
    
        @NotNull(groups = {
        UpdateValidator.class})
        private Long id;// ID
        /**
         * 新增时校验条件生效
         * 用户名不能为空，且用户名个数在1-20之间。
         */
        @NotEmpty(message = "username必填", groups = {
        InsertValidator.class})
        @Size(max = 20, min = 1, message = "用户名个数在1-20之间", groups = {
        InsertValidator.class})
        private String username;// 用户名
    
        @NotBlank(message = "密码必填", groups = {
        InsertValidator.class})
        @Size(min = 6, message = "密码个数不少于六位", groups = {
        InsertValidator.class})
        private String password;// 密码
    
        /**
         * 新增时校验条件生效
         * 邮箱校验规则
         */
        @NotBlank(message = "邮箱不能为空", groups = {
        InsertValidator.class})
        @Email(groups = {
        InsertValidator.class})
        @Size(max = 30,  groups = {
        InsertValidator.class})
        private String email;// 邮箱
    
        /**
         * 新增更新时校验条件生效
         * 使用了手机号校验规则
         */
        @NotBlank(message = "手机号不能为空", groups = {
        InsertValidator.class})
        @TelephoneNumber(groups = {
        InsertValidator.class, UpdateValidator.class}, message = "手机号不正确")
        @Size(max = 11, groups = {
        InsertValidator.class, UpdateValidator.class})
        private String mobile;// 手机号
    
        @Size(max = 20, min = 6, groups = {
        InsertValidator.class})
        private String provinceRegionCode;// 省份区域代码
    
        @Size(max = 20, min = 6, groups = {
        UpdateValidator.class})
        private String cityRegionCode;// 地市区域代码
    
        @Size(max = 40, groups = {
        UpdateValidator.class})
        private String address;// 街道地址
    
        @Size(max = 256, groups = {
        UpdateValidator.class})
        private String profile;// 个人简介
    
    }

@RestController
    @RequestMapping("/pretty")
    @Validated
    public class TestController {
        
    
    
        /**--------------------单参数 PathVariable------------------------*/
        @GetMapping("/{num}")
        public Integer detail(@PathVariable("num") @Min(1) @Max(20) Integer num,
                              @RequestParam(name = "email",required = true) @NotBlank @Email String email) {
        
            return num * num;
        }
    
        /**--------------------单参数 RequestParam------------------------*/
        @GetMapping("/getByEmail")
        public TestUserVo getByAccount(@RequestParam(name = "email") @NotBlank @Email String email,
                                       @RequestParam @NotBlank String id) {
        
            TestUserVo testDTO = new TestUserVo();
            testDTO.setEmail(email);
            return testDTO;
        }
    
        @PostMapping("/test-validation")
        public void testValidation(@RequestBody @Validated TestVO testDTO) {
        
            System.out.println("testDTO = " + testDTO);
        }
    
        @PostMapping("/testUser")
        public void testUser(@RequestBody @Validated(InsertValidator.class) User testDTO) {
        
            System.out.println("testDTO = " + testDTO);
        }
    
    }

![在这里插入图片描述][06fa3c9bcf9c4bca94d8a06cd9665a1a.png]

[hibernate-validator_controller]: https://blog.csdn.net/weixin_43811057/article/details/123157228?spm=1001.2014.3001.5501
[28ff112a690545bf8b09672b0cd08d70.png]: https://img-blog.csdnimg.cn/28ff112a690545bf8b09672b0cd08d70.png
[397de4966a5b49a89701430d6e199026.png]: https://img-blog.csdnimg.cn/397de4966a5b49a89701430d6e199026.png
[06fa3c9bcf9c4bca94d8a06cd9665a1a.png]: https://img-blog.csdnimg.cn/06fa3c9bcf9c4bca94d8a06cd9665a1a.png