配置插件依赖项

本文重点介绍了钉钉扩展插件的发布格式（*.deb），请仔细阅读避免产物缺少关键的配置。

为什么配置依赖

钉钉插件理论上需要包含所有依赖信息，包括如下：

依赖的功能 SDK （.aar/.jar文件）。

依赖的三方开源库 Maven 坐标地址信息。

额外的 Gradle 配置，比如 DataBinding 、 ButterKnife 的 Plugin 、注解处理器信息等。

任何依赖信息的缺少都会造成插件功能异常。

插件文件介绍

钉钉平台定义了客户端插件产物的标准格式（ DEB 文件）。 DEB 文件本质上是一个压缩文件，内部关键结构：

文件	描述
BundleManifest.xml	描述了额外的三方 mvn 依赖列表、gradle 相关配置等。
*.aar	依赖的 AAR 格式 SDK 文件
*.jar	依赖的 JAR 格式 SDK 文件

因此，当插件出现功能异常时（比如类找不到的 Crash ），可先自行解压查看插件文件中是否缺少相关的依赖信息。

插件依赖配置

依赖的功能 SDK

请将 SDK 打包成 aar 或者 jar 文件，放到创建的 Bundle 工程中的 ./libs 目录下，插件打包时会将文件合并打包。

说明

不支持工程源码依赖、或自定义SDK本地目录。

其他 Gradle 相关依赖配置项

设置最小 SDK 版本： minSDKVersion

bundle.xml 中添加如下：

  <minSdkVersion>21</minSdkVersion>

对应生成的 build.gradle 配置：

android {
  defaultConfig {
    minSdkVersion 21
  }
}

添加自定义依赖：dependencies

当你的 SDK 依赖了开源的三方库，或者自研的其他基础库已经发布到了公共仓库中，为了使用需要添加对应依赖，bundle.xml 中配置如下：

  <dependencies>
    <implementation path="com.xiaomi:mipush_client:3.7.2"/>
  </dependencies>

对于引入特有的 mvn 仓库配置：

  <repositories>
    <maven>http://developer.huawei.com/repo/</maven>
  </repositories>

对应的 build.gradle 中的配置如下：

repositories {
    maven {
        url "http://developer.huawei.com/repo/"
    }
}
dependencies {
  implementation "com.xiaomi:mipush_client:3.7.2"
}

添加注解解析器：kapt：

同样，假如引入了特有的注解编译器，bundle.xml 添加如下，其中 argument 代表配置的可选参数：

  <dependencies>
    <kapt path="com.github.bumptech.glide:compiler:4.8.0">
      <argument name="test-arg">"test-value"</argument>
    </kapt>
  </dependencies>

添加自己的 gradle 插件：apply-plugin

假如我们使用了类似 ButterKnife 的工具，需要在钉钉编译环境中添加 gralde 的插件，bundle.xml 可以如下

引入 classpath。

<classpaths>
    <classpath path="com.xxx.xxx:mygradlelib:1.1.0"/>
  </classpaths>

bundle.xml 添加使用 plugin。

  <apply-plugins>
    <plugin id="my-plugin"/>
  </apply-plugins>

添加自定义的packageOptions

假如你的 SDK 引入时会出现打包冲突时，可能需要配置 packageOptions ，主要支持 exclude 和 pickFirst 两种，可以在 bundle.xml 中添加如下片段：

<packaging-options>
    <exclude>META-INF/INDEX.LIST</exclude>
    <pickFirst>lib/arm64-v8a/libRSSupport.so</pickFirst>
</packaging-options

以上片段会被映射成如下 build.gradle 的脚本代码：

android {
		packagingOptions {
        exclude 'META-INF/INDEX.LIST'
        pickFirst 'lib/arm64-v8a/libRSSupport.so'
    }
}

使用内置插件

bundle.xml 中的添加示例：

<used-plugins>
	<plugin id="插件ID" />
  <plugin id="插件ID" 参数1="参数值"  参数2="参数值"/>
</used-plugins>

钉钉支持的内置插件清单

插件id	功能说明	示例
dataBinding	开启DataBinding	123
renderScript	开启RenderScript	12345

配置插件依赖项

为什么配置依赖#

插件文件介绍#

插件依赖配置#

依赖的功能 SDK#

其他 Gradle 相关依赖配置项#

设置最小 SDK 版本： minSDKVersion#

添加自定义依赖：dependencies#

添加注解解析器：kapt：#

添加自己的 gradle 插件：apply-plugin#

添加自定义的packageOptions#

使用内置插件#