SpringBoot JSR303数据校验

原创 已于 2022-08-26 17:13:50 修改 · 308 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring boot #java #spring

于 2022-07-20 15:07:30 首次发布
本文详细介绍了SpringBoot中如何使用JSR303进行数据校验，包括基本使用方法、分组校验的定义与应用、自定义校验注解和校验器的创建，以及控制器中异常的全局处理。同时，讨论了@Validated和@Valid的区别。

参考资源

基本使用

导包

//Spring只是定义接口没有实现，需要使用Hibernate 实现
implementation 'org.springframework.boot:spring-boot-starter-validation'

使用

public class UserParam {

	@NotEmpty(message = "username不能为空")
	private String username;

	@NotEmpty(message = "密码不能为空")
	private String pwd;

}

controller

@PostMapping("/test2")
	public String test2(@Valid UserParam userParam) {
		System.err.println(userParam);
		return "test";
	}

分组校验

定义分组   

package co.sekisuihouse.apServer.validated;

public interface UserAddGroup {

}

package co.sekisuihouse.apServer.validated;

public interface UserUpdateGroup {

}

使用

public class UserParam {
    
    @NotEmpty(message = "id不能为空", groups = { UserUpdateGroup.class })
	private String id;

	@NotEmpty(message = "username不能为空", groups = { UserAddGroup.class,UserUpdateGroup.class })
	private String username;

	@NotEmpty(message = "密码不能为空", groups = { UserUpdateGroup.class,UserAddGroup.class })
	private String pwd;
}

controller

package co.sekisuihouse.apServer.controller;

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

import co.sekisuihouse.apServer.pojo.request.UserParam;
import co.sekisuihouse.apServer.validated.UserAddGroup;
import co.sekisuihouse.apServer.validated.UserUpdateGroup;

@RestController
public class TestController {
	@PostMapping("/test")
	public String test(@Validated(UserAddGroup.class) UserParam userParam) {
		System.err.println(userParam);
		return "test";
	}

	@PostMapping("/test3")
	public String test3(@Validated(UserUpdateGroup.class) UserParam userParam) {
		System.err.println(userParam);
		return "test";
	}

}

自定义校验

自定义校验注解类 ListValue

package co.sekisuihouse.apServer.validated.annotation;

import javax.validation.Constraint;
import javax.validation.Payload;

import co.sekisuihouse.apServer.validated.ListValueConstraintValidator;

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.RetentionPolicy.RUNTIME;


@Documented
@Constraint(validatedBy = { ListValueConstraintValidator.class}) // 校验器需要自定义用什么要得校验器 多个以逗号隔开
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE }) // 哪都可以标注
@Retention(RUNTIME)
public @interface ListValue {
    String message() default "{co.sekisuihouse.apServer.validated.annotation.ListValue.message}";

    Class<?>[] groups() default { };

    Class<? extends Payload>[] payload() default { };

    // 数组，需要用户自己指定
    int[] value() default {};
}

自定义校验器 ListValueConstraintValidator

package co.sekisuihouse.apServer.validated;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

import co.sekisuihouse.apServer.validated.annotation.ListValue;

import java.util.HashSet;
import java.util.Set;

public class ListValueConstraintValidator implements ConstraintValidator<ListValue, Integer> {// <注解,校验值类型>
	// 存储所有可能的值
	private Set<Integer> set = new HashSet<>();

	// 初始化，你可以获取注解上的内容并进行处理
	@Override
	public void initialize(ListValue constraintAnnotation) {
		// 获取后端写好的限制 // 这个value就是ListValue里的value，我们写的注解是@ListValue(value={0,1})
		int[] value = constraintAnnotation.value();
		for (int i : value) {
			set.add(i);
		}
	}

	// 覆写验证逻辑
	@Override
	public boolean isValid(Integer value, ConstraintValidatorContext constraintValidatorContext) {
		// 看是否在限制的值里
		return set.contains(value);
	}
}

使用


public class UserParam {
	@ListValue(value = { 0, 1 }, message = "只能是1或者是2", groups = { UserAddGroup.class, UserUpdateGroup.class })
	private int sex;
}

controller

package co.sekisuihouse.apServer.controller;

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

import co.sekisuihouse.apServer.pojo.request.UserParam;
import co.sekisuihouse.apServer.validated.UserAddGroup;
import co.sekisuihouse.apServer.validated.UserUpdateGroup;

@RestController
public class TestController {
	@PostMapping("/test")
	public String test(@Validated(UserAddGroup.class) UserParam userParam) {
		System.err.println(userParam);
		return "test";
	}

	@PostMapping("/test3")
	public String test3(@Validated(UserUpdateGroup.class) UserParam userParam) {
		System.err.println(userParam);
		return "test";
	}

}

全局异常处理

package co.sekisuihouse.apServer.handler;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

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

import co.sekisuihouse.apServer.response.R;

@RestControllerAdvice
public class GlobalExceptionHandler {

