Spring Boot資料校驗

資料校驗是一個相當重要的環節，使用Spring Boot 進行資料校驗。

添加校驗依賴

https://www.iming.info/wp-content/uploads/2020/06/wp_editor_md_21070be39e7ffdb111a798fb54de055b.jpg https://www.iming.info/wp-content/uploads/2020/06/wp_editor_md_42f0767e1460690ddc9dab6d353e75ff.jpg

全部依賴檔案如下

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>
           

添加配置檔案

user:
  name:
    size: 使用者名長度不符合要求
  age:
    size: 年齡輸入不正确
           

添加資料校驗

package com.example.demo;

import javax.validation.constraints.DecimalMax;
import javax.validation.constraints.DecimalMin;
import javax.validation.constraints.Size;

public class User {
    private Integer id;
    // 其長度
    @Size(min = 5, max = 10, message = "{user.name.size}")
    private String name;
    // 其上限和下限
    @DecimalMax(value = "200", message = "{user.age.size}")
    @DecimalMin(value = "5", message = "{user.age.size}")
    private Integer age;
    // 省去get和set
}
           

編寫控制器

package com.example.demo;

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

import java.util.ArrayList;
import java.util.List;

@RestController
public class UserController {
    @PostMapping("/user")
    public List<String> addUser(@Validated User user, BindingResult bindingResult){
        List<String> errors = new ArrayList<>();
        // 非空
        if(bindingResult.hasErrors()){
            // 查找出Error 進行添加到結果集
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            for (ObjectError allError : allErrors) {
                errors.add(allError.getDefaultMessage());
            }
        }
        return errors;
    }
}
           

其中BindingResult 類是用于儲存錯誤資訊的

測試

https://www.iming.info/wp-content/uploads/2020/06/wp_editor_md_7f5c74683fc014be4dc39366d3b8ccf2.jpg

分組校驗

添加分組接口

https://www.iming.info/wp-content/uploads/2020/06/wp_editor_md_e0a687171ba2dc5da32efce7fa0740f4.jpg

在實體類中添加分組資訊

package com.example.demo;

import javax.validation.constraints.DecimalMax;
import javax.validation.constraints.DecimalMin;
import javax.validation.constraints.Size;

public class User {
    private Integer id;
    // 其長度
    @Size(min = 5, max = 10, message = "使用者名長度不符合要求", groups = ValidationGroup1.class)
    private String name;
    // 其上限和下限
    @DecimalMax(value = "200", message = "年齡輸入不正确", groups = ValidationGroup2.class)
    @DecimalMin(value = "5", message = "年齡輸入不正确", groups = ValidationGroup2.class)
    private Integer age;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}
           

控制器使用其分組

package com.example.demo;

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

import java.util.ArrayList;
import java.util.List;

@RestController
public class UserController {
    @PostMapping("/user")
    public List<String> addUser(@Validated(ValidationGroup2.class) User user, BindingResult bindingResult){
        List<String> errors = new ArrayList<>();
        // 非空
        if(bindingResult.hasErrors()){
            // 查找出Error 進行添加到結果集
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            for (ObjectError allError : allErrors) {
                errors.add(allError.getDefaultMessage());
            }
        }
        return errors;
    }
}
           

測試結果

https://www.iming.info/wp-content/uploads/2020/06/wp_editor_md_bdf352565e2ffec3755fdc37715fec7a.jpg

微信公衆号

https://www.iming.info/wp-content/uploads/2020/06/qrcode_for_gh_9901b36b3b0e_258-1.jpg