Android 高级进阶(源码剖析篇) 小而美的日志框架 timber（下）

Posted 2023-01-25 ACE1985

作者简介：ASCE1885， 《android 高级进阶》作者。本文由于潜在的商业目的，未经授权不开放全文转载许可，谢谢！本文分析的源码版本已经 fork 到我的 Github。

在上一篇文章中我们已经介绍了 timber 的核心原理，本文接着以timber-lint 代码为例来讲解 Android 自定义 Lint 的原理和实现。

我们知道 Android Studio 默认集成了 Lint 功能，相信大家应该都使用过，它能够帮助开发者快速发现代码中的各种问题，通过打开Preferences-Editor-Inspections，可以看到 Android Studio 默认支持的检查项，其中可以看到 Android 相关的 Lint，开发者可以根据项目的具体需求来配置检测规则：

一个完整的自定义 Lint 实现流程主要包含以下步骤：

• 新增 Lint Module

• 添加 Lint 依赖

• 定义 Issue

• 实现自定义 Detector 类

• 实现 Issue 注册器

下面我们结合 timber-lint 来一一介绍，需要注意的是，timber 工程目前是基于 Gradle 4.1 版本和 Android Gradle Plugin 3.0.0-beta5 版本。build.gradle 中的语法跟之前版本存在差别。

新增 Lint Module

为了实现自定义 Lint，我们需要在项目中增加一个 Java 类型的 Module，在 timber 中对应到 timber-lint 这个 Module，可以看到它的 build.gradle 的第一行是：

apply plugin: 'java-library' // 老版本是 apply plugin: 'java'

表明是 Java Library，而不是通常的 Android Library：

apply plugin: 'com.android.library'

添加 Lint 依赖

想要编写自定义 Lint，首先需要引入 Lint 的相关依赖，这里我们需要引入两个依赖：

• lint-api：编写自定义 Lint 所需要的 API 工具包

• lint-checks：Android 自带的 Lint 源码实现，也就是我们经常使用的

代码实现中，涉及工程根目录的 build.gralde 和 timber-lint 模块的 build.gradle，其中工程根目录的build.gradle 中定义了依赖的相关信息，代码如下：

ext 
  lintVersion = '25.3.0'


ext.deps = [
    lintapi    : "com.android.tools.lint:lint-api:$lintVersion",
    lintchecks : "com.android.tools.lint:lint-checks:$lintVersion"
]

timber-lint 模块的 build.gradle 中对这两个依赖进行引用，其中 compileOnly 相当于之前版本的 provided 的功能，只在编译阶段引入这些依赖，生成的 APK 中不会有这些依赖的文件。

定义 Issue

lint-api 使用 Issue 类来描述一个 Lint 问题，我们还是使用 Android Studio 自带的 Lint 来进行说明，以 Too Long Log Tags 这个 Issue 为例，如下所示：

一个完整的 Issue 包括以下字段：

• id：唯一标示

• briefDescription：问题的简介，长度通常限制在 5～6 个英文单词，主要用于描述问题而不是描述解决方案

• explanation：问题的详细解释，包含解决方案

• category：错误所属的类别（正确性，性能、安全、可用性等等）

• priority：优先级，取值范围是 1～10，10 表示最高优先级

• severity：问题的严重级别，取值范围是Fatal，Error，Warning，Information，Ignore

• implementation：这个 Issue 的具体实现，将 Issue 和 Detector 进行绑定，同时指定 Detector 作用的范围（scope）

具体到 timber-lint 中，它定义了八个 Issue，如下所示：

由于这些 issue 本质上是为了规范开发者对 timber 的使用，因此为了对 timber 有个更好的了解，我们来看看每个 issue的具体涵义。

LogNotTimber

不符合自定义 Lint 规则的代码示例：

说明：如果项目中直接使用 Android 系统 Log 而不是使用 Timber 的话，那么给出警告信息。

StringFormatInTimber

不符合自定义 Lint 规则的代码示例：

说明：如果调用 Timber 时参数包含 String.format() 方法，那么给出警告信息，因为 Timber 内部已经实现了String.format() 功能，无需使用者再手动调用。

ThrowableNotAtBeginning

不符合自定义 Lint 规则的代码示例：

说明：如果调用 Timber 时传入的参数中包含 Throwable 类型，且不是第一个参数时，那么给出警告信息。

BinaryOperationInTimber

不符合自定义 Lint 规则的代码示例：

说明：如果调用 Timber 时参数中存在字符串通过 + 拼接，那么给出警告信息，因为 Timber 内部已经实现了 String.format() 功能，无需使用者再手动调用。...更多内容请点击阅读原文继续阅读。