Android 自定义日志字符串高性能保存到文件框架实现

1，前言

之前使用了两三个热门的日志保存到文件框架，但还是有自定义麻烦、掉日志的情况，今天给出自实现此项需求的一种方式。

2，正文

2.1，代码实现：

object Log2FileUtils {
    private var fileName3 : File?= null
    private var txtFileName3 : File?= null
    private val strQueue: BlockingQueue<String> = LinkedBlockingQueue()
    private var saveThread3: Thread? = null

    fun tlog(s : String){
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {  //创建文件 android10及以上沙盒机制
            fileName3 =
                File(Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOCUMENTS)
                    .toString() + "/dukerDev/Log")
            if(!fileName3!!.exists()){
                fileName3!!.mkdirs()
            }
            txtFileName3 = File(Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOCUMENTS)
                .toString() + "/dukerDev/Log" + "/${getDateV1()}.txt")//以当天日期创建新的文件
            if(!txtFileName3!!.isFile){
                txtFileName3!!.createNewFile()
            }
        } else {
            fileName3 =
                File(Environment.getExternalStorageDirectory().toString() + "/dukerDev/Log")
            if(!fileName3!!.exists()){
                fileName3!!.mkdirs()
            }
            txtFileName3 =  File(Environment.getExternalStorageDirectory().toString() + "/dukerDev/Log" + "/${getDateV1()}.txt")
            if(!txtFileName3!!.isFile){
                txtFileName3!!.createNewFile()
            }
        }
        val s1 = "${getTimeV3()}: ${s}\n"  //在日志前加上毫秒级时间
        if (!strQueue.offer(s1)) {  //把日志写入到队列
            Log.e("dukerDev","日志写缓冲区已满")
        }
        if(saveThread3 == null || !saveThread3!!.isAlive){//第一次调用时，启动写文件线程
            saveThread3 = Thread(saveRunnable3, "save-thread3").apply { start() }
        }
    }

    private val saveRunnable3 = Runnable {  //写文件专用线程
        try {
            while (true){
                val str = strQueue.take()  //从队列中取日志
                writeToFile(str)
            }
        } catch (e: Exception) {
            Log.e("dukerDev","save3Runnable err ${e.message}")
        }
    }

    private fun writeToFile(s : String) {  //将日志写入到文件
        val buffer: ByteArray = s.toByteArray()
        var out: OutputStream? = null
        try {
            out = FileOutputStream(txtFileName3, true)
            out.write(buffer, 0, buffer.size)
        } catch (ex: java.lang.Exception) {
            Log.e("dukerDev","ex err ${ex.message}")
        } finally {
            try {
                out!!.close()
            } catch (ioEx: IOException) {
                Log.e("dukerDev","ioEx err ${ioEx.message}")
            }
        }
    }
}

fun getDateV1() = SimpleDateFormat("yyyy-MM-dd").format(Date())!!
fun getTimeV3() = SimpleDateFormat("yyyy-MM-dd HH:mm:ss:SSS").format(Date())

2.2，使用：

tlog("dukerDev test01")
Log2FileUtils.tlog("dukerDev test02")

2.3，文件输出：

2022-10-24 10:24:00:000: dukerDev test01
2022-10-24 10:24:00:060: dukerDev test02

2.4，说明：

1，创建文件时是以当天日期命名创建一个新的文件，防止所有日志全写到一个文件，查阅日志不方便
2，日志时间前缀精确到毫秒
3，专用写文件线程，保证性能
4，从队列写入读取，防止写日志时丢失或出错
5，此工具框架不太适用于特别大数据量的日志写入，特别大数据量可以考虑StringBuilder一次性写入文件

2.5，注意：

1，使用前需申请及动态获取文件读写权限
2，若创建文件或写文件失败，尝试在AndroidManifest.xml文件中添加 android:requestLegacyExternalStorage=“true”

转载请注明出处https://blog.csdn.net/Duker_tec/article/details/127492781

不完善或不正确的地方，欢迎大家评论区提出或补充