需求,即为甚么要做这一操作?
开发过程中,在自测和交付测试的过程中会遇到发生crash但是无法捕获异常的情况。比如:一个人在厕所无聊瞎点,突然就crash了。你不可能带着线、电脑和手机在厕所瞎点的吧,所以你看不到电脑上crash的日志,毕竟是瞎点,那么crash的步骤你并不清楚。如果crash日志没有,那么就尴尬了。
所以需求很简单,就是告诉我问题出在哪里,和发生的时间 。这样作为开发人员,就能快速定位问题所在,及时解决掉隐藏的bug。
下面看下CrashHandler类,用户手机Crash日志。
import android.content.Context;
import android.content.pm.PackageInfo;
import android.content.pm.PackageManager;
import android.os.Build;
import android.os.Environment;
import android.os.Looper;
import android.util.Log;
import android.widget.Toast;
import java.io.File;
import java.io.FileOutputStream;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;
import java.lang.reflect.Field;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
/**
* UncaughtException处理类,当程序发生Uncaught异常的时候,有该类来接管程序,并记录发送错误报告.
*/
public class CrashHandler implements Thread.UncaughtExceptionHandler {
public static final String TAG = "CrashHandler";
//系统默认的UncaughtException处理类
private Thread.UncaughtExceptionHandler mDefaultHandler;
//CrashHandler实例
private static CrashHandler INSTANCE = new CrashHandler();
//程序的Context对象
private Context mContext;
//用来存储设备信息和异常信息
private Map<String, String> infos = new HashMap<>();
//用于格式化日期,作为日志文件名的一部分
private DateFormat format = new SimpleDateFormat("yyyy-MM-dd-HH-mm-ss");
private CrashHandler() {
}
public static CrashHandler getInstance() {
return INSTANCE;
}
public void init(Context context) {
mContext = context;
//获取系统默认的UncaughtException处理器
mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();
//设置该CrashHandler为程序的默认处理器
Thread.setDefaultUncaughtExceptionHandler(this);
}
/**
* 当UncaughtException发生时会转入该函数来处理
*
* @param thread
* @param ex
*/
@Override
public void uncaughtException(Thread thread, Throwable ex) {
if (!handleException(ex) && mDefaultHandler != null) {
//如果用户没有处理则让系统默认的异常处理器来处理
mDefaultHandler.uncaughtException(thread, ex);
} else {
try {
Thread.sleep(2000);
} catch (InterruptedException e) {
Log.d(TAG, "error:", e);
}
//退出程序
android.os.Process.killProcess(android.os.Process.myPid());
System.exit(1);
}
}
/**
* 自定义错误处理,收集错误信息,发送错误报告
*
* @param ex true:处理了该异常信息返回true,否则返回false;
* @return
*/
private boolean handleException(Throwable ex) {
if (ex == null) {
return false;
}
new Thread() {
@Override
public void run() {
Looper.prepare();
Toast.makeText(mContext, "很抱歉,程序出现异常,即将退出.", Toast.LENGTH_LONG).show();
Looper.loop();
}
}.start();
collectDeviceInfo(mContext);
saveCrashInfoToFile(ex);
//TODO 上传log日志文件
return true;
}
/**
* 保存日志文件
*
* @param ex
* @return 返回文件名称, 便于将文件传送到服务器
*/
private String saveCrashInfoToFile(Throwable ex) {
StringBuffer sb = new StringBuffer();
for (Map.Entry<String, String> entry : infos.entrySet()) {
String key = entry.getKey();
String value = entry.getValue();
sb.append(key + "=" + value + "\n");
}
Writer writer = new StringWriter();
PrintWriter printWriter = new PrintWriter(writer);
ex.printStackTrace(printWriter);
Throwable cause = ex.getCause();
while (cause != null) {
cause.printStackTrace(printWriter);
cause = cause.getCause();
}
printWriter.close();
String result = writer.toString();
sb.append(result);
try {
long timeMillis = System.currentTimeMillis();
String time = this.format.format(new Date());
String fileName = "crash" + time + "-" + timeMillis + ".log";
if (Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED)) {
//TODO 替换成自己的保存日志文件目录
String path = "/sdcard/crashfile/";
File dir = new File(path);
if (!dir.exists()) {
dir.mkdirs();
}
FileOutputStream fos = new FileOutputStream(path + fileName);
fos.write(sb.toString().getBytes());
fos.close();
}
return fileName;
} catch (Exception e) {
Log.e(TAG, "an error occured while writing file...", e);
}
return null;
}
/**
* 收集设备信息
*
* @param mContext
*/
private void collectDeviceInfo(Context mContext) {
PackageManager pm = mContext.getPackageManager();
try {
PackageInfo pi = pm.getPackageInfo(mContext.getPackageName(), PackageManager.GET_ACTIVITIES);
if (pi != null) {
String versionName = pi.versionName == null ? "null" : pi.versionName;
String versionCode = pi.versionCode + "";
infos.put("versionName", versionName);
infos.put("versionCode", versionCode);
}
} catch (PackageManager.NameNotFoundException e) {
Log.d(TAG, "an error occured when collect package info", e);
}
Field[] fields = Build.class.getDeclaredFields();
for (Field field : fields) {
try {
field.setAccessible(true);
infos.put(field.getName(), field.get(null).toString());
Log.d(TAG, field.getName() + " : " + field.get(null));
} catch (Exception e) {
Log.d(TAG, "an error occured when collect crash info", e);
}
}
}
}
上面代码以及说明的很清楚了,这里就不做过多的解释了。下面来注册该类,在程序刚刚启动的时候。要创建一个类,并继承Application 类,作为程序的入口,并在配置文件AndroidManifest.xml进行配置。
package com.mph.retrofitutils;
import android.app.Application;
public class MyApp extends Application {
@Override
public void onCreate() {
super.onCreate();
CrashHandler crashHandler = CrashHandler.getInstance();
crashHandler.init(getApplicationContext());
}
}
这就完成了。
另外,贴出一个运行异常的自定义类,供程序可能出现异常的地方使用,代码如下:
public class ResultErrorException extends RuntimeException{
public ResultErrorException(String msg){
super(msg);
}
}
用法:
if(tResponseResult.getStatus()!=0){
throw new ResultErrorException(tResponseResult.getMsg());
}
直接抛出异常,程序就可以处理,也可以不抛出异常,自己处理异常。