1. 程式人生 > 其它 >springboot實現註解引數校驗

springboot實現註解引數校驗

引入依賴

說明:springboot版本2.30.RELEASE,必須要引入的是spring-boot-starter-web/webflux, spring-boot-starter-validation, lombok是一個工具包可以通過註解生成get/set構造 sl4j等;
本文程式碼,使用的webflux,整合mongodb的實現

<?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.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.zhou.webflux.example</groupId>
    <artifactId>webflux-mvc</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>webflux-mvc</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</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-mongodb-reactive</artifactId>
        </dependency>
        <!-- springboot2.30以上版本需要手動匯入,之前的版本只需引入spring-boot-starter-web/webflux -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

pojo模型

在需要校驗欄位需要增加valuation註解

package com.zhou.webflux.example.webfluxmvc.domain;

import lombok.Data;
import org.hibernate.validator.constraints.Range;
import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;

import javax.validation.constraints.NotBlank;

@Data
@Document(collection = "user")
public class User {
    @Id
    private String id;
    //不為空校驗註解
    @NotBlank
    private String name;
    //資料範圍註解
    @Range(min=10,max = 80,message = "age在10到80之間")
    private int age;

}

controller

在需要校驗的形參前加入 @Valid註解

@RestController
@RequestMapping("/user")
public class UserController {
    private final UserRepository repository;

    @PostMapping("")
    public Mono<User> createUser(@Valid @RequestBody User user) {
        //save update公用一個方法 有id修改 無id新增
        return this.repository.save(user);
    }
}

編寫springboot全域性異常處理類處理引數異常

@ControllerAdvice
public class CheckAdvice {
    @ExceptionHandler(WebExchangeBindException.class)
    public ResponseEntity handleBindException(WebExchangeBindException e){
        return new ResponseEntity<String>(toStr(e), HttpStatus.BAD_REQUEST);
    }

    private String toStr(WebExchangeBindException ex){
        return ex.getFieldErrors().stream().map(e -> e.getField() + ":" + e.getDefaultMessage())
                .reduce("", (s1, s2) -> s1 + "\n" + s2);
    }
}

演示