前端工程依赖自动注册方法及装置

摘要

本申请实施例提供一种前端工程依赖自动注册方法及装置，也可用于金融领域，方法包括：接收用户发送的前端工程启动指令，并根据设定命名规则对工程依赖信息文件中的工程依赖信息进行筛选，得到插件列表；根据所述插件列表中各插件对应的参数配置信息和插件调用接口进行插件注册操作，得到完成所述插件注册操作的前端工程；本申请能够有效避免开发人员在引入npm包插件时在工程入口文件中添加冗余代码，提升代码可维护性，同时可以避免在手工添加注册代码时引入不必要的错误。

说明书

技术领域

本申请涉及前端开发领域，也可用于金融领域，具体涉及一种前端工程依赖自动注册方法及装置。

背景技术

在大型前端项目开发过程中，通常会将一些影响全局的基础功能提取并封装为npm包(npm是随nodejs一起安装的包管理工具，在现代前端领域通常使用npm作为前端工程的依赖管理工具，在使用npm的前端工程内，在工程根路径下会有一个package.json文件，里面描述了该工程的一些基础信息，包括工程名称、版本号、作者、摘要信息、执行脚本、依赖包信息等)的形式，以插件的方式引入工程内，这样能够将基础功能与业务代码解耦，同时降低这些基础功能在不同工程间的复用难度。

现有技术中对于这类npm包插件，通常的引入方式为：(1)使用npm指令添加插件的对应依赖；(2)在工程入口文件内手工添加对插件的注册代码。

发明人发现，当前端工程中引入插件的数量较多时，上述(2)中添加在工程入口文件中的注册代码就会导致入口文件变得较难维护，原因是由于这类插件的注册逻辑通常大同小异，导致注册代码中存在不必要的冗余代码。

发明内容

针对现有技术中的问题，本申请提供一种前端工程依赖自动注册方法及装置，能够有效避免开发人员在引入npm包插件时在工程入口文件中添加冗余代码，提升代码可维护性，同时可以避免在手工添加注册代码时引入不必要的错误。

为了解决上述问题中的至少一个，本申请提供以下技术方案：

第一方面，本申请提供一种前端工程依赖自动注册方法，包括：

接收用户发送的前端工程启动指令，并根据设定命名规则对工程依赖信息文件中的工程依赖信息进行筛选，得到插件列表；

根据所述插件列表中各插件对应的参数配置信息和插件调用接口进行插件注册操作，得到完成所述插件注册操作的前端工程。

进一步地，所述根据设定命名规则对工程依赖信息文件中的工程依赖信息进行筛选，得到插件列表，包括：

读取工程依赖信息文件中的工程依赖信息，得到包含有工程依赖名称的依赖对象；

遍历所述依赖对象，并根据设定命名规则对各所述依赖对象中的工程依赖名称进行正则表达式匹配，并根据所述正则表达式匹配的通过结果得到插件列表。

进一步地，所述根据所述插件列表中各插件对应的参数配置信息和插件调用接口进行插件注册操作，包括：

对所述前端工程的主要配置对象接口进行封装，得到插件调用接口；

将所述插件调用接口作为第一传参，将所述插件列表中各插件对应的参数配置信息作为第二传参，根据所述第一传参和所述第二传参调用各插件相应的插件注册方法进行插件注册操作。

进一步地，所述将所述插件列表中各插件对应的参数配置信息作为第二传参，还包括：

判断所述插件列表中各插件对应的参数配置信息中是否包含有自定义配置对象；若是，则将所述自定义配置对象作为第二传参。

第二方面，本申请提供一种前端工程依赖自动注册装置，包括：

插件加载模块，用于接收用户发送的前端工程启动指令，并根据设定命名规则对工程依赖信息文件中的工程依赖信息进行筛选，得到插件列表；

插件注册模块，用于根据所述插件列表中各插件对应的参数配置信息和插件调用接口进行插件注册操作，得到完成所述插件注册操作的前端工程。

进一步地，所述插件加载模块包括：

依赖读取单元，用于读取工程依赖信息文件中的工程依赖信息，得到包含有工程依赖名称的依赖对象；

