入参校验及全局异常处理

1 引入依赖

<!-- spring-boot 2.3及以上的版本需要引入包 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2 注解使用说明

注解	说明
@NotNull	验证注解的元素必须非空（即非null且非空字符串）
@NotEmpty	验证注解的字符串元素必须非空且长度大于0
@NotBlank	验证注解的字符串元素必须非空，并且至少包含一个非空白字符
@Null	验证注解的元素必须为null
@AssertTrue	验证布尔值必须为true
@AssertFalse	验证布尔值必须为false
@Size	验证注解的字符串或集合元素的数量是否在指定的范围内
@Length	验证注解的字符串元素的长度是否在指定的范围内
@Min	验证注解的数值是否大于或等于指定的最小值
@Max	验证注解的数值是否小于或等于指定的最大值
@DecimalMin	验证注解的数值是否大于或等于指定的十进制最小值
@DecimalMax	验证注解的数值是否小于或等于指定的十进制最大值
@Email	验证注解的字符串是否是有效的电子邮件地址
@Pattern	验证注解的字符串是否与指定的正则表达式匹配
@Past	验证注解的日期元素是否在当前日期之前
@Future	验证注解的日期元素是否在当前日期之后
@Valid	递归验证关联对象的属性
@Positive	验证注解的数值是否大于0
@Negative	验证注解的数值是否小于0
@Digits	验证注解的数值是否有正确的整数位数和小数位数

3 注解应用到实体

@Data
public class TestOneDTO {

    @NotNull(message = "用户名不允许为空")
    @Size(min = 3, max = 50, message = "用户名长度必须在3到50个字符之间")
    private String username;

    @NotNull(message = "密码不允许为空")
    @Size(min = 6, max = 20, message = "密码长度必须在6到20个字符之间")
    private String password;

    @Email(message = "电子邮箱格式不正确")
    private String email;

    @Min(value = 18, message = "年龄必须至少为18岁")
    @Max(value = 100, message = "年龄不允许超过100岁")
    private Integer age;

    @Past(message = "生日不能大于当前时间")
    private LocalDateTime birthDate;

    @Pattern(regexp = "^((\\+86)|(0086))?(-\\d{3}-)?\\d{8}$", message = "手机号码格式不正确")
    private String phoneNumber;

    // 校验对象中的另一个对象（对象内容如下）
    @Valid
    private Address address;
    
    public boolean validate() {
        if (username == null || username.length() < 3 || username.length() > 50) {
            System.out.println("用户名长度必须在3到50个字符之间");
            return false;
        }
        if (password == null || password.length() < 6 || password.length() > 20) {
            System.out.println("密码长度必须在6到20个字符之间");
            return false;
        }
        if (email == null || !email.contains("@")) {
            System.out.println("电子邮箱格式不正确");
            return false;
        }
        if (age == null || age < 18 || age > 100) {
            System.out.println("年龄必须至少为18岁且不允许超过100岁");
            return false;
        }
        if (birthDate != null && birthDate.isAfter(LocalDateTime.now())) {
            System.out.println("生日必须是过去的时间");
            return false;
        }
        if (phoneNumber != null && !phoneNumber.matches("^((\\+86)|(0086))?(-\\d{3}-)?\\d{8}$")) {
            System.out.println("手机号码格式不正确");
            return false;
        }
        return true;
    }
}

@Data
class Address {
    @NotBlank(message = "地址不允许为空")
    @Size(min = 5, max = 200, message = "地址长度必须在5到200个字符之间")
    private String street;

    @NotBlank(message = "城市不允许为空")
    private String city;

}

4 自定义全局异常处理

4.1 定义

@ControllerAdvice：基于Aop思想的一种实现

• 默认对所有Controller进行拦截

• 也可以指定规则，类似于@ComponentScan

@ControllerAdvice(basePackages="org.my.pkg"), 则匹配org.my.pkg包及其子包下的所有Controller，当然也可以用数组的形式指定，如：@ControllerAdvice(basePackages={"org.my.pkg", "org.my.other.pkg"}), 也可以通过指定注解来匹配，比如我自定了一个 @CustomAnnotation 注解，我想匹配所有被这个注解修饰的 Controller, 可以这么写：@ControllerAdvice（annotations={CustomAnnotation.class})

4.2 用法

通过@ExceptionHandler、@InitBinder 或 @ModelAttribute这三个注解以及被其注解的方法来实现全局异常处理

（1）@ExceptionHandler

比如在方法上加：@ExceptionHandler(IllegalArgumentException.class)，则表明此方法处理

IllegalArgumentException 类型的异常，如果参数为空，将默认为方法参数列表中列出的任何异常

@ControllerAdvice
@ResponseBody
@Slf4j
public class GlobalExceptionHandler {

    /**
     * @Valid校验异常处理
     *   处理使用 @Valid 或者 @Validated 进行方法参数验证的异常
     */
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public Object methodArgumentNotValidExceptionHandler(HttpServletRequest request, MethodArgumentNotValidException e){
        StringBuffer sb = new StringBuffer();
        List<ObjectError> allErrors = e.getAllErrors();
        if (CollectionUtils.isNotEmpty(allErrors)){
            for (ObjectError allError : allErrors) {
                sb.append(allError.getDefaultMessage()).append("|");
            }
        }
        return sb.toString();
    }

    @ExceptionHandler(value = Exception.class)
    public Object exceptionHandler(HttpServletRequest request, Exception e){
        e.printStackTrace();
        log.info("Exception异常全局拦截:{}",e.getMessage());
        // 其余异常简单返回为服务器异常
        return e;
    }
}

（2）@ModelAttribute预设全局数据

@ControllerAdvice可以与@ModelAttribute注解结合使用，用于在Controller方法执行之前，向Model中添加全局数据。这可以用于预设一些在多个Controller方法中都需要使用的数据，如用户信息、系统配置等。

@ControllerAdvice  
public class GlobalDataBinder {  
  
    @ModelAttribute("globalData")  
    public Map<String, Object> addGlobalData() {  
        Map<String, Object> data = new HashMap<>();  
        data.put("appName", "MyApp");  
        data.put("appVersion", "1.0.0");  
        return data;  
    }  
}

（3）@InitBinder 请求参数预处理

@ControllerAdvice可以与@InitBinder注解结合使用，用于自定义请求参数的解析和绑定方式。这对于一些特殊类型的参数（如Date类型）尤其有用，因为Spring MVC默认可能不支持这些类型的直接绑定。通过@InitBinder，可以注册自定义的参数转换器或格式化器，以便将请求中的字符串参数转换为所需的类型。

@ControllerAdvice  
public class CustomInitBinder {  
  
    @InitBinder  
    public void initBinder(WebDataBinder binder) {  
        // 注册自定义的Date类型转换器  
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");  
        dateFormat.setLenient(false);  
        binder.registerCustomEditor(Date.class, new CustomDateEditor(dateFormat, false));  
    }  
}

这样，当Controller方法中的参数类型为Date时，Spring MVC将使用自定义的转换器来解析请求中的日期字符串。