百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程字典 > 正文

Hibernate Validation,基于Spring Boot 2.7的一点总结

toyiye 2024-06-21 12:17 12 浏览 0 评论

网上一些相关资料有些散乱,且有点过时,基于实际工作中的使用情况,做一下总结。

Spring Boot2.7是最后支持JDK8的版本。其spring-boot-starter-web并不内置hibernate-validation,必须先引入spring-boot-starter-validation。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
    <version>2.7.10</version>
</dependency>

配置类

主要是为了配置快速失败,错一个就抛出,这样用不着把所有字段都校验一遍。如果实际工作需要将所有的错误信息都校验并返回,可以忽略。

package com.example.demo.config;

 import javax.validation.Validation;
 import javax.validation.Validator;
 import javax.validation.ValidatorFactory;

 import org.hibernate.validator.HibernateValidator;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;

 @Configuration
 public class ValidatorConfig {

  @Bean
  public Validator validator() {
  ValidatorFactory factory = Validation.byProvider(HibernateValidator.class)
  .configure()
  .failFast(true)
  // 将fail_fast设置为true即可,如果想验证全部,则设置为false或者取消配置即可
  //.addProperty("hibernate.validator.fail_fast", "true")//这是另一种写法
  .buildValidatorFactory();
  return factory.getValidator();
  }
 }

Controller

在我的实际工作中,这些校验基本都放在Controller中,如果有在Service中进行校验的需求,可以搜索一下资料,实现起来也简单。

之前Controller的写法类似:

@GetMapping("/test")
  public ResultInfo<String> test(@Valid UserQueryParam param,BindingResult result) {
  if (result.hasErrors()){
   Map<String,String> errors = new HashMap<>();
   List<FieldError> fieldErrors = result.getFieldErrors();
   for (FieldError err : fieldErrors) {
     errors.put(err.getField(),err.getDefaultMessage());
    }
    //返回错误信息
    resturn new ResultInfo<String>(400,errors.toString,null);
  }
  System.out.println(param.toString());
  return new ResultInfo<String>(0, "", "ceshi");
 }

每个Controller都要进行result.hasErrors()处理,相当不优雅。

我们的Controller在开发规范上做了如下限制:

  1. 只有GET、POST两个method。
  2. get请求格式:/getById?userId=1,不使用/user/{id}格式。
  3. Controller的get参数,<=3个的,用@RequestParam,否则使用参数类。
  4. POST,使用JSON,用参数类接收。

因此我们的Controller大概写法如下:

package com.example.demo.controller;

 import javax.validation.Valid;
 import javax.validation.constraints.Max;
 import javax.validation.constraints.Min;

 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;

 import com.example.demo.params.UserAddParam;
 import com.example.demo.params.UserQueryParam;
 import com.example.demo.result.ResultInfo;

 @RestController
 @Validated
 public class TestController {
//GET @RequestParam
  @GetMapping("/testget")
  public ResultInfo<String> testGet(@Min(18) @Max(90) @RequestParam(value = "userId") Long userId) {
  System.out.println(userId);
  return new ResultInfo<String>(0, "", "ceshi");
  }
//GET 参数类
  @GetMapping("/testgetpojo")
  public ResultInfo<String> testGetPojo(@Valid UserQueryParam param) {
  System.out.println(param.toString());
  return new ResultInfo<String>(0, "", "ceshi");
  }
//POST 参数类
  @PostMapping("/testpost")
  public ResultInfo<String> testPostPojo(@Valid UserAddParam param) {
  System.out.println(param.toString());
  return new ResultInfo<String>(0, "", "ceshi");
  }
 }

POST没什么好讲的。关键在两个GET,请留意Controller类上的@Validated注解,以及两个GET的写法,详情后述。

全局校验错误异常处理类

package com.example.demo.handler;

import javax.validation.ConstraintViolationException;

import org.springframework.validation.BindException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import com.example.demo.result.ResultInfo;

@RestControllerAdvice
public class GlobalValidateExceptionHandler {

    /**
     * POST、GET请求,参数类校验异常
     * 
     * @param ex
     * @return
     */
    @ExceptionHandler(BindException.class)
    @ResponseBody
    public ResultInfo<?> handleBindException(BindException ex) {
        System.out.println("BindException");
        return new ResultInfo<>(400, ex.getBindingResult().getFieldError().getField()
                + ex.getBindingResult().getFieldError().getDefaultMessage(), null);
    }

    /**
     * GET 请求参数校验异常
     * 
     * @param ex
     * @return
     */
    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseBody
    public ResultInfo<?> handleGetConstraintViolationException(ConstraintViolationException ex) {
        System.out.println("ConstraintViolationException");
        return new ResultInfo<>(400, ex.getLocalizedMessage(), null);
    }

