在接口开发中,避免不了一些参数校验,本文主要介绍,基于注解+springboot 统一异常处理做参数校验。
1.搭建一个SpringBoot 项目
可参考: SpringBoot快速创建
2.添加参数校验依赖
spring-boot-starter-web 中已经依赖了 hibernate-validator
一下 Jar可以不加
注:本文使用的是Spring-boot 2.2.5.RELEASE
hibernate-validator 默认版本是6.0.18.Final
<!-- 校验工具 -->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>5.4.1.Final</version>
</dependency>
3.添加统一异常处理配置
package com.example.config.advice;
import com.example.config.enums.SysExceptionEnum;
import com.example.bean.result.Response;
import org.apache.commons.lang3.exception.ExceptionUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.validation.FieldError;
import org.springframework.web.HttpMediaTypeNotSupportedException;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
/**
* 全局统一异常处理
*
* @author 码农猿
*/
@ControllerAdvice
public class ExceptionAdvice {
/**
* 日志
*/
private static final Logger LOGGER = LoggerFactory.getLogger(ExceptionAdvice.class);
@ResponseBody
@ExceptionHandler(value = Exception.class)
public Response defaultExceptionHandler(Exception exception) {
Response result = new Response();
result.setSuccess(false);
try {
throw exception;
} catch (MethodArgumentNotValidException argEx) {
FieldError fieldError = argEx.getBindingResult().getFieldError();
String errorMsg = String.format("%s >> %s", fieldError.getField(),
fieldError.getDefaultMessage());
LOGGER.error("【全局异常捕获】>> 参数校验异常 >> {}", errorMsg);
result.setErrorCode(SysExceptionEnum.INVALID_PARAM.getCode());
result.setErrorMsg(errorMsg);
} catch (HttpRequestMethodNotSupportedException e) {
String errorMsg = String.format("请求方式 %s 错误 ! 请使用 %s 方式", e.getMethod(), e.getSupportedHttpMethods());
LOGGER.error("【全局异常捕获】>> {}", errorMsg);
result.setErrorCode(SysExceptionEnum.INVALID_PARAM.getCode());
result.setErrorMsg(errorMsg);
} catch (HttpMediaTypeNotSupportedException e) {
String errorMsg = String.format("请求类型 %s 错误 ! 请使用 %s 方式", e.getContentType(), e.getSupportedMediaTypes());
LOGGER.error("【全局异常捕获】>> {}", errorMsg);
result.setErrorCode(SysExceptionEnum.INVALID_PARAM.getCode());
result.setErrorMsg(errorMsg);
} catch (Exception e) {
LOGGER.error("【全局异常捕获】>> 未知异常 stack = {}", ExceptionUtils.getStackTrace(e));
result.setErrorCode(SysExceptionEnum.SYSTEM_ERROR.getCode());
result.setErrorMsg(SysExceptionEnum.SYSTEM_ERROR.getMsg());
}
return result;
}
}
4.添加测试接口
参数类
/**
* 人员信息新增参数
*
* @author mengqiang
*/
public class UserAddParam implements Serializable {
/**
* 用户名
*/
@NotBlank(message = "用户名不为空!")
private String userName;
/**
* 密码
*/
@NotBlank(message = "密码不为空!")
@Size(min = 6, max = 20, message = "密码长度介于{min}至{max}之间!")
private String userPassword;
/**s
* 真实姓名
*/
@NotBlank(message = "真实姓名不为空!")
private String realName;
/**
* 性别类型
* <p>
* 1-男,2-女,3-不详
*/
@NotNull
private Integer sexType;
/**
* 手机号
*/
@NotBlank(message = "手机号不为空!")
@Length(max = 11)
private String mobile;
/**
* remark测试
*/
private String remark;
//省略 get set
}
5.controller接口
注:接口中需要添加注解 @Valid
/**
* 人员管理接口
*
* @author 码农猿
*/
@RestController
@RequestMapping("/user")
public class UserInfoController {
/**
* 添加人员
*
* @author 码农猿
*/
@PostMapping(value = "/add-user")
public Response addUser1(@Valid @RequestBody UserAddParam addParam) {
return null;
}
}
6.测试结果
7.注意事项
1.注意一些注解的使用范围,是否有属性类型限制等要求。
2.嵌套类校验时需要添加 ,@Valid 注解
示例
8工具类校验
如果是从controller中进行校验参数,触发校验需要加@Valid注解,但是有些场景中并未从controller进入的参数又该如何触发校验呢?
自定义校验工具类
import com.example.bean.result.ValidateResult;
import com.google.common.collect.Iterables;
import java.util.Set;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
/**
* 校验工具类
*/
public class ValidateUtil {
public static final Validator VALIDATOR = Validation.buildDefaultValidatorFactory().getValidator();
public ValidateUtil() {
}
/**
* 校验参数核心方法
*/
public static <T> ValidateResult validate(T object) {
ValidateResult validateResult = new ValidateResult();
validateResult.setResult(true);
Set<ConstraintViolation<T>> constraintViolations = VALIDATOR.validate(object, new Class[0]);
ConstraintViolation<T> constraintViolation = (ConstraintViolation) Iterables.getFirst(constraintViolations, (Object) null);
if (constraintViolation != null) {
validateResult.setResult(false);
validateResult.setParamName(constraintViolation.getPropertyPath().toString());
validateResult.setMsg(constraintViolation.getMessage());
}
return validateResult;
}
}
使用示例
public class ValidateUtilTest {
public static void main(String[] args) {
UserAddParam userAddParam = new UserAddParam();
userAddParam.setMobile("123");
ValidateResult validate = ValidateUtil.validate(userAddParam);
//输出结果
System.out.println("校验结果 >> " + JSON.toJSONString(validate));
}
}
测试结果输出示例
校验结果 >> {"msg":"用户名不为空!","paramName":"userName","result":false}
附录
常用的注解
1.非空判断相关
注解 | 描述 |
---|---|
@NotNull | 不能为null |
@NotBlank | 不能为空,检查时会将空格忽略 |
@NotEmpty | 不能为空,这里的空是指空字符串 |
@Null | 检查该字段为空 |
2.长度判断相关
注解 | 描述 |
---|---|
@Max | 该字段的值只能小于或等于该值 |
@Min | 该字段的值只能大于或等于该值 |
@Size(min=, max=) | 检查该字段的size是否在min和max之间,可以是字符串、数组、集合、Map等 |
@DecimalMax | 只能小于或等于该值 |
@DecimalMin | 只能大于或等于该值 |
@Length(min=,max=) | 检查所属的字段的长度是否在min和max之间,只能用于字符串 |
@Range(min=,max=,message=) | 被注释的元素必须在合适的范围内 |
3.其它注解
注解 | 描述 |
---|---|
@Pattern(regex=,flag=) | 被注释的元素必须符合指定的正则表达式 |
检查是否是一个有效的email地址 | |
@Future | 检查该字段的日期是否是属于将来的日期 |
@AssertTrue | 用于boolean字段,该字段只能为true |
@AssertFalse | 该字段的值只能为false |
@Digits(integer=,fraction=) | 检查是否是一种数字的整数、分数,小数位数的数字 |
@URL(protocol=,host,port) | 检查是否是一个有效的URL,如果提供了protocol,host等,则该URL还需满足提供的条件 |
@Past | 检查该字段的日期是在过去 |
@Valid | 该注解主要用于字段为一个包含其他对象的集合或map或数组的字段,或该字段直接为一个其他对象的引用,这样在检查当前对象的同时也会检查该字段所引用的对象 |
关注公众号更多编程趣事,知识心得与您分享