一、Android为什么要日志文件
? 写程序就难免会写bug,有bug就需要调试,但是很多情况下app发布后,测试人员和用户无意中触发了bug确并不知道怎么复现bug。那这个时候就需要日志文件来帮助我们探查出bug的原因。
二、写日志文件
? 我们一般写log的时候用的是android.util.Log,那我们对这个Log做一次封装:
import android.content.Context;
import android.os.Environment;
import android.util.Log;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
public class MyLog {
private static Boolean MYLOG_SWITCH = true; // 日志文件总开关
private static Boolean MYLOG_WRITE_TO_FILE = true;// 日志写入文件开关
private static char MYLOG_TYPE = ‘v‘;// 输入日志类型,w代表只输出告警信息等,v代表输出所有信息
private static String MYLOG_PATH_SDCARD_DIR = "/0_myapp/log";// 日志文件在sdcard中的路径
private static int SDCARD_LOG_FILE_SAVE_DAYS = 0;// sd卡中日志文件的最多保存天数
private static String MYLOGFILEName = "Log.txt";// 本类输出的日志文件名称
private static SimpleDateFormat myLogSdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");// 日志的输出格式
private static SimpleDateFormat logfile = new SimpleDateFormat("yyyy-MM-dd");// 日志文件格式
public Context context;
public static void w(String tag, Object msg) { // 警告信息
log(tag, msg.toString(), ‘w‘);
}
public static void e(String tag, Object msg) { // 错误信息
log(tag, msg.toString(), ‘e‘);
}
public static void d(String tag, Object msg) {// 调试信息
log(tag, msg.toString(), ‘d‘);
}
public static void i(String tag, Object msg) {//
log(tag, msg.toString(), ‘i‘);
}
public static void v(String tag, Object msg) {
log(tag, msg.toString(), ‘v‘);
}
public static void w(String tag, String text) {
log(tag, text, ‘w‘);
}
public static void e(String tag, String text) {
log(tag, text, ‘e‘);
}
public static void d(String tag, String text) {
log(tag, text, ‘d‘);
}
public static void i(String tag, String text) {
log(tag, text, ‘i‘);
}
public static void v(String tag, String text) {
log(tag, text, ‘v‘);
}
/**
* 根据tag, msg和等级,输出日志
* @param tag
* @param msg
* @param level
*/
private static void log(String tag, String msg, char level) {
if (MYLOG_SWITCH) {//日志文件总开关
if (‘e‘ == level && (‘e‘ == MYLOG_TYPE || ‘v‘ == MYLOG_TYPE)) { // 输出错误信息
Log.e(tag, msg);
} else if (‘w‘ == level && (‘w‘ == MYLOG_TYPE || ‘v‘ == MYLOG_TYPE)) {
Log.w(tag, msg);
} else if (‘d‘ == level && (‘d‘ == MYLOG_TYPE || ‘v‘ == MYLOG_TYPE)) {
Log.d(tag, msg);
} else if (‘i‘ == level && (‘d‘ == MYLOG_TYPE || ‘v‘ == MYLOG_TYPE)) {
Log.i(tag, msg);
} else {
Log.v(tag, msg);
}
if (MYLOG_WRITE_TO_FILE)//日志写入文件开关
writeLogtoFile(String.valueOf(level), tag, msg);
}
}
/**
* 打开日志文件并写入日志
* @param mylogtype
* @param tag
* @param text
*/
private static void writeLogtoFile(String mylogtype, String tag, String text) {// 新建或打开日志文件
Date nowtime = new Date();
String needWriteFiel = logfile.format(nowtime);
String needWriteMessage = myLogSdf.format(nowtime) + " " + mylogtype + " " + tag + " " + text;
File dirPath = Environment.getExternalStorageDirectory();
File dirsFile = new File(dirPath + MYLOG_PATH_SDCARD_DIR);
if (!dirsFile.exists()){
dirsFile.mkdirs();
}
//Log.i("创建文件","创建文件");
File file = new File(dirsFile.toString(), needWriteFiel + "_" + MYLOGFILEName);// MYLOG_PATH_SDCARD_DIR
if (!file.exists()) {
try {
//在指定的文件夹中创建文件
file.createNewFile();
} catch (Exception e) {
e.printStackTrace();
}
}
try {
FileWriter filerWriter = new FileWriter(file, true);// 后面这个参数代表是不是要接上文件中原来的数据,不进行覆盖
BufferedWriter bufWriter = new BufferedWriter(filerWriter);
bufWriter.write(needWriteMessage);
bufWriter.newLine();
bufWriter.close();
filerWriter.close();
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 删除制定的日志文件
*/
public static void delFile() {// 删除日志文件
String needDelFiel = logfile.format(getDateBefore());
File dirPath = Environment.getExternalStorageDirectory();
File file = new File(dirPath, needDelFiel + MYLOGFILEName);// MYLOG_PATH_SDCARD_DIR
if (file.exists()) {
file.delete();
}
}
/**
* 得到现在时间前的几天日期,用来得到需要删除的日志文件名
*/
private static Date getDateBefore() {
Date nowtime = new Date();
Calendar now = Calendar.getInstance();
now.setTime(nowtime);
now.set(Calendar.DATE, now.get(Calendar.DATE) - SDCARD_LOG_FILE_SAVE_DAYS);
return now.getTime();
}
}
? 然后我们调用的时候用MyLog代替Log,其中还有两个开关参数:
MYLOG_SWITCH? //日志文件总开关,当它为true时才打印log
MYLOG_WRITE_TO_FILE? // 日志写入文件开关,当它为true时才写入到本地文件中
由于涉及到写文件,所以app需要读写文件权限,在AndroidMainfest.xml中加入
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
代码中加入
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M && this.checkSelfPermission(
Manifest.permission.WRITE_EXTERNAL_STORAGE) != PackageManager.PERMISSION_GRANTED) {
this.requestPermissions(new String[]{
Manifest.permission.READ_EXTERNAL_STORAGE,
Manifest.permission.WRITE_EXTERNAL_STORAGE
}, 1);
}
三、闪退日志文件
? 当app发生闪退时,一般都是有Exception没有catch住,Mylog就没办法了,这时候我们需要一个CrashHandler
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;
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<String, String>();
// 用于格式化日期,作为日志文件名的一部分
private DateFormat formatter = new SimpleDateFormat("yyyy-MM-dd_HH-mm-ss");
/** 保证只有一个CrashHandler实例 */
private CrashHandler() {
}
/** 获取CrashHandler实例 ,单例模式 */
public static CrashHandler getInstance() {
return INSTANCE;
}
/**
* 初始化
*
* @param context
*/
public void init(Context context) {
mContext = context;
// 获取系统默认的UncaughtException处理器
mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();
// 设置该CrashHandler为程序的默认处理器
Thread.setDefaultUncaughtExceptionHandler(this);
}
/**
* 当UncaughtException发生时会转入该函数来处理
*/
@Override
public void uncaughtException(Thread thread, Throwable ex) {
if (!handleException(ex) && mDefaultHandler != null) {
// 如果用户没有处理则让系统默认的异常处理器来处理
mDefaultHandler.uncaughtException(thread, ex);
} else {
try {
Thread.sleep(3000);
} catch (InterruptedException e) {
Log.e(TAG, "error : ", e);
}
// 退出程序
android.os.Process.killProcess(android.os.Process.myPid());
System.exit(1);
}
}
/**
* 自定义错误处理,收集错误信息 发送错误报告等操作均在此完成.
*
* @param ex
* @return true:如果处理了该异常信息;否则返回false.
*/
private boolean handleException(Throwable ex) {
if (ex == null) {
return false;
}
// 使用Toast来显示异常信息
new Thread() {
@Override
public void run() {
Looper.prepare();
Toast.makeText(mContext, "很抱歉,程序出现异常,即将退出.", Toast.LENGTH_LONG).show();
Looper.loop();
}
}.start();
// 收集设备参数信息
collectDeviceInfo(mContext);
// 保存日志文件
saveCrashInfo2File(ex);
return true;
}
/**
* 收集设备参数信息
*
* @param ctx
*/
public void collectDeviceInfo(Context ctx) {
try {
PackageManager pm = ctx.getPackageManager();
PackageInfo pi = pm.getPackageInfo(ctx.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.e(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.e(TAG, "an error occured when collect crash info", e);
}
}
}
/**
* 保存错误信息到文件中
*
* @param ex
* @return 返回文件名称,便于将文件传送到服务器
*/
private String saveCrashInfo2File(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 timestamp = System.currentTimeMillis();
String time = formatter.format(new Date());
String fileName = "crash-" + time + "-" + timestamp + ".log";
if (Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED)) {
String path = Environment.getExternalStorageDirectory() + "/0_myapp/log/";
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;
}
}
? 然后再在Application的onCreate中调用
CrashHandler.getInstance().init(getApplicationContext());
这样发生崩溃闪退就会把exception记录到日志中,方便我们查看解决问题。
?
?