从零开始实现放置游戏(五)——实现后台管理系统(3)实现切面日志

简介:  上一章,我们初步实现了后台管理系统的增删查改功能。然而还有很多功能不完善。这一章,我们先把系统日志搭建起来,不管是生产问题排查,还是方便开发调试,日志都是必不可少的核心功能。所谓切面日志,比如说,我们想把每个方法的入参都记录日志,那需要在每个方法里都写一行记录参数的语句,非常繁琐。所以需要提取出切面“方法执行前”,“方法执行后”等等,然后在这个切面里进行编程,记录入参的语句只需要写一次。

上一章,我们初步实现了后台管理系统的增删查改功能。然而还有很多功能不完善。这一章,我们先把系统日志搭建起来,不管是生产问题排查,还是方便开发调试,日志都是必不可少的核心功能。所谓切面日志,比如说,我们想把每个方法的入参都记录日志,那需要在每个方法里都写一行记录参数的语句,非常繁琐。所以需要提取出切面“方法执行前”,“方法执行后”等等,然后在这个切面里进行编程,记录入参的语句只需要写一次。整体的流程大致如下图:


502227-20190620170524591-709485307.png 


这里我们以rms模块为例,其他模块需要记录日志的地方参照本模块即可。


一、引入依赖


  java里,日志的实现一般是common-logging+log4j2或slf4j+logback,其中common-logging和slf4j是接口定义,log4j2和logback是具体实现。这里我们使用log4j,common-logging在其他包中已经间接引用了,无需重复添加,在pom中添加log4j的依赖即可(这里版本是2.11.2,也称log4j2,和1.x版本的区别较大,配置不通用,在网上学习时需注意):


<!-- 日志相关 -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.11.2</version>
</dependency>


二、添加配置文件


  在"/resources/"资源文件目录下新建"log4j2.xml",这是log4j的默认配置路径和文件名。


 log4j2.xml


在这个配置文件中,我们定义了日志存放路径"/logs/idlewow-rms/",windows下默认D盘。控制台的日志输出格式,以及3个级别INFO, WARN, ERROR的文件输出方式。同时把spring组件的日志级别提高到info,过滤掉debug信息。


  以info级别的日志为例,我们定义了日志的输出格式"[时间] [日志级别] [线程名称][SessionId][文件名称 - 代码行数] - 日志信息。日志的滚动策略,按天滚动,每1天生成1个日志文件,或大于20MB时,生成一个日志文件。


三、日志打印SessionId


  上面的配置中,我们定义了日志需要打印Sessionid,主要是方便精准定位问题。但log4j默认不支持此功能,需要我们单独实现一个Filter,在请求进来时,获取sessionId,并存到log4j的上下文中。


 LogSessionFilter.java


  Filter是servlet相关的机制,因此需要在web.xml文件中添加以下配置:


<!-- log4j记录session -->
<filter>
    <filter-name>logSessionFilter</filter-name>
    <filter-class>com.idlewow.rms.filter.LogSessionFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>logSessionFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>


四、具体使用


  配置全部完成,在我们想要使用log4j打印日志时,需要先获取一个logger,一般我们在contoller里声明一个final的成员变量,如下:


  private final Logger logger = LogManager.getLogger(this.getClass().getName());


  然后,在各个方法中,想记录日志时,只需像下面这样,即可打印对应级别的日志,


logger.info("hello world");
logger.warn("hello world");
logger.error("hello world");


 通常,在打印异常时,还会打印堆栈信息,方便定位问题,如下(在第一个参数传入异常信息,第二个参数传入异常对象):


logger.error(ex.getMessage(), ex);


五、切面日志的实现


  上面的日志功能,已经能让我们在程序中随时记录日志,下面我们实现切面日志的功能。这里需要依赖的两个包,spring-aop和aspectjweaver,前面我们已经引用过了。


  然后,我们需要一个类,定义切点、切面方法。新建一个包com.idlewow.rms.config,在此包下新建类LogAspect,代码如下:


LogAspect.java


这里我们定义了2个切点,commonPoint表示controller包下的所有public方法,returnPoint表示所有打了LogResult注解的方法(这是我们自定义的一个注解)。


  然后实现了4个切面方法,目前对应的都是commonPoint切点。


  其中,before在每次方法执行前都会执行,我们在这个方法里打印info级别的日志,记录请求URL、IP、入参等信息,同时记录请求起始时间,并分配一个trackId用来定位问题(假如同一个用户瞬间执行某个请求N次,SessionId都是相同的,我们就无法确定这N次中,每个返回数据对应的到底是哪次请求);


     after在每次方法之后后都会执行,我们在这个方法里记录每次请求耗时;


     afterThrowing在抛出异常时才会执行,我们在这个方法里打印error级别的日志;


     afterReturn是在方法正常返回时执行,我们在这个方法里打印返回结果。这里这个方法我们对应的是commonPoint切点,即所有方法都会打印返回结果,在实际应用时,可视情况改为对应returnPoint切点,这样只有加了@LogReuslt注解的方法,才会打印返回结果。


  最后,需要在spring的配置文件中,添加一行配置:


<aop:aspectj-autoproxy proxy-target-class="true"></aop:aspectj-autoproxy>


 注意:这句话应该配置在spring-mvc.xml中扫描完controller包之后。因为我们这里拦截的是controller的方法,在applicationContext中,我们还没有扫描controller类。这里老手对java web, spring框架中各部分的执行顺序了解,更容易理解。新手照着配即可,做多了自然就懂了。


六、运行效果


  至此,日志功能已经实现,我们运行一下看下效果:


502227-20190620181754079-1085262034.png


