Spring Validation 介绍

最新推荐文章于 2024-08-14 17:30:46 发布
最新推荐文章于 2024-08-14 17:30:46 发布
阅读量557 收藏
点赞数 4
分类专栏： 学习 文章标签： java spring spring boot jsr
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Ezresl/article/details/112714299
版权

Spring Validation 介绍

环境搭建

在 pom.xml 中引入依赖：

Springboot-2.3 之前的版本只需引入 web 依赖即可。

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

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

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

简单使用

对实体类

此处使用 Lombok

校验注解解析

@Data
public class User {
    @NotBlank(message = "用户名不能为空")
    private String userName;
    @NotNull(message = "性别不能为空")
    private Integer sex;
    @Length(max = 20, message = "备注长度不能超过20")
    private String remark;
}

对接口

@RestController
public class UserController {
    @GetMapping("/user")
    public String hello(@Valid User user) {
        return user.toString();
    }
}

测试

访问该接口，传递不符合校验注解的数据

可以看到，没有通过校验的异常信息会在控制台打印出来

BindingResult

未使用 BindingResult 进行数据校验时，若校验不通过，系统会报异常，访问失败

使用 BindingResult 进行数据校验时，若校验不通过，错误信息会存储在其中而系统不会报异常，访问成功

注意：一个校验注解后面跟一个 BindingResult，若有多个校验注解，需要每个都对应一个 BindingResult

如下代码演示使用 BindingResult 并打印出其存储的校验失败信息：

@RestController
public class UserController {
    @GetMapping("/user")
    public String hello(@Valid User user, BindingResult result) {
        List<FieldError> fieldErrors = result.getFieldErrors();
        if (!fieldErrors.isEmpty()) {
            //打印校验错误信息
            fieldErrors.forEach(x-> System.out.println(x.getDefaultMessage()));
        }
        return user.toString();
    }
}

Validated和Valid

简介

@Valid 是使用 Hibernate validation

@Validated 是使用 Spring Validator

说明：java 的JSR303声明了@Valid 这类接口，而 Hibernate-validator 对其进行了实现

@Validation 对 @Valid 进行了二次封装，在使用上并没有区别，但在分组、注解位置、嵌套验证等功能上有所不同，这里主要就这几种情况进行说明。

区别

@Validated：可以用在在类上、方法上和方法参数上。但不能用于成员属性（field）

@Validated 支持分组校验

@Valid：可以用在方法、构造函数、方法参数和成员属性（field）上

@Valid 支持嵌套校验

分组校验

在日常开发过程中，对于同一个参数，需要在不同场景下应用不同的校验规则，如：

  • 新增时 code 可以为空，修改时 code 不能为空。

使用 @Validated 进行分组校验

实体类

@Data
public class User {
    @NotBlank(message = "code不能为空", groups = {Update.class})
    private String code;
    @NotBlank(message = "用户名不能为空", groups = {Save.class, Update.class})
    private String userName;
    @NotNull(message = "性别不能为空", groups = {Save.class, Update.class})
    private Integer sex;
    @Length(max = 20, message = "备注长度不能超过20", groups = {Save.class, Update.class})
    private String remark;

    public interface Save {
    }

    public interface Update {
    }
}

接口

@RestController
public class UserController {
    @PostMapping("/user")
    public String save(@Validated(User.Save.class) User user, BindingResult result) {
        List<FieldError> fieldErrors = result.getFieldErrors();
        List<String> list = new ArrayList<>();
        if (!fieldErrors.isEmpty()) {
            fieldErrors.forEach(x -> list.add(x.getDefaultMessage()));
        }
        return list.toString();
    }

    @PutMapping("/user")
    public String update(@Validated(User.Update.class) User user, BindingResult result) {
        List<FieldError> fieldErrors = result.getFieldErrors();
        List<String> list = new ArrayList<>();
        if (!fieldErrors.isEmpty()) {
            fieldErrors.forEach(x -> list.add(x.getDefaultMessage()));
        }
        return list.toString();
    }
}

