SpringBoot使用validation进行自参数校验

news2024/11/16 15:29:04

一：介绍

在 SpringBoot 项目开发中，很多与数据库交互的参数需要校验数据正确性。很多小伙伴会把参数判断写进代码里，但是这种写法往往会有低可读性以及多处使用的时候，需要变更验证规则时，不易于维护等缺点。今天给大家介绍 Starter 的 validation 依赖。可以直接使用注解的方式进行参数的校验，可读性与维护性都显著提高。

一些常见的：

二：使用

1、添加依赖

该依赖属于 org.springframework.boot 下。

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

因为后面用到了 @Data ，所以需要添加 lombok。

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

2、编写 pojo 类

代码如下：

import lombok.Data;

import javax.validation.constraints.*;
import java.time.LocalDate;

@Data
public class Person {
  @NotBlank(message = "名字不能为空")
  private String name;

  @Max(value = 100,message = "年龄不能大于100岁")
  @Min(value = 0 ,message = "年龄不能小于0岁")
  private int age;

  @Email(message = "邮箱格式不正确")
  private String email;

  //@Past(message = "生日不能大于当前日期")
  //private LocalDate birthDay;
}

3、编写controller类

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;

@RestController
@RequestMapping("/validation")
public class validationController {
  @PostMapping("/demo")
  public Person demo(@RequestBody @Valid Person person){
    return person;
  }
}