首页 > 资讯 > 精选 >如何在SpringBoot中使用JSR303对后端数据进行校验

664

分享到

如何在SpringBoot中使用JSR303对后端数据进行校验

2023-06-07 21:06:55 664人浏览八月长安

摘要

如何在SpringBoot中使用jsR303对后端数据进行校验？很多新手对此不是很清楚，为了帮助大家解决这个难题，下面小编将为大家详细讲解，有这方面需求的人可以来学习下，希望你能有所收获。项目创建首先创建一个springboot项目使用的s

如何在SpringBoot中使用jsR303对后端数据进行校验？很多新手对此不是很清楚，为了帮助大家解决这个难题，下面小编将为大家详细讲解，有这方面需求的人可以来学习下，希望你能有所收获。

项目创建

首先创建一个springboot项目

使用的springboot版本为：（本文代码以该版本为准，不同版本springboot，在下面内容会出现一些差异）

<parent>  <groupId>org.springframework.boot</groupId>  <artifactId>spring-boot-starter-parent</artifactId>  <version>2.3.9.RELEASE</version>  <relativePath/> <!-- lookup parent from repository --> </parent>

引入如下依赖

 <dependencies>  <dependency>   <groupId>org.springframework.boot</groupId>   <artifactId>spring-boot-starter-thymeleaf</artifactId>  </dependency>  <dependency>   <groupId>org.springframework.boot</groupId>   <artifactId>spring-boot-starter-WEB</artifactId>  </dependency>  <dependency>   <groupId>org.springframework.boot</groupId>   <artifactId>spring-boot-devtools</artifactId>   <scope>runtime</scope>   <optional>true</optional>  </dependency>  <dependency>   <groupId>org.projectlombok</groupId>   <artifactId>lombok</artifactId>   <optional>true</optional>  </dependency>  <dependency>   <groupId>org.springframework.boot</groupId>   <artifactId>spring-boot-starter-test</artifactId>   <scope>test</scope>   <exclusions>    <exclusion>     <groupId>org.junit.vintage</groupId>     <artifactId>junit-vintage-engine</artifactId>    </exclusion>   </exclusions>  </dependency>  <dependency>   <groupId>org.springframework.boot</groupId>   <artifactId>spring-boot-starter-validation</artifactId>  </dependency> </dependencies>

这个作标在新一点的springboot版本中，需要单独引入。在老版本是默认引入的。这个是用来引入对jsr303注解的支持。

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

接着创建一个Java Bean

package cn.jxj4869.demo.entity;import lombok.Data;import javax.validation.constraints.NotNull;@Datapublic class User { @NotNull private Integer id; private String username; private String passWord; private String email;}

返回类型的JavaBean

package cn.jxj4869.demo.entity;import java.util.HashMap;public class R extends HashMap<String, Object> {private static final long serialVersionUID = 1L;public R() {put("code", 0);put("msg", "success");}public static R error(int code, String msg) {R r = new R();r.put("code", code);r.put("msg", msg);return r;}public static R ok(String msg) {R r = new R();r.put("msg", msg);return r;}public R put(String key, Object value) {super.put(key, value);return this;}}

创建一个controller。

index方法用来跳转到首页。

package cn.jxj4869.demo.controller;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.*;@Controllerpublic class UserController { @RequestMapping("/") public String index(){  return "index"; }}

首页代码放到resources/templates目录下

<!DOCTYPE html><html lang="en"><head> <meta charset="UTF-8"> <title>Title</title> <style>  div{   margin-top: 50px;  } </style></head><body><div> 新增表单 <br><br> <fORM method="post">  <label>用户名</label>  <input type="text" name="username"/>  <br>  <label>密码</label>  <input type="text" name="password"/>  <br>  <label>邮箱</label>  <input type="email" name="email"/>  <br>  <input type="submit" value="提交"/> </form></div><div> 更新表单 <br><br> <form method="post">  <input type="hidden" name="id" value="1">  <label>用户名</label>  <input type="text" name="username"/>  <br>  <label>密码</label>  <input type="text" name="password"/>  <br>  <label>邮箱</label>  <input type="email" name="email"/>  <br>  <input type="submit" value="提交"/> </form></div></body></html>

