Android Data Binding 在 library module 中遇到错误及解决办法

记一次 data binding 在 library module 中遇到的大坑

使用 data binding 也有半年多了，从最初的 setvariable，替换 findviewbyid，到比较高级的双向绑定，自定义 adapter、component，查看源码了解编译、运行流程，也算是小有成果，且没有碰到 data binding 本身实现上的问题。

然而，最近在一次重构组件化（见 mdcc 上冯森林的《回归初心，从容器化到组件化》）的过程中，碰到了一个比较严重的 bug。已经提交 issue（#224048）到了 aosp，虽然改起来是不麻烦，但是因为是 gradle plugin，所以 - -，还是让 google 自己来吧。希望能早日修复。

library module 生成 class

在 library module 下启用 data binding 很简单，跟 application module 一样，加上:

android { 
 databinding {
  enabled = true
 }
}

对应生成的 binding 类会在 manifest 里面指定的 package name 下的 databinding 包下。

坑

于是坑的地方就在这里了，编译不过了…

为啥呢？报错说 symbol 找不到…于是在 module 的 build 下查看生成的 binding 类…卧槽？！怎么是 abstract 的？怎么都找不到那些 get 方法了？虽然我也不知道为什么我们会从 binding 类里面去拿之前 set 进去的 viewmodel。

wtf?!

what happened

fuck 归 fuck，究竟怎么回事还是要研究一下的。

是我们姿势错了？dagger2 生成哪里出问题了？还是 data binding 的 bug 呢？

因为之前也研究过 data binding 生成部分的代码，所以找到问题所在没有花太多时间，这里不多啰嗦，直接看对应位置。

在 compilerchief 的 writeviewbinderinterfaces 中:

public void writeviewbinderinterfaces(boolean islibrary) {
 ensuredatabinder();
 mdatabinder.writerbaseclasses(islibrary);
}

对应 databinder:

public void writerbaseclasses(boolean islibrary) {
 for (layoutbinder layoutbinder : mlayoutbinders) {
  try {
   scope.enter(layoutbinder);
   if (islibrary || layoutbinder.hasvariations()) {
    string classname = layoutbinder.getclassname();
    string canonicalname = layoutbinder.getpackage() + "." + classname;
    if (mwrittenclasses.contains(canonicalname)) {
     continue;
    }
    l.d("writing data binder base %s", canonicalname);
    mfilewriter.writetofile(canonicalname,
      layoutbinder.writeviewbinderbaseclass(islibrary));
    mwrittenclasses.add(canonicalname);
   }
  } catch (scopedexception ex){
   scope.defer(ex);
  } finally {
   scope.exit();
  }
 }
}

这里调用了 layoutbinder（真正的实现类会调用 writeviewbinder）:

public string writeviewbinderbaseclass(boolean forlibrary) {
 ensurewriter();
 return mwriter.writebaseclass(forlibrary);
}

可以看到如果是 library module，我们会做特殊的编译，而不会生成真正的实现:

public fun writebaseclass(forlibrary : boolean) : string =
 kcode("package ${layoutbinder.`package`};") {
  scope.reset()
  nl("import android.databinding.bindable;")
  nl("import android.databinding.databindingutil;")
  nl("import android.databinding.viewdatabinding;")
  nl("public abstract class $baseclassname extends viewdatabinding {")
  layoutbinder.sortedtargets.filter{it.id != null}.foreach {
   tab("public final ${it.interfaceclass} ${it.fieldname};")
  }
  nl("")
  tab("protected $baseclassname(android.databinding.databindingcomponent bindingcomponent, android.view.view root_, int localfieldcount") {
   layoutbinder.sortedtargets.filter{it.id != null}.foreach {
    tab(", ${it.interfaceclass} ${it.constructorparamname}")
   }
  }
  tab(") {") {
   tab("super(bindingcomponent, root_, localfieldcount);")
   layoutbinder.sortedtargets.filter{it.id != null}.foreach {
    tab("this.${it.fieldname} = ${it.constructorparamname};")
   }
  }
  tab("}")
  nl("")
  variables.foreach {
   if (it.userdefinedtype != null) {
    val type = modelanalyzer.getinstance().applyimports(it.userdefinedtype, model.imports)
    tab("public abstract void ${it.settername}($type ${it.readablename});")
   }
  }
  tab("public static $baseclassname inflate(android.view.layoutinflater inflater, android.view.viewgroup root, boolean attachtoroot) {") {
   tab("return inflate(inflater, root, attachtoroot, android.databinding.databindingutil.getdefaultcomponent());")
  }
  tab("}")
  tab("public static $baseclassname inflate(android.view.layoutinflater inflater) {") {
   tab("return inflate(inflater, android.databinding.databindingutil.getdefaultcomponent());")
  }
  tab("}")
  tab("public static $baseclassname bind(android.view.view view) {") {
   if (forlibrary) {
    tab("return null;")
   } else {
    tab("return bind(view, android.databinding.databindingutil.getdefaultcomponent());")
   }
  }
  tab("}")
  tab("public static $baseclassname inflate(android.view.layoutinflater inflater, android.view.viewgroup root, boolean attachtoroot, android.databinding.databindingcomponent bindingcomponent) {") {
   if (forlibrary) {
    tab("return null;")
   } else {
    tab("return databindingutil.<$baseclassname>inflate(inflater, ${layoutbinder.modulepackage}.r.layout.${layoutbinder.layoutname}, root, attachtoroot, bindingcomponent);")
   }
  }
  tab("}")
  tab("public static $baseclassname inflate(android.view.layoutinflater inflater, android.databinding.databindingcomponent bindingcomponent) {") {
   if (forlibrary) {
    tab("return null;")
   } else {
    tab("return databindingutil.<$baseclassname>inflate(inflater, ${layoutbinder.modulepackage}.r.layout.${layoutbinder.layoutname}, null, false, bindingcomponent);")
   }
  }
  tab("}")
  tab("public static $baseclassname bind(android.view.view view, android.databinding.databindingcomponent bindingcomponent) {") {
   if (forlibrary) {
    tab("return null;")
   } else {
    tab("return ($baseclassname)bind(bindingcomponent, view, ${layoutbinder.modulepackage}.r.layout.${layoutbinder.layoutname});")
   }
  }
  tab("}")
  nl("}")
 }.generate()
}

那么问题来了，这里的这个只是用来使 library module 编译能通过的 abstract class，只生成了所有 variable 的 setter 方法啊，getter 呢？坑爹呢？

看来是 google 压根没考虑到还需要这个。写 kotlin 的都少根筋吗？

规避方案

为了让 library module 能编译通过（这样才能在 application module 生成真正的 binding 实现），只好避免使用 getter 方法，幸而通过之前开发的 databindingadapter 和 lambda presenter 确实能规避使用 getter 去拿 viewmodel。

不管怎么说，希望 google 能在下个版本修复这个问题。就是 iterator 一下，写个 abstract 接口而已。

感谢阅读，希望能帮助到大家，谢谢大家对本站的支持！