定制化实现Databinding的思路与实践

2023-10-16 12:15:37

在Android开发中，Databinding是一个非常重要的功能，它可以帮助我们轻松地将数据绑定到布局文件中，从而大大提高开发效率。然而，在使用Databinding时，我们通常需要手动修改布局文件，以便添加Databinding所需的标签。这不仅耗时费力，而且还容易出错。

为了解决这个问题，我们可以通过插件的方式来实现Databinding的自动化。具体来说，我们可以编写一个插件，在创建布局文件时自动添加Databinding所需的标签。这样，我们就无需再手动修改布局文件，从而大大提高了开发效率。

实现Databinding插件化有以下三个步骤：

创建一个新的Android Studio插件项目。
在插件中编写代码，以便在创建布局文件时自动添加Databinding所需的标签。
将插件安装到Android Studio中，并启用它。

下面，我们就来详细介绍一下这三个步骤。

第一步：创建一个新的Android Studio插件项目

首先，我们需要创建一个新的Android Studio插件项目。具体步骤如下：

打开Android Studio，点击“File”菜单，然后选择“New”->“Project”。
在“New Project”对话框中，选择“Android Plugin”项目类型，然后点击“Next”。
在“Configure your project”对话框中，填写项目名称、项目路径等信息，然后点击“Finish”。

第二步：在插件中编写代码

接下来，我们需要在插件中编写代码，以便在创建布局文件时自动添加Databinding所需的标签。具体步骤如下：

在插件项目中，找到“src/main/kotlin”文件夹，然后创建一个新的Kotlin文件，并命名为“MyDatabindingPlugin.kt”。
在“MyDatabindingPlugin.kt”文件中，编写以下代码：

import com.android.ide.common.xml.AndroidManifestParser
import com.android.tools.idea.assistant.datamodel.GeneratedFile
import com.android.tools.idea.assistant.datamodel.ProjectContext
import com.android.tools.idea.assistant.extensions.register.AnnotationBasedExtensionPoint
import com.android.tools.idea.assistant.extensions.register.ExtensionGroup
import com.android.tools.idea.assistant.extensions.register.SimpleExtension
import com.android.tools.idea.common.model.NlComponent
import com.android.tools.idea.common.type.AndroidAttributeData
import com.android.tools.idea.common.type.AndroidClassType
import com.android.tools.idea.common.type.AndroidResourceType
import com.android.tools.idea.gradle.util.EmbeddedGradleDaemon
import com.android.tools.idea.model.AndroidModel
import com.android.tools.idea.rendering.classloading.AarClassloader
import com.android.tools.idea.rendering.classloading.dexlib.DexLibClassloader
import com.android.tools.idea.rendering.classloading.dexlib.DexLibV3Classloader
import com.android.tools.idea.rendering.classloading.fallback.CachingResourceClassLoader
import com.android.tools.idea.rendering.classloading.fallback.FallbackResourceClassLoader
import com.android.tools.idea.rendering.classloading.fallback.LibraryResourceClassLoader
import com.android.tools.idea.rendering.classloading.fallback.NdkClassloader
import com.android.tools.idea.rendering.classloading.fallback.NestedResourceClassLoader
import com.android.tools.idea.rendering.classloading.fallback.ProjectClassLoader
import com.android.tools.idea.rendering.classloading.fallback.WrappedClassLoader
import com.android.tools.idea.rendering.classloading.loaders.ClasspathResourceLoader
import com.android.tools.idea.rendering.classloading.loaders.JarClasspathResourceLoader
import com.android.tools.idea.rendering.classloading.loaders.ZipResourceLoader
import com.android.tools.idea.rendering.classloading.sources.LocalJarResourceSource
import com.android.tools.idea.rendering.classloading.sources.NestedAndroidLibraryResourceSource
import com.android.tools.idea.rendering.classloading.sources.NestedLocalJarResourceSource
import com.android.tools.idea.rendering.classloading.sources.PathResourceSource
import com.android.tools.idea.rendering.classloading.sources.RepositoryResourceSource
import com.android.tools.idea.rendering.classloading.sources.SdkResourceSource
import com.android.tools.idea.rendering.classloading.sources.ZipResourceSource
import com.android.tools.idea.rendering.layout.DataBindingSupport
import com.android.tools.idea.rendering.layout.DataBindingUtil
import com.android.tools.idea.rendering.render.RenderResult
import com.android.tools.idea.rendering.render.java.JavaClassSourceProvider
import com.google.common.collect.ImmutableSet
import org.gradle.tooling.model.GradleProject
import java.io.File

class MyDatabindingPlugin : SimpleExtension(
    ExtensionGroup.ACTIVITY_LAYOUT_RESOURCE_GENERATOR,
    AndroidModel.DesignModel::class.java,
    ImmutableSet.of(DataBindingSupport::class.java)
) {
    override fun generate(
        context: ProjectContext,
        component: NlComponent,
        data: DataBindingSupport,
        renderResult: RenderResult?
    ): GeneratedFile? {
        val model = context.model as AndroidModel
        val manifestFile = model.fetchDelegate<AndroidManifestParser, File>(AndroidModel.Delegate.MANIFEST_FILE)
        val gradleProject = model.fetchDelegate<EmbeddedGradleDaemon, GradleProject>(AndroidModel.Delegate.GRADLE_PROJECT)
        val projectClassLoader = ProjectClassLoader(
            manifestFile,
            model.namespaceHandler,
            gradleProject,
            model.getAndroidTarget()
        )
        val dexLibClassloaders = listOf(DexLibClassloader(), DexLibV3Classloader())
        val resourceClassloaders = listOf(AarClassloader(projectClassLoader), CachingResourceClassLoader(projectClassLoader))
        val classpathClassloaders = listOf(
            ClasspathResourceLoader(projectClassLoader),
            JarClasspathResourceLoader(projectClassLoader),
            ZipResourceLoader()
        )
        val resourceLoaders = listOf(
            PathResourceSource(),
            SdkResourceSource(),
            RepositoryResourceSource(),
            LocalJarResourceSource(),
            NestedAndroidLibraryResourceSource(),
            NestedLocalJarResourceSource(),
            ZipResourceSource()
        )
        val wrappedClassloaders = listOf(WrappedClassLoader(projectClassLoader, dexLibClassloaders))
        val fallbackResourceClassloaders = listOf(FallbackResourceClassLoader(resourceLoaders, wrappedClassloaders), LibraryResourceClassLoader(wrappedClassloaders))
        val ndkClassloader = NdkClassloader()
        val layout = renderResult!!.layout
        val util = DataBindingUtil(
            layout,
            data,
            JavaClassSourceProvider(projectClassLoader),
            classpathClassloaders,
            resourceClassloaders,
            fallbackResourceClassloaders,
            ndkClassloader,
            renderResult.scene
        )
        val dom = util.generateDatabindingDom()
        if (dom != null) {
            val result = AndroidAttributeData(dom.toXml(), AndroidClassType.get(DataBindingSupport::class.java), AndroidResourceType.XML)
            return GeneratedFile("layout-v2.xml", result.getXml())
        }
        return null
    }
}