依赖筛选单元，用于遍历所述依赖对象，并根据设定命名规则对各所述依赖对象中的工程依赖名称进行正则表达式匹配，并根据所述正则表达式匹配的通过结果得到插件列表。

进一步地，所述插件注册模块包括：

插件调用接口封装单元，用于对所述前端工程的主要配置对象接口进行封装，得到插件调用接口；

注册方法调用单元，用于将所述插件调用接口作为第一传参，将所述插件列表中各插件对应的参数配置信息作为第二传参，根据所述第一传参和所述第二传参调用各插件相应的插件注册方法进行插件注册操作。

进一步地，所述注册方法调用单元包括：

自定义配置参数处理子单元，用于判断所述插件列表中各插件对应的参数配置信息中是否包含有自定义配置对象；若是，则将所述自定义配置对象作为第二传参。

第三方面，本申请提供一种电子设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述程序时实现所述的前端工程依赖自动注册方法的步骤。

第四方面，本申请提供一种计算机可读存储介质，其上存储有计算机程序，该计算机程序被处理器执行时实现所述的前端工程依赖自动注册方法的步骤。

由上述技术方案可知，本申请提供一种前端工程依赖自动注册方法及装置，通过对工程依赖信息文件中的工程依赖信息进行筛选，得到插件列表，然以后根据所述插件列表中各插件对应的参数配置信息和插件调用接口自动进行插件注册操作，由此能够有效避免开发人员在引入npm包插件时在工程入口文件中添加冗余代码，提升代码可维护性，同时可以避免在手工添加注册代码时引入不必要的错误。

附图说明

为了更清楚地说明本申请实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图是本申请的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1为本申请实施例中的前端工程依赖自动注册方法的流程示意图之一；

图2为本申请实施例中的前端工程依赖自动注册方法的流程示意图之二；

图3为本申请实施例中的前端工程依赖自动注册方法的流程示意图之三；

图4为本申请实施例中的前端工程依赖自动注册装置的结构图之一；

图5为本申请实施例中的前端工程依赖自动注册装置的结构图之二；

图6为本申请实施例中的前端工程依赖自动注册装置的结构图之三；

图7为本申请实施例中的前端工程依赖自动注册装置的结构图之四；

图8为本申请实施例中的电子设备的结构示意图。

具体实施方式

为使本申请实施例的目的、技术方案和优点更加清楚，下面将结合本申请实施例中的附图，对本申请实施例中的技术方案进行清楚、完整的描述，显然，所描述的实施例是本申请一部分实施例，而不是全部的实施例。基于本申请中的实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的所有其他实施例，都属于本申请保护的范围。

考虑到现有技术中当前端工程中引入插件的数量较多时，添加在工程入口文件中的注册代码就会导致入口文件变得较难维护的问题，本申请提供一种前端工程依赖自动注册方法及装置，通过对工程依赖信息文件中的工程依赖信息进行筛选，得到插件列表，然以后根据所述插件列表中各插件对应的参数配置信息和插件调用接口自动进行插件注册操作，由此能够有效避免开发人员在引入npm包插件时在工程入口文件中添加冗余代码，提升代码可维护性，同时可以避免在手工添加注册代码时引入不必要的错误。

为了能够有效避免开发人员在引入npm包插件时在工程入口文件中添加冗余代码，提升代码可维护性，同时可以避免在手工添加注册代码时引入不必要的错误，本申请提供一种前端工程依赖自动注册方法的实施例，参见图1，所述前端工程依赖自动注册方法具体包含有如下内容：

步骤S101：接收用户发送的前端工程启动指令，并根据设定命名规则对工程依赖信息文件中的工程依赖信息进行筛选，得到插件列表。

可以理解的是，本申请可以从工程依赖信息文件中获取当前工程的工程依赖信息，由于这工程依赖信息中包含有工程内所有依赖的信息，因此本申请可以进一步根据约定好的命名规则将需要注册的插件信息筛选出来，得到插件列表。

