CrashHandler全局异常捕获
程序员文章站
2022-03-21 17:14:29
应用在日常的开发中,我们经常需要去Logcat测试我们的App,但由于很多原因,Android Monitor会闪屏或者Crash信息丢失。 这个时候就需要一个CrashHandler来将Crash写入到本地方便我们随时随地查看安卓已经帮我们想好了解决问题的接口(UncaughtExceptionHandler)。从名称上就知道这是用来处理没有捕捉到的野生Exception的。平时我们try catch的Exception的那就叫捕捉到的。看一下UncaughtExceptionHandler的源码:...
Android应用不可避免地会发送carsh,也称之为崩溃,无论你地程序写得多么完美,总是无法完全避免crash的发生,可能是由于Android系统底层的bug,也可能是由于不充分的机型适配或者其他不可预知的情况导致程序崩溃。当crash发生时,系统会kill掉正在执行的程序,现象就是闪退或者提示用户已停止运行。
安卓已经帮我们想好了解决问题的接口(UncaughtExceptionHandler
)。从名称上就知道这是用来处理没有捕捉到的野生Exception的。平时我们try catch的Exception的那就叫捕捉到的。看一下UncaughtExceptionHandler
的源码:
@FunctionalInterface
public interface UncaughtExceptionHandler {
/**
* Method invoked when the given thread terminates due to the
* given uncaught exception.
* <p>Any exception thrown by this method will be ignored by the
* Java Virtual Machine.
* @param t the thread
* @param e the exception
*/
void uncaughtException(Thread t, Throwable e);
}
代码很简单,这是一个接口,并且只有一个方法。当出现未捕捉的exception时,系统会回调这个方法。具体实现在ThreadGroup.java
的uncaughtException
:
public void uncaughtException(Thread t, Throwable e) {
if (parent != null) {
parent.uncaughtException(t, e);
} else {
Thread.UncaughtExceptionHandler ueh =
Thread.getDefaultUncaughtExceptionHandler();
if (ueh != null) {
ueh.uncaughtException(t, e);
} else if (!(e instanceof ThreadDeath)) {
System.err.print("Exception in thread \""
+ t.getName() + "\" ");
e.printStackTrace(System.err);
}
}
}
从上面的源码分析我们知道,只要我们重写一个类实现UncaughtExceptionHandler接口,替换当前线程的默认UncaughtExceptionHandler对象就行。系统为我们提供了方法Thread.getDefaultUncaughtExceptionHandler()和Thread.setDefaultUncaughtExceptionHandler(UncaughtExceptionHandler eh)。
Crash的捕获
- 实现
Thread.UncaughtExceptionHandler
接口,并重写uncaughtException
方法,此时你的CrashHandler就具备了接收处理异常的能力了。 - 调用
Thread.setDefaultUncaughtExceptionHandler(CrashHandler)
,来使用我们自定义的CrashHandler
来取代系统默认的CrashHandler
- 结合单例模式
- 总体三步: 捕获异常、信息数据获取、数据写入和上传
import android.content.Context;
import android.os.Environment;
import android.util.Log;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;
import java.util.Date;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import android.content.pm.PackageInfo;
import android.content.pm.PackageManager;
import android.os.Build;
import android.os.Process;
import android.provider.Settings;
import java.lang.reflect.Field;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
public class RCrashHandler implements Thread.UncaughtExceptionHandler {
public static final String TAG = "RCrashHandler";
//系统默认的UncaughtException处理类
private Thread.UncaughtExceptionHandler mDefaultHandler;
//CrashHandler实例
private static volatile RCrashHandler INSTANCE;
//程序的Context对象
private Context mContext;
//用来存储设备信息和异常信息
private ConcurrentHashMap<String, String> Infos = new ConcurrentHashMap<>();
//文件保存路径
private static String getGlobalPath() {
return Environment.getExternalStorageDirectory().getAbsolutePath()
+ File.separator + "ql_crash_log";
}
private RCrashHandler() {
}
public static RCrashHandler getInstance() {
if (INSTANCE == null) {
synchronized (RCrashHandler.class) {
if (INSTANCE == null) {
INSTANCE = new RCrashHandler();
}
}
}
return INSTANCE;
}
/**
* 初始化
*
* @param context 上下文
*/
public void init(Context context) {
mContext = context;
//保存一份系统默认的CrashHandler
mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();
//使用我们自定义的异常处理器替换程序默认的
Thread.setDefaultUncaughtExceptionHandler(this);
}
/**
* 这个是最关键的函数,当程序中有未被捕获的异常,系统将会自动调用uncaughtException方法
*
* @param t 出现未捕获异常的线程
* @param e 未捕获的异常,有了这个ex,我们就可以得到异常信息
*/
@Override
public void uncaughtException(Thread t, Throwable e) {
if (!catchCrashException(e) && mDefaultHandler != null) {
//没有自定义的CrashHandler的时候就调用系统默认的异常处理方式
mDefaultHandler.uncaughtException(t, e);
} else {
//退出应用
Process.killProcess(Process.myPid());
}
}
/**
* 自定义错误处理,收集错误信息 发送错误报告等操作均在此完成.
*
* @param ex
* @return true:如果处理了该异常信息;否则返回false.
*/
private boolean catchCrashException(Throwable ex) {
if (ex == null) {
return false;
}
//收集设备参数信息
collectInfos(mContext, ex);
//保存日志文件
saveCrashInfo2File(ex);
return true;
}
/**
* 获取设备参数信息
*
* @param context
*/
private void collectInfos(Context context, Throwable ex) {
// 反射机制
Field[] mFields = Build.class.getDeclaredFields();
// 迭代Build的字段key-value 此处的信息主要是为了在服务器端手机各种版本手机报错的原因
for (Field field : mFields) {
try {
field.setAccessible(true);
Infos.put(field.getName(), field.get("").toString());
Log.e(TAG, "collectBuildInfos: " + field.getName() + " " + field.get("").toString());
// 获得包管理器
PackageManager mPackageManager = context.getPackageManager();
// 得到该应用的信息,即主Activity
PackageInfo mPackageInfo = mPackageManager.getPackageInfo(context.getPackageName(), PackageManager.GET_ACTIVITIES);
if (mPackageInfo != null) {
String versionName = mPackageInfo.versionName == null ? "null" : mPackageInfo.versionName;
String versionCode = mPackageInfo.versionCode + "";
Infos.put("versionName", versionName);
Infos.put("versionCode", versionCode);
}
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (PackageManager.NameNotFoundException e) {
e.printStackTrace();
}
}
}
/**
* 将崩溃日志信息写入本地文件
*/
private String saveCrashInfo2File(Throwable ex) {
StringBuffer mStringBuffer = getDeviceInfo(Infos);
mStringBuffer.append("\n\n-----------------------获取捕获异常的信息--------------------------\n\n");
mStringBuffer.append(collectExceptionInfos(ex));
// 保存文件,设置文件名
//用于格式化日期,作为日志文件名的一部分
DateFormat formatter = new SimpleDateFormat("yyyy-MM-dd-HH-mm-ss");
String mTime = formatter.format(new Date());
String mFileName = "CrashLog-" + mTime + ".txt";
if (Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED)) {
try {
File mDirectory = new File(getGlobalPath());
Log.v(TAG, mDirectory.toString());
if (!mDirectory.exists()) {
mDirectory.mkdirs();
}
FileOutputStream mFileOutputStream = new FileOutputStream(mDirectory + File.separator + mFileName);
mFileOutputStream.write(mStringBuffer.toString().getBytes());
mFileOutputStream.close();
return mFileName;
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
return null;
}
/**
* 获取捕获异常的信息
*
* @param ex
*/
private String collectExceptionInfos(Throwable ex) {
Writer mWriter = new StringWriter();
PrintWriter mPrintWriter = new PrintWriter(mWriter);
ex.printStackTrace(mPrintWriter);
ex.printStackTrace();
Throwable mThrowable = ex.getCause();
// 迭代栈队列把所有的异常信息写入writer中
while (mThrowable != null) {
mThrowable.printStackTrace(mPrintWriter);
// 换行 每个个异常栈之间换行
mPrintWriter.append("\r\n");
mThrowable = mThrowable.getCause();
}
// 记得关闭
mPrintWriter.close();
return mWriter.toString();
}
/**
* 将HashMap遍历转换成StringBuffer
*/
private StringBuffer getDeviceInfo(ConcurrentHashMap<String, String> stringMap) {
StringBuffer sb = new StringBuffer();
for (Map.Entry<String, String> entry : stringMap.entrySet()) {
String key = entry.getKey();
String value = entry.getValue();
sb.append(key).append("=").append(value).append("\n");
}
return sb;
}
}
测试代码:
btn.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
throw new RuntimeException("自定义异常,csj");
}
});
初始化:
public class MyApp extends Application {
@Override
public void onCreate() {
super.onCreate();
RCrashHandler.getInstance().init(this);
}
}
本文地址:https://blog.csdn.net/csj731742019/article/details/107539838