经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » Java相关 » Spring Boot » 查看文章
通过AOP拦截Spring Boot日志并将其存入数据库
来源:cnblogs  作者:华为云开发者联盟  时间:2023/8/29 14:47:33  对本文有异议

本文分享自华为云社区《Spring Boot入门(23):【实战】通过AOP拦截Spring Boot日志并将其存入数据库》,作者:bug菌。

前言

在软件开发中,常常需要记录系统运行时的日志。日志记录有助于排查系统问题、优化系统性能、监控操作行为等。本文将介绍如何使用Spring Boot和AOP技术实现拦截系统日志并保存到数据库中的功能。

摘要

本文将通过以下步骤实现拦截系统日志并保存到数据库中的功能:

  1. 配置数据库连接
  2. 定义日志实体类
  3. 定义日志拦截器
  4. 使用AOP拦截日志并保存到数据库中

AOP介绍

AOP,全称是Aspect Oriented Programming,即面向切面编程。AOP的目的是将那些与业务无关,但是业务模块都需要的功能,如日志统计、安全控制、事务处理等,封装成可重用的组件,从而将它们从业务逻辑代码中划分出来,编写成独立的切面。这样做,既可以保持业务逻辑的纯净和高内聚性,又可以使得系统的多个模块都可以共享这些公共的功能。

Spring框架提供了对AOP的支持,Spring Boot自然也不例外。使用Spring Boot的AOP功能,我们可以在运行时动态地将代码横向切入到各个关注点(方法或者类)中。这种横向切面的方式,比传统的纵向切面(继承)更加灵活。

AOP的实现

添加依赖

在pom.xml中添加以下依赖:

  1. <dependency>
  2.  
  3. <groupId>org.springframework.boot</groupId>
  4.  
  5. <artifactId>spring-boot-starter-aop</artifactId>
  6.  
  7. </dependency>
  8.  
  9. <dependency>
  10.  
  11. <groupId>org.mybatis.spring.boot</groupId>
  12.  
  13. <artifactId>mybatis-spring-boot-starter</artifactId>
  14.  
  15. </dependency>

这样我们就可以使用Spring Boot的AOP功能和MyBatis框架。

配置数据库连接

首先需要在Spring Boot项目的application.properties文件中配置数据库连接信息:

  1. spring.datasource.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=false
  2. spring.datasource.username=root
  3. spring.datasource.password=123456
  4. spring.datasource.driver-class-name=com.mysql.jdbc.Driver

或者你也可以使用YAML的配置格式:

cke_123.png

定义日志实体类

定义一个Log实体类用于保存日志信息,并使用@Entity和@Table注解指定对应的数据库表和字段:

  1. @Entity
  2. @Table(name = "sys_log")
  3. public class Log {
  4. @Id
  5. @GeneratedValue(strategy = GenerationType.IDENTITY)
  6. private Long id;
  7. private String username;
  8. private String operation;
  9. private String method;
  10. private String params;
  11. private String ip;
  12. private Date createTime;
  13. // 省略getter和setter方法
  14. }

定义日志拦截器

