Java Validator用法 java validate方法

Jakarta Bean Validation 旧版本也叫Java Bean Validation,至从Java EE规范移交给Eclipse基金会管理后改成这个名字；主要是规范了参数校验的标准，可以让开发中把你的代码优雅地展现在你的面前，既能达到校验的目的，又能使代码简洁工整；下面使用几个简单的场景介绍一下用法。

Jakarta Bean Validation规范只是接口，具体还是各大开源机构的实现，目前有一些实现版本比如：Hibernate Validator、Apache BVal，Hibernate Validator使用最多，更新也比较及时。目前已经出到7.x.x版本了。7.x.x版本是基于Jakarta Bean Validation 3.0 版本；6.x.x是基于Jakarta/Java Bean Validation 2.0版本，下面基于SpringBoot 案例演示具体用法。

一、Maven 坐标

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.20</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

二、验证模型(Model)

package com.codingx.validator.model;
import lombok.Data;
import javax.validation.constraints.*;

@Data
public class User {
    @NotNull(message = "用户名不能为空")
    @Size(message = "用户名长度不满足",max = 8,min = 5)
    private String username;
    @Pattern(message = "性别不对",regexp = "^(男|女){1}#34; )
    private String userSex;
    @Email(message = "邮箱错误")
    private String userEmail;
    @Min(message = "未满十八周岁",value = 18)
    private Integer userAge;
    private String passwd;
    @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}#34;, message = "手机号格式有误")
    private String mobilePhone;
}

三、接口实现类(Controller) Rest类型

package com.codingx.validator.controller;
import com.codingx.validator.model.RestResponse;
import com.codingx.validator.model.User;
import org.springframework.http.MediaType;
import org.springframework.util.Assert;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
@RestController
public class UserRegisterController {
    @PostMapping(value="/register", produces={MediaType.APPLICATION_JSON_VALUE}, consumes={MediaType.APPLICATION_JSON_VALUE})
    public RestResponse<Boolean> register(@RequestBody @Validated User user){
      	//此方法是Springboot 提供的断言校验方法，也挺好用的大家也多用一下
        //毕竟可以很大程度简化代码的复杂度
        Assert.notNull(user.getPasswd(),"密码不能为空");
        Assert.hasLength(user.getPasswd(),"密码不能为空字符..请检查");
        return RestResponse.succ(true,"注册成功");
    }
}

四、定义一个全局异常，毕竟现在都是前后端分离的项目，统一异常可以极大简化处理异常逻辑，又工整、合理

package com.codingx.validator;
import com.codingx.validator.model.RestResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import javax.validation.ValidationException;
/**
 * 全局异常处理
 * 因为参数校验会抛出几种不同的校验异常，索性都捕获了
 * @param <T>
 */
@Slf4j
@RestControllerAdvice
public class GlobalExecptionHandler<T> {
    //方法参数校验异常
    @ExceptionHandler(value= MethodArgumentNotValidException.class)
    public RestResponse<T> validationHandler(MethodArgumentNotValidException e){
        StringBuffer sb = new StringBuffer("");
        for (ObjectError error : e.getBindingResult().getAllErrors()) {
            sb.append(",[").append(error.getDefaultMessage()).append("]");
        }
        return RestResponse.fail(sb.substring(1));
    }
    //校验异常
    @ExceptionHandler(value= ValidationException.class)
    public RestResponse<T> validationHandler(ValidationException e){
        return RestResponse.fail(e.getMessage());
    }
    //不合法参数异常，针对SpringBoot Assert断言抛出的异常
    @ExceptionHandler(value= IllegalArgumentException.class)
    public RestResponse<T> validationHandler(IllegalArgumentException e){
        return RestResponse.fail(e.getMessage());
    }
    //其他异常
    @ExceptionHandler(value=Throwable.class)
    public RestResponse<T> execptionHandler(Throwable e){
        log.error("系统异常",e);
        return RestResponse.fail("系统异常");
    }
}

五、启动类，没啥特别的，就是简单的Springboot启动类

package com.codingx.validator;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class ValidatorApplication {
    public static void main(String[] args) {
        SpringApplication.run(ValidatorApplication.class, args);
    }
}

六、启动成功后，上我们接口测试工具POSTMAN,下面是一些调试参数，大家可以调整测试一下校验情况。

感觉是不是大大提高了代码的简洁程度，再也不用写一堆NPE判断了。

注：Controller方法中顺便测试了一下Springboot 提供的校验方法，同样也可以达到效果，在一些场景可以简化代码的复杂度。

此演示代码均在gitee有共享，有需要的可以下来来看看。

地址：https://gitee.com/xworkers/codingx-demo

欢迎交流，如有错误，欢迎指正。