查看: 1798|回复: 0

[Java代码] 详解Spring AOP 实现“切面式”valid校验

发表于 2018-2-25 08:00:00

why:

为什么要用aop实现校验?

answer:

spring mvc 默认自带的校验机制 @Valid + BindingResult, 但这种默认实现都得在Controller方法的中去接收BindingResult,从而进行校验.

eg:

  1. if (result.hasErrors()) {
  2. List<ObjectError> allErrors = result.getAllErrors();
  3. List<String> errorlists = new ArrayList<>();
  4. for (ObjectError objectError : allErrors) {
  5. errorlists.add(objectError.getDefaultMessage());
  6. }
  7. }
复制代码

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

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

1. 栗子(旧版本)

1.1 接口层(IDAL)

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

  1. httpMethid: POST
  2. parameters:@RequestBody接收请求数据
  3. valid:@Valid +BindingResult
  1. @ResponseBody
  2. @PostMapping("body")
  3. public ResponseVO bodyPost(@RequestBody @Valid TestVO body,BindingResult result){
  4. //校验到错误
  5. if (result.hasErrors()) {
  6. List<ObjectError> allErrors = result.getAllErrors();
  7. List<String> lists = new ArrayList<>();
  8. for (ObjectError objectError : allErrors) {
  9. lists.add(objectError.getDefaultMessage());
  10. }
  11. return new ResponseVO(HttpStatus.BAD_REQUEST.value(), "parameter empty", lists);
  12. }
  13. return new ResponseVO(HttpStatus.OK.value(), "bodyPost", null);
  14. }
复制代码

1.2 实体(vo)校验内容

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

  1. public class TestVO {
  2. @Getter
  3. @Setter
  4. @Min(value = 0,message = "请求参数isString不能小于0")
  5. private Integer isInt;
  6. @Getter
  7. @Setter
  8. @NotBlank(message = "请求参数isString不能为空")
  9. private String isString;
  10. }
复制代码

1.3 结果测试

2. aop校验(升级版)

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

2.1 接口层(IDAL)

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

  1. @ParamValid
  2. @ResponseBody
  3. @PostMapping("body")
  4. public ResponseVO bodyPost(@RequestBody @Valid TestVO body,BindingResult result){
  5. return new ResponseVO("bodyPost", null);
  6. }
复制代码

2.2 自定义注解(annotation)

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

  1. @Target(ElementType.METHOD)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. public @interface ParamValid {}
复制代码

2.3 重点!切面实现(Aspect)

切面详解:

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

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

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

响应校验结果:

  1. 通过RequestContextHolder获取response
  2. 获取响应OutputStream
  3. 将BindingResult封装响应
  1. @Aspect
  2. @Component
  3. public class ParamValidAspect {
  4. private static final Logger log = LoggerFactory.getLogger(ParamValidAspect.class);
  5. @Before("@annotation(paramValid)")
  6. public void paramValid(JoinPoint point, ParamValid paramValid) {
  7. Object[] paramObj = point.getArgs();
  8. if (paramObj.length > 0) {
  9. if (paramObj[1] instanceof BindingResult) {
  10. BindingResult result = (BindingResult) paramObj[1];
  11. ResponseVO errorMap = this.validRequestParams(result);
  12. if (errorMap != null) {
  13. ServletRequestAttributes res = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  14. HttpServletResponse response = res.getResponse();
  15. response.setCharacterEncoding("UTF-8");
  16. response.setContentType(MediaType.APPLICATION_JSON_UTF8_VALUE);
  17. response.setStatus(HttpStatus.BAD_REQUEST.value());
  18. OutputStream output = null;
  19. try {
  20. output = response.getOutputStream();
  21. errorMap.setCode(null);
  22. String error = new Gson().toJson(errorMap);
  23. log.info("aop 检测到参数不规范" + error);
  24. output.write(error.getBytes("UTF-8"));
  25. } catch (IOException e) {
  26. log.error(e.getMessage());
  27. } finally {
  28. try {
  29. if (output != null) {
  30. output.close();
  31. }
  32. } catch (IOException e) {
  33. log.error(e.getMessage());
  34. }
  35. }
  36. }
  37. }
  38. }
  39. }
  40. /**
  41. * 校验
  42. */
  43. private ResponseVO validRequestParams(BindingResult result) {
  44. if (result.hasErrors()) {
  45. List<ObjectError> allErrors = result.getAllErrors();
  46. List<String> lists = new ArrayList<>();
  47. for (ObjectError objectError : allErrors) {
  48. lists.add(objectError.getDefaultMessage());
  49. }
  50. return new ResponseVO(HttpStatus.BAD_REQUEST.value(), "parameter empty", lists);
  51. }
  52. return null;
  53. }
  54. }
复制代码

2.4 测试结果

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

  1. 去除代码冗余
  2. AOP异步处理
  3. 优化代码实现

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



回复

使用道具 举报