Hugo 应用内方法调用监控实践

做项目的时候有时候需要打印方法的传参和返回值，甚至方法的执行时间，有没有一种简单方便通用的方式去做这个呢，Hugo就可以。
使用方法很简单，Hugo是基于注解被调用的，引入相关依赖后，在方法上加上 @DebugLog 即可, 也可以在类前加上@DebugLog， 对该类的所有方法都可以监控到。
Hugo这个项目使用起来其实非常简单， 但我对gradle编译不是太熟悉， 中间花了1天多的时间来解决编译上的问题。

方法总结如下:

新建一个工程myapplication

1. 只需要在build.gradle上加上这几句话就可以了, android studio会远程下载需要的依赖包.

buildscript {
    repositories {
        mavenCentral()
    }

    dependencies {
        classpath 'com.jakewharton.hugo:hugo-plugin:1.2.1'
    }
}

apply plugin: 'com.android.application'
apply plugin: 'com.jakewharton.hugo'

2. 在class前或是方法前加上注解@DebugLog

import hugo.weaving.DebugLog;

@DebugLog
public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        getName("ahking","wang");
    }

    @Override
    protected void onPause() {
        super.onPause();
    }

    public String getName(String first, String last) {
        SystemClock.sleep(15); // Don't ever really do this!
        return first + " " + last;
    }
}

3. 在logcat中可以看到输出的log信息

08-05 10:41:23.677  10151-10151/com.example.myapplication V/MainActivity﹕ ⇢ ()
08-05 10:41:23.687  10151-10151/com.example.myapplication V/MainActivity﹕ ⇠  [0ms]
08-05 10:41:23.687  10151-10151/com.example.myapplication V/MainActivity﹕ ⇢ onCreate(savedInstanceState=null)
08-05 10:41:23.768  10151-10151/com.example.myapplication V/MainActivity﹕ ⇢ getName(first="ahking", last="wang")
08-05 10:41:23.788  10151-10151/com.example.myapplication V/MainActivity﹕ ⇠ getName [15ms] = "ahking wang"
08-05 10:41:23.788  10151-10151/com.example.myapplication V/MainActivity﹕ ⇠ onCreate [102ms]
08-05 10:41:23.898  10151-10151/com.example.myapplication V/MainActivity﹕ ⇢ onCreateOptionsMenu(menu=android.support.v7.view.menu.MenuBuilder@41658010)
08-05 10:41:23.908  10151-10151/com.example.myapplication V/MainActivity﹕ ⇠ onCreateOptionsMenu [1ms] = true
08-05 10:41:32.286  10151-10151/com.example.myapplication V/MainActivity﹕ ⇢ onPause()
08-05 10:41:32.286  10151-10151/com.example.myapplication V/MainActivity﹕ ⇠ onPause [0ms]

以getName()的调用为例, 不仅输出了调用参数， 而且输出返回值， 以及这个方法的执行时间， 这对于调试性能问题是非常有帮助的.
完整的项目代码在: /home/wangxin/src/github/hugo/myapplication

应用在chromium项目上

把hugo应用在chromium项目上， 只在build.gradle上添加上面的那几句话， 编译是无法通过的。
通过在myapplication项目上查看@DebugLog的定义， 发现它的实现在这里:

/home/wangxin/.gradle/caches/modules-2/files-2.1/com.jakewharton.hugo/hugo-annotations/1.2.1/52d129a681468a4df976ff411fd163265dc6f99c/hugo-annotations-1.2.1-sources.jar

于是在chrome的build.gradle上连蒙带猜的添加:

dependencies {
    compile fileTree(dir: 'libs', exclude: 'android-support-multidex.jar', include: '*.jar')
    compile 'com.android.support:multidex:1.0.0'
    compile project(':mediaplayer')
    compile project(':web_contents_delegate_android')
    compile project(':browser_I')
    compile project(':chromium_gen')
    compile files('libs/hugo-annotations-1.2.1-sources.jar') //加上这行
    compile files('libs/decrawso.jar')
    compile files('libs/qihoospeechrecognition.jar')
    compile files('libs/QHStatAgent.jar')
    compile files('libs/adsdk_0.1.16.1125.jar')
    compile files('libs/andfix.jar')
    compile files('libs/opensdk-release.jar')
}
//需要把jar文件拷贝到 “/home/wangxin/src/src_chrome45ce_rel_v6/m_browser_chromium/chrome/android/java/libs”目录下

