Hibernate-Validator的学习
此教程基于黑马程序员Java品达通用权限项目,哔哩哔哩链接:https://www.bilibili.com/video/BV1tw411f79E?p=49
1.hibernate-validator介绍
早期的网站,用户输入一个邮箱地址,需要将邮箱地址发送到服务端,服务端进行校验,校验成功后,给前端一个响应。
有了JavaScript
后,校验工作可以放在前端去执行。那么为什么还需要服务端校验呢? 因为前端传来的数据不可信。前端很容易获取到后端的接口,如果有人直接调用接口,就可能会出现非法数据,所以服务端也要数据校验。
总的来说:
- 前端校验:主要是提高用户体验
- 后端校验:主要是保证数据安全可靠
校验参数基本上是一个体力活,而且冗余代码繁多,也影响代码的可读性,我们需要一个比较优雅的方式来解决这个问题。Hibernate Validator 框架刚好解决了这个问题,可以以很优雅的方式实现参数的校验,让业务代码和校验逻辑分开,不再编写重复的校验逻辑。
Hibernate-Validator优势:
- 验证逻辑与业务逻辑之间进行了分离,降低了程序耦合度
- 统一且规范的验证方式,无需你再次编写重复的验证代码
- 你将更专注于你的业务,将这些繁琐的事情统统丢在一边
hibernate-validator
的maven坐标:
<dependency><groupId>org.hibernate</groupId><artifactId>hibernate-validator</artifactId><version>6.0.18.Final</version>
</dependency>
2.hibernate-validator常用注解
hibernate-validator提供的校验方式为在类的属性上加入相应的注解来达到校验的目的。hibernate-validator提供的用于校验的注解如下:
注解 | 说明 |
---|---|
@AssertTrue | 用于boolean字段,该字段只能为true |
@AssertFalse | 用于boolean字段,该字段只能为false |
@CreditCardNumber | 对信用卡号进行一个大致的验证 |
@DecimalMax | 只能小于或等于该值 |
@DecimalMin | 只能大于或等于该值 |
检查是否是一个有效的email地址 | |
@Future | 检查该字段的日期是否是属于将来的日期 |
@Length(min=,max=) | 检查所属的字段的长度是否在min和max之间,只能用于字符串 |
@Max | 该字段的值只能小于或等于该值 |
@Min | 该字段的值只能大于或等于该值 |
@NotNull | 不能为null |
@NotBlank | 不能为空,检查时会将空格忽略 |
@NotEmpty | 不能为空,这里的空是指空字符串 |
@Pattern(regex=) | 被注释的元素必须符合指定的正则表达式 |
@URL(protocol=,host,port) | 检查是否是一个有效的URL,如果提供了protocol,host等,则该URL还需满足提供的条件 |
3.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( 在springboot2.3之前 )--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!-- lombok --><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.2</version></dependency><!-- hibernate-validator 校验 --><dependency><groupId>org.hibernate</groupId><artifactId>hibernate-validator</artifactId><version>6.0.8.Final</version></dependency></dependencies></project>
第二步:创建User类
package cn.itcast.entity;import lombok.Data;
import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.*;@Data
public class User {// @NotNull 不能为null@NotNull(message = "用户id不能为空")private Integer id;// @NotEmpty 不能为空,这里的空是指空字符串@NotEmpty(message = "用户名不能为空")// @Length(min=,max=) 检查所属的字段的长度是否在min和max之间,只能用于字符串@Length(max = 50, message = "用户名长度不能超过50")private String username;@Max(value = 80,message = "年龄最大为80")@Min(value = 18,message = "年龄最小为18")private int age;// @Pattern(regex=) 被注释的元素必须符合指定的正则表达式@Pattern(regexp = "[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$",message = "邮箱格式不正确")// @Email(message = "请输入正确的邮箱")private String email;
}
第三步:创建UserController
package cn.itcast.controller;import cn.itcast.entity.User;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.constraints.NotBlank;@RestController
@RequestMapping("/user")
@Validated // 开启hibernate-validator校验功能
public class UserController {// 简单数据类型校验,// 这里用@RequestMapping的原因是我们通过浏览器的方式进行测试,对请求方式没有要求,只要路径匹配即可@RequestMapping("/delete")public String delete(@NotBlank(message = "id不能为空") String id){System.out.println("delete..." + id);return "OK";}// 对象属性校验 @Validated// 这里用@RequestMapping的原因是我们通过浏览器的方式进行测试,对请求方式没有要求,只要路径匹配即可@RequestMapping("/save")public String save(@Validated User user){System.out.println("save..." + user);return "OK";}
}
第四步:创建application.yml
server:port: 9100
第五步:创建启动类
package cn.itcast;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication
public class HibernateValidatorApp {public static void main(String[] args) {SpringApplication.run(HibernateValidatorApp.class,args);}}
启动项目,访问地址:http://localhost:9100/user/save
,浏览器页面直接报错,
通过控制台输出可以看到已经进行数据校验了,并且3个错误如下:
Field error in object 'user' on field 'id': rejected value [null]; codes [NotNull.user.id,NotNull.id,NotNull.java.lang.Integer,NotNull]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.id,id]; arguments []; default message [id]]; default message [用户id不能为空]
Field error in object 'user' on field 'username': rejected value [null]; codes [NotEmpty.user.username,NotEmpty.username,NotEmpty.java.lang.String,NotEmpty]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.username,username]; arguments []; default message [username]]; default message [用户名不能为空]
Field error in object 'user' on field 'age': rejected value [0]; codes [Min.user.age,Min.age,Min.int,Min]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.age,age]; arguments []; default message [age],18]; default message [年龄最小为18]]
第六步:为了能够在页面友好的显示数据校验结果,可以通过全局异常处理来解决,创建全局异常处理类
package cn.itcast.config;import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.Set;/*** 全局异常处理* @ControllerAdvice: 切面,用于拦截controller,这里表示在类上添加了RestController或Controller的类都会被拦截到* @ResponseBody:响应的数据时json数据,不是返回页面(类上有Controller才可以返回页面),而是通过输出流返回json数据*/
@ControllerAdvice(annotations = {RestController.class, Controller.class})
@ResponseBody
public class ExceptionConfiguration {/*** 异常处理方法* @param ex 异常* @param request* @return 异常提示信息** @ExceptionHandler 异常处理器,加上这个注解才是异常处理方法,添加上ConstraintViolationException.class(约束异常),* BindException.class 表示只抓这两种异常,因为hibernate-validator进行校验时会返回这两种异常*/@ExceptionHandler({ConstraintViolationException.class,BindException.class})public String validateException(Exception ex, HttpServletRequest request) {ex.printStackTrace();String msg = null;// 如果是ConstraintViolationExceptionif(ex instanceof ConstraintViolationException){ConstraintViolationException constraintViolationException = (ConstraintViolationException)ex;Set<ConstraintViolation<?>> violations = constraintViolationException.getConstraintViolations();ConstraintViolation<?> next = violations.iterator().next(); // 得到所有异常信息msg = next.getMessage(); // 得到异常提示信息// 如果是BindException}else if(ex instanceof BindException){BindException bindException = (BindException)ex;msg = bindException.getBindingResult().getFieldError().getDefaultMessage(); // 得到异常提示信息}return msg;}
}
重启程序可以发现此时页面可以友好的显示校验信息了:
通过控制台的输出可以看到,校验框架将我们的多个属性都进行了数据校验(默认行为),如果我们希望只要有一个属性校验失败就直接返回提示信息,后面的属性不再进行校验了该如何实现呢?
第七步:创建ValidatorConfiguration类,指定校验时使用快速失败返回模式
package cn.itcast.config;import org.hibernate.validator.HibernateValidator;
import org.springframework.context.annotation.Bean;
import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;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用于控制快速失败返回模式的开启
package cn.itcast.config;import org.springframework.context.annotation.Import;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;/*** 在启动类上添加该注解来启动表单验证功能---快速失败返回模式*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(ValidatorConfiguration.class)
public @interface EnableFormValidator {
}
第九步:在启动类上加入EnableFormValidator注解,开启快速失败返回模式
package cn.itcast;import cn.itcast.config.EnableFormValidator;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication
@EnableFormValidator
public class HibernateValidatorApp {public static void main(String[] args) {SpringApplication.run(HibernateValidatorApp.class,args);}
}
通过控制台的输出可以看到,虽然我们输入的数据有多个都不符合校验规则,但是只有一个校验失败异常信息,这说明已经开启了快速失败返回模式。
4.制作starter
第一步:创建maven工程validator-util并配置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.3.2.RELEASE</version><relativePath/> <!-- lookup parent from repository --></parent><groupId>org.example</groupId><artifactId>validator-util</artifactId><version>1.0-SNAPSHOT</version><dependencies><!--spring-boot-starter-web中已经依赖了hibernate-validator( 在springboot2.3之前 )--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!-- hibernate-validator 校验 --><dependency><groupId>org.hibernate</groupId><artifactId>hibernate-validator</artifactId><version>6.0.8.Final</version></dependency></dependencies>
</project>
第二步:创建ValidatorConfiguration类,指定校验时使用快速失败返回模式
package config;import org.hibernate.validator.HibernateValidator;
import org.springframework.context.annotation.Bean;
import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;public class ValidatorConfiguration {@Beanpublic Validator validator() {// ValidatorFactory: 校验的工厂对象,ValidatorFactory validatorFactory =// 表示使用HibernateValidator进行校验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用于控制快速失败返回模式的开启
package config;import org.springframework.context.annotation.Import;import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;/*** 在启动类上添加该注解来启动表单验证功能---快速失败返回模式*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(ValidatorConfiguration.class)
public @interface EnableFormValidator {
}
第四步:按照SpringBoot starter
的规范(没有starter基础的可以去看我的starter博客,点击前往)编写/resources/META-INF/spring.factories文件,内容如下:
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\com.itheima.config.ValidatorConfiguration
注:如果有多个配置,以英文逗号分隔即可
第五步:对该maven项目进行打包的操作
5.使用starter
第一步:创建maven工程并配置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>com.itheima</groupId><artifactId>myHibernateValidatorApp</artifactId><version>1.0-SNAPSHOT</version><dependencies><dependency><groupId>org.example</groupId><artifactId>validator-util</artifactId><version>1.0-SNAPSHOT</version></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></dependency></dependencies>
</project>
注意:为防止我们自定义的starter识别不到,我们需要更新一下maven仓库,
第二步:创建User类
package cn.itcast.entity;import lombok.Data;
import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.*;@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
package cn.itcast.controller;import cn.itcast.entity.User;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.constraints.NotBlank;@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";}
}
第四步:创建application.yml
server:port: 9000
第五步:创建启动类
package cn.itcast;import com.itheima.pinda.validator.config.EnableFormValidator;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication
@EnableFormValidator
public class MyHibernateValidatorApplication {public static void main(String[] args) {SpringApplication.run(MyHibernateValidatorApplication.class,args);}
}
启动项目,访问地址:http://localhost:9000/user/save
,可以看到控制台输出:
2020-03-11 16:40:30.288 WARN 17428 --- [nio-9000-exec-4] .w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 1 errors
Field error in object 'user' on field 'age': rejected value [0]; codes [Min.user.age,Min.age,Min.int,Min]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.age,age]; arguments []; default message [age],18]; default message [年龄最小为18]]
页面效果:
这说明已经开始进行输入校验了,而且根据控制台输出可以看出已经开启快速失败返回模式。
为了能够给页面一个友好的提示,也可以按需要加入全局异常处理。
喜欢请关注我
至此,我们的Hibernate-Validator的学习
就讲解完毕了。喜欢我的话可以关注我的微信公众号 我爱学习呀嘻嘻 ,不定期分享各类资源哦。