Android JetPack源码分析技巧

本文从《一文搞懂Android JetPack组件原理之Lifecycle、LiveData、ViewModel与源码分析技巧》
拆分而来，原文内容更加全面，欢迎收藏。

Android Jetpack是一个比较新的开源库，包含了丰富的单元测试用例和Demo工程，甚至可以从提交记录中看到官方的开发流程和bug修复记录。这些信息也一定程度上可以帮助我们分析JetPack的原理，在这里就和大家分享几个技巧心得，希望帮助到大家。

源码下载
官方地址: https://android.googlesource.com/platform/frameworks/support/或Github: https://github.com/androidx/androidx，以上都列出了比较详细的下载步骤和编译方法，按步骤操作一般没多大问题，如果已经安装过repo工具，可以跳过第一步。

安装repo

mkdir ~/bin
PATH=~/bin:$PATH
curlhttps://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
chmod a+x ~/bin/repo

配置git中的姓名和邮箱，已配置可忽略

git config --globaluser.name "Your Name"
git config --globaluser.email "you@example.com"

创建一个文件夹存放要下载的源码

mkdir androidx-master-dev
cd androidx-master-dev

使用repo命令下载源码仓库

repo init -u https://android.googlesource.com/platform/manifest -b androidx-master-dev
repo sync -j8 -c

使用命令以Android Studio打开源码库

cd androidx-master-dev/frameworks/support/
./studiow

第一次打开可能会自动下载一个最新的Android Studio，稍等一会儿，就可以看到熟悉的界面了。

源码分析技巧

比较顺手的技巧有查看代码提交记录、使用单元测试和运行Demo工程，这里分享下查看代码提交记录和使用单元测试的具体做法，其它方式大家可以自行挖掘，也希望一起交流进步。

查看代码提交记录

比如Lifecycling的lifecycleEventObserver()方法比较复杂，刚开始不太能理解这个方法封装注解解析后的监听者那部分逻辑。可以使用以下方法查看这几行的提交记录，方便理解。

查看Annotate

点击相关行，查看提交信息

双击相关类，查看改动记录

在改动记录中，还可以继续查看Annotation，理解原有的功能

继续查看Annotation

可以使用该技巧先理解旧功能是什么样的，从而对比出这次改动所增加的特性。

以本例来说，可以看出旧getObserverConstructorType()方法是直接返回构造对象，这个构造对象可能是注解处理器生成的类的，也可能是普通监听者需要用反射处理的类的，然后用这个构造对象创建出监听器的封装。而这次修改了getObserverConstructorType()返回为解析后的结果类型，包括REFLECTIVE_CALLBACK和GENERATED_CALLBACK，再用这个类型和getObserverConstructorType()方法中解析的缓存判断应该创建哪个监听器的封装对象。这次增加的功能点是对实现多个LifecycleObserver接口的监听器的支持，可以在单元测试类GeneratedAdapterTest中找到具体使用示例。

interface OnPauses extends LifecycleObserver {
    @OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
    void onPause();
    @OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
    void onPause(LifecycleOwner owner);
} 

interface OnPauseResume extends LifecycleObserver {
    @OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
    void onPause();
    @OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
    void onResume();
}

class Impl1 implements OnPauses, OnPauseResume {
    List<String> mLog;

    Impl1(List<String> log) {
        mLog = log;
    }

    @Override
    public void onPause() {
        mLog.add("onPause_0");
    }

    @Override
    public void onResume() {
        mLog.add("onResume");
    }

    @Override
    public void onPause(LifecycleOwner owner) {
        mLog.add("onPause_1");
    }
}

比如上面的Impl1实现了OnPauses和OnPauseResume两个LifecycleObserver接口，这次增加的功能点就是对Impl1也可以使用注解解析器生成封装类，以优化性能。

使用单元测试用例

JetPack中的单元测试非常丰富，而且从提交信息中一般都可以看到本次改动对应修改的单元测试类，比如上面的例子中，Commit Message可以看到“Test: GeneratedAdaptersTest”，可以很快定位到该单元测试，再加上断点调试的手段，更快地理解源码。

比如，之前一直有提到注解解析器生成的监听器封装类，那这个类具体代码是什么样的呢，就可以在GeneratedAdaptersTest找到使用注解的实例，再通过断点找到这个类。

GeneratedAdaptersTest

debug运行testOnAny()测试

debug

通过堆栈可以定位到GeneratedAdaptersTest_TestObserver_LifecycleAdapter类，

public class GeneratedAdaptersTest_TestObserver_LifecycleAdapter implements GeneratedAdapter {
  final GeneratedAdaptersTest.TestObserver mReceiver;

  GeneratedAdaptersTest_TestObserver_LifecycleAdapter(GeneratedAdaptersTest.TestObserver receiver) {
    this.mReceiver = receiver;
  }

  @Override
  public void callMethods(LifecycleOwner owner, Lifecycle.Event event, boolean onAny,
      MethodCallsLogger logger) {
    boolean hasLogger = logger != null;
    if (onAny) {
      if (!hasLogger || logger.approveCall("onAny", 1)) {
        mReceiver.onAny();
      }
      return;
    }
    if (event == Lifecycle.Event.ON_CREATE) {
      if (!hasLogger || logger.approveCall("onCreate", 1)) {
        mReceiver.onCreate();
      }
      return;
    }
  }
}

该类既是注解解析器生成的监听器封装类，它的callMethods()方法的实现由TestObserver的注解决定，TestObserver中使用了ON_CREATE和ON_ANY注解，所以除了onAny为true的情况，callMethods()只回调监听者的onCreate()方法。

注解处理器的实现可以定位到lifecycle-compiler项目中看，这里限于篇幅就不展开了。

注解处理器

另外，还有一些源码分析工具可以提高分析的效率，比如SimpleUML和SequenceDiagram插件等，大家如果有其它想法和心得，欢迎在评论区分享交流。