Unlogged SDK 使用教程

1. 项目介绍

Unlogged SDK 是一个用于记录 Java 代码执行的开源工具。它通过在代码中添加探针（probes）来捕获代码执行过程中的事件，并以二进制格式存储这些事件。这些记录可以通过 Unlogged IntelliJ 插件进行回放，并生成 JUnit 测试用例。Unlogged SDK 的主要功能包括：

• 代码执行记录：详细记录代码执行过程中的每一个步骤。
• 回放功能：通过插件回放记录，查看代码执行的详细过程。
• JUnit 测试生成：从记录中自动生成 JUnit 测试用例。
• 性能分析：识别代码中的瓶颈，并提供性能数据。

2. 项目快速启动

2.1 安装依赖

首先，你需要在你的项目中添加 Unlogged SDK 的依赖。你可以通过 Maven 或 Gradle 来添加依赖。

Maven

<dependencies>
    <dependency>
        <groupId>video.bug</groupId>
        <artifactId>unlogged-java-sdk</artifactId>
        <version>0.2.16</version>
    </dependency>
</dependencies>

Gradle

dependencies {
    implementation 'video.bug:unlogged-sdk:0.2.16'
    annotationProcessor 'video.bug:unlogged-sdk:0.2.16'
}

2.2 启用 Unlogged SDK

在你的应用程序入口点添加 @Unlogged 注解，以启用 Unlogged SDK。

public class Main {
    @Unlogged
    public static void main(String[] args) {
        // 你的代码
    }
}

2.3 禁用 Unlogged SDK

在生产环境中，建议禁用 Unlogged SDK。你可以在编译时或运行时禁用它。

编译时禁用

mvn package -Dunlogged.disable

或

./gradlew build -Dunlogged.disable

运行时禁用

@Unlogged(enable = false)
public class Main {
    public static void main(String[] args) {
        // 你的代码
    }
}

3. 应用案例和最佳实践

3.1 代码调试

Unlogged SDK 可以帮助开发者在本地环境中详细记录代码执行过程，并通过插件回放这些记录，从而更有效地进行代码调试。

3.2 自动化测试

通过 Unlogged SDK 生成的记录，可以自动生成 JUnit 测试用例，减少手动编写测试用例的工作量，提高测试覆盖率。

3.3 性能优化

Unlogged SDK 提供了详细的性能数据，开发者可以通过这些数据识别代码中的瓶颈，并进行针对性的优化。

4. 典型生态项目

4.1 Unlogged IntelliJ 插件

Unlogged IntelliJ 插件是与 Unlogged SDK 配合使用的工具，它提供了代码执行记录的回放功能，并支持从记录中生成 JUnit 测试用例。

4.2 Kaitai 格式

Unlogged SDK 使用 Kaitai 格式来描述二进制记录的结构，这使得记录的解析和处理更加方便。

4.3 JUnit 5

Unlogged SDK 生成的测试用例基于 JUnit 5，这使得测试用例的编写和执行更加现代化和灵活。

通过以上步骤，你可以快速上手并使用 Unlogged SDK 来记录和分析 Java 代码的执行过程。