定义一个日志拦截器LogInterceptor,通过实现HandlerInterceptor接口来拦截请求并记录日志:

  1. @Component
  2. public class LogInterceptor implements HandlerInterceptor {
  3. @Autowired
  4. private LogRepository logRepository;
  5. @Override
  6. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  7. // 获取请求的IP地址
  8. String ip = getIpAddress(request);
  9. // 获取当前用户
  10. String username = getCurrentUsername();
  11. // 获取请求的方法名
  12. String method = request.getMethod();
  13. // 获取请求的URL
  14. String url = request.getRequestURI();
  15. // 获取请求的参数
  16. String params = getParams(request);
  17. // 创建日志实体
  18. Log log = new Log();
  19. log.setIp(ip);
  20. log.setMethod(method);
  21. log.setOperation("访问");
  22. log.setParams(params);
  23. log.setUsername(username);
  24. log.setCreateTime(new Date());
  25. // 保存日志到数据库中
  26. logRepository.save(log);
  27. return true;
  28. }
  29. // 省略实现HandlerInterceptor接口的其他方法
  30.  
  31. /**
  32. * 获取请求的IP地址
  33. */
  34.  
  35. private String getIpAddress(HttpServletRequest request) {
  36. String ip = request.getHeader("X-Forwarded-For");
  37. if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
  38. ip = request.getHeader("Proxy-Client-IP");
  39. }
  40. if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
  41. ip = request.getHeader("WL-Proxy-Client-IP");
  42. }
  43. if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
  44. ip = request.getHeader("HTTP_CLIENT_IP");
  45. }
  46. if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
  47. ip = request.getHeader("HTTP_X_FORWARDED_FOR");
  48. }
  49. if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
  50. ip = request.getRemoteAddr();
  51. }
  52. return ip;
  53. }
  54. /**
  55. * 获取当前用户
  56. */
  57.  
  58. private String getCurrentUsername() {
  59. Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
  60. if (authentication != null) {
  61. return authentication.getName();
  62. }
  63. return null;
  64. }
  65. /**
  66. * 获取请求的参数
  67. */
  68.  
  69. private String getParams(HttpServletRequest request) {
  70. Map<String, String[]> parameterMap = request.getParameterMap();
  71. if (parameterMap == null || parameterMap.isEmpty()) {
  72. return null;
  73. }
  74. StringBuilder sb = new StringBuilder();
  75. for (Map.Entry<String, String[]> entry : parameterMap.entrySet()) {
  76. sb.append(entry.getKey()).append("=").append(Arrays.toString(entry.getValue())).append("&");
  77. }
  78. return sb.toString();
  79. }
  80. }

使用AOP拦截日志并保存到数据库中

使用AOP技术拦截所有Controller类中的方法,并执行LogInterceptor中的preHandle方法,记录日志并保存到数据库中。

定义一个LogAspect切面类,通过实现@Aspect注解和@Before注解来实现方法拦截:

  1. @Aspect
  2. @Component
  3. public class LogAspect {
  4. @Autowired
  5. private LogInterceptor logInterceptor;
  6. @Pointcut("execution(public * com.example.demo.controller..*.*(..))")
  7. public void logAspect() {}
  8. @Before("logAspect()")
  9. public void doBefore(JoinPoint joinPoint) {
  10. ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  11. if (attributes == null) {
  12. return;
  13. }
  14. HttpServletRequest request = attributes.getRequest();
  15. HttpServletResponse response = attributes.getResponse();
  16. HandlerMethod handlerMethod = (HandlerMethod) joinPoint.getSignature();
  17. try {
  18. logInterceptor.preHandle(request, response, handlerMethod);
  19. } catch (Exception e) {
  20. e.printStackTrace();
  21. }
  22. }
  23. }

代码方法介绍

  • LogInterceptor.preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)方法:拦截请求并记录日志的方法。
  • LogInterceptor.getIpAddress(HttpServletRequest request)方法:获取请求的IP地址。
  • LogInterceptor.getCurrentUsername()方法:获取当前用户。
  • LogInterceptor.getParams(HttpServletRequest request)方法:获取请求的参数。
  • LogAspect.logAspect()方法:定义AOP切入点,拦截Controller类中的所有方法。
  • LogAspect.doBefore(JoinPoint joinPoint)方法:执行方法拦截操作,并调用LogInterceptor.preHandle方法来记录日志。

测试用例

可以使用Postman等工具发起请求来测试拦截器是否生效,并查看数据库中是否保存了对应的日志信息。这里就不直接演示了,毕竟使用起来非常的简单易上手。

全文小结

本文介绍了如何使用Spring Boot和AOP技术实现拦截系统日志并保存到数据库中的功能,包括配置数据库连接、定义日志实体类、定义日志拦截器、使用AOP拦截日志并保存到数据库中等步骤。通过本文的介绍,可以更好地理解Spring Boot和AOP的应用,为开发高效、稳定的系统提供参考。

注:

环境说明:Windows10 + Idea2021.3.2 + Jdk1.8 + SpringBoot 2.3.1.RELEASE

 

点击关注,第一时间了解华为云新鲜技术~

 

原文链接:https://www.cnblogs.com/huaweiyun/p/17664738.html

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

本站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号