	/**
	 * 表单验证异常处理
	 */
	@ExceptionHandler(value = BindException.class)
	public R validExceptionHandler(BindException exception, HttpServletRequest request, HttpServletResponse response) {
		/*
		 * 获取全部错误信息
		 */
//		List<FieldError> fieldErrors = exception.getFieldErrors();
//		Map<String, String> errors = new HashMap<>();
//		for (FieldError error : fieldErrors) {
//			errors.put(error.getField(), error.getDefaultMessage());
//		}

		FieldError fieldError = exception.getFieldError();
		return new R(-1, fieldError.getDefaultMessage());

	}

}

常用注解

validator内置注解：

@Null：被注释的元素必须为null
@NotNull：被注释的元素必须不为null
@AssertTrue：被注释的元素必须为true
@AssertFalse：被注释的元素必须为false
@Min(value)：被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value)：被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value)：被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value)：被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max, min)：被注释的元素的大小必须在指定的范围内
@Digits (integer, fraction)：被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past：被注释的元素必须是一个过去的日期
@Future：被注释的元素必须是一个将来的日期
@Pattern(value)：被注释的元素必须符合指定的正则表达式

Hibernate Validator 附加的注解：

@Email：被注释的元素必须是电子邮箱地址
@Length：被注释的字符串的大小必须在指定的范围内
@NotEmpty：被注释的字符串的必须非空
@Range：被注释的元素必须在合适的范围内
@NotBlank：验证字符串非null，且长度必须大于0

@Validated和@Valid区别

概要:

1.@Validated不支持嵌套校验，@Valid支持嵌套校验
2.@Validated可以用在其他被spring管理的类上，@Valid只能用在controller。
3.@Validated支持分组校验，@Valid不支持分组校验
4.@Validated可以做方法参数校验，

@Valid可用在

1. 方法，作用：TODO
2. 字段 ，作用：嵌套校验
3. 构造器， 作用：TODO
4. 参数，作用：开启校验验证功能

@Validated可用在

1. 类  ，作用： 对该类中的所有方法上的参数进行校验
2. 方法  ，作用：TODO 
3. 参数，作用：开启校验验证功能



 

