Spring Boot中参数验证（@Valid）

Spring Boot中参数验证（@Valid）

1 概述

Spring Boot中使用@Valid实现参数验证。

2 工程布局

xml文件

	4.0.0
	
		org.springframework.boot
		spring-boot-starter-parent
		2.3.12.RELEASE
		 
	

	com.example
	test
	0.0.1-SNAPSHOT
	test
	Demo project for Spring Boot
	
		11
	
	
		
			org.springframework.boot
			spring-boot-starter-web
		

		
		
			org.springframework.boot
			spring-boot-starter-validation
		

		
			org.projectlombok
			lombok
			1.18.20
			provided
		

	

	
		
			
				org.springframework.boot
				spring-boot-maven-plugin
			
		
	

3 源代码

3.1 ValidParamConfig

package com.example.test.config;

import org.springframework.http.HttpStatus;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

@RestControllerAdvice
public class ValidParamConfig {

    // 捕获方法中参数异常
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public WebResult>> invalidParameterExceptionHandler(MethodArgumentNotValidException exception){

        // 获取错误信息
        List fieldErrors = exception.getBindingResult().getFieldErrors();

        // 设置默认返回值
        WebResult>> data = new WebResult<>();
        data.setMsg("The parameter is invalid ");
        data.setCode(-1);

        // 重构参数
        ArrayList> errorList = new ArrayList<>();
        fieldErrors.forEach(error ->{
            HashMap temp = new HashMap<>();
            temp.put("Attr", error.getField());
            temp.put("Msg", error.getDefaultMessage());
            errorList.add(temp);
        });
        data.setData(errorList);

        return data;
    }
}

3.2 WebResult

package com.example.test.config;

/**
 * 自定义统一返回值
 * @param  自定义参数
 */
public class WebResult {

    private int code;
    private String msg;
    private T data;

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}

3.3 TestController

package com.example.test.controller;


import com.example.test.entity.TestParam;
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("/test")
public class TestController {

    @RequestMapping("/query")
    public String queryData(@RequestBody @Valid TestParam testParam){
        return "I am mason";
    }

}

3.4 TestParam

package com.example.test.entity;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotEmpty;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class TestParam {
    @Min(value = 1, message = "值不能小于1")
    private int num;
    @NotEmpty(message = "信息不能为空")
    private String msg;
}

3.5 StatusCode

package com.example.test.util;

/**
 * 设置状态码
 */
public enum StatusCode {

    PARAM_ERROR(1, "Success");

    private int code;
    private String msg;

    /**
     * 设置状态码
     * @param code 状态码
     * @param msg 状态消息
     */
    StatusCode(int code, String msg){
        this.code = code;
        this.msg = msg;
    }

    public int getCode() {
        return code;
    }
    public void setCode(int code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}

application.yml文件和Application.java文件无变化

4 运行结果