编写插件功能

如果你需要编写插件功能，你可以依据本文档操作步骤完成插件功能的开发。

前提条件

操作步骤

在 MainBundle 中的 onApplicationCreate 中添加初始化代码，监听 Activity 生命周期并为所有 activity 注入水印。

@Bundle
public class MainBundle extends BundleApplication {
		
    ... ...
    
    @Override
    public void onApplicationCreate(BundleContext context) {
        super.onApplicationCreate(context);
        this.bundleContext = context;   // 该行不要删除

        context.getApplication().registerActivityLifecycleCallbacks(new Application.ActivityLifecycleCallbacks() {
            
            @Override
            public void onActivityResumed(@NonNull Activity activity) {
                Watermark.show(activity);
            }				
            ... ...
        });
    }
}

使用设置扩展点添加自定义设置菜单，使用 Dingtalk DevKit 工具中的 New Extension 创建扩展实现类，选择设置扩展点 EpSettingMenu。

补充设置菜单实现。

@Extension(id = "example_securit_setting", target = "setting_items")
public class ExampleSettingMenu extends EpSettingMenu {

    @Override
    public SettingMenuObject getMenuObject() {
        SettingMenuObject menu = new SettingMenuObject();
        menu.title = "演示设置";
        return menu;
    }

		... ...

    @Override
    public void onClick(View v) {
        // 此处可startActivity，打开自定义的Activity
        // Demo工程演示效果
				Toast.makeText(v.getContext(), "点击自定义设置菜单", Toast.LENGTH_SHORT).show();
    }
}

（可选）添加自定义混淆配置

打开 consumer-rules.pro 文件，并在文件中补充必要的混淆规则。

说明

\1. 如涉及到Gson等反射场景时，请务必添加Keep规则

\2. 请不要添加通用规则，仅添加插件代码相关Keep规则

后续步骤

编写插件功能完成后，你需要编译生成产物（*.deb）。

常见问题

1. 开发中的编译问题

AndroidManifest.xml文件，请避免配置allowBackup、tool:replace等属性，该节点属性应尽可能为空，只包含子节点（Activity、Service等），避免和钉钉冲突导致集成编译失败。

<application>  	<!-- 建议application节点不要添加任何参数-->

	<!-- 如果依赖了某个sdk的miniSDKVersion和钉钉不一致，
		请配置overrideLibrary属性-->
	<uses-sdk
	  android:minSdkVersion="21"
    android:targetSdkVersion="29"
    tools:overrideLibrary="com.airbnb.lottie"/>

  <meta-data
    android:name="example_key"
    android:value="example_value" />

  <activity
    android:name="com.example.DemoActivity"
    android:launchMode="singleTop"
    android:screenOrientation="portrait"/>

</application>

如果使用了FileProvider，请自定义class并继承FileProvider，避免直接在AndroidManifest文件中配置FileProvider，同时配置的resource.xml文件建议附带sdk.tag的命名，避免文件名冲突。

重要

此处android:resource定义的path文件命名请务必追加自定义前缀，避免使用常规命名被覆盖。

// 建议改为如下形式
<provider
			// 此处Provider命名请使用自定义Provider类	
     android:name="com.example.DemoFileProvider"
     android:authorities="com.example.fileprovider"
     android:exported="false"
     android:grantUriPermissions="true">
     <meta-data
          android:name="android.support.FILE_PROVIDER_PATHS"
          android:resource="@xml/example_paths" />  
					//此处android:resource的文件名命名请注意，避免重复！！！
</provider>

2. so架构引入

对于新引入的SO请提供32位、64位版本，即armeabi（或armeabi-v7）、 arm64-v8a两种版本。

对于SO冲突，可到钉钉官网下载最新版本，解压后查看lib目录中是否存在冲突的SO文件，如果有请验证使用钉钉的版本是否存在功能异常。

3. 外部依赖三方SDK冲突

请务必不要直接将三方库（比如jar）直接打包到SDK中，否则会集成编译冲突。

对于开源库，请使用maven仓库坐标方式依赖。

当存在相同依赖库时，请优先使用钉钉依赖的版本，如果必须使用原有版本时，请联系钉钉技术确认解决方案。

4. Support库版本适配

钉钉已经使用AndroidX版本，请确认你的插件是否适配。参考版本：

androidx.activity:activity:1.1.0@aar
androidx.appcompat:appcompat:1.2.0@aar
androidx.arch.core:core-common:2.1.0@jar
androidx.arch.core:core-runtime:2.1.0@aar
androidx.browser:browser:1.0.0@aar
androidx.cardview:cardview:1.0.0@aar
androidx.constraintlayout:constraintlayout:1.1.3@aar
androidx.coordinatorlayout:coordinatorlayout:1.0.0@aar
androidx.core:core:1.3.2@aar
androidx.customview:customview:1.0.0@aar
androidx.documentfile:documentfile:1.0.0@aar
androidx.drawerlayout:drawerlayout:1.0.0@aar
androidx.exifinterface:exifinterface:1.0.0@aar
androidx.fragment:fragment:1.2.0@aar
androidx.media:media:1.0.0@aar
androidx.palette:palette:1.0.0@aar
androidx.recyclerview:recyclerview:1.0.0@aar
androidx.savedstate:savedstate:1.0.0@aar
androidx.slidingpanelayout:slidingpanelayout:1.0.0@aar
androidx.swiperefreshlayout:swiperefreshlayout:1.0.0@aar
androidx.vectordrawable:vectordrawable:1.1.0@aar
androidx.viewpager:viewpager:1.0.0@aar
androidx.webkit:webkit:1.3.0@aar
androidx.window:window:1.1.0-alpha03@aar
com.alibaba:fastjson:1.1.71.android@jar
com.google.android.material:material:1.0.0@aar
com.google.android.play:core:1.8.3@aar
com.google.android:flexbox:1.0.0@aar
com.google.code.gson:gson:2.2.4@jar
com.google.dagger:dagger:2.23@jar
com.squareup.okhttp3:okhttp:3.11.0@jar
io.reactivex.rxjava2:rxandroid:2.0.2@aar
org.jetbrains.kotlin:kotlin-stdlib:1.7.10@jar
org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.1@jar
org.jsoup:jsoup:1.8.2@ja

前提条件#

操作步骤#

后续步骤#

常见问题#

1. 开发中的编译问题#

2. so架构引入#

3. 外部依赖三方SDK冲突#

4. Support库版本适配#