一种快速开发Cordova插件的方法及工具

技术领域

本发明涉及插件开发技术领域，具体的说是一种快速开发Cordova插件的方法及工具。

背景技术

使用Cordova插件可以一次开发多平台应用、简化开发流程、提高应用程序性能、建立插件生态系统，但是开发Corodva插件需要熟悉Web技术和原生开发技术，对开发者的技能要求较高，学习成本也相对较高。

发明内容

本发明针对目前技术发展的需求和不足之处，提供一种快速开发Cordova插件的方法及工具。

第一方面，本发明提供一种快速开发Cordova插件的方法，解决上述技术问题采用的技术方案如下：

一种快速开发Cordova插件的方法，其包括如下步骤：

S1、定义JSON配置文件，配置文件用于定义生成的代码的结构和行为；

S2、代码生成器读取步骤S1的配置文件，自动生成Cordova插件工程，并进一步自动获取插件存在路径和方法添加到Cordova插件工程中，以自动更新config.xml的配置选项。

可选的，步骤S1定义的配置文件包含规则和projectName、version、id、plugins、initMethods五个参数，其中，projectName表示工程名称，version表示版本号，id表示插件id，也是生成插件名称，plugins表示包含的第三方SDK的JAR包，initMethods表示初始化的命令方式，projectName、version、id这三个参数的类型为String，plugins、initMethods这两个参数的类型为String[]。

进一步可选的，执行步骤S2时，代码生成器根据配置文件中的plugins内容自动获取插件的存在路径，并添加到Cordova插件工程中，以自动更新config.xml的配置选项。

进一步可选的，执行步骤S2，配置文件中的initMethod内容存在配置项时，代码生成器根据initMethod内容的配置项动态生成对应的调用方法并添加到Cordova插件工程中，以自动更新config.xml的配置选项。

进一步可选的，代码生成器非首次读取步骤S1的配置文件时，

首先查看是否存在Cordova插件工程，

随后根据配置文件中的plugins选项遍历已生成的代码，对比是否存在未引入的插件，若存在，则自动获取未引入插件的存在路径，并更新到Cordova插件工程中，

再后根据配置文件中的initMethod选项遍历已生成的代码，对比是否存在未引入的配置项，若存在，则动态更新对应的调用方法，并更新到Cordova插件工程中。

第二方面，本发明提供一种快速开发Cordova插件的工具，解决上述技术问题采用的技术方案如下：

一种快速开发Cordova插件的工具，其包括：

定义模块，用于定义JSON配置文件，配置文件用于定义生成的代码的结构和行为；

插件生成模块，用于使用代码生成器读取配置文件，自动生成Cordova插件工程，并进一步自动获取插件存在路径和方法添加到Cordova插件工程中，以自动更新config.xml的配置选项。

可选的，所涉及配置文件包含规则和projectName、version、id、plugins、initMethods五个参数，其中：

projectName表示工程名称，version表示版本号，id表示插件id，也是生成插件名称，plugins表示包含的第三方SDK的JAR包，initMethods表示初始化的命令方式；

projectName、version、id这三个参数的类型为String，plugins、initMethods这两个参数的类型为String[]。

进一步可选的，所涉及插件生成模块使用代码生成器读取配置文件自动生成Cordova插件工程后，进一步根据配置文件中的plugins内容自动获取插件的存在路径，并添加到Cordova插件工程中，以自动更新config.xml的配置选项。

进一步可选的，所涉及插件生成模块使用代码生成器读取配置文件自动生成Cordova插件工程后，在配置文件中的initMethod内容存在配置项时，进一步根据initMethod内容的配置项动态生成对应的调用方法并添加到Cordova插件工程中，以自动更新config.xml的配置选项。

进一步可选的，所涉及插件生成模块使用代码生成器非首次读取配置文件时，通过如下操作实现config.xml配置选项的自动更新：

首先查看是否存在Cordova插件工程，

随后根据配置文件中的plugins选项遍历已生成的代码，对比是否存在未引入的插件，若存在，则自动获取未引入插件的存在路径，并更新到Cordova插件工程中，

再后根据配置文件中的initMethod选项遍历已生成的代码，对比是否存在未引入的配置项，若存在，则动态更新对应的调用方法，并更新到Cordova插件工程中。

