如何创建一个引入Module的Cordova插件

如何创建一个引入Module的Cordova插件

需求背景

之前有说过cordova是什么，如何创建一个cordova的插件。
但是之前说的是简单的插件，实际开发过程中，我们可能需要在插件里面用到自定义的module，或者是第三方sdk（有的第三方sdk也以module的形式存在）。
在Android环境下，这种情况还挺常见的。

网上找到的一些例子，通常是讲如何加入module的，很少有说如何将module做成插件，达到可以随时引用或者删除的效果。
强行增加module甚至要去修改cordova库的build代码，npm一更新package，就会出错，也不方便Jenkins进行自动化打包。

那么如何优雅的来做这件事情呢？
事实上，通过阅读官方文档（最新版本英文文档），大致可以知道如何在插件里引入一个module。

Cordova插件和module融合

首先，你得知道，如何添加一个Cordova插件。

添加android的module

在插件的文件plugin.xml中Android的配置添加一行framework

<platform name="android">
	<framework src="src/android/test_module" custom="true" />
</platform>

test_module文件夹下所有东西都会被作为一个android的module库拷贝到目标目录。
目标目录的路径为:<projectPath>/<pluginname>/<packagename-test_module>
同时最终的settings.project文件会发生变化，多出如下几行

include ":test_plugin:test_module"
project(":test_plugin:test_module").projectDir = new File("test_plugin/helloworld-test_module")

这几行的作用是使得AndroidStudio自动识别对应的模块。

同时最终的app的build.gradle文件也会多出：

    implementation(project(path: ":test_plugin:test_module"))

这几行将决定module文件被正确的识别。

优点

相比其他方案，带module的插件在module更新时候，可以更快更新，直接把插件中的module文件夹删除再覆盖即可。不用考虑文件变化，多了少了文件等情况。

缺点

不明白默认的拷贝为什么还会自动多出来个包名，感觉packagename这个前缀没有什么作用，不如没有。

如何用hook修改gradle

实际上拷贝了module之后，很多时候需要额外修改gradle文件来帮助解析。（例如module里面包含arr文件的情况下，需要添加flatDir）
这可以通过在plugin.xml中增加这一段代码来实现

<hook type="after_prepare" src="apply.js" />

cordova build的时候会先进行准备（prepare），然后编译（compile）
after_prepare就是在准备之后，执行的脚本。多数情况下使用after_prepare脚本类型就可以了。
关于脚本类型还有哪些，可以查看官网的Hooks文档。
至于例子，可以参考插件cordova-plugin-androidx-adapter

其他文档

Cordova使用入门简介
如何创建Cordova插件

参考文档

以下文档是其他引入module的方案，
直接把module强写到脚本里面，修改cordova源码：
将module写成cordova插件

把module拆成多个文件，引用到插件中：
ionic框架Android平台，添加第三方module引用