nRF Logger API 开源项目FAQ

nRF Logger API 开源项目FAQ

项目基础介绍

nRF Logger API 是由Nordic Semiconductor开发并维护的一个公开库，它使开发者能够轻松地将自定义日志记录到nRF Logger数据库中。此项目广泛应用于[nRF Connect]及[nRF Toolbox]这两个可在Google Play获取的应用程序中。设计目的是为了提供一种当LogCat不可用时的调试方案，尤其适用于Android 4.2及以上版本。该库通过Maven Central分发，并支持与Timber库集成，便于日志处理。

主要编程语言

主要使用的编程语言是Java，对于较新版本的支持，则可能包含了Kotlin的元素，以适应现代Android开发趋势。

新手注意事项及解决步骤

注意事项1: 版本兼容性

问题: 开发者可能面临项目不兼容AndroidX的问题。 解决步骤:

1. 确认自己的项目是否已经迁移至AndroidX。若未迁移，应使用2.2.0或之前版本的nRF Logger API。
2. 使用以下命令手动迁移至AndroidX（如果需要）：

   refspec=+refs/heads/*:refs/remotes/origin/*
   git fetch origin ${refspec}
   git subtree split --prefix=app --branch android-x-migration
   

注意事项2: ProGuard规则配置

问题: 使用ProGuard可能会导致日志库的相关类被误优化移除。 解决步骤:

1. 在项目的proguard-rules.pro文件中添加以下保持规则：

   -keep class no.nordicsemi.android.log.** { *; }
   

2. 确保这条规则不会被其他混淆设置覆盖。

注意事项3: Timber集成中的日志级别差异

问题: 整合Timber时，可能会遇到日志级别的混淆，因为Timber和nRF Logger的日志级别不完全匹配。 解决步骤:

1. 引入nRF Logger的Timber插件：implementation 'no.nordicsemi.android:log-timber:2.5.0'。
2. 根据nRF Logger的要求调整日志级别使用。比如，想要记录应用级别的日志，需要特别留意无法直接使用Timber的I()方法来达到目的，可能需要自定义逻辑来映射Timber的级别到nRF Logger的相应级别。
3. 对于不需要前缀【TAG】的情况，可以调用tree.setLoggingTagsEnabled(false)禁用此功能。

通过遵循上述指南，新手开发者能够更顺利地集成nRF Logger API到他们的Android项目中，避免常见的陷阱，并有效利用其提供的日志功能进行调试和分析。