传统的检验方式

要在后端进行数据校验，传统的校验方式在controller层接受数据后，按照要求对数据进行校验

比如要接收一个user bean对象。

现在要对user对象中的username属性进行非空校验，password属性进行非空校验和长度校验。

 @PostMapping("/user") @ResponseBody public R user1(User user) throws Exception {  if(StringUtils.isEmpty(user.getUsername())) {   return R.error(400,"username不能为空");  }  if(StringUtils.isEmpty(user.getPassword())||user.getPassword().length()>8||user.getPassword().length() <4) {   return R.error(400,"password无效");  }  return null; }

如果有多个方法都需要接受user对象，而且要校验的属性可能不止username和password这两个属性，如果每个方法里面都采用上面这种校验方式的话，代码就会很臃肿，而且不好维护，当改变了userbean的属性，或者对校验规则进行修改后，就得对所有的校验代码进行更新。这是一件工程量很大的事。

使用JSR303

为了解决上述问题，我们可以使用JSR303提供的注解进行校验。

JSR是Java Specification Requests的缩写，意思是Java 规范提案。JSR303也就是第303号提案。

使用JSR303的方法很简单，例如上面的需求，我们只需要在user的属性上加上注解即可。

步骤如下：

给Bean添加校验注解，一般是在 javax.validation.constraints这个包下，也还有一些是hibernate提供的。

开启校验功能@Valid。

当校验失败的时候，会抛出org.springframework.validation.BindException异常。

常用的校验注解在文末

package cn.jxj4869.demo.entity;import lombok.Data;import org.hibernate.validator.constraints.Length;import javax.validation.constraints.NotNull;@Datapublic class User { private Integer id; @NotBlank private String username; @NotBlank @Length(min = 4,max = 8) private String password; private String email;}

然后在controller里面的方法上，加上@Valid注解即可

 @PostMapping("/user2") @ResponseBody public R user2(@Valid User user) throws Exception {  System.out.println(user);  return null; }

当校验失败后，会出现如下错误。并且会给出默认的提示信息。

如何在SpringBoot中使用JSR303对后端数据进行校验

自定义错误信息

那这个错误信息是怎么来的呢。

进入@NotNULL注解的代码里面

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })@Retention(RUNTIME)@Repeatable(List.class)@Documented@Constraint(validatedBy = { })public @interface NotBlank {String message() default "{javax.validation.constraints.NotNull.message}";............ ............ ............}

会有一个message属性。显然就是指定错误的提示内容。而这些错误提示是在一个叫validationMessages.properties的文件中，用idea的搜索工具可以找到，双击shift键打开搜索。

发现有这么多validationMessages.properties的文件，而且支持国际化。

如何在SpringBoot中使用JSR303对后端数据进行校验

打开validationMessages_zh.properties,可以看到里面定义了这么多的提示。而错误提示就是从这文件中获取的。

如何在SpringBoot中使用JSR303对后端数据进行校验

如果我们不想用默认的校验提示信息的话，可以自己指定。

指定message的值即可。

@NotBlank(message = "用户名不能为空") private String username;

如何在SpringBoot中使用JSR303对后端数据进行校验

错误信息的获取与响应

当校验出错时，会默认返回一个错误界面，或者返回错误提示的JSON数据。但默认提供的显然不是我们想要的，如果可以拿到错误信息，那我们就能自定义相应数据了。

拿到错误信息的方式也很简单，只要在方法中加上BindingResult result这个参数，错误信息就会封装这里面。