本发明的一种快速开发Cordova插件的方法及工具，与现有技术相比具有的有益效果是：

(1)本发明能够通过配置文件简化创建Cordova工程配置命令，提高开发效率；

(2)本发明能够实现Cordova插件的快速创建工程、增加依赖插件、增加调用方式，达到了Cordova插件一次开发过后，不会因为后续引入第三方SDK而需要再次使用人力资源去做代码修改，并且减少生成代码的复杂性，从而实现Cordova工程可维护性、可拓展性的提高。

附图说明

附图1是本发明实施例一的方法流程图。

具体实施方式

为使本发明的技术方案、解决的技术问题和技术效果更加清楚明白，以下结合具体实施例，对本发明的技术方案进行清楚、完整的描述。

实施例一：

结合附图1，本实施例提出一种快速开发Cordova插件的方法，其包括如下步骤：

S1、定义JSON配置文件，配置文件用于定义生成的代码的结构和行为；

配置文件包含规则和projectName、version、id、plugins、initMethods五个参数，其中：

projectName表示工程名称，version表示版本号，id表示插件id，也是生成插件名称，plugins表示包含的第三方SDK的JAR包，initMethods表示初始化的命令方式，projectName、version、id这三个参数的类型为String，plugins、initMethods这两个参数的类型为String[]。

S2、代码生成器读取步骤S1的配置文件，自动生成Cordova插件工程，并进一步根据配置文件中的plugins内容自动获取插件的存在路径，根据initMethod内容的配置项动态生成对应的调用方法，随后添加到Cordova插件工程中，以自动更新config.xml的配置选项。

需要补充的是：代码生成器非首次读取步骤S1的配置文件时，

首先查看是否存在Cordova插件工程，

随后根据配置文件中的plugins选项遍历已生成的代码，对比是否存在未引入的插件，若存在，则自动获取未引入插件的存在路径，并更新到Cordova插件工程中，

再后根据配置文件中的initMethod选项遍历已生成的代码，对比是否存在未引入的配置项，若存在，则动态更新对应的调用方法，并更新到Cordova插件工程中。

需要补充的是：在使用代码生成器非首次读取配置文件时，Cordova插件工程是已经存在的。

实施例二：

本实施例提出一种快速开发Cordova插件的工具，其包括：

定义模块，用于定义JSON配置文件，配置文件用于定义生成的代码的结构和行为，包含规则和projectName、version、id、plugins、initMethods五个参数，其中：projectName表示工程名称，version表示版本号，id表示插件id，也是生成插件名称，plugins表示包含的第三方SDK的JAR包，initMethods表示初始化的命令方式；projectName、version、id这三个参数的类型为String，plugins、initMethods这两个参数的类型为String[]；

插件生成模块，用于使用代码生成器读取配置文件，自动生成Cordova插件工程，并进一步根据配置文件中的plugins内容自动获取插件的存在路径，根据initMethod内容的配置项动态生成对应的调用方法，并添加到Cordova插件工程中，以自动更新config.xml的配置选项。

需要补充的是：所涉及插件生成模块使用代码生成器非首次读取配置文件时，通过如下操作实现config.xml配置选项的自动更新：

首先查看是否存在Cordova插件工程，

随后根据配置文件中的plugins选项遍历已生成的代码，对比是否存在未引入的插件，若存在，则自动获取未引入插件的存在路径，并更新到Cordova插件工程中，

再后根据配置文件中的initMethod选项遍历已生成的代码，对比是否存在未引入的配置项，若存在，则动态更新对应的调用方法，并更新到Cordova插件工程中。

需要补充的是：在插件生成模块使用代码生成器非首次读取配置文件时，Cordova插件工程是已经存在的。

综上可知，采用本发明的一种快速开发Cordova插件的方法及工具，可以快速生成Corodva插件模板代码，支持配置参数自动包含第三方SDK生成，支持生成模板时录入参数可以动态调整生成模板的类型。

以上应用具体个例对本发明的原理及实施方式进行了详细阐述，这些实施例只是用于帮助理解本发明的核心技术内容。基于本发明的上述具体实施例，本技术领域的技术人员在不脱离本发明原理的前提下，对本发明所作出的任何改进和修饰，皆应落入本发明的专利保护范围。