hibernate-validator的使用

本文主要是介绍hibernate-validator的使用，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

总的来说：

前端校验：主要是提高用户体验
后端校验：主要是保证数据安全可靠

校验参数基本上是一个体力活，而且冗余代码繁多，也影响代码的可读性，我们需要一个比较优雅的方式来解决这个问题。Hibernate Validator 框架刚好解决了这个问题，可以以很优雅的方式实现参数的校验，让业务代码和校验逻辑分开,不再编写重复的校验逻辑。

hibernate-validator优势：

验证逻辑与业务逻辑之间进行了分离，降低了程序耦合度
统一且规范的验证方式，无需你再次编写重复的验证代码
你将更专注于你的业务，将这些繁琐的事情统统丢在一边

hibernate-validator常用注解：

hibernate-validator提供的校验方式为在类的属性上加入相应的注解来达到校验的目的。hibernate-validator提供的用于校验的注解如下：
@AssertTrue：用于boolean字段，该字段只能为true
@AssertFalse：用于boolean字段，该字段只能为false
@CreditCardNumber：对信用卡号进行一个大致的验证
@DecimalMax：只能小于或等于该值
@DecimalMin：只能大于或等于该值
@Email：检查是否是一个有效的email地址
@Future：检查该字段的日期是否是属于将来的日期
@Length(min=,max=)：检查所属的字段的长度是否在min和max之间,只能用于字符串
@Max：该字段的值只能小于或等于该值
@Min：该字段的值只能大于或等于该值
@NotNull：不能为null
@NotBlank：不能为空，检查时会将空格忽略
@NotEmpty：不能为空，这里的空是指空字符串
@Pattern(regex=)：被注释的元素必须符合指定的正则表达式
@URL(protocol=,host,port)：检查是否是一个有效的URL，如果提供了protocol，host等，则该URL还需满足提供的条件

hibernate-validator入门案例
第一步：创建maven工程hibernate-validator_demo并配置pom.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.2.2.RELEASE</version><relativePath/></parent><groupId>cn.itcast</groupId><artifactId>hibernate-validator_demo</artifactId><version>1.0-SNAPSHOT</version><dependencies><!--spring-boot-starter-web中已经依赖了hibernate-validator--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!--<dependency><groupId>org.hibernate</groupId><artifactId>hibernate-validator</artifactId><version>6.0.18.Final</version></dependency>--></dependencies>
</project>

注意：spring-boot-starter-web中已经依赖了hibernate-validator，所以无需再次导入。

第二步：创建User类

@Data
public class User {@NotNull(message = "用户id不能为空")private Integer id;@NotEmpty(message = "用户名不能为空")@Length(max = 50, message = "用户名长度不能超过50")private String username;@Max(value = 80,message = "年龄最大为80")@Min(value = 18,message = "年龄最小为18")private int age;@Pattern(regexp = "[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$",message = "邮箱格式不正确")private String email;
}

第三步：创建UserController

@RestController
@RequestMapping("/user")
@Validated //开启校验功能
public class UserController {//简单数据类型校验@RequestMapping("/delete")public String delete(@NotBlank(message = "id不能为空") String id){System.out.println("delete..." + id);return "OK";}//对象属性校验@RequestMapping("/save")public String save(@Validated User user){System.out.println("save..." + user);return "OK";}
}

第五步：创建启动类

@SpringBootApplication
public class HibernateValidatorApp {public static void main(String[] args) {SpringApplication.run(HibernateValidatorApp.class,args);}
}

第六步：为了能够在页面友好的显示数据校验结果，可以通过全局异常处理来解决，创建全局异常处理类

/*** 全局异常处理*/
@ControllerAdvice(annotations = {RestController.class, Controller.class})
@ResponseBody
public class ExceptionConfiguration {@ExceptionHandler({ConstraintViolationException.class,BindException.class})public String validateException(Exception ex, HttpServletRequest request) {ex.printStackTrace();String msg = null;if(ex instanceof ConstraintViolationException){ConstraintViolationException constraintViolationException = (ConstraintViolationException)ex;Set<ConstraintViolation<?>> violations = constraintViolationException.getConstraintViolations();ConstraintViolation<?> next = violations.iterator().next();msg = next.getMessage();}else if(ex instanceof BindException){BindException bindException = (BindException)ex;msg = bindException.getBindingResult().getFieldError().getDefaultMessage();}return msg;}
}

重启程序可以发现此时页面可以友好的显示校验信息了
在这里插入图片描述
通过控制台的输出可以看到，校验框架将我们的多个属性都进行了数据校验（默认行为），如果我们希望只要有一个属性校验失败就直接返回提示信息，后面的属性不再进行校验了该如何实现呢？

第七步：创建ValidatorConfiguration类，指定校验时使用快速失败返回模式

public class ValidatorConfiguration {@Beanpublic Validator validator() {ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class).configure()//快速失败返回模式.addProperty("hibernate.validator.fail_fast", "true").buildValidatorFactory();return validatorFactory.getValidator();}/*** 开启快速返回* 如果参数校验有异常，直接抛异常，不会进入到 controller，使用全局异常拦截进行拦截*/@Beanpublic MethodValidationPostProcessor methodValidationPostProcessor() {MethodValidationPostProcessor postProcessor = new MethodValidationPostProcessor();/**设置validator模式为快速失败返回*/postProcessor.setValidator(validator());return postProcessor;}
}

注意：上面创建的类并不是配置类，所以到目前为止快速失败返回模式并不会生效，为了使其生效需要创建一个注解用于控制此模式的开启

第八步：创建注解EnableFormValidator用于控制快速失败返回模式的开启
/**

在启动类上添加该注解来启动表单验证功能—快速失败返回模式
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(ValidatorConfiguration.class)
public @interface EnableFormValidator {
}
第九步：在启动类上加入EnableFormValidator注解，开启快速失败返回模式

@SpringBootApplication
@EnableFormValidator
public class HibernateValidatorApp {public static void main(String[] args) {SpringApplication.run(HibernateValidatorApp.class,args);}
}