SpringBoot系列（三）JSR303数据校验
大鱼的博客
03-26 1278
拓展 点击跳转哦~：SpringBoot系列学习汇总和拓展 文章目录前言一、校验数据案例二、validated类2.1、空检查：2.2、Boelan检查：2.3、长度检查：2.4、日期检查：2.5、数值检查： 前言 我使用的SpringBoot版本是2.4.4，理论上其spring-boot-starter-web模块里面会包含hibernate-validator包，但是我找了一圈没有找到。。所以默默的在本项目里加了上去 添加hibernate-validator 包 <dependenc
springboot整合JSR303参数校验与全局异常处理
jcc4261的博客
02-03 454
我们在日常开发中，避不开的就是参数校验，有人说前端不是会在表单中进行校验的吗？在后端中，我们可以直接不管前端怎么样判断过滤，我们后端都需要进行再次判断，为了安全。因为前端很容易拜托，当测试使用PostMan来测试，如果后端没有校验，不就乱了吗？肯定会有很多异常的。今天小编和大家一起学习一下JSR303专门用于参数校验的，算是一个工具吧！JSR-303 是 JAVA EE 6 中的一项子规范，叫做 Bean Validation，官方参考实现是Hibernate Validator。
SpringMVC—表单验证
rotating_windmill
09-26 557
表单验证 @Null：被注释的元素必须为 null @NotNull：被注释的元素必须不为 null @AssertTrue：被注释的元素必须为 true @AssertFalse：被注释的元素必须为 false @Min(value)：被注释的元素必须是一个数字，其值必须大于等于指定的最小值 @Max(value)：被注释的元素必须是一个数字，其值必须小于等于指定的最大值
springboot使用JSR303数据校验
weixin_45608165的博客
03-26 274
如何使用 在springboot2.3.0版本以后需要引入validation的starter启动器 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> 用注解@validated标注某个
Spring Boot使用JSR303校验
qq_33594592的博客
10-11 1234
Hibernate Validator JSR-303 JSR-349
SpringBoot：JSR303数据校验
qq_52183856的博客
01-07 202
SpringBoot：JSR303数据校验
SpringBoot结合JSR303对前端数据进行校验的示例代码
10-14
本文将详细介绍如何在SpringBoot项目中结合JSR303（Java Bean Validation）进行前端数据校验，并通过示例代码来阐述其实现过程。 首先，让我们了解数据校验的基本分类。数据校验通常分为前端校验和后端校验。 前端...
Springboot集成JSR303参数校验的方法实现
10-16
Spring Boot集成JSR303参数校验的方法实现涉及了Java中参数校验的标准规范，即JSR303（Bean Validation）规范，该规范通过在Java对象属性上添加注解来实现数据校验的约束定义。这种方式能够将校验逻辑与业务逻辑分离...
JSR303数据校验springboot-01-config.zip
09-14
这个"springboot-01-config.zip"压缩包文件可能包含了关于如何在Spring Boot项目中集成和配置JSR303数据校验的示例代码和配置文件。Spring Boot是一个流行的Java框架，简化了Spring应用的初始搭建以及开发过程，而...
SpringBoot业务开发 05、SpringBoot集成JSR303实现参数校验+全局异常捕捉_使用参数校验jsr303如何捕获
最新发布
2401_84167046的博客
04-17 924
Min(value = 0, message = “排序必须要大于等于0”, groups = {AddGroup.class, UpdateGroup.class})@NotBlank(message = “品牌logo地址不能为空”, groups = {AddGroup.class, UpdateGroup.class})@NotBlank(message = “品牌名称不能为空”, groups = {AddGroup.class, UpdateGroup.class})
springboot JSR303参数校验 全局异常处理
01-07
Springboot全局异常处理、JSR303参数校验，具体详见: https://blog.youkuaiyun.com/herojuice/article/details/85788681
Spring Boot——JSR303数据校验
万里顾一程的博客
04-25 514
Spring Boot——JSR303数据校验 数据校验 数据校验是任何一个应用程序都会用到的功能,无论是显示层还是持久层. 通常,相同的校验逻辑会分散在各个层中, 这样,不仅浪费了时间还会导致错误的发生(译注: 重复代码). 为了避免重复, 开发人员经常会把这些校验逻辑直接写在领域模型里面, 但是这样又把领域模型代码和校验代码混杂在了一起, 而这些校验逻辑更应该是描述领域模型的元数据. 使用数据校验，可以保证数据的正确性； JSR JSR是Java Specification Requests的缩
SpringBoot-JSR303数据校验
yooppa的博客
07-04 215
springBoot 配置文件
SpringBoot使用JSR303进行数据验证
Nicholas_GUB的博客
11-14 2115
SpringBoot支持JSR303的验证规范。 JSR303 规范（Bean Validation 规范）为 JavaBean 验证定义了相应的元数据模型和 API。在应用程序中，通过使用 Bean Validation 或是你自己定义的 constraint，例如 @NotNull, @Max, @ZipCode ， 就可以确保数据模型（JavaBean）的正确性。constraint 可以附加到字段，getter 方法，类或者接口上面。对于一些特定的需求，用户可以很容易的开发定制化的 constra
springboot使用JSR303校验
qq_41399941的博客
07-29 427
springboot 结合JSR303校验
springboot学习笔记03：jsr303数据校验
m0_46096424的博客
09-15 182
@ConfigurationProperties 1.支持jsr303校验 2.批量注入配置文件中的属性 3.支持松散绑定 4.支持复杂类型封装 @value 1.一个一个指定，单独注解赋值 2.不支持jsr303校验 3.不支持松散绑定 4.不支持复杂类型封装 5.支持SpEL cp只需要写一次即可, value则需要每个字段都添加 松散绑定:这个什么意思呢?比如我的yml中写的last-name,这个和lastName是一样的,- 后面跟着的字母默认是大写的,这就是松散绑定 .
SpringBoot-JSR303请求参数校验
jackiezz的博客
03-19 255
在实际的业务场景中同一个Entity的校验可能会有不同的规则，比如添加数据品牌id必须为空，而更新数据品牌Id必须不为空，针对这种情况我们需要使用分组校验来实现。校验不合法的提示信息，在Controller中通过 BindingResult对象来获取校验的结果信息，然后解析出来后封装为R对象响应。面临特殊的校验需要我们可以通过正则表达式来处理，当然我们也可以通过自定义校验注解的方式来实现。在需要校验的Bean的字段头部添加对应的注解。关联自定义的校验注解和校验器。创建自定义的校验注解。
springboot整合JSR303校验
weixin_60257072的博客
01-14 902
此时就用到了分组校验，同一个属性定义多个校验规则属于不同的分组，比如：添加订单定义@NULL规则属于insert分组，更新订单定义@NotEmpty规则属于update分组，insert和update是分组的名称，是可以修改的。我们用class类型来表示不同的分组，所以我们定义不同的接口类型（空接口）表示不同的分组，由于校验分组是公用的，所以定义在 base工程中。Contoller中校验请求参数的合法性，包括：必填项校验，数据格式校验，比如：是否是符合一定的日期格式，等。
springboot整合jsr303数据校验
weixin_48895167的博客
04-29 1158
学习目标： jsr303数据校验，为什么要学习这个技术呢，个人看法，唯一确保某些数据的合法性，比如在添加一个用户的时候用户的名称和密码肯定不能为空吧，即使在前端做了非空验证也不能保证用户会不会通过其他手段绕开前端的验证往数据库添加非法数据，所以在后台也需要做数据校验，双重保障。 开始实现： 第一步：导入依赖 <!--jsr303数据校验--> <dependency> <groupId>org.springframework.boot</g
SpringBoot与JSR303实现前端数据校验示例
SpringBoot结合JSR303（也称为 Bean Validation）提供了一种优雅的方式来执行后端数据校验，以弥补前端校验的不足。本示例将详细介绍如何在SpringBoot应用中利用JSR303进行后端数据校验。 一、JSR303简介 JSR303是...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值