经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » Java相关 » Spring » 查看文章
在springboot中使用AOP进行全局日志记录
来源:jb51  时间:2021/11/24 11:07:34  对本文有异议

前言

此前项目上需要对用户的操作进行日志记录,以便后续追踪问题,所以就学习了使用 spring AOP 来进行日志记录。

1、 spring AOP 是什么?

spring 的两大核心就是 IOC 和 AOP,AOP 是 spring 框架面向切面的编程思想,AOP是横切性的技术,将涉及多业务流程的通用功能抽取并单独封装,形成独立的切面,再将这些切面横向切入到业务流程指定的位置中。

2、spring AOP 能做什么?

AOP 主要是从切面入手,将日志记录、安全控制、事务处理、全局异常处理等全局功能从我们的业务逻辑代码中划分出来。

3、spring AOP 我能用 AOP 解决什么问题?

正好我这边需要做一个全局的日志,如果每个方法都去写日志记录,这样代码量非常大,而且代码繁琐冗余,全局记录的话,只需要在方法上增加一个注解就可以实现日志记录。

好了,不多bb,直接上代码实现

一、引入依赖,增加自定义注解

1、引入 maven 依赖

  1. <!--利用 AOP 做操作日志记录-->
  2. <dependency>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-starter-aop</artifactId>
  5. </dependency>

2、增加自定义注解 OperationLog

  1. @Target(ElementType.METHOD) //注解放置的目标位置,METHOD是可注解在方法级别上
  2. @Retention(RetentionPolicy.RUNTIME) //注解执行阶段
  3. @Documented
  4. public @interface OperationLog {
  5. String operDesc() default ""; // 操作说明
  6. }

