如何在发布版Android应用中通过Kotlin写入日志文件？

一、选择安全的存储位置 #

以下两个位置的文件不会被Android系统自动删除（仅会随应用卸载清除），完全符合需求：

• 应用内部私有Files目录：路径为context.filesDir，属于应用专属私有空间，无需申请存储权限，适合无需用户手动查看的日志。
• 外部存储应用专属目录：路径为context.getExternalFilesDir(null)，Android 10及以上无需权限，用户可通过文件管理器在Android/data/[你的应用包名]/files路径下找到日志，适合需要用户提供日志排查问题的场景。

二、Kotlin实现格式化日志写入工具类 #

下面是封装好的工具类，实现类似printf()的格式化输出功能，支持追加写入日志：

import android.content.Context
import java.io.BufferedWriter
import java.io.File
import java.io.FileWriter
import java.io.IOException
import java.text.SimpleDateFormat
import java.util.*

object LogFileUtil {
    private const val LOG_FILE_NAME = "logfile.txt"
    private val dateFormat = SimpleDateFormat("yyyy-MM-dd HH:mm:ss", Locale.getDefault())

    // 模拟printf的格式化日志写入方法
    fun logPrintf(context: Context, format: String, vararg args: Any?) {
        val formattedContent = String.format(Locale.getDefault(), format, *args)
        appendLogToFile(context, formattedContent)
    }

    private fun appendLogToFile(context: Context, content: String) {
        // 选择内部私有存储（如需外部存储，替换为下面注释的代码）
        val logFile = File(context.filesDir, LOG_FILE_NAME)
        // val logFile = File(context.getExternalFilesDir(null), LOG_FILE_NAME)

        try {
            // 追加模式写入，添加时间戳便于排查
            val timeStamp = dateFormat.format(Date())
            val logLine = "[$timeStamp] $content\n"

            BufferedWriter(FileWriter(logFile, true)).use { writer ->
                writer.write(logLine)
            }
        } catch (e: IOException) {
            // 发布版中可通过系统日志记录写入失败信息（避免递归问题）
            android.util.Log.e("LogFileUtil", "日志写入失败: ${e.message}")
        }
    }
}

三、使用示例 #

在任意需要输出日志的地方直接调用：

// 格式化输出用户操作信息
LogFileUtil.logPrintf(context, "用户ID: %d，执行操作: %s", 1001, "提交订单")
// 格式化输出数值型数据
LogFileUtil.logPrintf(context, "接口响应耗时: %.2f ms", 62.34)

四、注意事项 #

• 日志大小管控：建议添加日志大小限制逻辑，比如当文件超过10MB时，自动备份旧日志并清空当前文件，避免占用过多设备存储。
• 权限兼容：若使用外部存储目录，Android 9及以下需在Manifest中添加权限：

  <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="28"/>
  

内容的提问来源于stack exchange，提问作者Cool_Coder