Stream Log 开源项目教程

Stream Log 开源项目教程

stream-log🛥 A lightweight and extensible logger library for Kotlin and Android.项目地址:https://gitcode.com/gh_mirrors/st/stream-log

1. 项目介绍

Stream Log 是一个轻量级且可扩展的日志库，专为 Kotlin 和 Android 开发设计。它起源于 stream-chat-android 项目，并已经在全球数亿用户中得到了验证。Stream Log 简单易用，支持将运行时日志消息记录到外部 txt 文件中，便于追踪日志信息。

2. 项目快速启动

2.1 添加依赖

首先，在你的项目中添加 Stream Log 的依赖。在 build.gradle 文件中添加以下内容：

dependencies {
    implementation("io.getstream:stream-log:$version")
}

2.2 初始化日志管理器

在你的应用程序类中初始化日志管理器：

class App : Application() {
    override fun onCreate() {
        super.onCreate()
        // 安装 AndroidStreamLogger
        AndroidStreamLogger.installOnDebuggableApp(this)
        
        // 设置日志验证器
        StreamLog.setValidator { priority ->
            priority.level >= Priority.VERBOSE.level
        }
    }
}

2.3 打印日志

现在你可以简单地打印日志消息：

streamLog { "This is a log message" }
streamLog(priority = Priority.INFO, tag = "Tag") { "This is a log message" }
StreamLog.d(tag = "Tag") { "This is a log message" }

3. 应用案例和最佳实践

3.1 记录运行时日志到外部文件

Stream Log 支持将日志消息记录到外部 txt 文件中，便于在复杂场景下追踪日志信息。你不需要进行额外的设置，只需添加 stream-log-android-file 依赖：

dependencies {
    implementation("io.getstream:stream-log-android-file:$version")
}

3.2 在 Jetpack Compose 中使用

在 Jetpack Compose 中，你可以使用 taggedLogger 来获取带有标签的日志记录器：

val logger by taggedLogger()
logger.d { "Button Clicked" }

4. 典型生态项目

4.1 Stream Log Android

Stream Log Android 是基于 Stream Log 的 Android 日志库，提供了更便捷的 Android 日志记录功能。

4.2 Stream Log Android File

Stream Log Android File 是一个扩展库，用于将日志消息持久化到外部 txt 文件中，便于复杂场景下的日志追踪。

4.3 Stream Log BOM

Stream Log BOM（Bill of Materials）允许你通过指定 BOM 的版本来管理所有 Stream Log 库的版本，简化了依赖管理。

dependencies {
    implementation("io.getstream:stream-log-bom:$version")
    implementation("io.getstream:stream-log")
    implementation("io.getstream:stream-log-file")
    implementation("io.getstream:stream-log-android")
    implementation("io.getstream:stream-log-android-file")
}

通过以上步骤，你可以快速上手并使用 Stream Log 进行日志记录，同时利用其丰富的生态项目扩展功能。

stream-log🛥 A lightweight and extensible logger library for Kotlin and Android.项目地址:https://gitcode.com/gh_mirrors/st/stream-log