英文原文正文为项目原始 README（英文），本站后续会翻译为中文，当前仅剔除图片与无关章节并统一排版。

记录器

适用于 Android 的可读、结构化日志。将消息、集合、JSON 和 XML 转换为易于在 Logcat 中扫描的输出。

• 漂亮的输出，可选择显示线程和调用者信息
• JSON 和 XML 格式化
• 可读的列表、映射和数组
• 自定义标签和日志过滤
• 异常堆栈跟踪
• 灵活的目标，包括 Logcat 和文件

设置

将 Google Maven 和 Maven Central 添加到你的依赖仓库：

dependencyResolutionManagement {
  repositories {
    google()
    mavenCentral()
  }
}

dependencies {
  implementation("com.orhanobut:logger:2.2.0")
}

在您的应用程序中初始化一次，然后记录：

Logger.addLogAdapter(AndroidLogAdapter())
Logger.d("hello %s", "world")

消息

Logger.d("debug")
Logger.e("error")
Logger.w("warning")
Logger.v("verbose")
Logger.i("information")
Logger.wtf("What a Terrible Failure")

Logger.d("hello %s", "world")
Logger.d(listOf("foo", "bar"))
Logger.d(mapOf("key" to "value"))
Logger.d(intArrayOf(1, 2, 3))
Logger.json("""{"items":[1,2,3]}""")
Logger.xml("<root><item>value</item></root>")

收集和结构化输出使用调试优先级。使用 Logger.e(throwable, "message") 包含异常及其原因。

在调用线程上为恰好一条消息设置标签：

Logger.t("Checkout").d("Order submitted")

格式化和过滤

val format = PrettyFormatStrategy.newBuilder()
  .showThreadInfo(false) // Default: true
  .methodCount(0)        // Default: 2 caller frames
  .methodOffset(0)       // Default: 0 additional frames skipped
  .tag("MyApp")          // Default: PRETTY_LOGGER
  .build()

Logger.addLogAdapter(object : AndroidLogAdapter(format) {
  override fun isLoggable(priority: Int, tag: String?): Boolean = BuildConfig.DEBUG
})

Logger.t("Screen").d("A message tagged MyApp-Screen")

重写 LogAdapter.isLoggable 以按优先级或标签过滤信息。上面的示例仅在调试构建中启用日志记录。在替换已配置的适配器之前，使用 Logger.clearLogAdapters()。

对于 Logcat 过滤，请使用 PRETTY_LOGGER 或您配置的标签。

文件记录

使用 CsvFormatStrategy 和自定义的 DiskLogStrategy 将格式化日志保存到应用私有存储。示例 sample 展示了完整的设置，包括后台写入和清理。应用私有存储无需存储权限。

默认的 DiskLogAdapter() 仍然使用传统的共享外部存储位置。现代 Android 通过分区存储限制了该位置；对于当前应用，请使用示例中的自定义策略。

Timber 集成

Timber.plant(object : Timber.DebugTree() {
  override fun log(priority: Int, tag: String?, message: String, t: Throwable?) {
    Logger.log(priority, tag, message, t)
  }
})

许可证

Apache 许可证 2.0