Springboot模块系列:数据校验

最新推荐文章于 2024-08-03 14:18:38 发布
最新推荐文章于 2024-08-03 14:18:38 发布
阅读量271 收藏
点赞数 1
分类专栏： # Spring 文章标签： 数据校验 Valid Validated BindingResult
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Xin_101/article/details/109225332
版权
本文介绍了Spring Boot中使用@Valid和@Validated进行数据校验的方法，包括请求体、URL参数的校验，并展示了如何通过@RestControllerAdvice和ExceptionHandler进行全局异常处理，简化错误信息返回。此外，还对比了独立数据校验的方式。
摘要由CSDN通过智能技术生成

1 入参实体

package com.company.web.dto;

import javax.validation.constraints.*;
import java.io.Serializable;

/**
 * Question and answer. 
 * @author xindaqi 
 * @since 2020-10-20
 */

public class QuestionAnswerInputDTO implements Serializable{

    @NotNull 
    @NotBlank(message = "参数为空")
    private String questions;

    @NotNull
    @NotBlank(message = "参数为空answer")
    private String answers;

    public void setQuestions(String questions) {
        this.questions = questions;
    }
    public String getQuestions() {
        return questions;
    }

    public void setAnswers(String answers) {
        this.answers = answers;
    }
    public String getAnswers() {
        return answers;
    }

    
}

2 统一返回数据

package com.company.web.vo.common;

import com.company.web.enums.common.*;

/**
 * Uniform response. 
 * @author xindaqi 
 * @since 2020-10-20
 * @param <T>
 */

public class ResponseVO<T> {

    private Integer code;

    private String msg;

    private T data;

