Java使用@Validated注解进行参数验证的方法

目前项目中大部分代码进行参数验证都是写代码进行验证,为了提升方便性和代码的简洁性,所以整理了下使用注解进行参数验证。使用效果如下:

// 要验证的实体类
@Data
public class User implements Serializable {
  @NotBlank(message = "id不能为空!",groups = Update.class)
  protected String id = "";
  @NotBlank(message = "商户id不能为空!")
  protected String tenantId;
  @NotBlank(message = "名称不能为空!")
  protected String name = "";
}
// controller
// 在要验证的参数上添加@Validated注解即可
@PostMapping("add")
public boolean addUser(@Validated @RequestBody User user) {
    ProdAllotStandard info = allotStandardService.getProdAllotStandardWithDetailById(id);
    return info;
}
// 修改则需要比添加的基础上多验证一个id,可以通过group的方式进行区分
// 实体类上不设置groups,默认会是Default,所以修改的时候,我们需要指定Update和Default这两个组
// group是可以自定义的,我默认定义了Add,Update,Delete,Search这四个组
@PostMapping("update")
public boolean updateUser(@Validated({Update.class, Default.class}) @RequestBody User user) {
    ProdAllotStandard info = allotStandardService.getProdAllotStandardWithDetailById(id);
    return info;
}
// 当然该注解也支持service上实现,同样的使用方法,在service的实现类的参数上加上对应注解即可,如:
public boolean addUser(@Validated User user) {

}
// 通过不同group的搭配,我们就可以灵活的在实体类上配置不同场景的验证了
// group为一个接口,用以下方式创建
public interface Add {
}

下面看一下具体的实现,验证框架的核心实现采用的是hibernate-validator,我采用的是5.4.3.Final版本。

controller和service的实现方式不同,下面分别介绍下。

不管哪种实现,我们都需要先定义一个异常和一个异常拦截器,当参数校验出现问题时,我们就抛出对应异常。

// 为了简短,省略了部分代码
public class ParamsException extends RuntimeException{
  private String code;
  public BusinessException() {
  }
  public ParamsException(String code,String message) {
    super(message);
    this.code = code;
  }
  public ParamsException(String message) {
    super(message);
  }
}
// 定义异常处理类
@ControllerAdvice
public class ExceptionAdvice {

  private static Logger L = LoggerFactory.getLogger(ExceptionAdvice.class);

  // 对所有的ParamsException统一进行拦截处理,如果捕获到该异常,则封装成MessageBody返回给前端
  @ExceptionHandler(value = ParamsException.class)
  @ResponseStatus(HttpStatus.OK)
  @ResponseBody
  public MessageBody handleParamsException(HttpServletRequest request, BusinessException e){
    L.error(e.getMessage(),e);
    return getErrorMessageBody(e.getData(),e.getMessage(),e.getMessage(),
        StringUtils.isEmpty(e.getCode())?ResponseCode.BUSINESS_ERROR:e.getCode());
  }
  private MessageBody getErrorMessageBody(Object data,String message,String errorInfo,String code){
    MessageBody body = new MessageBody();
    body.setCode(code);
    body.setData(data);
    body.setErrorCode(Integer.parseInt(code));
    body.setErrorInfo(errorInfo);
    body.setMessage(message);
    body.setSuccess(false);
    return body;
  }
}

controller的验证的实现:

主要是通过实现spring mvc给我们留下的接口进行实现的,该方案没有用到反射和代理。

1.  实现spring提供的SmartValidator接口

public class ParamsValidator implements SmartValidator {

  private javax.validation.Validator validator = Validation.buildDefaultValidatorFactory().getValidator();