测试

可以看出，修改比新增多校验了 code，分组校验成功

新增

修改

分组校验优化

使用校验注解时，若不指定其 groups ，会有一个默认的组 Default，从这个 Default 入手，优化代码

实体类

新建 Update 组 并继承 Default 组，只对 code 指定为 Update 组，其他不指定

此时不仅会校验 Update 组，未指定组（即 Default 组）的属性也会被校验

@Data
public class User {
    @NotBlank(message = "code不能为空", groups = Update.class)
    private String code;
    @NotBlank(message = "用户名不能为空")
    private String userName;
    @NotNull(message = "性别不能为空")
    private Integer sex;
    @Length(max = 20, message = "备注长度不能超过20")
    private String remark;

    public interface Update extends Default {
    }
}

接口

在编写接口时，如果 Update 继承了 Default，下面两个写法就是等效的：

  1. @Validated(Update.class)
  2. @Validated(Update.class,Default.class)

如果 @Validated 进行校验时没有指定组，等效于 @Validated(Default.class)

  1. @Validated
  2. @Validated(Default.class)
@RestController
public class UserController {
    @PostMapping("/user")
    public String save(@Validated User user, BindingResult result) {
        List<FieldError> fieldErrors = result.getFieldErrors();
        List<String> list = new ArrayList<>();
        if (!fieldErrors.isEmpty()) {
            fieldErrors.forEach(x -> list.add(x.getDefaultMessage()));
        }
        return list.toString();
    }

    @PutMapping("/user")
    public String update(@Validated(User.Update.class) User user, BindingResult result) {
        List<FieldError> fieldErrors = result.getFieldErrors();
        List<String> list = new ArrayList<>();
        if (!fieldErrors.isEmpty()) {
            fieldErrors.forEach(x -> list.add(x.getDefaultMessage()));
        }
        return list.toString();
    }
}

测试

嵌套校验

如果需要校验的对象中包含对象/集合，使用 @Valid 嵌套校验解决校验问题

实体类

Order
@Data
public class Order {
    @NotBlank(message = "order: code 不能为空")
    private String code;
    @Length(max = 1, message = "order:test 最长为1")
    private String test;
}
User
@Data
public class User {
    @NotBlank(message = "user:code不能为空")
    private String code;
    @NotBlank(message = "user:用户名不能为空")
    private String userName;
    @Valid
    @NotNull(message = "Order 对象不能为空")
    private Order order;
}

接口

@RestController
public class UserController {
    @PostMapping("/user")
    public String save(@Validated User user, BindingResult result) {
        List<FieldError> fieldErrors = result.getFieldErrors();
        List<String> list = new ArrayList<>();
        if (!fieldErrors.isEmpty()) {
            fieldErrors.forEach(x -> list.add(x.getDefaultMessage()));
        }
        return list.toString();
    }
}

测试

自定义校验

Spring Validation 允许用户自定义校验，分两步：

  1. 自定义校验注解
  2. 编写校验类

自定义校验手机号

实体类
@Data
public class User {
    @Phone(message = "手机号不合法")
    private String phoneNumber;
}
自定义注解
@Documented
@Constraint(validatedBy = {PhoneValidator.class})
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface Phone {
    //默认错误消息
    String message() default "请输入合法的手机号码";

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

    //负载
    Class<? extends Payload>[] payloads() default {};
}
校验类

正则校验（未测试）

手机号

(^0[0-9]{2,3}[0-9]{8})|(^((\(\d{3}\))|(\d{3}\-))?(1[3456789]\d{9})$)|(^(400)(\d{3})(\d{4}$))|(^(800)(\d{3})(\d{4}$))

座机

^[0][1-9]{2,3}-[0-9]{5,10}$

400

^400-([0-9]){1}([0-9-]{6})([0-9]){1}$