    /**
     * GET 请求参数必填校验异常
     * 
     * @param ex
     * @return
     */
    @ExceptionHandler(MissingServletRequestParameterException.class)
    @ResponseBody
    public ResultInfo<?> handleRequestParamException(MissingServletRequestParameterException ex) {
        System.out.println("MissingServletRequestParameterException");
        return new ResultInfo<>(400, ex.getParameterName()+"不可为空", null);
    }
}

基于上面的Controller的写法,对参数的校验有如下:

  1. GET、POST参数类校验,会抛出BindException异常。
  2. GET请求参数RequestParam必填项校验,会抛出MissingServletRequestParameterException异常。
  3. GET请求参数RequestParam的校验(min、max、email、size等),会抛出ConstraintViolationException异常。

在处理类做了统一地处理,并返回相关错误信息,大家可以根据实际工作要求,进行进一步地丰富。

相关推荐

为何越来越多的编程语言使用JSON(为什么编程)

JSON是JavascriptObjectNotation的缩写,意思是Javascript对象表示法,是一种易于人类阅读和对编程友好的文本数据传递方法,是JavaScript语言规范定义的一个子...

何时在数据库中使用 JSON(数据库用json格式存储)

在本文中,您将了解何时应考虑将JSON数据类型添加到表中以及何时应避免使用它们。每天?分享?最新?软件?开发?,Devops,敏捷?,测试?以及?项目?管理?最新?,最热门?的?文章?,每天?花?...

MySQL 从零开始:05 数据类型(mysql数据类型有哪些,并举例)

前面的讲解中已经接触到了表的创建,表的创建是对字段的声明,比如:上述语句声明了字段的名称、类型、所占空间、默认值和是否可以为空等信息。其中的int、varchar、char和decimal都...

JSON对象花样进阶(json格式对象)

一、引言在现代Web开发中,JSON(JavaScriptObjectNotation)已经成为数据交换的标准格式。无论是从前端向后端发送数据,还是从后端接收数据,JSON都是不可或缺的一部分。...

深入理解 JSON 和 Form-data(json和formdata提交区别)

在讨论现代网络开发与API设计的语境下,理解客户端和服务器间如何有效且可靠地交换数据变得尤为关键。这里,特别值得关注的是两种主流数据格式:...

JSON 语法(json 语法 priority)

JSON语法是JavaScript语法的子集。JSON语法规则JSON语法是JavaScript对象表示法语法的子集。数据在名称/值对中数据由逗号分隔花括号保存对象方括号保存数组JS...

JSON语法详解(json的语法规则)

JSON语法规则JSON语法是JavaScript对象表示法语法的子集。数据在名称/值对中数据由逗号分隔大括号保存对象中括号保存数组注意:json的key是字符串,且必须是双引号,不能是单引号...

MySQL JSON数据类型操作(mysql的json)

概述mysql自5.7.8版本开始,就支持了json结构的数据存储和查询,这表明了mysql也在不断的学习和增加nosql数据库的有点。但mysql毕竟是关系型数据库,在处理json这种非结构化的数据...

JSON的数据模式(json数据格式示例)

像XML模式一样,JSON数据格式也有Schema,这是一个基于JSON格式的规范。JSON模式也以JSON格式编写。它用于验证JSON数据。JSON模式示例以下代码显示了基本的JSON模式。{"...

前端学习——JSON格式详解(后端json格式)

JSON(JavaScriptObjectNotation)是一种轻量级的数据交换格式。易于人阅读和编写。同时也易于机器解析和生成。它基于JavaScriptProgrammingLa...

什么是 JSON:详解 JSON 及其优势(什么叫json)

现在程序员还有谁不知道JSON吗?无论对于前端还是后端,JSON都是一种常见的数据格式。那么JSON到底是什么呢?JSON的定义...

PostgreSQL JSON 类型:处理结构化数据

PostgreSQL提供JSON类型,以存储结构化数据。JSON是一种开放的数据格式,可用于存储各种类型的值。什么是JSON类型?JSON类型表示JSON(JavaScriptO...

JavaScript:JSON、三种包装类(javascript 包)

JOSN:我们希望可以将一个对象在不同的语言中进行传递,以达到通信的目的,最佳方式就是将一个对象转换为字符串的形式JSON(JavaScriptObjectNotation)-JS的对象表示法...

Python数据分析 只要1分钟 教你玩转JSON 全程干货

Json简介:Json,全名JavaScriptObjectNotation,JSON(JavaScriptObjectNotation(记号、标记))是一种轻量级的数据交换格式。它基于J...

比较一下JSON与XML两种数据格式?(json和xml哪个好)

JSON(JavaScriptObjectNotation)和XML(eXtensibleMarkupLanguage)是在日常开发中比较常用的两种数据格式,它们主要的作用就是用来进行数据的传...

取消回复欢迎 发表评论:

请填写验证码