在build.gradle的末尾的{}外, 再加上下面这几行代码:

buildscript {
    repositories {
        mavenCentral()
    }

    dependencies {
        classpath 'com.jakewharton.hugo:hugo-plugin:1.2.1'
    }
}
apply plugin: 'com.jakewharton.hugo'

在ChromeTabbedActivity类前加上注解

import hugo.weaving.DebugLog;
@DebugLog
public class ChromeTabbedActivity extends ChromeActivity implements ActionBarDelegate,
        OverviewModeObserver, INetworkChangeListener, IOrientationListener {

Log输出如下:

08-05 14:36:32.502  21461-21461/com.qihoo.browser V/ChromeTabbedActivity﹕ ⇠ postInflationStartup [131ms]
08-05 14:36:32.512  21461-21461/com.qihoo.browser V/ChromeTabbedActivity﹕ ⇢ onStart()
08-05 14:36:32.512  21461-21461/com.qihoo.browser V/ChromeTabbedActivity﹕ ⇠ onStart [0ms]
08-05 14:36:32.512  21461-21461/com.qihoo.browser V/ChromeTabbedActivity﹕ ⇢ onResume()
08-05 14:36:32.522  21461-21461/com.qihoo.browser V/ChromeTabbedActivity﹕ ⇠ onResume [3ms]
08-05 14:36:32.963  21461-21461/com.qihoo.browser V/ChromeTabbedActivity﹕ ⇢ onCreateWithNative()
08-05 14:36:32.963  21461-21461/com.qihoo.browser V/ChromeTabbedActivity﹕ ⇢ AsyncLoadData()
08-05 14:36:32.963  21461-21461/com.qihoo.browser V/ChromeTabbedActivity﹕ ⇢ cacheFrequentFromDb()
08-05 14:36:32.983  21461-21461/com.qihoo.browser V/ChromeTabbedActivity﹕ ⇠ cacheFrequentFromDb [13ms]
08-05 14:36:32.983  21461-21461/com.qihoo.browser V/ChromeTabbedActivity﹕ ⇠ AsyncLoadData [13ms]
08-05 14:36:32.983  21461-21461/com.qihoo.browser V/ChromeTabbedActivity﹕ ⇠ onCreateWithNative [19ms]

到此为止，终于把Hugo在这个项目中用上了.

在开发和调试中的实际作用

1. 方便打log

这点毋庸置疑，一行代码解决了一个类的所有log打印的作用， 而且还自动加上了调用参数， 返回参数，执行时间等信息.

2. 性能调试更方便

方法的执行时间一目了然， 比用traceview要方便的多. 对于发现耗时方法很是有帮助.

3. 对于一些疑难bug的解决

比如我现在碰到的一个问题， 启动浏览器有时候闪屏，有时候却又不闪屏， 那很可能是启动过程不一致造成的问题。
通过脚本把所有的类前都加上@DebugLog注释
通过hugo把2次log收集起来， 再通过对比， 就可以比较容易的发现2次启动过程在执行过程中有哪些差异，找到造成bug的代码点。

4. 快速找到某个操作在代码中的对应位置

正常开发中， 不可能在所有的方法中都加上log信息， 通过hugo，例如点了某个菜单项， 可以快速定位到这个操作在项目代码中的位置，提高我们的开发效率.

碰到的一个小问题

hugo @debugLog 使用到整个类的时候， 小概率会出现行为异常.
遇到过一次， 使用到ThemeOnlinePreviewActivityV3.java上， 一直数据显示不出来. 所以在使用hugo的时候要注意这一点， 如果出现行为异常， 可以尝试把@debugLog去掉，看看是不是就正常了.

Refer:

https://github.com/JakeWharton/hugo/ //大神JakeWharton实现的一套方法调用监控.
http://www.open-open.com/lib/view/open1451870348761.html //使用介绍
https://yq.aliyun.com/articles/7104 //实现原理
==== done ====