步骤S102：根据所述插件列表中各插件对应的参数配置信息和插件调用接口进行插件注册操作，得到完成所述插件注册操作的前端工程。

可以理解的是，本申请在读取工程内的各插件对应的参数配置信息后可以依次将这些参数配置信息作为参数调用插件的注册方法，同时为了提升插件灵活性，本申请也可以将工程内相关对象以插件调用接口的形式暴露给插件的注册方法。

从上述描述可知，本申请实施例提供的前端工程依赖自动注册方法，能够通过对工程依赖信息文件中的工程依赖信息进行筛选，得到插件列表，然以后根据所述插件列表中各插件对应的参数配置信息和插件调用接口自动进行插件注册操作，由此能够有效避免开发人员在引入npm包插件时在工程入口文件中添加冗余代码，提升代码可维护性，同时可以避免在手工添加注册代码时引入不必要的错误。

为了能够准确对工程依赖信息文件中的工程依赖信息进行筛选，在本申请的前端工程依赖自动注册方法的一实施例中，参见图2，上述步骤S101还可以具体包含如下内容：

步骤S201：读取工程依赖信息文件中的工程依赖信息，得到包含有工程依赖名称的依赖对象。

步骤S202：遍历所述依赖对象，并根据设定命名规则对各所述依赖对象中的工程依赖名称进行正则表达式匹配，并根据所述正则表达式匹配的通过结果得到插件列表。

可选的，由于插件也属于npm依赖的一部分，因此插件与其他工程依赖信息共同存储在工程依赖信息文件中，因此本申请可以通过特殊命名方式让插件与其他工程依赖区分。

具体的，为了避免与社区其他依赖库的命名重复，本申请采用特定的命名方式对插件进行命名，例如以@icbc-plugin/name或者icbc-plugin-name的方式对插件命名，这样在工程依赖信息文件中，这类插件的名称就可以很容易被识别出来。

举例而言，首先通过读取工程依赖信息文件，得到包含所有工程依赖的名称与版本信息的对象，结构例如：

可以看到每个具体的依赖信息是以“依赖名称：版本号”的形式存储于上述对象结构中，这时遍历这个对象，对每一条依赖信息的依赖名称进行正则表达式匹配，将满足命名规范的依赖筛选出来，这些依赖就是插件。筛选后会得到以插件名称为元素的数组，例如上述示例筛选后可以得到数组[“@icbc-plugin/micro-frontend”，“icbc-plugin-iframeloader”]。

为了能够自动完成插件注册操作，在本申请的前端工程依赖自动注册方法的一实施例中，参见图3，上述步骤S102还可以具体包含如下内容：

步骤S301：对所述前端工程的主要配置对象接口进行封装，得到插件调用接口。

步骤S302：将所述插件调用接口作为第一传参，将所述插件列表中各插件对应的参数配置信息作为第二传参，根据所述第一传参和所述第二传参调用各插件相应的插件注册方法进行插件注册操作。

可选的，为了让插件能够修改工程内的配置，本申请可以将工程的主要配置对象接口(包括路由、全局状态的接口)封装为插件调用接口(即插件API)，并在插件注册时，将插件API作为第一传参传给插件。因此在插件代码中，可以在执行方法中利用作为参数的插件API修改工程内的相关配置。

可选的，针对每一个插件，本申请可以获取当前插件存储在工程内的参数配置信息(包含插件的配置项以及启动所需的各项参数等)作为第二传参，将参数配置信息和封装好的插件API作为参数调用插件的注册方法完成注册。插件列表内所有插件都处理完成后，自动注册将结束工作。

为了能够在插件注册时准确确定注册方法的传参，在本申请的前端工程依赖自动注册方法的一实施例中，上述步骤S302还可以具体包含如下内容：

判断所述插件列表中各插件对应的参数配置信息中是否包含有自定义配置对象；若是，则将所述自定义配置对象作为第二传参。

与此同时，有些插件会有自定义的配置，这部分信息以对象的形式储存在工程的参数配置文件中，配置文件中插件自定义配置的结构示例如下，以插件名为key，value值为对应插件的自定义配置：

