# lzh-21-log-spring-boot-starter

**Repository Path**: coding_13/lzh-21-log-spring-boot-starter

## Basic Information

- **Project Name**: lzh-21-log-spring-boot-starter
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-29
- **Last Updated**: 2025-09-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# lzh-21-log-spring-boot-starter

一个用于简化日志记录的 Spring Boot Starter，提供日志切面、追踪过滤器和 MDC 适配器等功能。

## 特性

- **日志切面（LogAdvice）**：通过 AOP 实现方法级别的日志记录。
- **追踪过滤器（WebTraceFilter）**：为每个请求生成唯一的追踪 ID。
- **MDC 适配器（TtlMDCAdapter）**：支持线程上下文的日志追踪。
- **日志工具类（MDCTraceUtil）**：提供追踪 ID 和 Span ID 的生成与管理。

## 使用方法

### 1. 添加依赖

在 `pom.xml` 中添加该 Starter 的依赖：

```xml
<dependency>
    <groupId>com.lzh</groupId>
    <artifactId>lzh-21-log-spring-boot-starter</artifactId>
    <version>1.0.0</version>
</dependency>
```

### 2. 启用日志功能

在 Spring Boot 应用的主类上添加 `@EnableAspectJAutoProxy` 注解以启用 AOP：

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

### 3. 使用日志注解

在需要记录日志的方法上添加 `@Log` 注解：

```java
@RestController
public class ExampleController {

    @Log
    @GetMapping("/example")
    public String example() {
        return "Hello, World!";
    }
}
```

## 配置

### 日志配置

在 `application.yml` 或 `application.properties` 中配置日志输出格式和级别：

```yaml
logging:
  level:
    com.lzh.log: DEBUG
```

### 自定义追踪 ID 生成

可以通过自定义 `MDCTraceUtil` 中的 `createTraceId()` 方法来实现自己的追踪 ID 生成逻辑。

## 构建与发布

### 构建项目

```bash
mvn clean install
```

### 发布到仓库

```bash
mvn deploy
```

## 贡献

欢迎提交 Pull Request 和建议。请确保代码风格一致，并提供清晰的提交信息。

## 许可证

该项目使用 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。