hibernate-validator后端表单数据校验的使用示例详解

目录

• hibernate-validator后端表单数据校验的使用
• 1、hibernate-validator介绍
• 2、hibernate-validator常用注解
• 3、 hibernate-validator入门案例
• 3.1、第一步：创建maven工程hibernate-validator_demo并配置pom.xml文件
• 3.2、创建实体类
• 3.3、创建UserController
• 3.4、创建项目启动类
• 3.5、创建application.yml配置文件
• 4、启动项目测试
• 4.1、删除控制器没有携带数据
• 4.2、删除控制器携带id时
• 4.2、访问对象属性校验不携带数据时
• 4.3、访问对象属性校验携带数据时
• 5、处理异常信息
• 6、重新启动项目测试
• 7、修改代码，一次校验不通过就不再执行
• 8、创建注解EnableFormValidator用于控制快速失败返回模式的开启

hibernate-validator后端表单数据校验的使用

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>

提示：spring-boot-starter-web中已经依赖了hibernate-validator

2、hibernate-validator常用注解

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

3、 hibernate-validator入门案例

3.1、第一步：创建maven工程hibernate-validator_demo并配置pom.xml文件

spring-boot-starter-web中已经依赖了hibernate-validator

<?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>org.example</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>
    </properties>

    <dependencies>
        <!--spring-boot-starter-web中已经依赖了hibernate-validator-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!--
		<dependency>
              <groupId>org.hibernate</groupId>
              <artifactId>hibernate-validator</artifactId>
              <version>6.0.18.Final</version>
        </dependency>
		-->
    </dependencies>

</project>

3.2、创建实体类

NotEmpty：不能为空字符串

package com.zcl.entity;
import lombok.Data;
import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.*;
/**
 * 项目名称：hibernate-validator_demo
 * 描述：用户实体类
 *
 * @author zhong
 * @date 2022-08-29 12:48
 */
@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.3、创建UserController

package com.zcl.controller;

import com.zcl.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;

/**
 * 项目名称：hibernate-validator_demo
 * 描述：用户控制器
 *
 * @author zhong
 * @date 2022-08-29 12:53
 */
@RestController
@RequestMapping("/user")
@Validated
public class UserController {
    /**
     * 简单数据类型校验
     * @param id
     * @return
     */
    @RequestMapping("/delete")
    public String delete(@NotBlank(message = "id不能为空") String id){
        System.out.println("delete..." + id);
        return "OK";
    }

    /**
     * 对象属性校验
     * @param user
     * @return
     */
    @RequestMapping("/save")
    public String save(@RequestBody @Validated User user){
        System.out.println("save..." + user);
        return "OK";
    }
}

3.4、创建项目启动类

package com.zcl;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * 项目名称：hibernate-validator_demo
 * 描述：项目启动类
 *
 * @author zhong
 * @date 2022-08-29 13:04
 */
@SpringBootApplication
public class HibernateValidatorApp {
    public static void main(String[] args) {
        SpringApplication.run(HibernateValidatorApp.class, args);
    }
}

3.5、创建application.yml配置文件

该配置文件可有可无

server:
  port: 8080

4、启动项目测试

使用测试工具或插件进行访问：http://localhost:8080/user/delete

4.1、删除控制器没有携带数据

当id为空的时候会直接报错响应到前端页面

4.2、删除控制器携带id时

4.2、访问对象属性校验不携带数据时

提示有三个报错信息

IDEA控制台查看

4.3、访问对象属性校验携带数据时

5、处理异常信息

在config包下创建全局的异常处理器，全局捕获@RestController或@Controller的注解控制器

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

/**
 * 项目名称：hibernate-validator_demo
 * 描述：全局的异常处理
 *
 * @author zhong
 * @date 2022-08-29 13:17
 */
@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;
    }
}

6、重新启动项目测试

注意：当我们的请求【http://localhost:8080/user/save?id=1】控制器的时候，不是使用get请求或者路径的方式提交参数，后端的全局拦截代码是捕获不到异常信息的，返回的还是之前的直接错误显示在前端的浏览器上。通过get请求以及路径参数的方式提交就可以了

7、修改代码，一次校验不通过就不再执行

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

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

/**
 * 项目名称：hibernate-validator_demo
 * 描述：指定校验时使用快速失败返回模式
 *
 * @author zhong
 * @date 2022-08-29 13:38
 */
public class ValidatorConfiguration {
    @Bean
    public Validator validator() {
        ValidatorFactory validatorFactory =
                Validation.byProvider(HibernateValidator.class)
                        .configure()
                        //快速失败返回模式
                        .addProperty("hibernate.validator.fail_fast", "true")
                        .buildValidatorFactory();
        return validatorFactory.getValidator();
    }

    /**
     * 开启快速返回
     * 如果参数校验有异常，直接抛异常，不会进入到 controller，使用全局异常拦截进行拦截
     */
    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor() {
        MethodValidationPostProcessor postProcessor =
                new MethodValidationPostProcessor();
        /**设置validator模式为快速失败返回*/
        postProcessor.setValidator(validator());
        return postProcessor;
    }
}

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

8、创建注解EnableFormValidator用于控制快速失败返回模式的开启

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

/**
 * 项目名称：hibernate-validator_demo
 * 描述：在启动类上添加该注解来启动表单验证功能---快速失败返回模式
 *
 * @author zhong
 * @date 2022-08-29 13:41
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(ValidatorConfiguration.class)
public @interface EnableFormValidator {
}

在启动类上加上上面的注解

package com.zcl;

import com.zcl.config.EnableFormValidator;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * 项目名称：hibernate-validator_demo
 * 描述：项目启动类
 *
 * @author zhong
 * @date 2022-08-29 13:04
 */
@SpringBootApplication
@EnableFormValidator
public class HibernateValidatorApp {
    public static void main(String[] args) {
        SpringApplication.run(HibernateValidatorApp.class, args);
    }
}

再次启动项目的时候通过测试对象属性，少传递两个参数集合看出效果，当前面的验证不通过的时候后面的就不会再次验证了

到此这篇关于hibernate-validator后端表单数据校验的使用的文章就介绍到这了,更多相关hibernate-validator数据校验内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！