插件注册所做的工作就是依次调用每个插件的入口方法，在调用开始前会先通过配置信息读取所有插件的自定义配置，并在调用插件的入口方法时，将对应的自定义配置作为第二传参传入，如果不存在自定义配置则传空值。当插件入口方法执行完成后即完成了当前插件的注册工作。

为了能够有效避免开发人员在引入npm包插件时在工程入口文件中添加冗余代码，提升代码可维护性，同时可以避免在手工添加注册代码时引入不必要的错误，本申请提供一种用于实现所述前端工程依赖自动注册方法的全部或部分内容的前端工程依赖自动注册装置的实施例，参见图4，所述前端工程依赖自动注册装置具体包含有如下内容：

插件加载模块10，用于接收用户发送的前端工程启动指令，并根据设定命名规则对工程依赖信息文件中的工程依赖信息进行筛选，得到插件列表。

插件注册模块20，用于根据所述插件列表中各插件对应的参数配置信息和插件调用接口进行插件注册操作，得到完成所述插件注册操作的前端工程。

从上述描述可知，本申请实施例提供的前端工程依赖自动注册装置，能够通过对工程依赖信息文件中的工程依赖信息进行筛选，得到插件列表，然以后根据所述插件列表中各插件对应的参数配置信息和插件调用接口自动进行插件注册操作，由此能够有效避免开发人员在引入npm包插件时在工程入口文件中添加冗余代码，提升代码可维护性，同时可以避免在手工添加注册代码时引入不必要的错误。

为了能够准确对工程依赖信息文件中的工程依赖信息进行筛选，在本申请的前端工程依赖自动注册装置的一实施例中，参见图5，所述插件加载模块10包括：

依赖读取单元11，用于读取工程依赖信息文件中的工程依赖信息，得到包含有工程依赖名称的依赖对象。

依赖筛选单元12，用于遍历所述依赖对象，并根据设定命名规则对各所述依赖对象中的工程依赖名称进行正则表达式匹配，并根据所述正则表达式匹配的通过结果得到插件列表。

为了能够自动完成插件注册操作，在本申请的前端工程依赖自动注册装置的一实施例中，参见图6，所述插件注册模块20包括：

插件调用接口封装单元21，用于对所述前端工程的主要配置对象接口进行封装，得到插件调用接口。

注册方法调用单元22，用于将所述插件调用接口作为第一传参，将所述插件列表中各插件对应的参数配置信息作为第二传参，根据所述第一传参和所述第二传参调用各插件相应的插件注册方法进行插件注册操作。

为了能够在插件注册时准确确定注册方法的传参，在本申请的前端工程依赖自动注册装置的一实施例中，参见图7，所述注册方法调用单元22包括：

自定义配置参数处理子单元221，用于判断所述插件列表中各插件对应的参数配置信息中是否包含有自定义配置对象；若是，则将所述自定义配置对象作为第二传参。

从硬件层面来说，为了能够有效避免开发人员在引入npm包插件时在工程入口文件中添加冗余代码，提升代码可维护性，同时可以避免在手工添加注册代码时引入不必要的错误，本申请提供一种用于实现所述前端工程依赖自动注册方法中的全部或部分内容的电子设备的实施例，所述电子设备具体包含有如下内容：

处理器(processor)、存储器(memory)、通信接口(Communications Interface)和总线；其中，所述处理器、存储器、通信接口通过所述总线完成相互间的通信；所述通信接口用于实现前端工程依赖自动注册装置与核心业务系统、用户终端以及相关数据库等相关设备之间的信息传输；该逻辑控制器可以是台式计算机、平板电脑及移动终端等，本实施例不限于此。在本实施例中，该逻辑控制器可以参照实施例中的前端工程依赖自动注册方法的实施例，以及前端工程依赖自动注册装置的实施例进行实施，其内容被合并于此，重复之处不再赘述。

可以理解的是，所述用户终端可以包括智能手机、平板电子设备、网络机顶盒、便携式计算机、台式电脑、个人数字助理(PDA)、车载设备、智能穿戴设备等。其中，所述智能穿戴设备可以包括智能眼镜、智能手表、智能手环等。

