增加日志存储到硬盘功能

Author: catchpig

app/src/main/java/com/catchpig/kmvvm/app/KotlinMvpApp.kt

@@ -5,7 +5,7 @@ import com.catchpig.download.manager.DownloadManager
 import com.catchpig.kmvvm.BuildConfig
 import com.catchpig.kmvvm.R
 import com.catchpig.mvvm.network.manager.NetManager
-import com.catchpig.utils.LogUtils
+import com.catchpig.utils.ext.initLogger
 import com.scwang.smart.refresh.footer.ClassicsFooter
 import com.scwang.smart.refresh.header.MaterialHeader
 import com.scwang.smart.refresh.layout.SmartRefreshLayout
@@ -15,6 +15,9 @@ import com.scwang.smart.refresh.layout.SmartRefreshLayout
  * @date 2019/8/18 00:18
  */
 class KotlinMvpApp : Application() {
+    companion object {
+        private const val TAG = "KotlinMvpApp"
+    }
 
     init {
         //设置全局的Header构建器
@@ -31,12 +34,16 @@ class KotlinMvpApp : Application() {
     override fun onCreate() {
         super.onCreate()
         val debug = BuildConfig.DEBUG
-        // 框架内部已经初始化了,如果不需要打印日志的代码行数,就不需要再次初始化
-        LogUtils.getInstance().showLineNumber(debug)
+        initLogger()
         NetManager.getInstance().setDebug(debug)
         initDownload()
     }
 
+    private fun initLogger() {
+        val path = "${externalCacheDir?.absolutePath}/logs"
+        initLogger(path, "kmvvm")
+    }
+
     /**
      * 不是必须要设置下载路径,内部有默认的下载路径,如果需要变下载路径,请重新设置
      */

mvvm/build.gradle

@@ -36,7 +36,7 @@ android {
         viewBinding = true
     }
 }
-
+Properties
 def dependenciesVersion = rootProject.dependenciesVersion
 dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])

mvvm/src/main/java/com/catchpig/mvvm/initializer/KotlinMvvmInitializer.kt

@@ -4,18 +4,19 @@ import android.app.Application
 import android.content.Context
 import androidx.startup.Initializer
 import com.catchpig.mvvm.lifecycle.ActivityLifeCycleCallbacksImpl
-import com.catchpig.utils.LogUtils
 import com.catchpig.utils.ext.logd
 import com.catchpig.utils.manager.ContextManager
