common-log4j2-starter

1.功能介绍

1.ApplicationReadyListener

• 程序启动时，动态获取并打印以下信息：
  • 日志存储的根目录的绝对路径
  • 应用的访问地址（包括端口）
  • 前端请求时可用的日期格式

2.ApplicationEnvironmentPreparedListener

• 获取日志根目录及模块名，并将其设置为环境变量供 log4j2-spring.xml 使用。

3.TraceIdLoggingAspect

• 每次请求开始时打印一行日志，包含请求的 traceId，以便于日志追踪。

4.LogAspect

• 日志切面（AOP），匹配所有 controller 和 service 包中的方法，记录以下信息：
  • 方法的执行时间
  • 请求参数
  • 返回结果

5.使用自定义的 banner.txt

• 读取项目的版本号，并在启动时展示自定义的 Banner。

2.配置示例

1.application.yml

sun-rays:
  log4j2:
    home: /Users/sunxiansheng/IdeaProjects/sunrays-framework/sunrays-demo/common-log4j2-starter-demo/logs  # 日志根目录 (默认: ./logs)
    log-aspect-enable: true  # 开启日志切面（默认为true）

2.@SkipLogAspect注解

可以放到方法或者类上，用于跳过这个类或者这个方法的日志切面

3.案例演示

1.创建模块

2.目录结构

3.pom.xml

    <dependencies>
        <!-- common-log4j2-starter -->
        <dependency>
            <groupId>cn.sunxiansheng</groupId>
            <artifactId>common-log4j2-starter</artifactId>
        </dependency>

        <!-- 引入web模块作为测试！ -->
        <dependency>
            <groupId>cn.sunxiansheng</groupId>
            <artifactId>common-web-starter</artifactId>
        </dependency>
    </dependencies>

4.application.yml 配置日志输出根目录

sun-rays:
   log4j2:
      home: /Users/sunxiansheng/IdeaProjects/sunrays-framework-demo/common-log4j2-starter-demo/logs  # 日志根目录 (默认: ./logs)

5.Log4j2Controller.java 测试Controller

package cn.sunxiansheng.log4j2.controller;

import cn.sunxiansheng.log4j2.annotation.SkipLogAspect;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * Description: Log4j2Controller
 *
 * @Author sun
 * @Create 2025/1/19 13:07
 * @Version 1.0
 */
@RestController
public class Log4j2Controller {

    /**
     * A test endpoint.
     *
     * @return A sample response.
     */
    @RequestMapping("/test")
    public String test() {
        return "This is a test response from Log4j2Controller";
    }

    /**
     * 测试跳过日志切面的注解
     *
     * @param msg
     * @return
     */
    @SkipLogAspect // 这个注解加在类上也可以生效
    @RequestMapping("/skipLogAspect")
    public String skipLogAspect(String msg) {
        return "skip log aspect";
    }
}

6.Log4j2Application.java 启动类

package cn.sunxiansheng.log4j2;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * Description: Log4j2Application
 *
 * @Author sun
 * @Create 2025/1/19 13:07
 * @Version 1.0
 */
@SpringBootApplication
public class Log4j2Application {

    public static void main(String[] args) {
        SpringApplication.run(Log4j2Application.class, args);
    }
}

7.测试

1.启动

2.请求