@PostMapping("/user2") @ResponseBody public R user2(@Valid User user, BindingResult result) throws Exception {  System.out.println(user);  if(result.hasErrors()) { //判断是否有错误   Map<String,String> map = new HashMap<>();   //1、获取校验的错误结果   result.getFieldErrors().forEach((item)->{    //FieldError 获取到错误提示    String message = item.getDefaultMessage();    //获取错误的属性的名字    String field = item.getField();    map.put(field,message);   });   return R.error(400,"提交的数据不合法").put("data",map);  }  // 若没有错误，则进行接下去的业务操作。  return null; }

不过不推荐上面这种方式，理由同上，当校验的地方多了，每个方法里面都加上这么个异常处理，会让代码很臃肿。

不知道你们是否还记得，springMVC里面有个全局的异常处理，我们可以自定义一个异常处理，在这里面统一处理异常。

统一处理BinException。这样就可以不用在controller中去处理错误信息了。

package cn.jxj4869.demo.execption;import cn.jxj4869.demo.entity.R;import org.springframework.validation.BindException;import org.springframework.web.bind.annotation.ExceptionHandler;import org.springframework.web.bind.annotation.RestControllerAdvice;import java.util.HashMap;import java.util.Map;@RestControllerAdvice(basePackages = "cn.jxj4869.demo.controller")public class MyExceptionControllerAdvice { @ExceptionHandler(value = BindException.class) public R handleVaildException(BindException e) {   Map<String,String> map = new HashMap<>();   //1、获取校验的错误结果   e.getFieldErrors().forEach((item)->{    //FieldError 获取到错误提示    String message = item.getDefaultMessage();    //获取错误的属性的名字    String field = item.getField();    map.put(field,message);   });   return R.error(400,"提交的数据不合法").put("data",map); }}

错误异常类型补充

校验出错的时候，会抛出两种异常

org.springframework.validation.BindException

使用@Valid注解进行校验的时候抛出的

org.springframework.web.bind.MethodArgumentNotValidException

使用@validated校验的时候抛出的

在异常捕获中加入下面这个

 @ExceptionHandler(value= MethodArgumentNotValidException.class) public R handleVaildException(MethodArgumentNotValidException e){  BindingResult bindingResult = e.getBindingResult();  Map<String,String> map = new HashMap<>();  bindingResult.getFieldErrors().forEach((fieldError)->{   map.put(fieldError.getField(),fieldError.getDefaultMessage());  });  return R.error(400,"提交的数据不合法").put("data",map); }

分组校验

在不同业务场景下，校验规则是不一样的，比如user对象中id这个属性，在新增的时候，这个属性是不用填的，要为null，但是在修改的时候，id属性是不能为null的。

可以用注解中的groups属性来指定，在什么场合下使用改注解

@Documented@Constraint(validatedBy = { })@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })@Retention(RUNTIME)@Repeatable(List.class)public @interface NotBlank {Class<?>[] groups() default { };........}

首先定义两个接口AddGroup和UpdateGroup，不需要做任何实现

package cn.jxj4869.demo.valid;public interface UpdateGroup {}

package cn.jxj4869.demo.valid;public interface AddGroup {}

在user中指定group。

id属性在AddGroup的时候，要为null，在UpdateGroup的时候不能为null
username属性在AddGroup和Update的时候，都要进行校验，不能为空。
password属性，当校验的时候指定分组的话，会不起作用，因为没有给它指定校验的分组

package cn.jxj4869.demo.entity;import cn.jxj4869.demo.valid.AddGroup;import cn.jxj4869.demo.valid.UpdateGroup;import lombok.Data;import javax.validation.constraints.NotBlank;import javax.validation.constraints.NotEmpty;import javax.validation.constraints.NotNull;import javax.validation.constraints.Null;@Datapublic class User { @Null(groups = {AddGroup.class}) @NotNull(groups = {UpdateGroup.class}) private Integer id;   @NotBlank(message = "用户名不能为空",groups = {AddGroup.class,UpdateGroup.class}) private String username; @NotEmpty private String password; private String email;}

在controller中用@Validated注解，指定校验的分组

 @PostMapping("/user3") @ResponseBody public R user3(@Validated(UpdateGroup.class) User user) {  System.out.println(user);  return null; }

结果如下图所示，因为password属性没有指定校验的分组，所以在校验的时候，都不会对它进行合法性检查。

如何在SpringBoot中使用JSR303对后端数据进行校验

自定义校验

当提供的注解不能满足我们需求的时候，可以自定义注解。

例如我们现在给user新加一个属性status，并要求这个属性的值只能是0或者1。

新建一个@StatusValue注解。

根据jsr303的规范，校验注解得有三个属性。

message：用来获取错误提示的
groups：指定校验分组的。
payload：可以自定义一些负载信息

使用@Constraint注解指定该注解的校验器

package cn.jxj4869.demo.valid;import javax.validation.Constraint;import javax.validation.Payload;import java.lang.annotation.Documented;import java.lang.annotation.Retention;import java.lang.annotation.Target;import static java.lang.annotation.ElementType.*;import static java.lang.annotation.ElementType.TYPE_USE;import static java.lang.annotation.RetentionPolicy.RUNTIME;@Documented@Constraint(validatedBy = { StatusValueConstraintValidator.class })@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })@Retention(RUNTIME)@interface StatusValue { String message() default "{cn.jxj4869.valid.StatusValue.message}"; Class<?>[] groups() default { }; Class<? extends Payload>[] payload() default { }; int[] value() default { };}