在实际应用中，前端工程依赖自动注册方法的部分可以在如上述内容所述的电子设备侧执行，也可以所有的操作都在所述客户端设备中完成。具体可以根据所述客户端设备的处理能力，以及用户使用场景的限制等进行选择。本申请对此不作限定。若所有的操作都在所述客户端设备中完成，所述客户端设备还可以包括处理器。

上述的客户端设备可以具有通信模块(即通信单元)，可以与远程的服务器进行通信连接，实现与所述服务器的数据传输。所述服务器可以包括任务调度中心一侧的服务器，其他的实施场景中也可以包括中间平台的服务器，例如与任务调度中心服务器有通信链接的第三方服务器平台的服务器。所述的服务器可以包括单台计算机设备，也可以包括多个服务器组成的服务器集群，或者分布式装置的服务器结构。

图8为本申请实施例的电子设备9600的系统构成的示意框图。如图8所示，该电子设备9600可以包括中央处理器9100和存储器9140；存储器9140耦合到中央处理器9100。值得注意的是，该图8是示例性的；还可以使用其他类型的结构，来补充或代替该结构，以实现电信功能或其他功能。

一实施例中，前端工程依赖自动注册方法功能可以被集成到中央处理器9100中。其中，中央处理器9100可以被配置为进行如下控制：

步骤S101：接收用户发送的前端工程启动指令，并根据设定命名规则对工程依赖信息文件中的工程依赖信息进行筛选，得到插件列表。

步骤S102：根据所述插件列表中各插件对应的参数配置信息和插件调用接口进行插件注册操作，得到完成所述插件注册操作的前端工程。

从上述描述可知，本申请实施例提供的电子设备，通过对工程依赖信息文件中的工程依赖信息进行筛选，得到插件列表，然以后根据所述插件列表中各插件对应的参数配置信息和插件调用接口自动进行插件注册操作，由此能够有效避免开发人员在引入npm包插件时在工程入口文件中添加冗余代码，提升代码可维护性，同时可以避免在手工添加注册代码时引入不必要的错误。

在另一个实施方式中，前端工程依赖自动注册装置可以与中央处理器9100分开配置，例如可以将前端工程依赖自动注册装置配置为与中央处理器9100连接的芯片，通过中央处理器的控制来实现前端工程依赖自动注册方法功能。

如图8所示，该电子设备9600还可以包括：通信模块9110、输入单元9120、音频处理器9130、显示器9160、电源9170。值得注意的是，电子设备9600也并不是必须要包括图8中所示的所有部件；此外，电子设备9600还可以包括图8中没有示出的部件，可以参考现有技术。

如图8所示，中央处理器9100有时也称为控制器或操作控件，可以包括微处理器或其他处理器装置和/或逻辑装置，该中央处理器9100接收输入并控制电子设备9600的各个部件的操作。

其中，存储器9140，例如可以是缓存器、闪存、硬驱、可移动介质、易失性存储器、非易失性存储器或其它合适装置中的一种或更多种。可储存上述与失败有关的信息，此外还可存储执行有关信息的程序。并且中央处理器9100可执行该存储器9140存储的该程序，以实现信息存储或处理等。

输入单元9120向中央处理器9100提供输入。该输入单元9120例如为按键或触摸输入装置。电源9170用于向电子设备9600提供电力。显示器9160用于进行图像和文字等显示对象的显示。该显示器例如可为LCD显示器，但并不限于此。

该存储器9140可以是固态存储器，例如，只读存储器(ROM)、随机存取存储器(RAM)、SIM卡等。还可以是这样的存储器，其即使在断电时也保存信息，可被选择性地擦除且设有更多数据，该存储器的示例有时被称为EPROM等。存储器9140还可以是某种其它类型的装置。存储器9140包括缓冲存储器9141(有时被称为缓冲器)。存储器9140可以包括应用/功能存储部9142，该应用/功能存储部9142用于存储应用程序和功能程序或用于通过中央处理器9100执行电子设备9600的操作的流程。

