android data binding实践之：源码的正确打开姿势

android data binding实践之：源码的正确打开姿势

最近在深入学习android data binding库，一边写demo，一边看库的源码。但是在导入android data binding库的时候却遇到了各种麻烦。各种谷歌未果，最后折腾了一天终于找到了正确打开源码的姿势。这里mark一下给同样踩坑的人。

首先献上data binding库的源码仓库地址

git clone https://android.googlesource.com/platform/frameworks/data-binding

因为代码是使用gradle进行编译的，所以自己刚导入代码的时候简直就是心花怒放（相比那些使用maven、ant之类进行，gradle还是要来得更加亲切的）。但是实际上，踩坑之旅这才刚刚开始。

谜之”version.gradle”

android studio刚导入代码立马就看到了下面的编译错误：

Error:Could not read script ‘/Users/lemon/Documents/buildSrc/base/version.gradle’ as it does not exist.

我将源码放在了 /Users/lemon/Documents/ 目录下，但是这 version.gradle 究竟是何方神圣呢？使用全局搜索很快就在propLoader.gradle 这个文件中找到了引用，代码节选如下：

// load android gradle plugin's version file
apply from: "${root}/../buildSrc/base/version.gradle"
databindingProperties.version = ext.buildVersion
// load version from gradle build file
apply from: "$root/../buildSrc/base/version.gradle"
databindingProperties.androidPluginVersion=ext.buildVersion

不难才想，在 version.gradle 当中其实就是定义了一些关于编译环境的版本信息的常量值。而这里用到的常量值就只有 buildVersion 这一个，我猜想这应该指的就是 android plugin version 。所以在这一个地方我们可以有两个方案：

• 在项目根目录下添加一个 version.gradle 文件，并添加相应的变量定义，同时修改这里的引用地址；
• 直接把这里引用到的变量值替换成实际的常量值，并取消引入 version.gradle 这个文件。

在这里我选择的是第二种做法，代码如下：

//apply from: "$root/../buildSrc/base/version.gradle"
databindingProperties.androidPluginVersion='2.2.2'
// load android gradle plugin's version file
//apply from: "${root}/../buildSrc/base/version.gradle"
databindingProperties.version = '2.2.2'

你不会想到的”kotlin”出现了

修改完上面的文件之后重新编译，立马又出现了新的问题，找不到”kotlin”的支持，因为库当中有一个module compiler 使用了kotlin进行编写的，因此你需要在android studio当中安装kotlin插件，如下图所示：

如果你认为安装完插件之后就大功告成，那就真的是too young too simple了。重新编译之后，让人苦恼的想哭的编译问题又出现了：

Error:Could not find org.jetbrains.kotlin:kotlin-gradle-plugin:1.0.0-beta-4584.
…
Required by:
com.android.databinding:compiler:2.2.2

我们发现在 compiler 这个module编译的时候，还需要一个 otlin-gradle-plugin 。我们打开 compiler 下的 build.gradle 文件

apply plugin: 'java'
apply plugin: 'kotlin'

sourceSets {
    main.java.srcDirs += 'src/main/kotlin'
}

buildscript {
    // to make IJ happy
    ext.kotlin_version = dataBindingConfig.kotlinVersion
    dependencies {
        classpath 'commons-io:commons-io:2.4'
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
    }
}

dependencies {
    compile project(':dataBinding:compilerCommon')
    compile project(':dataBinding:baseLibrary')
    compile "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
    compile 'commons-io:commons-io:2.4'
    compile 'commons-codec:commons-codec:1.10'
    compile 'com.tunnelvisionlabs:antlr4:4.5'
    compile 'com.googlecode.juniversalchardet:juniversalchardet:1.0.3'
    testCompile 'junit:junit:4.12'
}

所以我们需要给 compiler 添加上正确的依赖。从详细的报错信息以及上面的配置我们会发现，项目并没有从远程仓库去寻找依赖，而是从本地寻找的，所以我们得加上要使用的远程仓库声明。另外，上面依赖的版本是通过 dataBindingConfig.kotlinVersion 定义的，为了减少修改，我直接把要使用的版本改成了最新的版本。具体修改之后的如下：

apply plugin: 'java'
apply plugin: 'kotlin'

sourceSets {
    main.java.srcDirs += 'src/main/kotlin'
}

buildscript {
    repositories {
        jcenter()
    }

    // to make IJ happy
//    ext.kotlin_version = dataBindingConfig.kotlinVersion
    dependencies {
        classpath 'commons-io:commons-io:2.4'
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.0.5-2"
    }
}

dependencies {
    compile project(':dataBinding:compilerCommon')
    compile project(':dataBinding:baseLibrary')
    //    compile "org.jetbrains.kotlin:kotlin-stdlib:1.0.5-2"
    compile 'commons-io:commons-io:2.4'
    compile 'commons-codec:commons-codec:1.10'
    compile 'org.antlr:antlr4:4.5.3'
    compile 'com.googlecode.juniversalchardet:juniversalchardet:1.0.3'
    testCompile 'junit:junit:4.12'
    compile 'org.jetbrains.kotlin:kotlin-gradle-plugin:1.0.5-2'
    compile 'org.jetbrains.kotlin:kotlin-stdlib:1.0.5-2'
}

有一个要需要注意的是，我一开始使用的仓库是 mavenCentral ,结果弄了好几个小时都不能正确下载，后来改成使用 jcenter 就好了。

经过上面的调整，然后美好的事情终于到来。data bindign这个库终于可以顺利编译了，清晰的代码目录、代码跳转等等该有的都有了。感动到哭了有木有。

热心提示

android data binding这个库是经过多次修改的，其中如双向绑定、lambada表达式这些是在gradle2.2 以后才会支持的，其他之前版本是没有的。所以如果使用默认的master分支下的代码，很抱歉，你会发现找不到相关的代码。。。。。。（在某个早上，我折腾了好几个小时，基本上把每个代码文件基本都翻了个遍，硬是没找到应该有的代码，在崩溃的边缘，我都要开始相信玄学，认为谷歌又偷偷摸摸使用了一些不为人知的黑科技了）。

在远程仓库的网页上，我们会发现除了很多的分支之外，还有很多的tag，如下图所示：

不难猜到在 gradle_2.2.2 这个tag下面应该有我们想要的全部特性的代码。所以在命令行下面，使用checkout命令就可以啦：

git checkout gradle_2.2.2

这下子终于可以愉快跟谷歌爸爸做朋友了。关于android data binding这个库的具体分析欢迎关注我的博客，接下来我会写关于data binding这个库的实践的系列博文。