Android自定义CrashHandler保存日志记录

代码部分

class MyCrashHandler private constructor(): Thread.UncaughtExceptionHandler {
    
    

    companion object {
    
    
        val instance by lazy(mode = LazyThreadSafetyMode.SYNCHRONIZED) {
    
    
            MyCrashHandler()
        }
    }

    private var mContext: Context? = null

    fun init(context: Context) {
    
    
        mContext = context
        //设置该CrashHandler为程序的默认处理器
        Thread.setDefaultUncaughtExceptionHandler(this)
    }

    override fun uncaughtException(t: Thread, e: Throwable) {
    
    
        LogUtils.w("crash", e.stackTraceToString())
        val stringBuilder = StringBuilder()
        stringBuilder.apply {
    
    
            append("为了尽快解决您的问题,我们将收集以下信息:\n")
            append("设备信息:")
            append(android.os.Build.BRAND + " " + android.os.Build.MODEL + " " + android.os.Build.DEVICE + "android" + android.os.Build.VERSION.RELEASE)
            append("\n")
            append("分辨率:")
            append("${
      
      ScreenUtils.getScreenWidth()}*${
      
      ScreenUtils.getScreenHeight()}")
            append("\n")
            append("版本号:")
            append(AppUtils.getAppVersionName())
            append("\n")
            append(e.stackTraceToString())
        }
        saveToFile(stringBuilder.toString())
    }

    /**
     * 保存到本app目录下document/crash/
     */
    private fun saveToFile(text: String) {
    
    
        if (mContext == null) return
        delFile()
        val document =  mContext!!.getExternalFilesDir(Environment.DIRECTORY_DOCUMENTS)?.absolutePath
        val date = TimeUtils.getNowString(SimpleDateFormat("yyyyMMdd-HHmmss"))
        val isSuccess = FileIOUtils.writeFileFromString(document  + "/crash/" + date + ".txt", text)
        LogUtils.d("crash", "日志保存=$isSuccess")
    }

    /**
     * 删除超过七天的文件
     */
    private fun delFile() {
    
    
        val files = mContext!!.getExternalFilesDir(Environment.DIRECTORY_DOCUMENTS + "/crash")?.listFiles()
        for (item in files!!.iterator()) {
    
    
            val name = item.nameWithoutExtension
            LogUtils.d("crash", name)
            val date = TimeUtils.getFitTimeSpanByNow(name, SimpleDateFormat("yyyyMMdd-HHmmss"), 1).toInt()
            if (date >= 7) {
    
    
                LogUtils.d("crash", "已删除过时日志fileName=${
      
      item.name}")
                FileUtils.delete(item)
            }
        }
    }
}

介绍

先上了代码,下面就不用再贴了,直接说方法名对应即可。
使用单例模式,后续初始化。
1、首先要继承Thread.UncaughtExceptionHandler,这是app全局处理未捕获异常处理的handler,即崩溃,然后在初始化的时候Thread.setDefaultUncaughtExceptionHandler(this),设置该CrashHandler为程序的默认处理器。
2、并且重写override fun uncaughtException(t: Thread, e: Throwable)方法。在该方法中记录上报crash。这里只介绍记录到本地,并在每次记录的时候拉取之前记录的日志,删除七天以前的日志。
其中TimeUtils、FileIOUtils、FileUtils等都是

	//工具类
    implementation 'com.blankj:utilcode:1.30.5'

这个工具类中的,推荐大家使用。
现在保存文件到当前app私有路径下是不需要权限的,记录一下。

使用到项目中

这样写好了谁去调用初始化呢?可是留了一个init函数没人调用呢!
没错,我们还需要像初始化第三方库的时候一样初始化它。这里我们使用AppStartUp。

首先在build文件中加入:

	//AppStartUp
    implementation "androidx.startup:startup-runtime:1.0.0"

然后创建初始化类

class CrashInit : Initializer<Unit> {
    
    
    override fun create(context: Context) {
    
    
        MyCrashHandler.instance.init(context)
    }

    override fun dependencies(): List<Class<out Initializer<*>>> {
    
    
        return emptyList()
    }
}

需要重写两个方法,override fun create(context: Context)和 override fun dependencies(): List<Class<out Initializer<*>>>。
对于create方法,就是我们初始化第三方库的地方,这里我们使用单例初始化刚才写好的CrashHandler。
对于dependencies()方法,指的是该初始化内容需要依赖哪些其他初始化,这样会优先初始化其他类。一般情况下我们是不需要的,除非项目中有优先级较高的初始化内容。我们返回一个空list。

这样就完成了吗?No。
还需要在AndroidManifest文件中配置一个AppStartUp的provider

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    package="com.kxqin.frametest">

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.FrameTest">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
        <!--AppStartUp-->
        <provider
            android:name="androidx.startup.InitializationProvider"
            android:authorities="${
      
      applicationId}.androidx-startup"
            android:exported="false"
            tools:node="merge">
            <meta-data
                android:name="com.kxqin.frametest.crash.CrashInit"
                android:value="androidx.startup" />
        </provider>
    </application>

</manifest>

可供我们修改的地方并不是很多,只需要在meta下面加入我们的包名即可。AppStartUp也可以延迟初始化,具体的步骤自己去翻阅吧,这里并没有使用延迟初始化。

猜你喜欢

转载自blog.csdn.net/qq_39168470/article/details/113758929
今日推荐