    public void setCode(Integer code) {
        this.code = code;
    }
    public Integer getCode() {
        return code;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
    public String getMsg() {
        return msg;
    }

    public void setData(T data) {
        this.data = data;
    }
    public T getData() {
        return data;
    }

    public ResponseVO(){}

    public ResponseVO(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public ResponseVO(Integer code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }

    public static ResponseVO ok() {
        return new ResponseVO(EnumsCode.SUCCESS.getCode(), EnumsCode.SUCCESS.getMsg());
    }

    public static ResponseVO ok(Object data) {
        return new ResponseVO(EnumsCode.SUCCESS.getCode(), EnumsCode.SUCCESS.getMsg(), data);
    }

    public static ResponseVO fail() {
        return new ResponseVO(EnumsCode.FAIL.getCode(), EnumsCode.FAIL.getMsg());
    }

    public static ResponseVO invalid() {
        return new ResponseVO(EnumsCode.INVALID.getCode(), EnumsCode.FAIL.getMsg());
    }

    public static ResponseVO invalid(String msg) {
        return new ResponseVO(EnumsCode.INVALID.getCode(), msg);
    }

    public static ResponseVO empty() {
        return new ResponseVO(EnumsCode.EMPTY.getCode(), EnumsCode.EMPTY.getMsg());
    }

    public static ResponseVO exception(Integer code) {
        switch (code) {
            case 4003:
                return new ResponseVO(EnumsCode.ARITHMETICEXCEPTION.getCode(), EnumsCode.ARITHMETICEXCEPTION.getMsg());
                
            case 4004:
                return new ResponseVO(EnumsCode.NULLPOINTEREXCEPTION.getCode(), EnumsCode.NULLPOINTEREXCEPTION.getMsg());
                
        }
        return new ResponseVO(EnumsCode.INVALID.getCode(), EnumsCode.INVALID.getMsg());
    }
  
}

3 数据校验

测试数据:

{
    "questions":"",
    "answers":"1234"
}

3.1 请求体数据校验

使用Valid类校验.

import javax.validation.Valid;
  • Usage
package com.company.web.controller;

import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.annotation.Validated;
import org.springframework.validation.BindException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.company.web.dto.*;
import com.company.web.service.*;
import com.company.web.vo.common.*;

import javax.validation.Valid;
import javax.validation.constraints.NotBlank;
import java.util.List;

/**
 * Transactional test.
 * @author xindaqi
 * @since 2020-10-20
 */
@CrossOrigin(origins = "*", maxAge = 3600)
@RestController 
@RequestMapping("/api/function/test")
public class TransactionalTestController {

    static Logger logger = LoggerFactory.getLogger(TransactionalTestController.class);

    @Autowired 
    private IDataSaveService dataSaveService;

    @RequestMapping(value = "/transactional/rollback/raw", method = RequestMethod.POST)
    public ResponseVO saveDataWithRollback(@RequestBody @Valid QuestionAnswerInputDTO params) {
    // TODO logic.

    }
    
}

3.2 请求URL数据校验

  • 使用Validated类校验和NotBlank,NotNull等校验
  • 在类上使用注解@Validated
import org.springframework.validation.annotation.Validated;
import javax.validation.constraints.NotBlank;
  • Usage
package com.company.web.controller;

import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.annotation.Validated;
import org.springframework.validation.BindException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.company.web.dto.*;
import com.company.web.service.*;
import com.company.web.vo.common.*;

import javax.validation.Valid;
import javax.validation.constraints.NotBlank;
import java.util.List;

/**
 * Transactional test.
 * @author xindaqi
 * @since 2020-10-20
 */
@CrossOrigin(origins = "*", maxAge = 3600)
@RestController 
@RequestMapping("/api/function/test")
@Validated
public class TransactionalTestController {

    static Logger logger = LoggerFactory.getLogger(TransactionalTestController.class);

    @Autowired 
    private IDataSaveService dataSaveService;

    @RequestMapping(value = "/transactional/rollback/raw", method = RequestMethod.GET)
    public ResponseVO saveDataWithRollback(@NotBlank(message = "不能为空") @RequestParam("id") String id) {
        // TODO logic.

    }
    
}

3.3 统一数据校验

3.3.1 统一异常捕获

package com.company.web.exception;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.MethodArgumentNotValidException;
// import org.springframework.messaging.handler.annotation.support.MethodArgumentNotValidException;
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;

import com.company.web.vo.common.*;

import java.util.List;
import java.util.stream.Collectors;
import javax.validation.ConstraintViolationException;

/**
 * Uniform exception handle. 
 * @author xindaqi
 * @since 2020-10-21
 */
@RestControllerAdvice
public class GlobalExceptionHandler {

    static Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    /**
     * 参数绑定异常
     * @param e
     * @return
     */
    @ExceptionHandler(BindException.class) 
    public ResponseVO validationExceptionHandler(BindException e) {
        BindingResult bindingResult = e.getBindingResult();
        List<FieldError> fieldErrors = bindingResult.getFieldErrors();
        // fieldErrors.forEach(fieldError -> {
        //     errorMsg += fieldError.getDefaultMessage();
        // });
        
        // fieldErrors.stream().map(FieldError::getDefaultMessage).collect(Collectors.toList());
        // // String errorMsg = String.join(",", fieldErrors);
        // String errorMsg = fieldErrors.toString();
        String errorMsg = "bindException";
        logger.info("Bind Validataion: {}", errorMsg);

        return ResponseVO.invalid(errorMsg);
        
    }

    /**
     * 方法参数校验异常
     * @param e
     * @return
     */
    @ExceptionHandler(MethodArgumentNotValidException.class) 
    public ResponseVO methodValidationExceptionHandler(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        List<FieldError> fieldErrors = bindingResult.getFieldErrors();
        fieldErrors.forEach(fieldError -> {
            logger.info("Invalid message: {}", fieldError.getDefaultMessage());
        });
        
        fieldErrors.stream().map(FieldError::getDefaultMessage).collect(Collectors.toList());
        logger.info("field error: {}", fieldErrors);
        String errorMsg = fieldErrors.toString();
        logger.info("Method Validataion: {}", errorMsg);
        return ResponseVO.empty(); 
    }

    /**
     * 空指针异常
     * @param e
     * @return
     */
    @ExceptionHandler(NullPointerException.class) 
    public ResponseVO exceptionHandler(NullPointerException e) {
            String errorMsg = e.getMessage();
            logger.info("Null pointer Exception Validataion: {}", errorMsg);
            return ResponseVO.exception(4004); 
        
    }


    /**
     * 数据计算异常
     * @param e
     * @return
     */
    @ExceptionHandler(ArithmeticException.class) 
    public ResponseVO exceptionHandler(ArithmeticException e) {
            String errorMsg = e.getMessage();
            logger.info("Arithmetic Exception Validataion: {}", errorMsg);
            return ResponseVO.exception(4003); 
        
    }

    /**
     * 未知异常
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class) 
    public ResponseVO exceptionHandler(Exception e) {
            String errorMsg = e.getMessage();
            logger.info("Exception Validataion: {}", errorMsg);
            return ResponseVO.invalid(errorMsg); 
        
    }
  
}

3.3.2 数据校验

  • 统一数据校验,将捕获的异常交给全局异常处理类
  • 省去了try…catch
  • 省去了BindingResult
package com.company.web.controller;

import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.annotation.Validated;
import org.springframework.validation.BindException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.company.web.dto.*;
import com.company.web.service.*;
import com.company.web.vo.common.*;

import javax.validation.Valid;
import javax.validation.constraints.NotBlank;
import java.util.List;

/**
 * Transactional test.
 * @author xindaqi
 * @since 2020-10-20
 */
@CrossOrigin(origins = "*", maxAge = 3600)
@RestController 
@RequestMapping("/api/function/test")
@Validated
public class TransactionalTestController {

    static Logger logger = LoggerFactory.getLogger(TransactionalTestController.class);

    @Autowired 
    private IDataSaveService dataSaveService;

    @RequestMapping(value = "/transactional/rollback/raw", method = RequestMethod.POST)
    public ResponseVO saveDataWithRollback(@RequestBody @Valid QuestionAnswerInputDTO params) {
            Boolean dataSaveFlag = dataSaveService.saveQuestionAndAnswerWithTransactionRollback(params);
            if(dataSaveFlag) {
                logger.info("成功--保存问题和答案");
                return ResponseVO.ok();
            }else {
                logger.info("失败--保存问题和答案");
                return ResponseVO.fail();
            }     

    }
 
}
  • 结果
{
    "code": 4001,
    "msg": "空数据",
    "data": null
}

3.4 独立数据校验

  • 独立数据校验使用try…catch捕获异常
  • 使用BindingResult进行数据校验
package com.company.web.controller;

import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.annotation.Validated;
import org.springframework.validation.BindException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.company.web.dto.*;
import com.company.web.service.*;
import com.company.web.vo.common.*;

import javax.validation.Valid;
import javax.validation.constraints.NotBlank;
import java.util.List;

/**
 * Transactional test.
 * @author xindaqi
 * @since 2020-10-20
 */
@CrossOrigin(origins = "*", maxAge = 3600)
@RestController 
@RequestMapping("/api/function/test")
public class TransactionalTestController {

    static Logger logger = LoggerFactory.getLogger(TransactionalTestController.class);

    @Autowired 
    private IDataSaveService dataSaveService;

    @RequestMapping(value = "/transactional/rollback/raw", method = RequestMethod.POST)
    public ResponseVO saveDataWithRollback(@RequestBody @Valid QuestionAnswerInputDTO params, BindingResult bindingResult) {
        try {
            
            if(bindingResult.hasErrors()){
                logger.info("Error:{}", bindingResult.getAllErrors());
                List<FieldError> fieldErrors = bindingResult.getFieldErrors();
                fieldErrors.forEach(fieldError ->{
                    logger.error("Error filed: {}. \n Error message: {}", fieldError.getField(), fieldError.getDefaultMessage());
                });

                return ResponseVO.empty();
            }
            Boolean dataSaveFlag = dataSaveService.saveQuestionAndAnswerWithTransactionRollback(params);
            if(dataSaveFlag) {
                logger.info("成功--保存问题和答案");
                return ResponseVO.ok();
            }else {
                logger.info("失败--保存问题和答案");
                return ResponseVO.fail();
            }

        }catch(Exception e) {
            e.printStackTrace();
            return ResponseVO.invalid();
        }

    }    
}
  • 结果
{
    "code": 4001,
    "msg": "空数据",
    "data": null
}

Error:[Field error in object 'questionAnswerInputDTO' on field 'questions': rejected value []; codes [NotBlank.questionAnswerInputDTO.questions,NotBlank.questions,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [questionAnswerInputDTO.questions,questions]; arguments []; default message [questions]]; default message [参数为空]]

4 小结

  • 数据校验:统一数据校验使用@Valid校验数据和@RestControllerAdvice增强Controller,借助ExceptionHandler捕获异常,省略try…catch
  • 数据校验:独立数据校验:使用BindingResult,独立对数据有性进行判断,需要使用try…catch
  • 数据校验:请求体校验,使用@Valid校验RequestBody
  • 数据校验:URL参数校验,使用@Validated在类上注解,同时使用NotNull等校验RequestParam

[参考文献]
[1]https://blog.csdn.net/Xin_101/article/details/109206848

天然玩家
关注
专栏目录
SpringBoot系列教程：集成MyBatis，SpringSecurity
AI天才研究院
07-30 1128
Spring Boot是一种新的开源Java开发框架，它极大地简化了基于Java的应用配置，自动装配，消息处理等流程，并提供了运行时的健康检查、外部化配置等功能，因此在实际项目开发中扮演着越来越重要的角色。本系列教程将详细介绍如何利用Spring Boot框架，整合Mybatis和Spring Security，实现对数据库的增删改查及安全管理。Spring Boot介绍MyBatis介绍Spring Security介绍如何整合Mybatis和Spring Security。
SpringBoot入门实战：SpringBoot服务层设计
AI天才研究院
11-11 130
1.背景介绍 Spring Framework是一个非常流行且功能强大的Java开发框架。它可以帮助开发者快速、简便地开发出功能完备、可伸缩的应用。而其中的一个重要的模块就是Spring Boot，它提供了开箱即用的starter组件（也就是一些依赖包），使得开发人员可以更加关注于业务逻辑实现。这些 starter 可以帮我们将大量重复性工作自动化处理
SpringBoot数据校验
m0_67402013的博客
08-02 411
先自我介绍一下，小编13年上师交大毕业，曾经在小公司待过，去过华为OPPO等大厂，18年进入阿里，直到现在。深知大多数初中级java工程师，想要升技能，往往是需要自己摸索成长或是报班学习，但对于培训机构动则近万元的学费，着实压力不小。因此我收集了一份《java开发全套学习资料》送给大家，初衷也很简单，就是希望帮助到想自学又不知道该从何学起的朋友，同时减轻大家的负担。如果输入的网址为http//localhost8888/t3id=1&name=asdd。判断包装类是否为null。...
springBoot：数据校验
记录点点滴滴的成长。
07-29 313
springBoot数据校验
SpringBoot服务端数据校验
最新发布
zhuge_long的专栏
08-03 654
在 Web 应用程序中，为了防止客户端传来的数据引发程序异常，常常需要对数据进行验证。数据验证分为：客户端验证服务端验证在Spring Boot 3中，参数校验是通过Bean Validation API实现的，这个API是JSR 380规范的一部分。Spring Boot集成了Hibernate Validator作为默认的校验器。所有的这些注解都有 message 属性，用于设置错误提示信息（如果没有设置，则会有默认的错误提示信息）。Hibernate Validator 实现了 JSR 303，它除了
SpringBoot ~ 数据校验
简单点
06-07 134
添加pom依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> 编写实体类 /** * @author wsyjlly * @create 2019.06.29 - 12:18 **/ @AllArgs..
springboot--数据校验
zyp的博客
09-20 917
SpringBoot实现数据校验的方法 SpringBoot使用了Hibernate-validate校验框架 spring-boot-strarter-web启动器中已经包含了Hibernate-validate的jar包 校验方法 在实体类上加上校验规则 public class Users { // @NotBlank非空校验 @NotBlank pri...
Spring Boot中的数据校验
技术研究中心
07-06 549
大家好，我是免费搭建查券返利机器人省钱赚佣金就用微赚淘客系统3.0的小编，也是冬天不穿秋裤，天冷也要风度的程序猿！今天我们将深入探讨Spring Boot中的数据校验，了解如何在应用程序中有效地验证和处理数据。数据校验在应用开发中至关重要，它可以有效地防止无效或恶意数据输入，保障系统的稳定性和安全性。Spring Boot提供了强大的数据校验支持，通过注解和验证器可以轻松地对数据进行验证。合理地使用数据校验可以提升系统的安全性和稳定性，减少无效数据的输入，保障应用程序的健壮性。然后编写对应的验证器。
SpringBoot服务端数据校验过程详解
08-24
SpringBoot 服务端数据校验过程详解 SpringBoot 服务端数据校验过程详解是指在服务端对接收到的数据进行有效性验证，以确保数据的正确性和安全性。数据验证是企业级项目架构上最基础的功能模块，是防止黑客攻击和...
基于SpringBoot校验license
11-27
在实现这些功能时，Spring Boot的灵活性和模块化设计使得开发者可以方便地将许可校验逻辑整合到应用程序中。例如，可以创建一个自定义的Spring Boot Starter，包含所有校验相关的配置和Bean，便于在多个项目中复用。...
SpringBoot新闻头条：登陆功能、分类模块的实现
ljcmy13579的博客
07-29 342
8.SpringBoot新闻头条：登陆功能、标签模块、分类模块的实现 接着上一篇编写 登录功能 密码加密 在templates目录下创建admin目录，并添加login.html(简单的登陆界面) <form class="ui large form" method="post" action="#" th:action="@{/admin/login}"> <div class="ui segment">
spring-boot 数据校验
waimifeier的博客
05-21 568
spring-boot v2.3 以上版本需要手动导入依赖包 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency>
【Spring Boot】数据校验
Black_Customer的博客
04-20 3423
本篇主要介绍了springboot中的数据校验，包括Hibernate Validator，JavaBean参数校验，URL参数校验，JavaBean对象级联校验，分组校验和声明自定义校验注解，文中样例都是正确的样例，无需担心跑不通的情况，在阅读后肯定会对小伙伴们有所帮助。
Spring Boot数据校验
qq_43623970的博客
06-23 490
数据校验是一个相当重要的环节，使用Spring Boot 进行数据校验。 添加校验依赖 全部依赖文件如下 <?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
springboot数据校验
苏木的小站
02-04 174
普通校验是最基础的，也很简单。 下面开始springboot普通校验.github:https://github.com/fengqing11/springboot-validation 创建项目，依赖如下： <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0...
JSR303定义的校验类型
红桃∩
01-09 403
原地址：https://www.cnblogs.com/wang-yaz/p/10737726.html 空检查 @Null 验证对象是否为null @NotNull 验证对象是否不为null, 无法查检长度为0的字符串 @NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格. @NotEmpty 检查约束元素是否为NULL或...
SpringBoot 数据校验
siriusol的博客
05-02 658
数据校验是开发过程中一个常见的环节，一般来说，为了提高系统运行效率，都会在前端进行数据校验，但是这并不意味着不必在后端做数据校验了，因为用户还是可能在获取数据接口后手动传入非法数据，所以后端还是需要做数据校验。 Spring Boot 对此也提供了相关的自动化配置解决方案。 普通校验 添加依赖： <dependency>--> <groupId>org.spr...
SpringBoot的数据校验
liulang68的博客
09-16 229
应用程序必须通过某种手段来确定客户端输入的数据是正确的。 springmvc里面讲过有两种方式：一种是使用spring自带的基于接口的验证器，第二种是使用jsr标准实现。 参考文章：https://blog.csdn.net/qq_40794973/article/details/97967016 参考文章：https://blog.csdn.net/a909301740/article/details/81671897 参考文章：http://www.360doc.com/content/18/0829/
SpringBoot学习模块：注解、版本差异与核心特性
例如，`@SpringBootApplication`是Spring Boot的核心注解，它结合了`@Configuration`（配置类）、`@EnableAutoConfiguration`（启动自动配置）和`@ComponentScan`（组件扫描）三个注解的功能。 ## 二、Spring Boot...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

天然玩家

坚持才能做到极致

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值