public class PhoneValidator implements ConstraintValidator<Phone, String> {
    /**
     * 正则匹配手机号
     * 校验手机号，号段主要有(不包括上网卡)：130~139、150~153，155~159，180~189、170~171、176~178。14号段为上网卡专属号段
     * 如有其他需求，修改此处正则即可
     */
    private static final Pattern PATTERN = Pattern.compile("^((13[0-9])|(17[0-1,6-8])|(15[^4,\\\\D])|(18[0-9]))\\d{8}$");
    private static final Integer PHONE_LENGTH = 11;

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 不为空才进行校验
        if (value != null) {
            if (value.length() != PHONE_LENGTH) {
                return false;
            }
            Matcher matcher = PATTERN.matcher(value);
            return matcher.find();
        }
        return true;
    }
}
测试

实战

使用 Spring Validation + AOP 进行数据校验

Ezresl
关注
专栏目录
用注解进行参数校验，spring validation介绍、使用、实现原理分析
刘正阳的专栏
03-24 7246
spring validation是什么 在平时的需求开发中，经常会有参数校验的需求，比如一个接收用户注册请求的接口，要校验用户传入的用户名不能为空、用户名长度不超过20个字符、传入的手机号是合法的手机号格式等等。遇到这种情况很多人会在controller接口中去写一些判断代码。但是如果我们又提供了一个修改用户信息的接口，这个接口也需要对用户的参数进行校验，那么我们的校验代码就会散落在两个地方，和真正的业务处理逻辑耦合在一起，而且如果未来要新增一种校验逻辑也需要在修改多个地方。...
Spring Validation参数校验
Cymothoe的博客
05-04 849
简单使用 Java API规范 (JSR303) 定义了Bean校验的标准validation-api，但没有提供实现。hibernate validation是对这个规范的实现，并增加了校验注解如@Email、@Length等。Spring Validation是对hibernate validation的二次封装，用于支持spring mvc参数自动校验。接下来，我们以spring-boot项目为例，介绍Spring Validation的使用。 引入依赖 如果spring-boot版本小于2.3
JAVA语言Spring Validation框架的作用
weixin_68138130的博客
07-11 463
JAVA语言Spring Validation框架的作用
STM32L151 UART串口参数与接收不定长度数据
09-11 1435
UART是单片机的一种重要的通信接口，通信参数涉及到波特率、数据长度、奇偶校验、停止位。 工业上往往有要求在线修改（无需重启单片机）串口通信参数的要求，同时对奇偶校验也有要求，除无校验、奇校验、偶校验外，还有MARK校验和SPACE校验： void bsp_SetUartBaud(COM_PORT_E _ucPort,uint32_t _baud,uint16_t _wordLen, uint16_t _parity, uint16_t _stopBits) { USART_InitTypeDef USA
Spring Validation 详解
最新发布
LYS00Q的博客
08-14 1043
Spring Validation 详解
STM32l151低功耗芯片串口通信(HAL库)
weymin
11-17 1万+
参考原子的stm32F1系列的串口通信实验，移植到stm32L1系列的程序代码。 1、采用串口中断方式，串口接收到消息产生中断，因此需要使能RXNE寄存器。HAL库函数的调用方式是__HAL_UART_ENABLE_IT(&UartHandle1, UART_IT_RXNE); UartHandle1是UART_HandleTypeDef类型，具体参考stm32lxx_ha...
spring数据校验：Validation
一个菜鸡的博客
05-19 4189
在开发中，我们经常遇到参数校验的需求，比如用户注册的时候，要校验用户名不能为空、用户名长度不超过20个字符、手机号是合法的手机号格式等等。如果使用普通方式，我们会把校验的代码和真正的业务处理逻辑耦合在一起，而且如果未来要新增一种校验逻辑也需要在修改多个地方。而spring validation允许通过注解的方式来定义对象校验规则，把校验和业务逻辑分离开，让代码编写更加方便。Spring Validation其实就是对Hibernate Validator进一步的封装，方便在Spring中使用。
spring validation
xiaoyaGrace的博客
02-13 126
前言 数据的校验是交互式网站一个不可或缺的功能，前端的js校验可以涵盖大部分的校验职责，如用户名唯一性，生日格式，邮箱格式校验等等常用的校验。但是为了避免用户绕过浏览器，使用http工具直接向后端请求一些违法数据，服务端的数据校验也是必要的，可以防止脏数据落到数据库中，如果数据库中出现一个非法的邮箱格式，也会让运维人员头疼不已。我在之前保险产品研发过程中，系统对数据校验要求比较严格且追求可变性及...
Spring Validation方法实现原理分析
08-27
Spring Validation方法实现原理分析 Spring Validation是Spring框架中的一种校验机制，用于验证JavaBean的属性是否符合JSR-303规范。该机制可以在应用程序中自动验证JavaBean的属性，从而确保数据的正确性和完整性...
Spring-Validation 后端数据校验的实现
08-18
Spring Validation 后端数据校验的实现 在软件开发中，数据校验是一项非常重要的任务。传统的数据校验方法是使用 if 语句来判断每个参数的属性，但是这种方法会使代码变得冗长和难以维护。为了解决这个问题，Spring...
STM32L151串口、IO输入、输出例程
03-21
STM32L151芯片串口和引脚的输入输出例程。代码里面的引脚需要根据实际情况更改，串口1发送，注意波特率。
Spring Validation
love coding
12-30 236
引入依赖 如果 spring-boot 版本小于 2.3.x，spring-boot-starter-web 会自动传入 hibernate-validator 依赖。如果 spring-boot 版本大于2.3.x，则需要手动引入依赖： <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> &lt
Spring validation框架简介
ProLayman的博客
03-02 1768
缘起 做SpringBoot项目时需要验证request参数，e.g： 这样的需求太常见了，几乎每个Controller接口都要验证，对于普通的校验规则如果手动校验，重复又繁琐，而且特别不优雅。试想，谁想在每个方法前都要排上一长串校验方法呢？ public String hello(@RequestParam("name") String name) throws Exception { validateNotNull(name); validateNotBlank(nam
强悍的Spring之spring validation
热门推荐
steven2xupt的博客
02-16 3万+
spring validation实现对Restful请求的数据进行校验 1、前言 数据的校验是交互式网站一个不可或缺的功能，前端的js校验可以涵盖大部分的校验职责，如用户名唯一性，生日格式，邮箱格式校验等等常用的校验。但是为了避免用户绕过浏览器，使用http工具直接向后端请求一些违法数据，服务端的数据校验也是必要的，可以防止脏数据落到数据库中，如果数据库中出现一个非法的邮箱格式，也会让运维人...
Spring Validation数据校验
weixin_44012070的博客
07-12 3808
①、使用@RequestBody传递参数，后端使用DTO(Data Transfer Object 数据传输对象)进行接受，只要给DTO对象加上@Validated注解就能进行自动参数校验。@ConvertGroup：用于分组校验，可以指定校验的分组，根据不同的分组执行不同的校验规则。@GroupSequence：用于定义校验分组的顺序，指定不同分组的执行顺序。4、支持国际化，可以根据不同的语言环境，使用不同的校验提示消息。3、支持分组校验，用于根据不同的校验场景，使用不同的校验规则；
Spring之数据校验：Vaildation
m0_52989725的博客
04-25 766
return age;} }/*在这个参数里面，使用了两个注解，分别是@NotNull和@Valid。@NotNull注解表示该参数不能为空，如果参数为null，则会抛出javax.validation.ConstraintViolationException异常。@Valid注解表示该参数需要进行数据校验，对于复杂类型的参数，需要对其中的成员变量进行校验。
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值