Springboot+Validation 实践

Springboot+Validation 简单实践

我们直接通过官网来学习Bean Validation，在首页介绍里，我们可以看到一些关键信息，比如：

“It’s part of Jakarta EE 8 ”

这说明Validation是J2EE的一个规范

点击「API Artifact」，可以看到Maven相关配置
点击「API JavaDocs」API文档，可以看到包名是javax.validation（javax.*即J2EE规范）

在Certified implementations（认证实现）下，只列出了 Hibernate Validator，说明Hibernate Validator是目前官方承认的一个最佳实现。

Springboot 实现

springboot版本 2.5.4

1. 依赖:

		<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

*注意不要再添加hibernate-validator的依赖，否则可能会不生效，用spring-boot-starter-validation自带的即可

2. 全局异常处理类

创建一个全局异常处理类

import com.homework.comments.utils.Response;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.validation.ConstraintViolationException;

/**
 * 全局异常处理
 */
@ControllerAdvice
public class GlobalExceptionHandler {

    /**
     * 方法参数校验
     */
    @ResponseBody
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Response handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        List<ObjectError> allErrors = e.getBindingResult().getAllErrors();
        //拼接所有message
        String message = allErrors.stream().map(s -> s.getDefaultMessage()).collect(Collectors.joining(";"));
        
        return new Response("-1", message);
    }

    @ResponseBody
    @ExceptionHandler(ConstraintViolationException.class)
    public Response handleConstraintViolationException(ConstraintViolationException e) {
        return new Response("-1", e.getMessage());
    }

    @ResponseBody
    @ExceptionHandler(Exception.class)
    public Response handleException(Exception e) {
        e.printStackTrace();
        String msg = e.getMessage();
        if (msg == null || msg.equals("")) {
            msg = "服务器出错";
        }
        return new Response("-1",msg);
    }
}

注意@ResponseBody最好加上，否则容易出现Circular view path异常，原因是控制器认为输出的不是json而是路径

3. 对参数类添加校验注解

package com.homework.comments.domain;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.validator.constraints.Length;

import javax.validation.constraints.Email;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    
    private int userId;
    
    @NotNull(message = "用户名不能为空")
    @Length(min = 5, max = 20, message = "用户名5～20个字符")
    @Pattern(regexp = "^[A-Za-z0-9]", message = "用户名只能是数字或字母")
    private String userName;
    
    @NotNull(message = "密码不能为空")
    @Length(min = 8, max = 20, message = "密码8～20个字符")
    @Pattern(regexp = "^(?=.*\\d)(?=.*[a-z])(?=.*[A-Z])(?=.*[~!@#$%^&*])",
            message = "密码必须含有一个大写一个小写字母，一个数字，一个特殊字符")
    private String userPassword;
    
    @NotNull(message = "邮箱不能为空")
    @Email(message = "邮箱不正确")
    private String email;
    
    private String createTime;
}

4. 对Controller添加校验注解

    /**
     * 注册新用户
     *
     */
    @PostMapping("/userRegister")
    public Response userRegister(@RequestBody @Valid User user){
        return userService.userRegister(user);
    }

测试

用postman发起请求，返回

{
    "status": "-1",
    "content": "密码必须含有一个大写一个小写字母，一个数字，一个特殊字符;密码8～20个字符;用户名只能是数字或字母;用户名5～20个字符;邮箱不正确"
}

总结

Bean Validation官网：https://beanvalidation.org/2.0/ J2EE规范，api，接口
Hibernate Validator 官网：http://hibernate.org/validator/ 是Bean Validation的最佳实现