通过AOP拦截Spring Boot日志并将其存入数据库

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

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

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

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

AOP介绍

AOP，全称是Aspect Oriented Programming，即面向切面编程。AOP的目的是将那些与业务无关，但是业务模块都需要的功能，如日志统计、安全控制、事务处理等，封装成可重用的组件，从而将它们从业务逻辑代码中划分出来，编写成独立的切面。这样做，既可以保持业务逻辑的纯净和高内聚性，又可以使得系统的多个模块都可以共享这些公共的功能。
Spring框架提供了对AOP的支持，Spring Boot自然也不例外。使用Spring Boot的AOP功能，我们可以在运行时动态地将代码横向切入到各个关注点（方法或者类）中。这种横向切面的方式，比传统的纵向切面（继承）更加灵活。
AOP的实现

添加依赖

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

1. <dependency>
3. <groupId>org.springframework.boot</groupId>
5. <artifactId>spring-boot-starter-aop</artifactId>
7. </dependency>
9. <dependency>
11. <groupId>org.mybatis.spring.boot</groupId>
13. <artifactId>mybatis-spring-boot-starter</artifactId>
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
3. spring.datasource.username=root
5. spring.datasource.password=123456
7. spring.datasource.driver-class-name=com.mysql.jdbc.Driver

复制代码

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

定义日志实体类

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

1. @Entity
3. @Table(name = "sys_log")
5. public class Log {
7. @Id
9. @GeneratedValue(strategy = GenerationType.IDENTITY)
11. private Long id;
13. private String username;
15. private String operation;
17. private String method;
19. private String params;
21. private String ip;
23. private Date createTime;
25. // 省略getter和setter方法
27. }

复制代码

定义日志拦截器

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

1. @Component
3. public class LogInterceptor implements HandlerInterceptor {
5. @Autowired
7. private LogRepository logRepository;
9. @Override
11. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
13. // 获取请求的IP地址
15. String ip = getIpAddress(request);
17. // 获取当前用户
19. String username = getCurrentUsername();
21. // 获取请求的方法名
23. String method = request.getMethod();
25. // 获取请求的URL
27. String url = request.getRequestURI();
29. // 获取请求的参数
31. String params = getParams(request);
33. // 创建日志实体
35. Log log = new Log();
37. log.setIp(ip);
39. log.setMethod(method);
41. log.setOperation("访问");
43. log.setParams(params);
45. log.setUsername(username);
47. log.setCreateTime(new Date());
49. // 保存日志到数据库中
51. logRepository.save(log);
55. return true;
57. }
59. // 省略实现HandlerInterceptor接口的其他方法
61. /**
63. * 获取请求的IP地址
65. */
67. private String getIpAddress(HttpServletRequest request) {
69. String ip = request.getHeader("X-Forwarded-For");
71. if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
73. ip = request.getHeader("Proxy-Client-IP");
75. }
77. if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
79. ip = request.getHeader("WL-Proxy-Client-IP");
81. }
83. if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
85. ip = request.getHeader("HTTP_CLIENT_IP");
87. }
89. if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
91. ip = request.getHeader("HTTP_X_FORWARDED_FOR");
93. }
95. if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
97. ip = request.getRemoteAddr();
99. }
101. return ip;
103. }
105. /**
107. * 获取当前用户
109. */
111. private String getCurrentUsername() {
113. Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
115. if (authentication != null) {
117. return authentication.getName();
119. }
121. return null;
123. }
125. /**
127. * 获取请求的参数
129. */
131. private String getParams(HttpServletRequest request) {
133. Map<String, String[]> parameterMap = request.getParameterMap();
135. if (parameterMap == null || parameterMap.isEmpty()) {
137. return null;
139. }
141. StringBuilder sb = new StringBuilder();
143. for (Map.Entry<String, String[]> entry : parameterMap.entrySet()) {
145. sb.append(entry.getKey()).append("=").append(Arrays.toString(entry.getValue())).append("&");
147. }
149. return sb.toString();
151. }
153. }

复制代码

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

使用AOP技术拦截所有Controller类中的方法，并执行LogInterceptor中的preHandle方法，记录日志并保存到数据库中。
定义一个LogAspect切面类，通过实现@Aspect注解和@Before注解来实现方法拦截：

1. @Aspect
3. @Component
5. public class LogAspect {
7. @Autowired
9. private LogInterceptor logInterceptor;
11. @Pointcut("execution(public * com.example.demo.controller..*.*(..))")
13. public void logAspect() {}
15. @Before("logAspect()")
17. public void doBefore(JoinPoint joinPoint) {
19. ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
21. if (attributes == null) {
23. return;
25. }
27. HttpServletRequest request = attributes.getRequest();
29. HttpServletResponse response = attributes.getResponse();
31. HandlerMethod handlerMethod = (HandlerMethod) joinPoint.getSignature();
33. try {
35. logInterceptor.preHandle(request, response, handlerMethod);
37. } catch (Exception e) {
39. e.printStackTrace();
41. }
43. }
45. }

复制代码

代码方法介绍

• 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
 
点击关注，第一时间了解华为云新鲜技术~
 

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！