经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » Java相关 » Spring Boot » 查看文章
Spring Boot配置AOP打印日志的全过程
来源:jb51  时间:2019/8/26 8:25:33  对本文有异议

前言

在项目开发中,日志系统是必不可少的,用AOP在Web的请求做入参和出参的参数打印,同时对异常进行日志打印,避免重复的手写日志,完整案例见文末源码。

一、Spring AOP

AOP(Aspect-Oriented Programming,面向切面编程),它利用一种"横切"的技术,将那些多个类的共同行为封装到一个可重用的模块。便于减少系统的重复代码,降低模块之间的耦合度,并有利于未来的可操作性和可维护性。

AOP中有以下概念:

  • Aspect(切面):声明类似于Java中的类声明,在Aspect中会包含一些Pointcut及相应的Advice。
  • Joint point(连接点):表示在程序中明确定义的点。包括方法的调用、对类成员的访问等。
  • Pointcut(切入点):表示一个组Joint point,如方法名、参数类型、返回类型等等。
  • Advice(通知):Advice定义了在Pointcut里面定义的程序点具体要做的操作,它通过(before、around、after(return、throw)、finally来区别实在每个Joint point之前、之后还是执行 前后要调用的代码。
  • Before:在执行方法前调用Advice,比如请求接口之前的登录验证。
  • Around:在执行方法前后调用Advice,这是最常用的方法。
  • After:在执行方法后调用Advice,after、return是方法正常返回后调用,after\throw是方法抛出异常后调用。
  • Finally:方法调用后执行Advice,无论是否抛出异常还是正常返回。
  • AOP proxy:AOP proxy也是Java对象,是由AOP框架创建,用来完成上述动作,AOP对象通常可以通过JDK dynamic proxy完成,或者使用CGLIb完成。
  • Weaving:实现上述切面编程的代码织入,可以在编译时刻,也可以在运行时刻,Spring和其它大多数Java框架都是在运行时刻生成代理。

二、项目示例

当然,在使用该案例之前,如果需要了解日志配置相关,可参考 SpringBoot 异步输出 Logback 日志, 本文就不再概述了。

2.1 在pom引入依赖

  1. <dependencies>
  2. <dependency>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-starter-web</artifactId>
  5. </dependency>
  6.  
  7. <dependency>
  8. <groupId>org.springframework.boot</groupId>
  9. <artifactId>spring-boot-starter-aop</artifactId>
  10. </dependency>
  11. <!-- 分析客户端信息的工具类-->
  12. <dependency>
  13. <groupId>eu.bitwalker</groupId>
  14. <artifactId>UserAgentUtils</artifactId>
  15. <version>1.20</version>
  16. </dependency>
  17. <!-- lombok -->
  18. <dependency>
  19. <groupId>org.projectlombok</groupId>
  20. <artifactId>lombok</artifactId>
  21. <scope>1.8.4</scope>
  22. </dependency>
  23. </dependencies>

2.2 Controller 切面:WebLogAspect

  1. @Aspect
  2. @Component
  3. @Slf4j
  4. public class WebLogAspect {
  5.  
  6. /**
  7. * 进入方法时间戳
  8. */
  9. private Long startTime;
  10. /**
  11. * 方法结束时间戳(计时)
  12. */
  13. private Long endTime;
  14.  
  15. public WebLogAspect() {
  16. }
  17.  
  18.  
  19. /**
  20. * 定义请求日志切入点,其切入点表达式有多种匹配方式,这里是指定路径
  21. */
  22. @Pointcut("execution(public * cn.van.log.aop.controller.*.*(..))")
  23. public void webLogPointcut() {
  24. }
  25.  
  26. /**
  27. * 前置通知:
  28. * 1. 在执行目标方法之前执行,比如请求接口之前的登录验证;
  29. * 2. 在前置通知中设置请求日志信息,如开始时间,请求参数,注解内容等
  30. *
  31. * @param joinPoint
  32. * @throws Throwable
  33. */
  34. @Before("webLogPointcut()")
  35. public void doBefore(JoinPoint joinPoint) {
  36.  
  37. // 接收到请求,记录请求内容
  38. ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  39. HttpServletRequest request = attributes.getRequest();
  40. //获取请求头中的User-Agent
  41. UserAgent userAgent = UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
  42. //打印请求的内容
  43. startTime = System.currentTimeMillis();
  44. log.info("请求开始时间:{}" + LocalDateTime.now());
  45. log.info("请求Url : {}" + request.getRequestURL().toString());
  46. log.info("请求方式 : {}" + request.getMethod());
  47. log.info("请求ip : {}" + request.getRemoteAddr());
  48. log.info("请求方法 : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
  49. log.info("请求参数 : {}" + Arrays.toString(joinPoint.getArgs()));
  50. // 系统信息
  51. log.info("浏览器:{}", userAgent.getBrowser().toString());
  52. log.info("浏览器版本:{}", userAgent.getBrowserVersion());
  53. log.info("操作系统: {}", userAgent.getOperatingSystem().toString());
  54. }
  55.  
  56. /**
  57. * 返回通知:
  58. * 1. 在目标方法正常结束之后执行
  59. * 1. 在返回通知中补充请求日志信息,如返回时间,方法耗时,返回值,并且保存日志信息
  60. *
  61. * @param ret
  62. * @throws Throwable
  63. */
  64. @AfterReturning(returning = "ret", pointcut = "webLogPointcut()")
  65. public void doAfterReturning(Object ret) throws Throwable {
  66. endTime = System.currentTimeMillis();
  67. log.info("请求结束时间:{}" + LocalDateTime.now());
  68. log.info("请求耗时:{}" + (endTime - startTime));
  69. // 处理完请求,返回内容
  70. log.info("请求返回 : {}" + ret);
  71. }
  72.  
  73. /**
  74. * 异常通知:
  75. * 1. 在目标方法非正常结束,发生异常或者抛出异常时执行
  76. * 1. 在异常通知中设置异常信息,并将其保存
  77. *
  78. * @param throwable
  79. */
  80. @AfterThrowing(value = "webLogPointcut()", throwing = "throwable")
  81. public void doAfterThrowing(Throwable throwable) {
  82. // 保存异常日志记录
  83. log.error("发生异常时间:{}" + LocalDateTime.now());
  84. log.error("抛出异常:{}" + throwable.getMessage());
  85. }
  86. }

2.3 编写测试

  1. @RestController
  2. @RequestMapping("/log")
  3. public class LogbackController {
  4.  
  5. /**
  6. * 测试正常请求
  7. * @param msg
  8. * @return
  9. */
  10. @GetMapping("/{msg}")
  11. public String getMsg(@PathVariable String msg) {
  12. return "request msg : " + msg;
  13. }
  14.  
  15. /**
  16. * 测试抛异常
  17. * @return
  18. */
  19. @GetMapping("/test")
  20. public String getException(){
  21. // 故意造出一个异常
  22. Integer.parseInt("abc123");
  23. return "success";
  24. }
  25. }

2.4 @Before和@AfterReturning部分也可使用以下代码替代

  1. /**
  2. * 在执行方法前后调用Advice,这是最常用的方法,相当于@Before和@AfterReturning全部做的事儿
  3. * @param pjp
  4. * @return
  5. * @throws Throwable
  6. */
  7. @Around("webLogPointcut()")
  8. public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
  9. // 接收到请求,记录请求内容
  10. ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  11. HttpServletRequest request = attributes.getRequest();
  12. //获取请求头中的User-Agent
  13. UserAgent userAgent = UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
  14. //打印请求的内容
  15. startTime = System.currentTimeMillis();
  16. log.info("请求Url : {}" , request.getRequestURL().toString());
  17. log.info("请求方式 : {}" , request.getMethod());
  18. log.info("请求ip : {}" , request.getRemoteAddr());
  19. log.info("请求方法 : " , pjp.getSignature().getDeclaringTypeName() , "." , pjp.getSignature().getName());
  20. log.info("请求参数 : {}" , Arrays.toString(pjp.getArgs()));
  21. // 系统信息
  22. log.info("浏览器:{}", userAgent.getBrowser().toString());
  23. log.info("浏览器版本:{}",userAgent.getBrowserVersion());
  24. log.info("操作系统: {}", userAgent.getOperatingSystem().toString());
  25. // pjp.proceed():当我们执行完切面代码之后,还有继续处理业务相关的代码。proceed()方法会继续执行业务代码,并且其返回值,就是业务处理完成之后的返回值。
  26. Object ret = pjp.proceed();
  27. log.info("请求结束时间:"+ LocalDateTime.now());
  28. log.info("请求耗时:{}" , (System.currentTimeMillis() - startTime));
  29. // 处理完请求,返回内容
  30. log.info("请求返回 : " , ret);
  31. return ret;
  32. }

三、 测试

3.1 请求入口LogbackController.java

  1. @RestController
  2. @RequestMapping("/log")
  3. public class LogbackController {
  4.  
  5. /**
  6. * 测试正常请求
  7. * @param msg
  8. * @return
  9. */
  10. @GetMapping("/normal/{msg}")
  11. public String getMsg(@PathVariable String msg) {
  12. return msg;
  13. }
  14.  
  15. /**
  16. * 测试抛异常
  17. * @return
  18. */
  19. @GetMapping("/exception/{msg}")
  20. public String getException(@PathVariable String msg){
  21. // 故意造出一个异常
  22. Integer.parseInt("abc123");
  23. return msg;
  24. }
  25. }

3.2 测试正常请求

打开浏览器,访问http://localhost:8082/log/normal/hello

日志打印如下:

[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [65] [INFO ] 请求开始时间:2019-02-24T22:37:50.892
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [66] [INFO ] 请求Url : http://localhost:8082/log/normal/hello
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [67] [INFO ] 请求方式 : GET
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [68] [INFO ] 请求ip : 0:0:0:0:0:0:0:1
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [69] [INFO ] 请求方法 :
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [70] [INFO ] 请求参数 : [hello]
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [72] [INFO ] 浏览器:CHROME
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [73] [INFO ] 浏览器版本:76.0.3809.100
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [74] [INFO ] 操作系统: MAC_OS_X
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [88] [INFO ] 请求结束时间:2019-02-24T22:37:50.901
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [89] [INFO ] 请求耗时:14
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [91] [INFO ] 请求返回 : hello

3.3 测试异常情况

访问:http://localhost:8082/log/exception/hello

[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [65] [INFO ] 请求开始时间:2019-02-24T22:39:57.728
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [66] [INFO ] 请求Url : http://localhost:8082/log/exception/hello
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [67] [INFO ] 请求方式 : GET
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [68] [INFO ] 请求ip : 0:0:0:0:0:0:0:1
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [69] [INFO ] 请求方法 :
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [70] [INFO ] 请求参数 : [hello]
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [72] [INFO ] 浏览器:CHROME
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [73] [INFO ] 浏览器版本:76.0.3809.100
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [74] [INFO ] 操作系统: MAC_OS_X
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [104] [ERROR] 发生异常时间:2019-02-24T22:39:57.731
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [105] [ERROR] 抛出异常:For input string: "abc123"
[2019-02-24 22:39:57.057] [org.apache.juli.logging.DirectJDKLog] [http-nio-8082-exec-9] [175] [ERROR] Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is java.lang.NumberFormatException: For input string: "abc123"] with root cause
java.lang.NumberFormatException: For input string: "abc123"

四、源码

4.1 示例代码

Github 示例代码

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对w3xue的支持。

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号