注意:添加log4j2依赖后,通过maven插件启动时,会有红字提示 :严重: Unable to process Jar entry [META-INF/versions/9/module-info.class] from Jar [jar:file:/D:/apache-maven-3.6.1/package/org/apache/logging/log4j/log4j-api/2.11.2/log4j-api-2.11.2.jar!/] for annotations。这是因为maven插件内置的tomcat7.0.47版本过低,但不影响程序正常运行。


maven插件不能修改tomcat版本,而且13年后就停止更新了。目前,如果因为tomcat版本低等问题导致有错误提示,可以直接下载一个新版本的tomcat,比如前言章节中的7.0.85,使用IDE集成的tomcat启动方式启动,就不会报错了。


小结


  本章实现了系统日志的搭建,为我们以后开发调试时快速定位问题打好基础。

相关实践学习
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
相关文章
WGLOG日志管理系统是怎么收集日志的
WGLOG通过部署Agent客户端采集日志,Agent持续收集指定日志文件并上报Server,Server负责展示与分析。Agent与Server需保持相同版本。官网下载地址:www.wgstart.com
|
Prometheus 监控 Cloud Native
基于docker搭建监控系统&日志收集
Prometheus 是一款由 SoundCloud 开发的开源监控报警系统及时序数据库(TSDB),支持多维数据模型和灵活查询语言,适用于大规模集群监控。它通过 HTTP 拉取数据,支持服务发现、多种图表展示(如 Grafana),并可结合 Loki 实现日志聚合。本文介绍其架构、部署及与 Docker 集成的监控方案。
1064 122
基于docker搭建监控系统&日志收集
|
监控 API 开发工具
HarmonyOS Next的HiLog日志系统完全指南:从入门到精通
本文深入解析HarmonyOS Next的HiLog日志系统,涵盖日志级别、核心API、隐私保护与高级回调功能,助你从入门到精通掌握这一重要开发工具。
1023 1
|
存储 前端开发 数据可视化
Grafana Loki,轻量级日志系统
本文介绍了基于Grafana、Loki和Alloy构建的轻量级日志系统。Loki是一个由Grafana Labs开发的日志聚合系统,具备高可用性和多租户支持,专注于日志而非指标,通过标签索引而非内容索引实现高效存储。Alloy则是用于收集和转发日志至Loki的强大工具。文章详细描述了系统的架构、组件及其工作流程,并提供了快速搭建指南,包括准备步骤、部署命令及验证方法。此外,还展示了如何使用Grafana查看日志,以及一些基本的LogQL查询示例。最后,作者探讨了Loki架构的独特之处,提出了“巨型单体模块化”的概念,即一个应用既可单体部署也可分布式部署,整体协同实现全部功能。
6821 189
Grafana Loki,轻量级日志系统
|
Ubuntu
在Ubuntu系统上设置syslog日志轮替与大小限制
请注意,在修改任何系统级别配置之前,请务必备份相应得原始档案并理解每项变更可能带来得影响。
1334 2
|
存储 消息中间件 缓存
MiniMax GenAI 可观测性分析 :基于阿里云 SelectDB 构建 PB 级别日志系统
基于阿里云SelectDB,MiniMax构建了覆盖国内及海外业务的日志可观测中台,总体数据规模超过数PB,日均新增日志写入量达数百TB。系统在P95分位查询场景下的响应时间小于3秒,峰值时刻实现了超过10GB/s的读写吞吐。通过存算分离、高压缩比算法和单副本热缓存等技术手段,MiniMax在优化性能的同时显著降低了建设成本,计算资源用量降低40%,热数据存储用量降低50%,为未来业务的高速发展和技术演进奠定了坚实基础。
841 1
MiniMax GenAI 可观测性分析 :基于阿里云 SelectDB 构建 PB 级别日志系统
WGLOG日志管理系统可以采集网络设备的日志吗
WGLOG日志审计系统提供开放接口,支持外部获取日志内容后发送至该接口,实现日志的存储与分析。详情请访问:https://www.wgstart.com/wglog/docs9.html
|
存储 JSON Go
PHP 日志系统的最佳搭档:一个 Go 写的远程日志收集服务
为了不再 SSH 上去翻日志,我写了个 Go 小脚本,用来接收远程日志。PHP 负责记录日志,Go 负责存储和展示,按天存储、支持 API 访问、可远程管理,终于能第一时间知道项目炸了。
472 10
|
存储 安全 Java
Spring Boot 3 集成Spring AOP实现系统日志记录
本文介绍了如何在Spring Boot 3中集成Spring AOP实现系统日志记录功能。通过定义`SysLog`注解和配置相应的AOP切面,可以在方法执行前后自动记录日志信息,包括操作的开始时间、结束时间、请求参数、返回结果、异常信息等,并将这些信息保存到数据库中。此外,还使用了`ThreadLocal`变量来存储每个线程独立的日志数据,确保线程安全。文中还展示了项目实战中的部分代码片段,以及基于Spring Boot 3 + Vue 3构建的快速开发框架的简介与内置功能列表。此框架结合了当前主流技术栈,提供了用户管理、权限控制、接口文档自动生成等多项实用特性。
1386 8
|
存储 监控 安全
5款 Syslog集中系统日志常用工具对比推荐
集中管理Syslog有助于持续监控网络中的恶意活动,确保日志的搜索和分析更为便捷。常用工具包括Rsyslog、Syslog-ng、Logstash和Fluentd,它们各有优劣。Rsyslog通过多种协议确保日志传输的安全性;Syslog-ng支持高效收集和转发日志;Logstash能解析多源日志并索引;Fluentd将日志转换为JSON格式。卓豪EventLog Analyzer则提供一体化的日志管理,支持日志分析、报表生成、用户行为分析及实时告警,是全面的日志管理解决方案。
701 0

热门文章

最新文章