使用Android中的Timber Library更好地记录日志

简介

在开发Android应用程序时，日志记录是一个非常重要的组成部分。Timber库是一个构建在Android的日志记录之上的轻量级的库，它能够帮助程序员更好地记录自己的日志信息，有助于调试和维护应用程序。

如何使用Timber库

要使用Timber库，需要两个步骤：

1. 在build.gradle文件中添加Timber库的依赖

dependencies {
    implementation 'com.jakewharton.timber:timber:4.7.1'
}

2. 在应用程序中初始化Timber库

class MyApp : Application() {
   override fun onCreate() {
        super.onCreate()
        if (BuildConfig.DEBUG) {
            Timber.plant(DebugTree())
        } else {
            Timber.plant(ReleaseTree())
        }
    }
}

在应用程序的入口点，一般是Application的onCreate()方法中，调用Timber.plant()方法初始化Timber库。

根据应用程序的运行环境，Timber库建议在DEBUG模式下使用DebugTree()输出日志，而在RELEASE模式下使用ReleaseTree()进行日志记录。

Timber库的日志记录方法

Timber记录日志的方法都是由debug，info，warning，error，wtf五种等级的方法构成，用法类似于Log类。例如：

Timber.d("debug log.")
Timber.i("info log.")
Timber.w("warning log.")
Timber.e("error log.")
Timber.wtf("wtf log.")

与Log不同的是，Timber能够将日志记录到标准的输出流之外。默认情况下，Timber使用Android的LogCat记录日志，但是它也允许将日志记录写入任何实现了Tree接口的流。例如，这里有一个将日志记录写入文件的自定义树：

class FileLoggingTree : Timber.Tree() {
 
    private val maxFileSize = 1024 * 1024.toLong() //1Mb
    private val logFileName = "app_log.txt"
 
    override fun log(priority: Int, tag: String?, message: String, t: Throwable?) {
        val logPriority = Log.getPriorityString(priority)
        val logMessage = "$logPriority/$tag: $message"
        val logFile = File(context.getExternalFilesDir(null), logFileName)
 
        if (!logFile.exists()) {
            logFile.createNewFile()
        }
 
        trimLogFile(logFile)
        writeLogToFile(logFile, logMessage)
    }
 
    private fun trimLogFile(logFile: File) {
        val fileSize = logFile.length()
 
        if (fileSize >= maxFileSize) {
            val inputStream = FileInputStream(logFile)
            inputStream.skip(fileSize / 2)
 
            val reader = BufferedReader(InputStreamReader(inputStream))
            val tempFile = File(context.getExternalFilesDir(null), "app_temp.txt")
            val output = PrintWriter(FileOutputStream(tempFile))
 
            reader.lines().forEach { output.println(it) }
 
            reader.close()
            output.close()
 
            tempFile.renameTo(logFile)
        }
    }
 
    private fun writeLogToFile(logFile: File, logMessage: String) {
        try {
            val fileWriter = FileWriter(logFile, true)
            val writer = PrintWriter(fileWriter)
            writer.println(logMessage)
 
            writer.flush()
            writer.close()
            fileWriter.close()
        } catch (e: Exception) {}
    }
}

此外，还有其他一些便于使用Timber记录日志的方法，例如：

// 格式化字符串
Timber.d("formatted %s", "log")

// 带有参数，并可选择是否显示线程和方法信息
Timber.d(Exception(), "log with %s", "args")
Timber.d(Throwable(), "log with %s by %s", "args", "creator")

// 记录耗时操作
val start = System.nanoTime()
doSomething()
Timber.d("operation took ${(System.nanoTime() - start) / 1000000} ms")

总结

使用Timber库能够帮助Android应用程序开发者更好地记录日志信息，是一个值得使用的工具库。在使用Timber库的时候需要注意库的初始设置和具体的使用方法，建议在不熟悉细节之前，先参考库的官方文档或者例子。