二、为自定义注解编写切面实现

  1. @Aspect //标识一个切面类
  2. @Component
  3. public class OperationLogAspect {
  4. private static final Logger logger = LoggerFactory.getLogger(OperationLogAspect.class);
  5. @Autowired
  6. private OperatelogsService OperatelogsService;
  7. @Autowired
  8. private SysUserService userService;
  9. /**
  10. * 设置操作日志切入点 记录操作日志 在注解的位置切入代码
  11. */
  12. @Pointcut("@annotation(com.wxw.annotation.OperationLog)")
  13. public void operLogPoinCut() {
  14. }
  15. /**
  16. * 正常返回通知,拦截用户操作日志,连接点正常执行完成后执行, 如果连接点抛出异常,则不会执行
  17. *
  18. * @param joinPoint 切入点
  19. * @param keys 返回结果
  20. */
  21. @AfterReturning(value = "operLogPoinCut()", returning = "keys")
  22. public void saveOperLog(JoinPoint joinPoint, Object keys) {
  23. // 获取RequestAttributes
  24. RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
  25. // 从获取RequestAttributes中获取HttpServletRequest的信息
  26. HttpServletRequest request = (HttpServletRequest) requestAttributes
  27. .resolveReference(RequestAttributes.REFERENCE_REQUEST);
  28. Operatelogs operlog = new Operatelogs();
  29. try {
  30. // 从切面织入点处通过反射机制获取织入点处的方法
  31. MethodSignature signature = (MethodSignature) joinPoint.getSignature();
  32. // 获取切入点所在的方法
  33. Method method = signature.getMethod();
  34. // 获取操作
  35. OperationLog opLog = method.getAnnotation(OperationLog.class);
  36. if (opLog != null) {
  37. String operDesc = opLog.operDesc();
  38. operlog.setfDescript(operDesc); // 操作描述
  39. }
  40. // 获取请求的类名
  41. String className = joinPoint.getTarget().getClass().getName();
  42. // 获取请求的方法名
  43. String methodName = method.getName();
  44. methodName = className + "." + methodName;
  45. operlog.setfRequestMethod(methodName); // 请求方法
  46. // 请求的参数
  47. Object[] arguments = joinPoint.getArgs();
  48. //判断参数数组是否为空
  49. Stream<?> stream = ArrayUtils.isEmpty(arguments) ? Stream.empty() : Arrays.asList(arguments).stream();
  50. //过滤 joinPoint.getArgs()返回的数组中携带有Request或者Response对象
  51. List<Object> logArgs = stream
  52. .filter(arg -> (!(arg instanceof HttpServletRequest) && !(arg instanceof HttpServletResponse)))
  53. .collect(Collectors.toList());
  54. // 先将参数所在的list 转换成json 数组
  55. JSONArray jsonArray = JSONArray.parseArray(JSON.toJSONString(logArgs));
  56. //再转 json 字符串
  57. String params = jsonArray.toJSONString();
  58. operlog.setfRequestData(params); // 请求参数
  59. operlog.setfResponseData(JSON.toJSONString(keys)); // 返回结果
  60. SysUser user = getUser();
  61. operlog.setfOptby(user != null ? user.getfUserid() : 0); // 请求用户ID
  62. operlog.setfOptname(user != null ? user.getfUsercode() : "admin"); // 请求用户名称
  63. operlog.setfOpton(new Date()); // 创建时间
  64. operlog.setfIp(getIp()); // 请求IP
  65. operlog.setfRequestUrl(request.getRequestURI()); // 请求URI
  66. OperatelogsService.save(operlog);
  67. } catch (Exception e) {
  68. e.printStackTrace();
  69. }
  70. }
  71. /**
  72. * 异常返回通知,用于拦截异常日志信息 连接点抛出异常后执行
  73. *
  74. * @param joinPoint 切入点
  75. * @param e 异常信息
  76. */
  77. @AfterThrowing(pointcut = "operLogPoinCut()", throwing = "e")
  78. public void saveExceptionLog(JoinPoint joinPoint, Throwable e) {
  79. // 获取RequestAttributes
  80. RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
  81. // 从获取RequestAttributes中获取HttpServletRequest的信息
  82. HttpServletRequest request = (HttpServletRequest) requestAttributes
  83. .resolveReference(RequestAttributes.REFERENCE_REQUEST);
  84. Operatelogs operlog = new Operatelogs();
  85. try {
  86. // 从切面织入点处通过反射机制获取织入点处的方法
  87. MethodSignature signature = (MethodSignature) joinPoint.getSignature();
  88. // 获取切入点所在的方法
  89. Method method = signature.getMethod();
  90. // 获取请求的类名
  91. String className = joinPoint.getTarget().getClass().getName();
  92. // 获取请求的方法名
  93. String methodName = method.getName();
  94. methodName = className + "." + methodName;
  95. // 请求的参数
  96. Object[] arguments = joinPoint.getArgs();
  97. //判断参数数组是否为空
  98. Stream<?> stream = ArrayUtils.isEmpty(arguments) ? Stream.empty() : Arrays.asList(arguments).stream();
  99. //过滤 joinPoint.getArgs()返回的数组中携带有Request或者Response对象
  100. List<Object> logArgs = stream
  101. .filter(arg -> (!(arg instanceof HttpServletRequest) && !(arg instanceof HttpServletResponse)))
  102. .collect(Collectors.toList());
  103. // 先将参数所在的list 转换成json 数组
  104. JSONArray jsonArray = JSONArray.parseArray(JSON.toJSONString(logArgs));
  105. //再转 json 字符串
  106. String params = jsonArray.toJSONString();
  107. operlog.setfRequestData(params); // 请求参数
  108. operlog.setfRequestMethod(methodName); // 请求方法名
  109. operlog.setfExceptionName(e.getClass().getName()); // 异常名称
  110. operlog.setfResponseData(stackTraceToString(e.getClass().getName(), e.getMessage(), e.getStackTrace())); // 异常信息
  111. SysUser user = getUser();
  112. operlog.setfOptby(user != null ? user.getfUserid() : 0); // 请求用户ID
  113. operlog.setfOptname(user != null ? user.getfUsercode() : "admin"); // 请求用户名称
  114. operlog.setfOpton(new Date()); // 创建时间
  115. operlog.setfRequestUrl(request.getRequestURI()); // 请求URI
  116. operlog.setfIp(getIp()); // 请求IP
  117. operatelogsService.save(operlog);
  118. } catch (Exception e2) {
  119. e2.printStackTrace();
  120. }
  121. }
  122. /**
  123. * 获取用户信息,由于我这边 token 是使用 jwt 生成,所以可以从中获取用户id,再根据id获取用户数据
  124. *
  125. * @return
  126. */
  127. public SysUser getUser() {
  128. HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
  129. SysUser sysUser = null;
  130. String token = request.getHeader("token");// 从 http 请求头中取出 token
  131. if(token != null){
  132. // 获取 token 中的 user id
  133. String userId = JWT.decode(token).getAudience().get(0);
  134. sysUser = userService.getOne(new QueryWrapper<SysUser>().lambda().eq(SysUser::getfUserid,
  135. userId));
  136. }
  137. return sysUser;
  138. }
  139. /**
  140. * 获取ip
  141. *
  142. * @return
  143. */
  144. public String getIp() {
  145. //获得本机的ip和名称
  146. InetAddress addr = null;
  147. try {
  148. addr = InetAddress.getLocalHost();
  149. } catch (UnknownHostException e) {
  150. throw new CustomException(500,e.getMessage());
  151. }
  152. String ip = addr.getHostAddress();
  153. // String hostname = addr.getHostName();
  154. return ip;
  155. }
  156. /**
  157. * 转换异常信息为字符串
  158. *
  159. * @param exceptionName 异常名称
  160. * @param exceptionMessage 异常信息
  161. * @param elements 堆栈信息
  162. */
  163. public String stackTraceToString(String exceptionName, String exceptionMessage, StackTraceElement[] elements) {
  164. StringBuffer strbuff = new StringBuffer();
  165. for (StackTraceElement stet : elements) {
  166. strbuff.append(stet + "\n");
  167. }
  168. String message = exceptionName + ":" + exceptionMessage + "\n\t" + strbuff.toString();
  169. return message;
  170. }
  171. }

三、使用自定义日志注解

在这里插入图片描述

将自定义注解加在方法上,请求方法之后,就可以将方法的日志记录到自己的数据库里面了。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持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号