存储器9140还可以包括数据存储部9143，该数据存储部9143用于存储数据，例如联系人、数字数据、图片、声音和/或任何其他由电子设备使用的数据。存储器9140的驱动程序存储部9144可以包括电子设备的用于通信功能和/或用于执行电子设备的其他功能(如消息传送应用、通讯录应用等)的各种驱动程序。

通信模块9110即为经由天线9111发送和接收信号的发送机/接收机9110。通信模块(发送机/接收机)9110耦合到中央处理器9100，以提供输入信号和接收输出信号，这可以和常规移动通信终端的情况相同。

基于不同的通信技术，在同一电子设备中，可以设置有多个通信模块9110，如蜂窝网络模块、蓝牙模块和/或无线局域网模块等。通信模块(发送机/接收机)9110还经由音频处理器9130耦合到扬声器9131和麦克风9132，以经由扬声器9131提供音频输出，并接收来自麦克风9132的音频输入，从而实现通常的电信功能。音频处理器9130可以包括任何合适的缓冲器、解码器、放大器等。另外，音频处理器9130还耦合到中央处理器9100，从而使得可以通过麦克风9132能够在本机上录音，且使得可以通过扬声器9131来播放本机上存储的声音。

本申请的实施例还提供能够实现上述实施例中的执行主体为服务器或客户端的前端工程依赖自动注册方法中全部步骤的一种计算机可读存储介质，所述计算机可读存储介质上存储有计算机程序，该计算机程序被处理器执行时实现上述实施例中的执行主体为服务器或客户端的前端工程依赖自动注册方法的全部步骤，例如，所述处理器执行所述计算机程序时实现下述步骤：

步骤S101：接收用户发送的前端工程启动指令，并根据设定命名规则对工程依赖信息文件中的工程依赖信息进行筛选，得到插件列表。

步骤S102：根据所述插件列表中各插件对应的参数配置信息和插件调用接口进行插件注册操作，得到完成所述插件注册操作的前端工程。

从上述描述可知，本申请实施例提供的计算机可读存储介质，通过对工程依赖信息文件中的工程依赖信息进行筛选，得到插件列表，然以后根据所述插件列表中各插件对应的参数配置信息和插件调用接口自动进行插件注册操作，由此能够有效避免开发人员在引入npm包插件时在工程入口文件中添加冗余代码，提升代码可维护性，同时可以避免在手工添加注册代码时引入不必要的错误。

本领域内的技术人员应明白，本发明的实施例可提供为方法、装置、或计算机程序产品。因此，本发明可采用完全硬件实施例、完全软件实施例、或结合软件和硬件方面的实施例的形式。而且，本发明可采用在一个或多个其中包含有计算机可用程序代码的计算机可用存储介质(包括但不限于磁盘存储器、CD-ROM、光学存储器等)上实施的计算机程序产品的形式。

本发明是参照根据本发明实施例的方法、设备(装置)、和计算机程序产品的流程图和/或方框图来描述的。应理解可由计算机程序指令实现流程图和/或方框图中的每一流程和/或方框、以及流程图和/或方框图中的流程和/或方框的结合。可提供这些计算机程序指令到通用计算机、专用计算机、嵌入式处理机或其他可编程数据处理设备的处理器以产生一个机器，使得通过计算机或其他可编程数据处理设备的处理器执行的指令产生用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的装置。

这些计算机程序指令也可存储在能引导计算机或其他可编程数据处理设备以特定方式工作的计算机可读存储器中，使得存储在该计算机可读存储器中的指令产生包括指令装置的制造品，该指令装置实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能。

这些计算机程序指令也可装载到计算机或其他可编程数据处理设备上，使得在计算机或其他可编程设备上执行一系列操作步骤以产生计算机实现的处理，从而在计算机或其他可编程设备上执行的指令提供用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的步骤。

本发明中应用了具体实施例对本发明的原理及实施方式进行了阐述，以上实施例的说明只是用于帮助理解本发明的方法及其核心思想；同时，对于本领域的一般技术人员，依据本发明的思想，在具体实施方式及应用范围上均会有改变之处，综上所述，本说明书内容不应理解为对本发明的限制。