  @Override
  public boolean supports(Class<?> clazz) {
    return true;
  }
  // 注解上没有有group的验证逻辑
  @Override
  public void validate(Object target, Errors errors) {
    validate(target,errors,null);
  }
  // 注解上带有group的验证逻辑
  // 第一个参数为我们要验证的参数,第二个不用管,第三个为注解上设置个groups
  @Override
  public void validate(Object target, Errors errors, Object... validationHints) {
    // 这里面为验证实现,可以根据自己的需要进行完善与修改
    if (target == null) {
      throw new ParamsException("参数不能为空!");
    } else {
      if(target instanceof String) {
        if(StringUtils.isEmpty(target)) {
          throw new ParamsException("参数不能为空!");
        }
      }else if(target instanceof Collection) {
        for(Object o:(Collection)target){
          validate(o,validationHints);
        }
      }else {
        validate(target,validationHints);
      }

    }

  }
  private void validate(Object target,Object ... objs) {
    Set<ConstraintViolation<Object>> violations;
    // 没有groups的验证
    if(objs==null || objs.length==0) {
      violations = validator.validate(target);
    } else {
    // 基于groups的验证
      Set<Class<?>> groups = new LinkedHashSet<Class<?>>();
      for (Object hint : objs) {
        if (hint instanceof Class) {
          groups.add((Class<?>) hint);
        }
      }
      violations = validator.validate(target, ClassUtils.toClassArray(groups));
    }
    // 若为空,则验证通过
    if(violations==null||violations.isEmpty()) {
      return;
    }
    // 验证不通过则抛出ParamsException异常。
    for(ConstraintViolation item:violations) {
      throw new ParamsException(item.getMessage());
    }
  }
}

2. 配置并设置Validator验证器

@Configuration
public class WebMvcConfigurer extends WebMvcConfigurerAdapter{
  // 我们在这里重写spring的一个方法,返回我们自定义的验证器
  @Override
  public Validator getValidator() {
    return createValidator();
  }
  @Bean
  public ParamsValidator createValidator(){
    return new ParamsValidator();
  }
}

非常简单,通过上面配置,就可以在controller上使用注解了。

spring mvc对这个注解的处理主要是在RequestResponseBodyMethodProcessor这个类中的resolveArgument方法实现的,该类主要处理方法的参数和返回值。

spring mvc调用的一段代码。

protected void validateIfApplicable(WebDataBinder binder, MethodParameter parameter) {
  Annotation[] annotations = parameter.getParameterAnnotations();
  for (Annotation ann : annotations) {
    Validated validatedAnn = AnnotationUtils.getAnnotation(ann, Validated.class);
    if (validatedAnn != null || ann.annotationType().getSimpleName().startsWith("Valid")) {
      Object hints = (validatedAnn != null ? validatedAnn.value() : AnnotationUtils.getValue(ann));
      Object[] validationHints = (hints instanceof Object[] ? (Object[]) hints : new Object[] {hints});
      binder.validate(validationHints);
      break;
    }
  }
}

service的验证的实现:

该方案主要通过aop进行拦截处理的。如下配置:

@Component
@Aspect
public class ParamsValidateAdvice {
  // 这里重用上面定义的那个validator
  private ParamsValidator validator = new ParamsValidator();
  /**
   * 拦截参数上加了@Validated的注解的方法
   * 排除掉controller,因为controller有自己的参数校验实现 不需要aop
   */
  @Pointcut("execution(* com.choice..*(..,@org.springframework.validation.annotation.Validated (*), ..)) && " +
      "!execution(* com.choice..api..*(..)) && " +
      "!execution(* com.choice..controller..*(..)) ")
  public void pointCut(){}

  @Before("pointCut()")
  public void doBefore(JoinPoint joinPoint){
    Object[] params=joinPoint.getArgs();
    MethodSignature signature = (MethodSignature) joinPoint.getSignature();
    Method method = signature.getMethod();
    Parameter[] parameters = method.getParameters();
    // 验证参数上的注解
    for(int i=0;i<parameters.length;i++) {
      Parameter p = parameters[i];
      // 获取参数上的注解
      Validated validated = p.getAnnotation(Validated.class);
      if(validated==null) {
        continue;
      }
      // 如果设置了group
      if(validated.value()!=null && validated.value().length>0) {
        validator.validate(params[i],null,validated.value());
      } else {
        validator.validate(params[i],null);
      }
    }
  }
}

这样就可以在service使用验证注解了,具体的Pointcut可以自己进行配置。

个人觉得参数校验在controller或者对外暴露的服务中去做就好了,因为这些都是对外提供服务的,controller层也应该去做这些,所以参数需要校验好。

没必要在自己内部调用的service中加校验。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

时间: 2019-08-12

详解Spring 参数验证@Validated和@Valid的区别