+import com.orhanobut.logger.AndroidLogAdapter
+import com.orhanobut.logger.Logger
 
 class KotlinMvvmInitializer : Initializer<Boolean> {
     companion object {
         private const val TAG = "KotlinMvvmInitializer"
     }
 
     override fun create(context: Context): Boolean {
-        val applicationContext = context!!.applicationContext
-        initLog(applicationContext)
+        val applicationContext = context.applicationContext
+        initLog()
         initContext(applicationContext)
         "create".logd(TAG)
         return true
@@ -27,8 +28,8 @@ class KotlinMvvmInitializer : Initializer<Boolean> {
         application.registerActivityLifecycleCallbacks(ActivityLifeCycleCallbacksImpl())
     }
 
-    private fun initLog(context: Context) {
-        LogUtils.getInstance().init(context)
+    private fun initLog() {
+        Logger.addLogAdapter(AndroidLogAdapter())
     }
 
     override fun dependencies(): MutableList<Class<out Initializer<*>>> {

utils/build.gradle

@@ -40,6 +40,7 @@ dependencies {
     implementation "androidx.appcompat:appcompat:${dependenciesVersion["appcompat"]}"
     implementation "androidx.core:core-ktx:${dependenciesVersion["core_ktx"]}"
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:${dependenciesVersion["kotlin"]}"
+    api "com.orhanobut:logger:${dependenciesVersion["logger"]}"
     api("com.google.android.material:material:${dependenciesVersion["material"]}")
 
     api project(':annotation')

utils/src/main/java/com/catchpig/utils/LogUtils.kt

@@ -1,14 +1,27 @@
 package com.catchpig.utils.ext
 
-import com.catchpig.utils.LogUtils
+import android.os.HandlerThread
+import com.catchpig.utils.logger.MvvmDishLogStrategy
+import com.orhanobut.logger.CsvFormatStrategy
+import com.orhanobut.logger.DiskLogAdapter
+import com.orhanobut.logger.Logger
+
+fun initLogger(path: String, tag: String) {
+    val handlerThread = HandlerThread("mvvm-log")
+    handlerThread.start()
+    val handler = MvvmDishLogStrategy.WriteHandler(handlerThread.looper, path)
+    val csvFormatStrategy =
+        CsvFormatStrategy.newBuilder().logStrategy(MvvmDishLogStrategy(handler)).tag(tag).build()
+    Logger.addLogAdapter(DiskLogAdapter(csvFormatStrategy))
+}
 
 /**
  *
  * @author TLi2
  **/
-fun String.logv(tag: String) = LogUtils.getInstance().vExt(tag, this)
-fun String.logd(tag: String) = LogUtils.getInstance().dExt(tag, this)
-fun String.logi(tag: String) = LogUtils.getInstance().iExt(tag, this)
-fun String.logw(tag: String) = LogUtils.getInstance().wExt(tag, this)
-fun String.loge(tag: String) = LogUtils.getInstance().eExt(tag, this)
+fun String.logv(tag: String) = Logger.v(tag, this)
+fun String.logd(tag: String) = Logger.d(tag, this)
+fun String.logi(tag: String) = Logger.i(tag, this)
+fun String.logw(tag: String) = Logger.w(tag, this)
+fun String.loge(tag: String) = Logger.e(tag, this)
 

utils/src/main/java/com/catchpig/utils/ext/LogExt.kt

@@ -0,0 +1,80 @@
+package com.catchpig.utils.logger
+
+import android.os.Handler
+import android.os.Looper
+import android.os.Message
+import com.orhanobut.logger.LogStrategy
+import java.io.File
+import java.io.FileWriter
+import java.io.IOException
+
+class MvvmDishLogStrategy(private val handler: WriteHandler) : LogStrategy {
+    companion object {
+        private const val TAG = "MvvmDishLogStrategy"
+    }
+
+    override fun log(level: Int, tag: String?, message: String) {
+        handler.sendMessage(handler.obtainMessage(level, message))
+    }
+
+    class WriteHandler(
+        private val looper: Looper,
+        private val folder: String,
+        private val maxFileSize: Int = 10 * 1024 * 1024
+    ) : Handler(looper) {
+
+        override fun handleMessage(msg: Message) {
+            val content = msg.obj as String
+
+            var fileWriter: FileWriter? = null
+            val logFile = getLogFile(folder, "logs")
+
+            try {
+                fileWriter = FileWriter(logFile, true)
+
+                writeLog(fileWriter, content)
+
+                fileWriter.flush()
+                fileWriter.close()
+            } catch (e: IOException) {
+                if (fileWriter != null) {
+                    try {
+                        fileWriter.flush()
+                        fileWriter.close()
+                    } catch (e1: IOException) { /* fail silently */
+                    }
+                }
+            }
+        }
+
+        private fun writeLog(fileWriter: FileWriter, content: String) {
+            fileWriter.append(content)
+        }
+
+        private fun getLogFile(folderName: String, fileName: String): File {
+            val folder = File(folderName)
+            if (!folder.exists()) {
+                folder.mkdirs()
+            }
+
+            var newFileCount = 0
+            var newFile: File
+            var existingFile: File? = null
+            newFile = File(folder, String.format("%s_%s.log", fileName, newFileCount))
+            while (newFile.exists()) {
+                existingFile = newFile
+                newFileCount++
+                newFile = File(folder, String.format("%s_%s.log", fileName, newFileCount))
+            }
+
+            if (existingFile != null) {
+                if (existingFile.length() >= maxFileSize) {
+                    return newFile
+                }
+                return existingFile
+            }
+
+            return newFile
+        }
+    }
+}

utils/src/main/java/com/catchpig/utils/logger/MvvmDishLogStrategy.kt

@@ -45,7 +45,8 @@ ext {
             'coroutines'        : '1.6.4',
             'serialization'     : '1.4.1',
             'lifecycle'         : '2.6.1',
-            "ksp"               : '2.0.21-1.0.26'
+            "ksp"               : '2.0.21-1.0.26',
+            "logger"            : "2.2.0"
     ]
 }