Timber自定义Debug Tree类问题：无日志输出与方法名显示异常

问题1：拼接文件名、行号、方法名后无日志输出 #

原因 #

Android系统自带的Log类对日志Tag的长度有严格限制（最大23个字符），你拼接的(文件名:行号)#方法名格式很容易超出这个长度，导致日志被系统直接过滤，无法输出。而仅返回文件名时长度较短，符合限制所以能正常打印。

解决方案 #

方案1：缩短Tag长度，控制在23字符以内

可以截取文件名前缀、缩短方法名，或者直接截断过长的Tag：

public class MyDebugTree extends Timber.DebugTree {     
    @Override 
    protected String createStackElementTag(StackTraceElement element) {
        // 去掉文件名后缀，只保留类名
        String fileName = element.getFileName().split("\\.")[0];
        // 类名过长就截取前5位
        fileName = fileName.length() > 5 ? fileName.substring(0, 5) : fileName;
        // 拼接后检查长度，超过就截断
        String tag = String.format("(%s:%d)#%s", fileName, element.getLineNumber(), element.getMethodName());
        return tag.length() > 23 ? tag.substring(0, 23) : tag;
    } 
}

方案2：把信息放到日志消息前缀，避开Tag长度限制

如果不想压缩信息，直接把文件名、行号、方法名加到日志内容的开头，完全不受Tag限制：

public class MyDebugTree extends Timber.DebugTree {
    @Override
    protected void log(int priority, String tag, String message, Throwable t) {
        // 找到调用Timber的栈元素
        StackTraceElement callerElement = findCallingStackElement();
        // 拼接前缀
        String logPrefix = String.format("(%s:%d)#%s: ", 
            callerElement.getFileName(), 
            callerElement.getLineNumber(), 
            callerElement.getMethodName());
        // 调用父类方法打印带前缀的日志
        super.log(priority, tag, logPrefix + message, t);
    }

    // 复用Timber的栈元素查找逻辑
    private StackTraceElement findCallingStackElement() {
        StackTraceElement[] stackTraces = Thread.currentThread().getStackTrace();
        for (StackTraceElement element : stackTraces) {
            String className = element.getClassName();
            // 跳过Timber本身和当前Tree的类
            if (!className.equals(Timber.class.getName()) && !className.equals(getClass().getName())) {
                return element;
            }
        }
        // 兜底用父类的逻辑
        return super.getStackTraceElement();
    }
}

问题2：无法获取异常栈顶的目标方法名 #

原因 #

Timber默认的createStackElementTag获取的是调用Timber.e()的那个方法的栈信息，而err.getStackTrace()[0]拿到的是抛出异常的那个方法的栈信息，两者指向的代码位置完全不同，所以日志效果自然不一致。

解决方案 #

方案1：手动拼接异常栈顶信息（简单直接）

在处理异常时，直接从异常栈中取出目标方法名，拼到日志里：

}, err -> {
    // 取异常栈的第一个元素，就是抛出异常的位置
    StackTraceElement exceptionSource = err.getStackTrace()[0];
    // 打印异常来源信息
    Timber.e("异常抛出位置：%s() 位于 %s:%d", 
        exceptionSource.getMethodName(), 
        exceptionSource.getFileName(), 
        exceptionSource.getLineNumber());
    // 同时打印完整异常栈
    Timber.e(err, "错误详情");
}

方案2：自定义Tree自动添加异常栈顶信息

如果想全局统一处理，修改log方法，当传入异常时自动把栈顶信息加到日志开头：

public class MyDebugTree extends Timber.DebugTree {
    @Override
    protected void log(int priority, String tag, String message, Throwable t) {
        String finalMessage = message == null ? "" : message;
        // 如果有异常，就添加栈顶信息前缀
        if (t != null && t.getStackTrace().length > 0) {
            StackTraceElement exceptionElement = t.getStackTrace()[0];
            String exceptionPrefix = String.format("[异常来自 %s() 于 %s:%d] ", 
                exceptionElement.getMethodName(), 
                exceptionElement.getFileName(), 
                exceptionElement.getLineNumber());
            finalMessage = exceptionPrefix + finalMessage;
        }
        super.log(priority, tag, finalMessage, t);
    }
}

之后只要调用Timber.e(err, "错误提示")，日志就会自动带上异常抛出的方法名和位置信息。

内容的提问来源于stack exchange，提问作者WHOATEMYNOODLES