Springboot怎样进行参数校验？@Validation注解怎么用？分组校验如何实现？

1.导入依赖包

springboot中进行参数校验的注解是

@validation

，要想使用该注解，需要在

pom.xml

文件中导入依赖包：

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

为了写实体类的时候省去一堆geter、setter，我们再导入Lombok：

<dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
   <version>1.18.18</version>
   <optional>true</optional>
</dependency>
           

2.创建演示代码

2.1 创建实体类

这里以用户注册为例，所以创建一个用户信息类

package com.example.demo.entity;

import lombok.*;

import javax.validation.constraints.Email;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;

@Data
@AllArgsConstructor
@NoArgsConstructor
@ToString
public class User {

    @NotBlank(message = "姓名不能为空")
    private String name;

    @Email(message = "邮箱格式错误")
    private String email;

    @NotNull(message = "年龄不能空")
    private Integer age;

    @NotBlank(message = "性别不能为空")
    private String sex;
}
           

可以选择的校验注解有：

Bean Validation 中内置的 constraint:

• @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(regex=,flag=)

  被注释的元素必须符合指定的正则表达式

Hibernate Validator 附加的 constraint:

• @NotBlank

  验证字符串非null，且长度必须大于0

• @Email

  被注释的元素必须是电子邮箱地址

• @Length(min=,max=)

  被注释的字符串的大小必须在指定的范围内

• @NotEmpty

  被注释的字符串的必须非空

• @Range(min=,max=,message=)

  被注释的元素必须在合适的范围内

2.2 创建Controller

由于是个小Demo，我就不写Service之类的了，只写Controller做演示。

package com.example.demo.Controller;

import com.example.demo.entity.User;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class RegisterController {

    @RequestMapping(value = "/register")
    public void doRegister(@Validated User user, BindingResult bindingResult){
        if (bindingResult.hasErrors()){
            System.out.println(bindingResult.getFieldError().getDefaultMessage());
        }else{
            System.out.println(user);
        }
    }
}
           

如上述代码所示，方法中的第一个参数用了

@Validated

注解，表示要校验的是User这个实体类中的属性参数，BindingResult所承接的是参数校验的结果，可以在方法体内将校验结果打印出来。

#3.分组校验

如果参数较多，需要校验参数的场景也比较多，可能会出现不同场景需要校验不同参数的情况，这时就需要分开校验。Springboot中引入了分组校验的功能，可以帮我们实现这个需求。

3.1创建组接口

首先，按照不同的场景创建不同的分组接口。这里我需要两个分组，所以创建了两个空接口。

仅用于校验email的组

package com.example.demo.group;

public interface EmailGroup {
}
           

用于校验其他参数的组

package com.example.demo.group;

public interface OtherGroup {
}
           

3.2 为参数分配组

接下来要为每一个参数分配组，直接修改实体类参数上的注解即可，指定接口的Class类对象。

package com.example.demo.entity;

import com.example.demo.group.EmailGroup;
import com.example.demo.group.OtherGroup;
import lombok.*;

import javax.validation.constraints.Email;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;

@Data
@AllArgsConstructor
@NoArgsConstructor
@ToString
public class User {

    @NotBlank(message = "姓名不能为空", groups = OtherGroup.class)
    private String name;

    @Email(message = "邮箱格式错误", groups = EmailGroup.class)
    private String email;

    @NotNull(message = "年龄不能空", groups = OtherGroup.class)
    private Integer age;

    @NotBlank(message = "性别不能为空", groups = OtherGroup.class)
    private String sex;
}
           

3.3 分组校验

然后就可以在控制器中的@Validation注解中分组校验了，指定接口的Class类对象。

package com.example.demo.Controller;

import com.example.demo.entity.User;
import com.example.demo.group.OtherGroup;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class RegisterController {

    @RequestMapping(value = "/register")
    public void doRegister(@Validated({OtherGroup.class}) User user, BindingResult bindingResult){
        if (bindingResult.hasErrors()){
            System.out.println(bindingResult.getFieldError().getDefaultMessage());
        }else{
            System.out.println(user);
        }
    }
}