SpringBoot基础教程1.3 基础数据验证

最新推荐文章于 2025-05-07 13:04:46 发布

qq_1909940880

最新推荐文章于 2025-05-07 13:04:46 发布

阅读量147

点赞数

分类专栏： SpringBoot2.0

SpringBoot2.0 专栏收录该内容

18 篇文章

订阅专栏

本文介绍了一种优雅的数据验证方式，避免了业务代码与验证逻辑的耦合。通过Spring Boot的依赖和JSR-303注解，实现了对实体类属性的有效性校验，如@NotNull、@Length等。并通过@Controller层的@Validated注解进行参数校验。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1. 概述

数据验证是企业应用开发中必备可少的环节，通常如果使用if-else在业务代码中写死验证逻辑，会导致验证逻辑与业务逻辑耦合。

2. 不合理的验证方式

public class BadDemo {

    public void bad(String str){
        if(null == str){
            throw new NullPointerException("str 不能为空");
        }

        // todo 业务逻辑
    }
}

上述代码，如果需要修改验证，str不为空且长度大于8，只能强行修改代码。

3. 优雅的数据验证方式

3.1. 添加pom.xml依赖

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

3.2 创建实体类


@Data
public class User {

    @NotNull(message = "名字不能为空")
    @Length(min = 4, max = 10, message = "name 长度必须在 {min} - {max} 之间")
    private String name;

    @NotNull(message = "年龄不能为空")
    @Min(value = 18, message = "年龄不能小于18岁")
    private Integer age;
}

JSR-303 注解解释
注解	说明
@NotNull	限制必须不为空
@NotEmpty	验证注解的元素值不为 null 且不为空（字符串长度不为0、集合大小不为0）
@NotBlack	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格
`@Pattern(value)`	限制必须符合指定的正则表达式
`@Size(max,min)`	限制字符长度必须在 min 到 max 之间（也可以用在集合上）
`@Email`	验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式
`@Max(value)`	限制必须为一个不大于指定值的数字
`@Min(value)`	限制必须为一个不小于指定值的数字
`@DecimalMax(value)`	限制必须为一个不大于指定值的数字
`@DecimalMin(value)`	限制必须为一个不小于指定值的数字
`@Past`	限制必须是一个过去的日期
`@Future`	限制必须是一个将来的日期

- 这里只列举了 javax.validation 包下的注解，同理在 spring-boot-starter-web 包中也存在hibernate-validator 验证包，里面包含了一些 javax.validation 没有的注解，有兴趣的可以看看

3.3 Controller层

@Validated
@RestController
public class UserController {

    @PostMapping("/user")
    public R addUser(@Validated @RequestBody User user, BindingResult br){

        if(br.hasErrors()){
            return R.isFail().msg(br.getFieldError().getDefaultMessage());
        } else {

            return R.isOk().data(user);
        }
    }

    @GetMapping("/user")
    public R test2(
            @NotBlank(message = "name 不能为空")
            @Length(min = 2, max = 10, message = "name 长度必须在 {min} - {max} 之间")
                    String name ) {

        return R.isOk().data(name);
    }
}

    注解解释
    - @Validated：开启数据有效性校验，添加在类上即为验证方法，添加在方法参数中即为验证参数对象。（添加在方法上无效）
    - @NotBlank：被注释的字符串不允许为空
    - @Length：被注释的字符串的大小必须在指定的范围内
    - @NotNull：被注释的字段不允许为空
    - @DecimalMin：被注释的字段必须大于或等于指定的数值

4. 测试结果

5. 工程目录

6. 结束语

说点什么呢，有任何建议，欢迎留言探本文源码。
---------------------
作者：Mkeeper
来源：优快云
原文：https://blog.youkuaiyun.com/liu19900205/article/details/81291561
版权声明：本文为博主原创文章，转载请附上博文链接！