android产品研发（二十二）-->android实用调试技巧

转载请标明出处：一片枫叶的专栏

上一篇文章中我们讲解了android UI优化方面的知识。我们讲解了android中的include、marge、ViewStub标签，在使用这些标签时可以简化我们的布局文件，优化组件绘制流程；讲解了android中的过度绘制相关知识点，通过优化我们的App过度绘制可以提高App的UI绘制流程与性能；我们还讲解了App中一些UI优化的小tips。更多关于android UI优化方面的知识可以参考我的：android产品研发（二十一）–>android中的UI优化

本文我们将讲解android中的调试技巧。程序调试，是将编制的程序投入实际运行前，用手工或编译程序等方法进行测试，修正语法错误和逻辑错误的过程。这是保证计算机信息系统正确性的必不可少的步骤。在android开发过程中熟练的使用调试技巧是一个很重要的方面。android的调试技巧包括熟练使用android中的日志API，自定义android日志框架，通过gradle配置调试日志，android studio的调试技巧等等。通过对本文的学习我们能够对android中调试技巧有一个大概的了解。

android中的打印API：

我们首先来看一下android中提供的打印日志API：

android.util.Log.java

这个类比较常用的打印日志的方法有5个,这5个方法都会把日志打印到AndroidMonitor中，android中日志分为五个级别：

Log.v(tag,message); //verbose模式,打印最详细的日志
Log.d(tag,message); //debug级别的日志
Log.i(tag,message); //info级别的日志
Log.w(tag,message); //warn级别的日志
Log.e(tag,message); //error级别的日志

其中tag和message分别是两个String值.从android开发帮助文档中来看,tag和message的定义分别是:

tag：Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg：The message you would like logged.

可看出tag用来标记log消息的源头的。而message则是这条log的内容.

一个简单的Log API例子

Log demo代码：

/**
 * 按钮点击事件，打印各个级别的日志
 */
button6.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Log.v(TAG, "this is a verbose log!!!");
                Log.d(TAG, "this is a debug log!!!");
                Log.i(TAG, "this is a info log!!!");
                Log.w(TAG, "this is a warning log!!!");
                Log.e(TAG, "this is a error log!!!");
            }
        });

好吧，我们点击按钮，看一下AndroidMonitor中的打印结果：

07-17 19:22:16.202 7530-7530/uuch.com.android_activityanim V/MainActivity: this is a verbose log!!!
07-17 19:22:16.202 7530-7530/uuch.com.android_activityanim D/MainActivity: this is a debug log!!!
07-17 19:22:16.202 7530-7530/uuch.com.android_activityanim I/MainActivity: this is a info log!!!
07-17 19:22:16.202 7530-7530/uuch.com.android_activityanim W/MainActivity: this is a warning log!!!
07-17 19:22:16.203 7530-7530/uuch.com.android_activityanim E/MainActivity: this is a error log!!!

通过这种android自身Log API打印日志的方式，是最常见的一种打印日志的，调试代码的方式，基本上所有的项目中你可能都会遇到这种日志代码，前面的一篇文章中我也分析了Log日志的部分源码，具体可参考我的：android源码解析之（六）–>Log

但是呢你会发现这时候打印的日志格式比较简陋，比如出现异常的时候我们想快速定位到代码在哪，这时候就比艰难了，所以下面我们讲一下自定义日志框架。

自定义android打印框架MLog：

前面我们发现使用Android原生的Log API打印的日志格式比较简陋，那么可不可以定制化的显示一些友好型的日志信息呢？答案是肯定的，在前面的文章中我介绍了一个自定义的日志框架MLog，可参考我的：github项目解析（五）–>android日志框架

关于MLog框架的使用方式，实现过程等已在文章中做过简单的介绍，这里就看一下其打印的日志格式：

自定义按钮点击事件：

在Application中初始化MLog框架

/**
 * 传入为true，则表示执行打印操作，否则不显示日志
 */
MLog.init(true);

尽量可以在Application的onCreate方法中执行，这是App的进程起始方法。

在源代码中执行打印日志的操作

/**
 * 自定义按钮的点击事件
 */
button6.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                MLog.v(TAG, "this is a verbose log!!!");
                MLog.d(TAG, "this is a debug log!!!");
                MLog.i(TAG, "this is a info log!!!");
                MLog.w(TAG, "this is a warning log!!!");
                MLog.e(TAG, "this is a error log!!!");
            }
        });

在AndroidMoitor中打印的日志格式和内容：

这样我们在点击日志信息的时候就能够跳转到这条日志的代码打印位置，是不是很方便？而且如果觉得日志格式不是很好的话，还可以定制化展示奥。

比如：

怎么样？是不是很好看了？

具体如何实现自定义Log框架以及自定义实现Log的显示样式可以参考我的：github项目解析（五）–>android日志框架

大多时候我们的App都有测试环境和正式环境两种环境的，当切换环境的时候要求我们在测试环境打印日志，则正式环境屏蔽日志，通过代码也可以实现，但是比较麻烦，有没有一个比较简单的方法呢？答案是肯定的，可以通过配置gradle的方式配置在测试环境中打印日志，在正式环境中屏蔽日志打印操作。

gradle中配置正式测试打印框架：

我们知道在android开发过程中为了调试代码经常在代码中添加一些日志信息，但是正式环境是不需要这些日志信息的，而且过得日志打印操作也会对App的性能有影响。

一个比较好的办法就是在App的测试环境中打印日志信息，在正式环境中屏蔽日志信息，那么如何实现呢？通过代码么？通过代码也是可以实现的，但是这样显得太原始了，其实android studio的gradle插件已经提供了这样的功能。

那么如何通过gradle配置日志打印信息呢？

buildTypes {
        debug {
            // 显示Log
            buildConfigField "boolean", "LOG_DEBUG", "true"
            //混淆
            minifyEnabled false
            //Zipalign优化
            zipAlignEnabled true
            // 移除无用的resource文件
            shrinkResources true
            //加载默认混淆配置文件
            proguardFiles getDefaultProguardFile(‘proguard-android.txt‘), ‘proguard-rules.pro‘
            //签名
            signingConfig signingConfigs.debug
        }
        release {
            // 不显示Log
            buildConfigField "boolean", "LOG_DEBUG", "false"
            //混淆
            minifyEnabled true
            //Zipalign优化
            zipAlignEnabled true
            // 移除无用的resource文件
            shrinkResources true
            //加载默认混淆配置文件
            proguardFiles getDefaultProguardFile(‘proguard-android.txt‘), ‘proguard-rules.pro‘
            //签名
            signingConfig signingConfigs.relealse
        }
    }

在android studio的module的gradle配置文件中，在buildTypes节点下可以配置自定义参数，这里我们在debug版本中定义LOG_DEBUG为true，在release版本中定义LOG_DEBUG为false。这样在编译的时候就会在gradle的编译类BuildConfig中生成成员变量:

LOG_DEBUG

若是正式环境则LOG_DEBUG的值为false
若是测试环境则LOG_DEBUG的值为true

所以这时候可以通过LOG_DEBUG变量的值控制日志是否打印。

/**
 * 在Application的onCreate方法中初始化MLog日志框架
 * 并根据apk环境判断是否显示日志信息
 */
if (BuildConfig.LOG_DEBUG == true) {
    MLog.init(true);
} else {
    MLog.init(false);
}

我们实现的MLog框架的init方法