zoukankan      html  css  js  c++  java
  • Android 日志记录杂谈-Logger,Timber,logback-android

    转载:http://www.jianshu.com/p/39834be3cb6c

    “Every time you log in production, a puppy dies.” – Jake Wharton

    做安卓项目中,调试程序的时候一般会进行打log来查看相关信息,而我原来是使用的系统自带的Log来打印。

    归结二个问题:<信息显示>,<信息存储>,就这二个问题我们具体来看如何解决

    -----------------------主体分割君---------------------------------------------------

    1.信息显示

    可能代码中你是这么写的log:Log.v(tag,"XXXX");当项目越来越多了。你查看log的时候发现,这个log信息不知道是哪个文件甚至哪段代码生成的,然后又要回头去找写这段log代码。而且一大片log信息挑出来后你看的眼睛也要花了。这时候我们是不是没办法,只能大海捞针一样来看,或者关键字tag来搜索。答案当然是不用。(这B装的我好累)

    所以根据这个情况我网上搜索后,发现挺多推荐Logger,于是我便使用Logger。

    看到Logger所能提供的功能:

    1.Thread information

    2.Class information

    3.Method information

    4.Pretty-print for json content

    5.Pretty-print for new line " "

    6.Clean output

    7.Jump to source

    -

    先上Logger源码地址:https://github.com/orhanobut/logger
    首先在build.gradle中引入Logger:
    compile 'com.orhanobut:logger:1.15'
    然后直接在代码中就可以使用Logger了。先看效果:

    public class Act_Logger extends Activity{
    
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
           //设置tagname,可以不写,默认为“PRETTYLOGGER”
          //  Logger.init("tagname");
    
            String name = "billy";
            Logger.d("你好啊,某某人");
            Logger.d("你好啊,%s",name);
            getString(name);
    
            ArrayList<UserBean> list = new ArrayList<UserBean>();
            list.add(new UserBean("user1",1));
            list.add(new UserBean("user2",2));
            list.add(new UserBean("user3",3));
            list.add(new UserBean("user4",4));
    
            Logger.d(list);
    
        }
    
        public void getString(String name){
            Logger.e("你好啊,%s",name);
        }
    }

    屏幕快照 2016-11-24 11.40.22 AM.png

    我们从Log信息中可以查看到线程的name,具体到哪个类,哪个方法,都有显示,而且Log信息也十分美观。
    而且可以点击跳到相应的代码处。十分方便,同时打印的时候支持Array, Map, Set 和 List。


    description.png

    什么,你觉得这样也没怎么样?那么如果你想查看一个json的信息,原来的log中json的排版也不(keng)错(die),现在来看看Logger中的json的信息显示。


    logger-log.png

    瞬间感觉高大上。快给同事们看看。

    这里提到一个小功能,为啥

       Logger.d("你好啊,某某人");
       Logger.d("你好啊,%s",name);

    都可以支持。

    是因为最终都调用了

    private String createMessage(String message, Object... args) {      
        return args == null || args.length == 0 ? message : String.format(message, args);
    }

    然后再用系统的Log来打印字符串。

    主要我觉得createMessage这个代码片段可以拿来作为util工具的一个方法挺方便的。就拿来用在自己项目里面了。

    2.信息存储

    Log如果我们用手机连着电脑调试,这时候是方便,可以一边操作一边查看信息,但是万一是安装到了某个客户手机上,或者某个安卓设备上,这时候你有某个需求需要去知道他的Log的信息,那时候难道你要连着电脑一边操作一边查看Log信息?

    这里网上我又查看了下,还是老套路,发现大家推荐Timber。然后我就使用了Timber。这个其实是Log的封装库,废话不多说。脱光衣服直接上。

    老套路,先附上Timber的源码地址:
    https://github.com/JakeWharton/timber

    在build.grade中引入Timber:
    compile 'com.jakewharton.timber:timber:4.3.1'

    在继承Application的自定义类中,设置Timber的树,其实Timber是类似管理着一片森林,具体用哪棵树是你自己这边决定的。比如Timber自带的是DebugTree这个类。

    @Override
    public void onCreate() {    
              super.onCreate();    
             //在这里先使用Timber.plant注册一个Tree,然后调用静态的.d .v 去使用     
              if (BuildConfig.DEBUG) {    
                    Timber.plant(new Timber.DebugTree());    
              } else {        
                    Timber.plant(new FileLoggingTree());    
              }
    }

    然后就可以使用了

    Timber.tag("code_gg");        
    Timber.d("test Timber %d",10);

    然后上面的FileLoggingTree是我这边自己写的一棵树,就是当我用Timber这个封装库拿到了Log的信息后,后面就可以我们自己处理了。比如写到文件中等。我这边先写了一个傻白甜的FileLoggingTree类,仅供参考。后面我们会用到另外一个第三方,就更强大了。

    其中String CacheDiaPath = context.getCacheDir().toString();

    private static class FileLoggingTree extends Timber.Tree {
            @Override
            protected void log(int priority, String tag, String message, Throwable t) {
                if (TextUtils.isEmpty(CacheDiaPath)) {
                    return;
                }
                File file = new File(CacheDiaPath + "/log.txt");
                Log.v("dyp", "file.path:" + file.getAbsolutePath() + ",message:" + message);
                FileWriter writer = null;
                BufferedWriter bufferedWriter = null;
                try {
                    writer = new FileWriter(file);
                    bufferedWriter = new BufferedWriter(writer);
                    bufferedWriter.write(message);
                    bufferedWriter.flush();
    
                } catch (IOException e) {
                    Log.v("dyp", "存储文件失败");
                    e.printStackTrace();
                } finally {
                    if (bufferedWriter != null) {
                        try {
                            bufferedWriter.close();
                        } catch (IOException e) {
                            e.printStackTrace();
                        }
                    }
                }
            }
    }

    log方法参数一共有int priority, String tag, String message, Throwable t这四个参数,而我这边就是简单的拿了message这个参数的内容,然后保存到了我指定路径下的log.txt文件中。当然Timber可以自己封装.

    比如还有记录崩溃信息的树

     /**
         * A tree which logs important information for crash reporting.
         */
        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);
                    }
                }
            }
        }

    当然我觉得我写的挺low的。后来我又去查看了一些能写到文件中的log的第三方。发现了logback-android。
    logback-android很强大,可以存储信息到
    -files
    -SQLite databases
    -logcat
    -sockets
    -syslog
    -email

    所以我们可以用Timber配合logback-android来模拟存储到文件中。

    首先又是老样子,附上logback-android源码地址:
    https://github.com/tony19/logback-android

    第一步:引入logback-android

    Gradle

    // only needed for SNAPSHOT builds
    repositories {
      maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
    }
    
    dependencies {
      compile 'org.slf4j:slf4j-api:1.7.21'
      compile 'com.github.tony19:logback-android-core:1.1.1-6'
      compile 'com.github.tony19:logback-android-classic:1.1.1-6'
    }

    第二步:在以下位置创建一个logback.xml文件,默认情况下这个路径和文件名是固定的


    Paste_Image.png

    第三步:配置logback文件

    <!--debug属性用来决定是否打印logback的日志信息-->
    <configuration debug='false'>
    
        <!--声明一个属性,用来指定log文件存放的路径-->
        <property name="LOG_DIR" value="/sdcard/rlog"/>
    
        <!--声明一个时间戳-->
        <timestamp datePattern="yyyyMMdd" key="today"/>
    
        <!--用于在控制台输出的Appender-->
        <appender name="LOGCAT" class="ch.qos.logback.classic.android.LogcatAppender">
            <encoder>
                <pattern>%-5relative [%thread][%file:%M:%line] - %msg%n</pattern>
            </encoder>
        </appender>
    
        <!--声明一个FileAppender-->
        <appender name="BASE_FILE" class="ch.qos.logback.core.FileAppender">
            <!--初始化的时候不创建文件,在第一次使用的时候创建文件-->
            <lazy>true</lazy>
            <!--log追加到文件,否则覆盖文件-->
            <append>true</append>
            <!--用来保存log的文件全路径-->
            <file>${LOG_DIR}/base.log</file>
            <!--输出log的格式-->
            <encoder>
                <!--<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} [%file:%line] - %msg%n</pattern>-->
                <pattern>%date [%thread] %-5level %logger{36} [%file:%line] - %msg%n</pattern>
            </encoder>
        </appender>
    
        <!--声明一个RollingFileAppender-->
        <appender name="BASE_ROLL_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${LOG_DIR}/base.roll.${today}.log</file>
            <append>true</append>
            <encoder>
                <pattern>%date %-5relative [%thread] %-5level %logger{36} [%file:%M:%line] - %msg%n
                </pattern>
            </encoder>
    
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${LOG_DIR}/base.roll.%d{yyyy-MM-dd}.log</fileNamePattern>
                <!--最大保存7天的日志-->
                <maxHistory>7</maxHistory>
            </rollingPolicy>
    
            <!--文件大于10mb,切换文件-->
            <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
                <maxFileSize>10MB</maxFileSize>
            </triggeringPolicy>
        </appender>
    
        <!--指定logtest采用BASE_ROLL_FILE声明的RollingFileAppender输出日志-->
        <logger name="logtest">
            <appender-ref ref="BASE_ROLL_FILE"/>
        </logger>
    
        <!-- Write INFO (and higher-level) messages to the log file -->
        <root level="TRACE">
            <appender-ref ref="LOGCAT"/>
        </root>
    
        <!--支持的level-->
        <!--TRACE-->
        <!--DEBUG-->
        <!--INFO-->
        <!--WARN-->
        <!--ERROR-->
    
        <!--<pattern>
          %d{yyyy-MM-dd HH:mm:ss} [%level] - %msg%n
          Logger: %logger
          Class: %class
          File: %file
          Caller: %caller
          Line: %line
          Message: %m
          Method: %M
          Relative: %relative
          Thread: %thread
          Exception: %ex
          xException: %xEx
          nopException: %nopex
          rException: %rEx
          Marker: %marker
          %n
      </pattern>-->
    
        <!--引用其他位置的配置信息-->
        <!--<includes>-->
        <!--<include file="/sdcard/foo.xml"/>-->
        <!--<include resource="assets/config/test.xml"/>-->
        <!--<include resource="AndroidManifest.xml"/>-->
    
        <!--<include file="/sdcard/logback/logback-test.xml"/>-->
        <!--<include file="/sdcard/logback/logback.xml"/>-->
        <!--<include resource="AndroidManifest.xml"/>-->
        <!--<include resource="assets/logback-test.xml"/>-->
        <!--<include resource="assets/logback.xml"/>-->
        <!--</includes>-->
    </configuration>

    还有其他的appender提供,详细说明移步: http://logback.qos.ch/manual/appenders.html

    第四步:
    可以在代码里面使用logback-android了

    //以下日志只会在控制台输出
    //        Logger logger = LoggerFactory.getLogger(MainActivity.class);
    //        logger.trace("angcyo-->{}","trace");
    //        logger.debug("angcyo-->{}","debug");
    //        logger.info("angcyo-->{}","info");
    //        logger.warn("angcyo-->{}","warn");
    //        logger.error("angcyo-->{}","error");
    
    //以下日志会在BASE_ROLL_FILE声明的文件中输出,并且也会在控制台输出
            Logger logger = LoggerFactory.getLogger("logtest");
            logger.trace("angcyo-->{}","trace");
            logger.debug("angcyo-->{}","debug");
            logger.info("angcyo-->{}","info");
            logger.warn("angcyo-->{}","warn");
            logger.error("angcyo-->{}","error");

    保存在文件中的Log信息:


    Paste_Image.png

    现在可以用logback-android 来写一颗树供Timber来使用:

    public class FileLoggingTree extends Timber.DebugTree {
    
        static Logger mLogger = LoggerFactory.getLogger(FileLoggingTree.class);
    
        @Override
        protected void log(int priority, String tag, String message, Throwable t) {
            if (priority == Log.VERBOSE) {
                return;
            }
    
            String logMessage = tag + ": " + message;
            switch (priority) {
                case Log.DEBUG:
                    mLogger.debug(logMessage);
                    break;
                case Log.INFO:
                    mLogger.info(logMessage);
                    break;
                case Log.WARN:
                    mLogger.warn(logMessage);
                    break;
                case Log.ERROR:
                    mLogger.error(logMessage);
                    break;
            }
        }
    }

    然后再调用Timber.plant(new FileLoggingTree());就可以了。

     
  • 相关阅读:
    vue样式的动态绑定
    vue表单选项框
    vue简单逻辑判断
    vue的选项卡功能
    简单vue的监听属性(单位换算)
    简单的Vue计算属性
    vue.js 入门
    head元素的内容
    HTML实体
    CSS元素的盒类型
  • 原文地址:https://www.cnblogs.com/benchao/p/7197723.html
Copyright © 2011-2022 走看看