通过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中添加以下依赖:
<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
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
Karmada 结合 coreDNS 插件实现跨集群统一域名访问
本文分享自华为云社区《Karmada 结合 coreDNS 插件实现跨集群统一域名访问》,作者:云容器大未来 。 在多云与混合云越来越成为企业标配的今天,服务的部署和访问往往不在一个 K8s集群中。如何做到服务访问与集群无关,成为了各个云服务提供商必须要面对的问题。本文基于Karmada v1.6.1版本,探索使用一致域名跨集群访问服务的方法,来解决该问题。 一、实践官方例子 按照官网例子(配置多集群服务发现)【1】,详细操作如下: 1. 部署业务 以部署 deployment 与service为例。在控制平面创建 deployment 和 service 并通过 PropagationPolicy 发到集群 member1 中。该步骤合并的 yaml 如下: apiVersion: apps/v1 kind: Deployment metadata: name: serve spec: replicas: 2 selector: matchLabels: app: serve template: metadata: labels: app: serve s...
- 下一篇
GaussDB技术解读:应用无损透明(ALT)
本文分享自华为云社区《DTCC 2023专家解读丨GaussDB技术解读系列之应用无损透明(ALT)》,作者: GaussDB 数据库。 近日,在第14届中国数据库技术大会(DTCC 2023)的GaussDB“五高两易”核心技术,给世界一个更优选择专场,华为云数据库技术专家徐宜良分享了《GaussDB高可用之应用无损透明》主题演讲,介绍了华为云GaussDB高可用方面的最新成果。 以下为演讲实录: 大家下午好!下面由我来为大家介绍GaussDB高可用之应用无损透明特性。 一、GaussDB应用无损透明特性简介 我们知道用户在使用数据库在线业务系统时,如果数据库服务端发生了维护操作,比如说重启或者主备切换,或者发生故障时,应用程序会感应到数据库之间的连接发生中断,一些执行的事务会被自动回滚掉。当数据服务恢复之后,应用程序需要重建连接,根据业务逻辑重试,这样对业务来说不仅增加了业务系统的开发复杂性,也增加业务运行风险。 我们知道数据库发生异常时,我们无法判断正在执行的事务是否提交完成。为了解决连接中断和事务自动回滚的问题,华为云GaussDB数据库提供了应用无损透明的高可用能力,通过这个...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- 2048小游戏-低调大师作品
- Windows10,CentOS7,CentOS8安装Nodejs环境
- Hadoop3单机部署,实现最简伪集群
- SpringBoot2初体验,简单认识spring boot2并且搭建基础工程
- CentOS8编译安装MySQL8.0.19
- CentOS7,CentOS8安装Elasticsearch6.8.6
- CentOS7编译安装Gcc9.2.0,解决mysql等软件编译问题
- SpringBoot2配置默认Tomcat设置,开启更多高级功能
- SpringBoot2更换Tomcat为Jetty,小型站点的福音
- CentOS7编译安装Cmake3.16.3,解决mysql等软件编译问题