一、问题提出
现在手机上的应用越来越多,任何时候,手机都是很多后台任务在执行。各种程序,任务为了记录执行过程,方便排查问题,都会输出一定的log。这样,就造成查看手机log输出情况的时候,发现log不断的在输出。加之,输出的log不规范,导致需要的log一下子被淹没在无尽的log中。而且android原生的log区分度低,信息少,出现问题时,难以精确定位。
二、解决措施
本文提供的方案重要在于规范应用的log输出格式,并且从调用堆栈从获取log执行的类名,方法和行数。因为格式一致,就很容易就能够过滤其他无用日志,找出我们需要的log。因为记录log执行的类名,方法和行数,所以,排查问题时,就可以快速定位到出现异常的具体位置。总之,该方法能够有效的提高问题的排查效率。
设计的流程:
1:设置统一的TAG标签,作为应用的log唯一标识。
2:调用getStackTrace获取当前调用栈的信息。
3:从调用栈中获取调用者的类名,方法名和具体的行数
4:输出log的详情信息。
关键代码:
调用:getMethodNames(new Throwable().getStackTrace());
具体实现:
private static void getMethodNames(StackTraceElement[] sElements){
className =sElements[1].getFileName();
methodName = sElements[1].getMethodName();
lineNumber =sElements[1].getLineNumber();
}
完成
输出log的详情信息开始设置统一的TAG标签获取当前调用栈的信息从调用栈中获取调用者的类名,方法名和具体的行数
。
三、实施例应用
在日常开发中,需要输出一定的log来排查问题。为了提高开发效率,log的输出应用基本快捷而且信息要准确,以便能快速排查问题。以下是使用android实现log规范化与精确定位和原生log的对比。
实现了log规范化与精确定位后:04-25 20:32:47.713 11980-11980/? E/MyApplication:onCreate(MainActivity.java:37)error
原生log:04-25 20:32:47.713 11980-11980/? E/MainActivity: error
可以看出:
1、android原生的log,信息简单,难以定位到具体的位置。实现了log规范化与精确定位后,知道了执行的类名,方法名,甚至是行数,能够快速的定位。
2、当需要的日志总多时,android原生的log就无法一次全部筛选出来。实现了log规范化与精确定位后,就可以通过TAG(这里为:MyApplication)一次全部筛选出来。
附:
源码:
packagecom.gbq.mylibrary.util;
importandroid.util.Log;
importcom.gbq.mylibrary.base.contants.Constants;
/**
* log工具类
* Created by gbq on 2017-3-20.
*/
public classLogUtil{
private static final booleanDEBUG=true;
private staticString className;//类名
private staticString methodName;//方法名
private static intlineNumber;//行数
privateLogUtil(){
}
private static booleanisDebuggable() {
returnDEBUG;
}
@SuppressWarnings({"StringBufferReplaceableByString","StringBufferMayBeStringBuilder"})
private staticString createLog(Stringlog) {
StringBufferbuffer=newStringBuffer();
buffer.append(methodName);
buffer.append("(").append(className).append(":").append(lineNumber).append(")");
buffer.append(log);
returnbuffer.toString();
}
private static voidgetMethodNames(StackTraceElement[]sElements){
className=sElements[1].getFileName();
methodName=sElements[1].getMethodName();
lineNumber=sElements[1].getLineNumber();
}
public static voide(Stringmessage){
if(!isDebuggable())
return;
// Throwable instance must be created before any methods
getMethodNames(newThrowable().getStackTrace());
Log.e(Constants.TAG,createLog(message));
}
public static voidi(Stringmessage){
if(!isDebuggable())
return;
getMethodNames(newThrowable().getStackTrace());
Log.i(Constants.TAG,createLog(message));
}
public static voidd(Stringmessage){
if(!isDebuggable())
return;
getMethodNames(newThrowable().getStackTrace());
Log.d(Constants.TAG,createLog(message));
}
public static voidv(Stringmessage){
if(!isDebuggable())
return;
getMethodNames(newThrowable().getStackTrace());
Log.v(Constants.TAG,createLog(message));
}
public static voidw(Stringmessage){
if(!isDebuggable())
return;
getMethodNames(newThrowable().getStackTrace());
Log.w(Constants.TAG,createLog(message));
}
public static voidwtf(Stringmessage){
if(!isDebuggable())
return;
getMethodNames(newThrowable().getStackTrace());
Log.wtf(Constants.TAG,createLog(message));
}
}
网友评论