后台管理系统的通用权限解决方案(五)SpringBoot整合hibernate-validator实现表单校验

1 hibernate-validator介绍

早期的网站，用户输入一个邮箱地址，需要将邮箱地址发送到服务端，服务端进行校验，校验成功后，给前端一个响应。

有了JavaScript后，校验工作可以放在前端去执行。那么为什么还需要服务端校验呢？

因为前端传来的数据不可信。前端很容易获取到后端的接口，如果有人直接调用接口，就可能会出现非法数据，所以服务端也要数据校验。总的来说：

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

校验参数基本上是一个体力活，而且冗余代码繁多，也影响代码的可读性，我们需要一个比较优雅的方式来解决这个问题。

Hibernate Validator 框架刚好解决了这个问题，可以以很优雅的方式实现参数的校验，让业务代码和校验逻辑分开，不再编写重复的校验逻辑。

hibernate-validator优势：

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

2 hibernate-validator常用注解

hibernate-validator提供的校验方式是在类的属性上加入相应的注解来达到校验的目的。常用注解如下：

注解	说明
@AssertTrue	用于boolean字段，该字段只能为true
@AssertFalse	用于boolean字段，该字段只能为true
@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还需满足提供的条件

3 hibernate-validator案例

• 1）创建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>com.hsgx</groupId><artifactId>hibernate-validator-demo</artifactId><version>1.0-SNAPSHOT</version><properties><maven.compiler.source>8</maven.compiler.source><maven.compiler.target>8</maven.compiler.target><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties><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>--><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></dependency></dependencies>
</project>

• 2）创建实体类User，并在其属性上使用hibernate-validator相关注解

package com.hsgx.pojo;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;
}

• 3）创建控制类UserController，并使用@Validated注解开启校验功能

package com.hsgx.controller;import com.hsgx.pojo.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";}}

• 4）创建启动类HibernateValidatorApp

package com.hsgx;import com.hsgx.config.EnableFormValidator;
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);}
}

• 5）启动服务，进行功能测试

调用http://127.0.0.1:8080/user/delete:

浏览器页面直接报错：

• 6）为了能够在页面友好的显示数据校验结果，可以通过全局异常处理类来解决。创建统一异常处理类ExceptionConfiguration

package com.hsgx.config;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(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;}
}

• 7）重启服务，再次测试可以发现浏览器可以友好地显示校验结果

虽然页面只显示“用户名不能为空”，但通过控制台的输出可以看到，校验框架将User对象地多个属性都进行了数据校验（默认行为），并输出校验结果。这其实是没必要的，实际上只要有一个属性校验失败就直接返回提示信息，后面的属性就不需要再进行校验。

• 8）创建快速失败返回模式配置类ValidatorConfiguration

package com.hsgx.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;}
}

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

• 9）创建注解@EnableFormValidator

package com.hsgx.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 {
}

• 10）在启动类上添加该注解，并重启服务，再次进行功能测试

@SpringBootApplication
@EnableFormValidator
public class HibernateValidatorApp

测试结果发现，页面提示没什么变化，控制台输出只输出第一个校验失败的属性：

…

本节完，更多内容查阅：后台管理系统的通用权限解决方案

延伸阅读：后台管理系统的通用权限解决方案(四)SpringBoot整合Dozer实现对象属性复制