Android更好的打印方式Timber使用简单记录

Timber进行打印，好处是使用简单，不用输入tag（tag自动为打印位置类的类名），并且可以一开始就设置是否打印，相当于有个控制打印的总开关。

 

一、引入依赖：

compile 'com.jakewharton.timber:timber:4.5.0'

 

二、gradle如下设置：

            android {
                buildTypes {
                    ...
                    release {
                        ...
                        debuggable false
                    }
                    debug {
                        ...
                        debuggable true
                    }
                }
            }

 

 

三、TimberUtil.java工具类：

package com.dway.utils;

import android.os.Environment;
import android.util.Log;

import com.dway.test.BuildConfig;

import java.io.File;

import timber.log.Timber;

/**
 * Timber打印开关工具类
 * 注意：1、需要依赖Timber，如：compile 'com.jakewharton.timber:timber:4.5.0'
        2、gradle中设置如下：
            android {
                buildTypes {
                    ...
                    release {
                        ...
                        debuggable false
                    }
                    debug {
                        ...
                        debuggable true
                    }
                }
            }
 * 使用：1、设置：Application设置下打印的模式
 *       2、打印：例如Timber.v("---onCreate---");打印的Tag会自动设置为代码所在的类名
 * Created by dway on 2017/8/9.
 */

public class TimberUtil {

    private final static String LOG_FILE_PATH = Environment.getExternalStorageDirectory().getPath() + File.separator + "log.test";

    /**
     * 设置log始终打开，可以在Application的onCreate中设置
     */
    public static void setLogDebug(){
        Timber.plant(new Timber.DebugTree());
    }

    /**
     * 设置log自动在debug打开，在release关闭，可以在Application的onCreate中设置
     */
    public static void setLogAuto(){
        if (BuildConfig.DEBUG) {//debug版本
            Timber.plant(new Timber.DebugTree());
        } else {//release版本
            Timber.plant(new CrashReportingTree());//打印关，同时gradle中的release的debuggable要设置为false
        }
    }

    /**
     * 设置log自动，并且想在release时仅在测试时有打印，
     * 在release版本时增加判断磁盘目录下是否存在文件 log.test，
     * 测试时让测试人员在磁盘目录下建立这么个文件。
     * 注意，如果读取存储需要权限申请的话，需要先获得权限，才能调用
     */
    public static void setLogAutoEx(){
        if (BuildConfig.DEBUG) {//debug版本
            Timber.plant(new Timber.DebugTree());
        } else {//release版本
            File logFile = new File(LOG_FILE_PATH);
            if(logFile.exists()){
                Timber.plant(new Timber.DebugTree());//打印开
            }else {
                Timber.plant(new CrashReportingTree());//打印关，同时gradle中的release的debuggable要设置为false
            }
        }
    }

    private static class CrashReportingTree extends Timber.Tree {
        @Override
        protected void log(int priority, String tag, String message, Throwable t) {
            if (priority == Log.VERBOSE || priority == Log.DEBUG) {
                return;
            }
            //FakeCrashLibrary.log(priority, tag, message);
            if (t != null) {
                if (priority == Log.ERROR) {
                    //FakeCrashLibrary.logError(t);
                } else if (priority == Log.WARN) {
                    // FakeCrashLibrary.logWarning(t);
                } else {

                }
            }
        }
    }

}

 

 

四、使用，一般Application中设置后，其他地方可以任意使用：

public class MyApp extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        
        //设置log自动在apk为debug版本时打开，在release版本时关闭
        TimberUtil.setLogAuto();
        //也可以设置log一直开
        //TimberUtil.setLogDebug();
        
        //打印tag为类名
        Timber.v("---onCreate---");
    }

}

设置为auto模式，那么在打包release的apk时，就能自动去掉了打印，平常debug时则可以看到打印信息。

 

五、也可以自己封装一个简单的打印工具类LogUtil，使用更简单，不需要任何依赖。

LogUtil工具类请参考另一篇博文 https://blog.csdn.net/lin_dianwei/article/details/82662653