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

更新时间：2018年01月17日 11:51:00 作者：CatalpaFlat

本篇文章主要介绍了详解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<>();
  for (ObjectError objectError : allErrors) {
    errorlists.add(objectError.getDefaultMessage());
  }
 }

获取errorlists。这样实现的话，每个需要校验的方法都得重复调用，即使封装也是。

可能上面那么说还不能表明spring 的@Valid + BindingResult实现，我先举个“栗子”。

1. 栗子（旧版本）

1.1 接口层（IDAL）

eg: 简单的POST请求，@RequestBody接收请求数据，@Valid + BindingResult进行校验

httpMethid: POST
parameters：@RequestBody接收请求数据
valid：@Valid +BindingResult

@ResponseBody
 @PostMapping("body")
 public ResponseVO bodyPost(@RequestBody @Valid TestVO body,BindingResult result){
  //校验到错误
  if (result.hasErrors()) {
   List<ObjectError> allErrors = result.getAllErrors();
   List<String> lists = new ArrayList<>();
   for (ObjectError objectError : allErrors) {
     lists.add(objectError.getDefaultMessage());
   }
   return new ResponseVO(HttpStatus.BAD_REQUEST.value(), "parameter empty", lists);
 }
   return new ResponseVO(HttpStatus.OK.value(), "bodyPost", null);
}

1.2 实体（vo）校验内容

@Valid + BindingResult的校验注解一大堆，网上一摸就有的！

public class TestVO {
  @Getter
  @Setter
  @Min(value = 0,message = "请求参数isString不能小于0")
  private Integer isInt;
  @Getter
  @Setter
  @NotBlank(message = "请求参数isString不能为空")
  private String isString;
}

1.3 结果测试

2. aop校验（升级版）

可以看到若是多个像bodyPost一样都需要对body进行校验的话，那么有一坨代码就必须不断复现，即使改为父类可复用方法，也得去调用。所以左思右想还是觉得不优雅。所以有了aop进行切面校验。

2.1 接口层（IDAL）

是的！你没看错，上面那一坨代码没了，也不需要调用父类的的共用方法。就单单一个注解就完事了：@ParamValid

@ParamValid
@ResponseBody
@PostMapping("body")
public ResponseVO bodyPost(@RequestBody @Valid TestVO body,BindingResult result){
  return new ResponseVO("bodyPost", null);
}

2.2 自定义注解（annotation）

这个注解也是简简单单的用于方法的注解。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ParamValid {}

2.3 重点！切面实现（Aspect）

切面详解：

@Before: 使用注解方式@annotation(XX),凡是使用到所需切的注解（@ParamValid），都会调用该方法

JoinPoint：通过JoinPoint获取方法的参数，以此获取BindingResult所校验到的内容

迁移校验封装: 将原先那一坨校验迁移到Aspect中：validRequestParams

响应校验结果：

通过RequestContextHolder获取response
获取响应OutputStream
将BindingResult封装响应

@Aspect
@Component
public class ParamValidAspect {

  private static final Logger log = LoggerFactory.getLogger(ParamValidAspect.class);

  @Before("@annotation(paramValid)")
  public void paramValid(JoinPoint point, ParamValid paramValid) {
    Object[] paramObj = point.getArgs();
    if (paramObj.length > 0) {
      if (paramObj[1] instanceof BindingResult) {
        BindingResult result = (BindingResult) paramObj[1];
        ResponseVO errorMap = this.validRequestParams(result);
        if (errorMap != null) {
          ServletRequestAttributes res = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
          HttpServletResponse response = res.getResponse();
          response.setCharacterEncoding("UTF-8");
          response.setContentType(MediaType.APPLICATION_JSON_UTF8_VALUE);
          response.setStatus(HttpStatus.BAD_REQUEST.value());

          OutputStream output = null;
          try {
            output = response.getOutputStream();
            errorMap.setCode(null);
            String error = new Gson().toJson(errorMap);
            log.info("aop 检测到参数不规范" + error);
            output.write(error.getBytes("UTF-8"));
          } catch (IOException e) {
            log.error(e.getMessage());
          } finally {
            try {
              if (output != null) {
                output.close();
              }
            } catch (IOException e) {
              log.error(e.getMessage());
            }
          }
        }
      }
    }
  }

  /**
   * 校验
   */
  private ResponseVO validRequestParams(BindingResult result) {
    if (result.hasErrors()) {
      List<ObjectError> allErrors = result.getAllErrors();
      List<String> lists = new ArrayList<>();
      for (ObjectError objectError : allErrors) {
        lists.add(objectError.getDefaultMessage());
      }
      return new ResponseVO(HttpStatus.BAD_REQUEST.value(), "parameter empty", lists);
    }
    return null;
  }
}

2.4 测试结果

看了上面两种结果，就可以对比出使用Spring AOP 配合@Valid + BindingResult进行校验的优点:

去除代码冗余
AOP异步处理
优化代码实现

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

您可能感兴趣的文章:

Spark-Sql入门程序示例详解
Spark SQL 作为 Spark 四大核心组件之一，主要用于处理结构化数据或半结构化数据，它支持在Spark 中使用 SQL 对数据进行查询，本文给大家介绍Spark-Sql入门程序，感兴趣的朋友跟随小编一起看看吧
2021-12-12
java 创建自定义数组
本篇文章是关于java 如何自己创建自定义数组,这里给大家一个小实例,希望能帮助有所需要的同学
2016-07-07
Spring Cloud Alibaba使用Sentinel实现接口限流
这篇文章主要介绍了Spring Cloud Alibaba使用Sentinel实现接口限流，本文详细的介绍了Sentinel组件的用法以及接口限流，感兴趣的可以了解一下
2019-04-04
基于Java编写一个限流工具类RateLimiter
这篇文章主要为大家详细介绍了如何基于Java编写一个限流工具类RateLimiter,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
2024-01-01
SpringBoot项目使用mybatis-plus逆向自动生成全套代码
在JavaWeb工程中，每一个SSM新项目或者说是SpringBoot项目也好，都少不了model、controller、service、dao等层次的构建。使用mybatis-plus逆向可以自动生成，感兴趣的可以了解一下
2021-09-09
SpringBoot+Querydsl 框架实现复杂查询解析
本篇主要将介绍的是利用spring query dsl框架实现的服务端查询解析和实现介绍，对SpringBoot Querydsl 查询操作感兴趣的朋友一起看看吧
2022-05-05
MybatisPlus多表连接查询的具体实现
MyBatis Plus是一款针对MyBatis框架的增强工具, 它提供了很多方便的方法来实现多表联查,本文主要介绍了MybatisPlus多表连接查询的具体实现,具有一定的参考价值,感兴趣的可以了解一下
2023-10-10
SpringBoot Redis配置多数据源的项目实践
springboot中默认的redis配置是只能对单个redis库进行操作的，那么我们需要多个库操作的时候这个时候就可以采用redis多数据源，本文就介绍了SpringBoot Redis配置多数据源，感兴趣的可以了解一下
2023-07-07
springboot如何集成mysql
这篇文章主要介绍了springboot如何集成mysql问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-08-08
Java序列化机制与原理的深入分析
有关Java对象的序列化和反序列化也算是Java基础的一部分，下面对Java序列化的机制和原理进行一些介绍
2013-05-05