Spring Validation验证框架对参数的验证机制提供了@Validated(Spring's JSR-303 规范,是标准 JSR-303 的一个变种),javax提供了@Valid(标准JSR-303规范),配合 BindingResult 可以直接提供参数验证结果.其中对于字段的特定验证注解比如 @NotNull 等网上到处都有,这里不详述 在检验 Controller 的入参是否符合规范时,使用 @Validated 或者 @Valid 在基本验证功能上没有太多区别.但是在分组.

详解Spring AOP 实现“切面式”valid校验

why: 为什么要用aop实现校验? answer: spring mvc 默认自带的校验机制 @Valid + BindingResult, 但这种默认实现都得在Controller方法的中去接收BindingResult,从而进行校验. eg: if (result.hasErrors()) { List<ObjectError> allErrors = result.getAllErrors(); List<String> errorlists = new ArrayList

详解Spring Boot 部署jar和war的区别

本文介绍了Spring Boot 部署jar和war两种方式的区别,分享给大家,具体如下: 1. packaging的方式不同,一种设置成jar一种是war <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

Springboot @Validated和@Valid的区别及使用详解

概述: @Valid是使用Hibernate validation的时候使用 @Validated是只用Spring Validator校验机制使用 说明:java的JSR303声明了@Valid这类接口,而Hibernate-validator对其进行了实现 @Validation对@Valid进行了二次封装,在使用上并没有区别,但在分组.注解位置.嵌套验证等功能上有所不同,这里主要就这几种情况进行说明. 注解位置: @Validated:用在类型.方法和方法参数上.但不能用于成员属性(fie

详解spring切面使用传递给被通知方法的参数

本文介绍了详解spring切面使用传递给被通知方法的参数,分享给大家,具体如下: 场景: BlankDisc代表CD实体,可以通过playTrack()方法直接播放某一个磁道中的歌曲. 需求是记录每个磁道被播放的次数. 一种方法就是修改playTrack()方法,直接在每次调用的时候记录这个数量.但是,记录磁道的播放次数与播放本身是不同的关注点,因此不应该属于playTrack()方法.这应该是切面要完成的任务. CompactDisc接口 public interface CompactDis

实例详解Spring Boot实战之Redis缓存登录验证码

本章简单介绍redis的配置及使用方法,本文示例代码在前面代码的基础上进行修改添加,实现了使用redis进行缓存验证码,以及校验验证码的过程. 1.添加依赖库(添加redis库,以及第三方的验证码库) <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-redis</artifactId> </dependency&

详解spring cloud config整合gitlab搭建分布式的配置中心

在前面的博客中,我们都是将配置文件放在各自的服务中,但是这样做有一个缺点,一旦配置修改了,那么我们就必须停机,然后修改配置文件后再进行上线,服务少的话,这样做还无可厚非,但是如果是成百上千的服务了,这个时候,就需要用到分布式的配置管理了.而spring cloud config正是用来解决这个问题而生的.下面就结合gitlab来实现分布式配置中心的搭建.spring cloud config配置中心由server端和client端组成, 前提:在gitlab中的工程下新建一个配置文件config

详解Spring的核心机制依赖注入

详解Spring的核心机制依赖注入 对于一般的Java项目,他们都或多或少有一种依赖型的关系,也就是由一些互相协作的对象构成的.Spring把这种互相协作的关系称为依赖关系.如A组件调用B组件的方法,可称A组件依赖于B组件,依赖注入让Spring的Bean以配置文件组织在一起,而不是以硬编码的方式耦合在一起 一.理解依赖注入 依赖注入(Dependency Injection) = 控制反转(Inversion ofControl,IoC):当某个Java实例(调用者)需另一个Java实例(被调

详解 Spring注解的(List&Map)特殊注入功能

详解 Spring注解的(List&Map)特殊注入功能 最近接手一个新项目,已经没有原开发人员维护了.项目框架是基于spring boot进行开发.其中有两处Spring的注解花费了大量的时间才弄明白到底是怎么用的,这也涉及到spring注解的一个特殊的注入功能. 首先,看到代码中有直接注入一个List和一个Map的.示例代码如下: @Autowired private List<DemoService> demoServices; @Autowired private Map<

详解spring boot starter redis配置文件

spring-boot-starter-Redis主要是通过配置RedisConnectionFactory中的相关参数去实现连接redis service. RedisConnectionFactory是一个接口,有如下4个具体的实现类,我们通常使用的是JedisConnectionFactory. 在spring boot的配置文件中redis的基本配置如下: # Redis服务器地址 spring.redis.host=192.168.0.58 # Redis服务器连接端口 spring.