springboot使用validator进行参数校验

15810356216

已于 2023-04-26 16:15:01 修改

阅读量1.5k

点赞数 1

分类专栏： springboot 文章标签： spring boot validation

于 2023-04-26 16:08:09 首次发布

本文链接：https://blog.csdn.net/L15810356216/article/details/130386901

版权

springboot 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

1.依赖导入

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

2.validation常用注解

@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(value) 被注释的元素必须符合指定的正则表达式。
@Email 被注释的元素必须是电子邮件地址
@Length 被注释的字符串的大小必须在指定的范围内
@Range 被注释的元素必须在合适的范围内
@NotEmpty：用在集合类上，不能为null，并且长度必须大于0
@NotBlank：只能作用在String上，不能为null，而且调用trim()后，长度必须大于0

3.定义封装统一返回对象

import java.util.HashMap;

public class ResponseBo extends HashMap<String, Object> {

	private static final long serialVersionUID = -8713837118340960775L;

	// 成功
	private static final Integer SUCCESS = 200;
	// 警告
	private static final Integer WARN = 203;
	// 异常 失败
	private static final Integer FAIL = 500;

	public ResponseBo() {
		put("code", SUCCESS);
		put("msg", "操作成功");
		put("data", null);
	}

	public static ResponseBo error(Object msg) {
		ResponseBo ResponseBo = new ResponseBo();
		ResponseBo.put("code", FAIL);
		ResponseBo.put("msg", msg);
		return ResponseBo;
	}

	public static ResponseBo warn(Object msg) {
		ResponseBo ResponseBo = new ResponseBo();
		ResponseBo.put("code", WARN);
		ResponseBo.put("msg", msg);
		return ResponseBo;
	}

	public static ResponseBo ok(Object msg) {
		ResponseBo ResponseBo = new ResponseBo();
		ResponseBo.put("code", SUCCESS);
		ResponseBo.put("msg", "成功");
		ResponseBo.put("data", msg);
		return ResponseBo;
	}

	public static ResponseBo ok() {
		return new ResponseBo();
	}

	public static ResponseBo error() {
		return ResponseBo.error("");
	}

	@Override
	public ResponseBo put(String key, Object value) {
		super.put(key, value);
		return this;
	}
}

4.单个字段参数校验

首先控制器类名需要加@Validated注解，然后直接在方法参数添加相应注解即可。

@Validated
@RestController
@RequestMapping("/interface/industry/")
public class IndustryController{

    @PostMapping("demo1")
    public ResponseBo demo1(@NotBlank(message = "行业名称不能为空") String name,
    		@NotNull(message = "行业状态不能为空") Integer status){
            return ResponseBo.ok();
    }

5.对象参数校验

首先实体类对象加入相应的注解，然后控制器方法对象前加入@Validated即可。

import javax.validation.constraints.Max;
import org.hibernate.validator.constraints.NotBlank;

@Table(name = "xxxxxxx")
public class Industry {
    
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer iId;

    
    @Column(name = "i_name")
    @NotBlank(message = "行业名称不能为空")
    @Max(value = 5,message = "最大值为5")
    private String iName;

    @Column(name = "i_status")
    private Integer iStatus;

    /** 手机号*/
//    @NotBlank(message = "手机号不能为空")
//    @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误")
//    private String mobile;

    //set/get省略........
    }

import org.springframework.validation.annotation.Validated;
@RestController
@RequestMapping("/interface/industry/")
public class IndustryController{  
  
    @PostMapping("demo2")
    public ResponseBo demo2(@Validated Industry industry){
    	//省略.........
    	return ResponseBo.ok();
    }
}

6.JSON对象参数校验与对象一致

import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestBody;

@RestController
@RequestMapping("/interface/industry/")
public class IndustryController{  
  
    @PostMapping("demo3")
    public ResponseBo demo3(@RequestBody @Validated Industry industry){
    	//省略.........
    	return ResponseBo.ok();
    }
}

7.定义捕获全局异常对象

注：可根据具体需要返回内容去修改

import java.util.List;
import java.util.Objects;
import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import org.apache.commons.lang.StringUtils;
import org.hibernate.validator.internal.engine.ConstraintViolationImpl;
import org.springframework.http.HttpStatus;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
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 xxx.xxxxx.common.domain.ResponseBo;

@RestControllerAdvice
public class ParamException{
 
	/**
	 * 处理JSON对象请求校验捕获
	 * @param ex
	 * @return
	 */
    @ExceptionHandler({MethodArgumentNotValidException.class})
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ResponseBo handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
        BindingResult bindingResult = ex.getBindingResult();
        StringBuilder sb = new StringBuilder("参数校验失败:");
        for (FieldError fieldError : bindingResult.getFieldErrors()) {
            sb.append(fieldError.getField()).append("：").append(fieldError.getDefaultMessage()).append(", ");
        }
        String msg = sb.toString();
        return ResponseBo.warn(msg);
    }
 
    /**
     * 处理单个参数校验捕获
     * @param ex
     * @return
     */
    @ExceptionHandler({ConstraintViolationException.class})
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ResponseBo handleConstraintViolationException(ConstraintViolationException ex) {
    	StringBuilder sb = new StringBuilder("参数校验失败:");
    	for (ConstraintViolation<?> constraintViolation : ex.getConstraintViolations()) {
    		ConstraintViolationImpl<?> cvi=(ConstraintViolationImpl<?>)constraintViolation;
    		sb.append(cvi.getPropertyPath()).append("：").append(cvi.getMessageTemplate());
		}
    	
        return ResponseBo.warn(sb.toString());
    }
    
   /**
    * 处理普通对象参数校验捕获
    */
    @ExceptionHandler(BindException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ResponseBo bindException(BindException ex, HttpServletRequest request) {
        try {
            // 拿到@NotNull,@NotBlank和 @NotEmpty等注解上的message值
            String msg = Objects.requireNonNull(ex.getBindingResult().getFieldError()).getDefaultMessage();
            if (StringUtils.isNotEmpty(msg)) {
                // 自定义状态返回
                return ResponseBo.warn(msg);
            }
        } catch (Exception ignored) {
        	return ResponseBo.error();
        }
        // 参数类型不匹配检验
        StringBuilder msg = new StringBuilder();
        List<FieldError> fieldErrors = ex.getFieldErrors();
        fieldErrors.forEach((oe) ->
                msg.append("参数:[").append(oe.getObjectName())
                        .append(".").append(oe.getField())
                        .append("]的传入值:[").append(oe.getRejectedValue()).append("]与预期的字段类型不匹配.")
        );
        return ResponseBo.warn(msg.toString());
    }
}

8.postman测试