自定义校验器

需要实现ConstraintValidator这个接口，第一个泛型是表示要校验哪个注解，第二个泛型是要校验的数据的类型。

initialize是初始化方法
isValid校验方法，判断是否校验成功

package cn.jxj4869.demo.valid;import javax.validation.ConstraintValidator;import javax.validation.ConstraintValidatorContext;import java.util.HashSet;import java.util.Set;public class StatusValueConstraintValidator implements ConstraintValidator<StatusValue,Integer> { private Set<Integer> set = new HashSet<>(); //初始化方法 @Override public void initialize(StatusValue constraintAnnotation) {  int[] value = constraintAnnotation.value();  for (int val : value) {   set.add(val);  } }  @Override public boolean isValid(Integer value, ConstraintValidatorContext context) {  return set.contains(value); }}

最后在resources目录下添加一个ValidationMessages.properties文件

用来指定错误信息。

cn.jxj4869.valid.StatusValue.message=必须提交指定的值

UserBean

@Datapublic class User { @Null(groups = {AddGroup.class}) @NotNull(groups = {UpdateGroup.class}) private Integer id; @NotBlank(message = "用户名不能为空",groups = {AddGroup.class,UpdateGroup.class}) private String username; @NotEmpty private String password; private String email; @StatusValue(value = {0,1},groups = {AddGroup.class,UpdateGroup.class}) private Integer status;}

如何在SpringBoot中使用JSR303对后端数据进行校验

常用注解汇总

注解	功能
@Null	对象必须为null
@NotNull	对象必须不为null，无法检查长度为0的字符串
@NotBlank	字符串必须不为Null，且去掉前后空格长度必须大于0
@NotEmpty	字符串必须非空
@Length(min = 1,max = 50)	字符串必须在指定长度内
@Range(min = 0,max = 100)	必须在指定范围内
@AssertTrue	对象必须为true
@AssertFalse	对象必须为false
@Max(Value)	必须为数字，且小于或等于Value
@Min(Value)	必须为数字，且大于或等于Value
@DecimalMax(Value)	必须为数字( BigDecimal )，且小于或等于Value。小数存在精度
@DecimalMin(Value)	必须为数字( BigDecimal )，且大于或等于Value。小数存在精度
@Digits(integer,fraction)	必须为数字( BigDecimal )，integer整数精度，fraction小数精度
@Size(min,max)	对象(Array、Collection、Map、String)长度必须在给定范围
@Email	字符串必须是合法邮件地址
@Past	Date和Calendar对象必须在当前时间之前
@Future	Date和Calendar对象必须在当前时间之后
@Pattern(regexp=“正则”)	字符串满足正则表达式的值

看完上述内容是否对您有帮助呢？如果还想对相关知识有进一步的了解或阅读更多相关文章，请关注编程网精选频道，感谢您对编程网的支持。

点击免费下载>>软考高级考试备考技巧/历年真题/备考精华资料

--结束END--

本文标题: 如何在SpringBoot中使用JSR303对后端数据进行校验

本文链接: https://www.lsjlt.com/news/250272.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑，方便收藏和打印～

下载Word文档

去做题

猜你喜欢

如何在SpringBoot中使用JSR303对后端数据进行校验

如何在SpringBoot中使用JSR303对后端数据进行校验？很多新手对此不是很清楚，为了帮助大家解决这个难题，下面小编将为大家详细讲解，有这方面需求的人可以来学习下，希望你能有所收获。项目创建首先创建一个springboot项目使用的s...

99+

2023-06-07
Springboot如何使用filter对requestbody参数进行校验

目录使用filter对request body参数进行校验通过filter修改body参数的思路知识点步骤使用filter对request body参数进行校验 @Slf4j pub...

99+

2022-11-13
如何使用SQL语句在MySQL中进行数据校验和完整性约束？

如何使用SQL语句在MySQL中进行数据校验和完整性约束？数据校验和完整性约束是数据库管理系统中常用的方法，用于确保数据的正确性和完整性。在MySQL中，我们可以通过使用SQL语句来实现这些约束。本文将介绍如何使用SQL语句在MySQL中进...

99+

2023-12-18

MySQL SQL语句数据校验
前端如何调用后端接口进行数据交互详解(axios和SpringBoot)

目录一、介绍二、项目结构三、代码编写四、运用总结前端调用后端接口，获得数据并渲染一、介绍一个完善的系统，前后端交互是必不可少的，这个过程可以分成下面几步：前端向后端发起请求后端...

99+

2023-03-19

前端和后端怎么进行数据交互的前端如何调用后端数据前端与后端接口的交互案例
如何在 ASP 中使用 http shell 对象进行数据加密？

ASP是一种流行的服务器端脚本语言，用于创建动态网站和Web应用程序。在ASP中，可以使用HTTP Shell对象进行数据加密。HTTP Shell对象是ASP中的一个内置对象，用于与操作系统交互，可以执行系统命令、创建和删除文件、读取和写...

99+

2023-06-02

http shell 对象
如何在 ASP 中使用 http shell 对象进行数据压缩？

ASP是一种常用的Web开发语言，其灵活性和易用性使其成为了许多开发者的首选。在ASP中，使用http shell对象进行数据压缩是一种非常常见的操作，本文将介绍如何在ASP中使用http shell对象进行数据压缩。一、什么是http ...

99+

2023-06-02

http shell 对象
如何在Python中进行数据可靠性存储和迁移，以及数据一致性的保证和校验

如何在Python中进行数据可靠性存储和迁移，以及数据一致性的保证和校验引言：数据的安全性和一致性对于任何应用程序都至关重要。在Python中，我们可以使用一些技术和库来确保数据的可靠性存储和迁移，以及数据一致性的保证和校验。本文将介绍几种...

99+

2023-10-22

数据迁移数据一致性数据可靠性存储
如何在Kotlin中利用SharedPreferences对数据进行存取

这篇文章将为大家详细讲解有关如何在Kotlin中利用SharedPreferences对数据进行存取，文章内容质量较高，因此小编分享给大家做个参考，希望大家阅读完这篇文章后对相关知识有一定的了解。具体方法如下class Preference...

99+

2023-05-31

kotlin sharedpreferences
如何在Android应用中对json数据进行解析

这篇文章将为大家详细讲解有关如何在Android应用中对json数据进行解析，文章内容质量较高，因此小编分享给大家做个参考，希望大家阅读完这篇文章后对相关知识有一定的了解。1、android自带解析 json_btn.setOnC...

99+

2023-05-31

android json 中对
如何在Python中使用二维码对象进行数据传输？

在当今数字化的时代，二维码已经成为了一种非常常见的数据传输方式。Python作为一种流行的编程语言，自然也有相应的库可以用来生成和解码二维码。在本篇文章中，我们将会探讨如何在Python中使用二维码对象进行数据传输。一、生成二维码对象 P...

99+

2023-10-23

响应二维码对象
PHP中如何使用正则表达式进行数据验证？

在 PHP 编程中，数据验证是一个非常重要的任务。当我们接收外部输入数据（例如用户的表单提交）时，我们需要在使用这些数据之前，对其进行验证，确保其格式正确并符合我们的要求。其中一种非常实用的验证方式就是使用正则表达式。正则表达式是一种强大的...

99+

2023-05-20

数据验证 PHP 正则表达式
Android项目中如何使用adapter对数据进行处理

本篇文章给大家分享的是有关Android项目中如何使用adapter对数据进行处理，小编觉得挺实用的，因此分享给大家学习，希望大家阅读完这篇文章后可以有所收获，话不多说，跟着小编一起来看看吧。具体如下：package com.cvte.ap...

99+

2023-05-31

android adapter roi
如何在 Python 中使用 NumPy 库对文件中的数据进行统计分析？

Python 是一种强大的编程语言，它拥有众多的库和工具可以帮助开发者更高效地完成任务。其中，NumPy 库是一款专门用于数值计算的库，在处理大量数据时可以提供高效的处理速度和良好的性能。在本文中，我们将介绍如何使用 NumPy 库对文件...

99+

2023-11-04

文件关键字 numy
如何在Laravel中使用对象关系映射（ORM）进行数据库操作？

Laravel是一款流行的PHP框架，它提供了许多方便的工具和库来简化Web应用程序的开发过程。其中一个重要的工具就是对象关系映射（ORM），它可以帮助开发人员在Laravel中进行数据库操作。 ORM是一种将关系型数据库中的表映射到面向对...

99+

2023-09-25

编程算法 laravel 对象
如何在Laravel中使用Python函数进行数据处理？

Laravel是一个流行的PHP框架，它提供了许多强大的功能和工具，可以使Web应用程序的开发过程更加高效和简便。然而，有时候我们需要使用其他编程语言的函数来处理数据，比如Python。在本文中，我们将介绍如何在Laravel中使用Pyth...

99+

2023-06-05

git 函数 laravel
如何在Java中使用Numpy进行大数据分析？

随着数据量的不断增长，大数据分析已经成为了现代社会中非常重要的工作之一。而Java作为一门非常流行的编程语言，也越来越多地被用于数据分析和处理方面。本文将为您介绍如何使用Java中的Numpy库进行大数据分析。一、什么是Numpy Num...

99+

2023-10-12

大数据对象 numpy
如何在Python中使用Numpy进行数据可视化？

Numpy是Python中一个非常流行的科学计算库，它提供了高效的多维数组操作以及各种数学函数。在数据分析和可视化方面，Numpy也是一个非常强大的工具。本文将介绍如何使用Numpy进行数据可视化。一、安装Numpy 在使用Numpy之...

99+

2023-08-11

日志 numy load
如何在 Python 函数中使用 Linux 数组进行数据处理？

在 Python 中，我们经常需要使用数组来存储和处理数据。而在 Linux 系统中，数组也是常见的数据类型之一。那么，在 Python 函数中如何使用 Linux 数组进行数据处理呢？本文将为您详细介绍。首先，让我们来了解一下 Pyth...

99+

2023-07-20

函数 linux 数组
如何在 Linux 中使用 Python 函数对数组进行处理和操作？

Linux 是一个非常流行的操作系统，而 Python 是一个强大的编程语言。在 Linux 中使用 Python 函数对数组进行处理和操作，是很多开发者和数据科学家常常需要做的一件事情。本文将介绍如何在 Linux 中使用 Python...

99+

2023-07-20

函数 linux 数组
如何在PHP中使用对象进行数据打包和解包？面试官必问！

PHP是一门广泛使用的编程语言，也是一门面向对象的语言。在开发过程中，我们通常需要将数据打包和解包，以便在不同的应用程序之间传递数据。本文将探讨如何在PHP中使用对象进行数据打包和解包。一、什么是数据打包和解包？在计算机科学中，数据打包...

99+

2023-10-18

对象面试打包