开源项目 aop-log 使用教程

开源项目 aop-log 使用教程

1. 项目的目录结构及介绍

aop-log 项目的目录结构如下：

aop-log/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   ├── com/
│   │   │   │   ├── github/
│   │   │   │   │   ├── aop/
│   │   │   │   │   │   ├── annotation/
│   │   │   │   │   │   ├── collector/
│   │   │   │   │   │   ├── config/
│   │   │   │   │   │   ├── processor/
│   │   │   │   │   │   └── AopLogApplication.java
│   │   └── resources/
│   │       ├── application.properties
│   │       └── logback.xml
│   └── test/
│       └── java/
│           └── com/
│               └── github/
│                   └── aop/
│                       └── AopLogApplicationTests.java
├── pom.xml
└── README.md

目录结构介绍

• src/main/java/com/github/aop/: 包含项目的主要代码。
  • annotation/: 存放自定义注解。
  • collector/: 存放日志收集器相关代码。
  • config/: 存放配置类。
  • processor/: 存放AOP处理器。
  • AopLogApplication.java: 项目启动类。
• src/main/resources/: 存放配置文件。
  • application.properties: 应用配置文件。
  • logback.xml: 日志配置文件。
• src/test/java/com/github/aop/: 存放测试代码。
  • AopLogApplicationTests.java: 测试启动类。
• pom.xml: Maven 项目配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 AopLogApplication.java，位于 src/main/java/com/github/aop/ 目录下。

package com.github.aop;

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

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

启动文件介绍

• @SpringBootApplication: 这是一个组合注解，包含了 @Configuration、@EnableAutoConfiguration 和 @ComponentScan，用于启动 Spring Boot 应用。
• main 方法：应用的入口点，通过 SpringApplication.run 方法启动 Spring Boot 应用。

3. 项目的配置文件介绍

项目的配置文件主要有两个：application.properties 和 logback.xml，位于 src/main/resources/ 目录下。

application.properties

# 应用配置
server.port=8080
spring.application.name=aop-log

# 日志配置
logging.level.root=INFO
logging.file.name=logs/aop-log.log

logback.xml

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_FILE}</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_FILE}.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss