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

 更新时间:2023年08月30日 08:30:20   作者:华为云开发者联盟  
本文介绍了如何使用Spring Boot和AOP技术实现拦截系统日志并保存到数据库中的功能,包括配置数据库连接、定义日志实体类、定义日志拦截器、使用AOP拦截日志并保存到数据库中等步骤,感兴趣的朋友一起看看吧

本文将介绍如何使用Spring Boot和AOP技术实现拦截系统日志并保存到数据库中的功能。

本文分享自华为云社区《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中添加以下依赖:

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
</dependency>

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

配置数据库连接

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

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

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

定义日志实体类

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

@Entity
@Table(name = "sys_log")
public class Log {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
private String username;
private String operation;
private String method;
private String params;
private String ip;
private Date createTime;
// 省略getter和setter方法
}

定义日志拦截器

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

@Component
public class LogInterceptor implements HandlerInterceptor {
@Autowired
private LogRepository logRepository;
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
// 获取请求的IP地址
String ip = getIpAddress(request);
// 获取当前用户
String username = getCurrentUsername();
// 获取请求的方法名
String method = request.getMethod();
// 获取请求的URL
String url = request.getRequestURI();
// 获取请求的参数
String params = getParams(request);
// 创建日志实体
Log log = new Log();
log.setIp(ip);
log.setMethod(method);
log.setOperation("访问");
log.setParams(params);
log.setUsername(username);
log.setCreateTime(new Date());
// 保存日志到数据库中
logRepository.save(log);
return true;
}
// 省略实现HandlerInterceptor接口的其他方法
/**
* 获取请求的IP地址
*/
private String getIpAddress(HttpServletRequest request) {
String ip = request.getHeader("X-Forwarded-For");
if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
ip = request.getHeader("Proxy-Client-IP");
}
if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
ip = request.getHeader("WL-Proxy-Client-IP");
}
if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
ip = request.getHeader("HTTP_CLIENT_IP");
}
if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
ip = request.getHeader("HTTP_X_FORWARDED_FOR");
}
if (StringUtils.isBlank(ip) || "unknown".equalsIgnoreCase(ip)) {
ip = request.getRemoteAddr();
}
return ip;
}
/**
* 获取当前用户
*/
private String getCurrentUsername() {
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
if (authentication != null) {
return authentication.getName();
}
return null;
}
/**
* 获取请求的参数
*/
private String getParams(HttpServletRequest request) {
Map<String, String[]> parameterMap = request.getParameterMap();
if (parameterMap == null || parameterMap.isEmpty()) {
return null;
}
StringBuilder sb = new StringBuilder();
for (Map.Entry<String, String[]> entry : parameterMap.entrySet()) {
sb.append(entry.getKey()).append("=").append(Arrays.toString(entry.getValue())).append("&");
}
return sb.toString();
}
}

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

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

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

@Aspect
@Component
public class LogAspect {
@Autowired
private LogInterceptor logInterceptor;
@Pointcut("execution(public * com.example.demo.controller..*.*(..))")
public void logAspect() {}
@Before("logAspect()")
public void doBefore(JoinPoint joinPoint) {
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
if (attributes == null) {
return;
}
HttpServletRequest request = attributes.getRequest();
HttpServletResponse response = attributes.getResponse();
HandlerMethod handlerMethod = (HandlerMethod) joinPoint.getSignature();
try {
logInterceptor.preHandle(request, response, handlerMethod);
} catch (Exception e) {
e.printStackTrace();
}
}
}

代码方法介绍

  • 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

到此这篇关于通过AOP拦截Spring Boot日志并将其存入数据库的文章就介绍到这了,更多相关AOP拦截Spring Boot日志内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring Boot 中使用cache缓存的方法

    Spring Boot 中使用cache缓存的方法

    Spring Cache是Spring针对Spring应用,给出的一整套应用缓存解决方案。下面小编给大家带来了Spring Boot 中使用cache缓存的方法,感兴趣的朋友参考下吧
    2018-01-01
  • springBoot server.port=-1的含义说明

    springBoot server.port=-1的含义说明

    这篇文章主要介绍了springBoot server.port=-1的含义说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • java 中动态代理(JDK,cglib)实例代码

    java 中动态代理(JDK,cglib)实例代码

    这篇文章主要介绍了java 中动态代理,这里介绍了JDK 动态代理与 cglib 动态代理的相关资料
    2017-04-04
  • Java中的事件处理机制详解

    Java中的事件处理机制详解

    这篇文章主要介绍了Java中的事件处理机制详解,Java事件处理是采取"委派事件模型",当事件发生时,产生事件的对象,会把此"信息"传递给"事件的监听者"处理,这里所说的"信息"实际上就是java.awt.event事件类库里某个类创建对象,需要的朋友可以参考下
    2023-09-09
  • Java之Spring整合Junit

    Java之Spring整合Junit

    Java Spring框架是一个轻量级的开源框架,具有很高的凝聚力和吸引力,本篇文章带你了解如何配置数据源、注解开发以及整合Junit
    2023-04-04
  • JAVA 创建线程池的注意事项

    JAVA 创建线程池的注意事项

    这篇文章主要介绍了JAVA 创建线程池的注意事项,文中讲解非常细致,代码帮助大家更好的理解和学习,感兴趣的朋友可以了解下
    2020-07-07
  • Java Web开发常用框架Spring MVC Struts示例解析

    Java Web开发常用框架Spring MVC Struts示例解析

    这篇文章主要为大家介绍了Java Web开发常用框架Spring MVC Struts示例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-06-06
  • Java绘图技术基础(实例讲解)

    Java绘图技术基础(实例讲解)

    下面小编就为大家带来一篇Java绘图技术基础(实例讲解)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08
  • Java Web实现简易图书管理系统

    Java Web实现简易图书管理系统

    这篇文章主要为大家详细介绍了Java Web实现简易图书管理系统,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-09-09
  • java数据结构-堆实现优先队列

    java数据结构-堆实现优先队列

    通常都把队列比喻成排队买东西,大家都很守秩序,先排队的人就先买东西。但是优先队列有所不同,它不遵循先进先出的规则,而是根据队列中元素的优先权,优先权最大的先被取出,这篇文章主要介绍了java数据结构-堆实现优先队列,感兴趣的朋友一起看看吧
    2021-08-08

最新评论