CN110297637B - 全平台客户端软件适用的资源文件热重载开发工具及方法 - Google Patents

Abstract

本发明公开一种全平台客户端软件适用的资源文件热重载开发工具，该开发工具预先设有配置文件，开发工具包括：配置文件解析模块，其用于解析用户根据配置文件的格式填入的配置参数并储存；文件监听模块，其用于读取配置参数并获取需要监听的资源文件路径；文件操作模块，其用于通过需要监听的资源文件路径获取需要监听的资源文件内容，根据配置参数处理需要监听的资源文件内容，获得最终文件；网络通信模块，其用于将最终文件推送给用户正在开发的程序，使正在开发的程序做出响应操作。本发明还公开一种全平台客户端软件适用的资源文件热重载方法。本发明消减手动进行的大量重复性耗时工作，绕过客户端编译运行，实时更新资源文件，提高开发效率。

Description

全平台客户端软件适用的资源文件热重载开发工具及方法

技术领域

本发明涉及计算机信息技术领域，具体是一种全平台客户端软件适用的资源文件热重载开发工具及方法。

背景技术

软件客户端都是基于编译型语言的，如果开发的功能需要频繁修改客户端所依赖的资源文件，那么现有的方案开发流程如下：①编写、修改资源文件②执行脚本处理资源文件③导入到客户端程序中④客户端重新编译运行看效果。现有技术需要频繁修改客户端所依赖的资源文件，就需要频繁重新编译运行客户端程序，编译是耗时的，这将带来开发效率低下的问题，依照现有的方案进行软件开发，从资源文件的修改到可以在客户端看到效果，这过程中需要大量的手动操作，以及非常耗时的客户端编译运行工作，极大地拖慢了软件开发效率，这些无差别的重复性工作浪费了开发人员的精力，而且人工操作这些步骤不能保证不出错误。

在web开发领域，webpack-dev-server插件工具可以解决网页开发过程中存在的上述问题，它可以在网页代码被修改时自动编译打包JS文件，并通过websocket通知浏览器刷新。webpack-dev-server开发工具，只能用于网页开发，并且只能用来作js文件的资源下发，并且无法在iOS，Android，Mac，Windows，Linux这些平台下的客户端软件中使用。且无法为使用者提供灵活的自定义操作机会，即在整个资源文件处理下发流程中，只能使用工具中预定义的功能，没办法把使用者自己编写的脚本工具融合进去。

因此，现有的软件开发工具存在以下缺点：软件开发效率低(需手动进行大量重复性耗时工作)；开发错误率高(人工易出错)；覆盖范围小(不适用于网页开发以外的领域)；定制灵活度低(无法提供面向使用者的灵活的定制化功能)。

发明内容

本发明的一个目的是解决至少上述问题，并提供至少后面将说明的优点。

本发明还有一个目的是提供一种全平台客户端软件适用的资源文件热重载开发工具，其是一个用来提高开发效率的通用的客户端软件开发工具，实时监听目标文件夹下文件的改动，并在监听到改动时运行用户自定义的脚本操作，推送给客户端进行实时刷新展示。

为了实现根据本发明的这些目的和其它优点，提供了一种全平台客户端软件适用的资源文件热重载开发工具，所述开发工具预先设有配置文件，所述开发工具包括：

配置文件解析模块，其用于解析用户根据配置文件的格式填入的配置参数并储存；

文件监听模块，其用于读取配置参数并获取需要监听的资源文件路径，并实时监听用户对于需要监听的资源文件是否有添加、修改、删除的操作；

文件操作模块，其用于当文件监听模块监听到添加、修改、删除的操作时，通过需要监听的资源文件路径获取需要监听的资源文件内容，并读取配置参数，根据配置参数处理需要监听的资源文件内容，获得最终文件；

网络通信模块，其用于将最终文件推送给用户正在开发的程序，使正在开发的程序做出响应操作。

优选的是，最终文件根据配置文件的格式传输到网络通信模块。

优选的是，正在开发的程序做出的响应操作包括修改、刷新。

优选的是，配置文件解析模块根据CommonJS文件来读取配置参数。

优选的是，文件监听模块通过Chokidar插件进行监听。

优选的是，需要监听的资源文件内容包括xml、json、图片。

优选的是，配置参数包括需要监听的资源文件路径、需要执行的脚本程序，文件操作模块自动运行需要执行的脚本程序来处理需要监听的资源文件内容以获得最终文件。

本发明还提供一种全平台客户端软件适用的资源文件热重载方法，包括以下步骤：

步骤一、解析用户根据配置文件的格式填入的配置参数并储存；

步骤二、读取配置参数并获取需要监听的资源文件路径，并实时监听用户对于需要监听的资源文件是否有添加、修改、删除的操作；

步骤三、当监听到添加、修改、删除的操作时，通过需要监听的资源文件路径获取需要监听的资源文件内容，并读取配置参数，根据配置参数处理需要监听的资源文件内容，获得最终文件；

步骤四、将最终文件推送给用户正在开发的程序，使正在开发的程序做出响应操作。

优选的是，步骤一中根据CommonJS文件来读取配置参数，步骤二中通过Chokidar插件进行实时监听，步骤三中的最终文件根据配置文件的格式传输到网络通信模块，步骤四中正在开发的程序做出的响应操作包括修改、刷新。

优选的是，需要监听的资源文件内容包括xml、json、图片。

本发明至少包括以下有益效果：

本发明消减手动进行的大量重复性耗时工作，绕过客户端编译运行，实时更新资源文件，提高开发效率，每次编译客户端会耗时几秒到几分钟不等(由客户端程序复杂程度决定)，使用本工具将会省去这些时间。本发明通过HTTP和TCP协议，与客户端进行便捷高效实时的资源文件数据交互，达到绕过客户端编译运行，快速高效的进行资源文件刷新展示的目的，提高软件开发效率。

本发明所述的开发工具自动监听资源文件的改动，自动运行用使用者定义的脚本操作，推送给客户端进行刷新操作，全部自动化，降低手动操作带来的开发错误率。

本发明所述的工具基于Node.js开发，网络通信基于HTTP，TCP，可以运行在所有平台下，适用于所有类型所有平台的客户端软件开发过程，增大适用范围广；

本发明为使用者提供友好的定制化接口，在使用者指定的时机运行使用者的脚本文件或插件程序，提高定制灵活度。

本发明的其它优点、目标和特征将部分通过下面的说明体现，部分还将通过对本发明的研究和实践而为本领域的技术人员所理解。

具体实施方式

下面结合实施例对本发明做进一步的详细说明，以令本领域技术人员参照说明书文字能够据以实施。

本发明提供了一种全平台客户端软件适用的资源文件热重载开发工具，所述开发工具预先设有配置文件，所述开发工具包括：

配置文件解析模块，其用于解析用户根据配置文件的格式填入的配置参数并储存；

文件监听模块，其用于读取配置参数并获取需要监听的资源文件路径，并实时监听用户对于需要监听的资源文件是否有添加、修改、删除的操作；

文件操作模块，其用于当文件监听模块监听到添加、修改、删除的操作时，通过需要监听的资源文件路径获取需要监听的资源文件内容，并读取配置参数，根据配置参数处理需要监听的资源文件内容，获得最终文件；

网络通信模块，其用于将最终文件推送给用户正在开发的程序，使正在开发的程序做出响应操作。

本发明中处于客户端的用户在开发程序时，根据配置文件填入自己想要设置的配置参数，这里配置参数是用户根据自己的意愿去开发程序而填入的信息，比如具体依靠CommonJS的文件引入规范，按照规范读取使用者指定的配置文件，将用户填入的配置参数信息转化为本发明所述的开发工具的程序运行数据，已达到用户可以灵活配置的目的；

然后，文件监听模块实时监听用户对于需要监听的资源文件是否有添加、修改、删除的操作，用户正在开发的程序中包含了需要监听的资源文件，对于需要监听的资源文件，文件监听模块读取配置参数并获取需要监听的资源文件路径，比如具体根据Node.js的第三方插件：Chokidar监听文件进行监听，获取的需要监听的资源文件路径对应会得到文件内容，用户可以看到这些信息；

当文件监听模块监听到用户执行了添加、修改、删除的操作时，文件操作模块通过需要监听的资源文件路径获取需要监听的资源文件内容，并读取配置参数，根据配置参数处理需要监听的资源文件内容，获得最终文件，配置参数中有一段脚本程序，文件操作模块会自动运行该脚本程序获得最终文件，最终文件就是用户在开发程序时的按照自己的意愿得到的文件；

网络通信模块将最终文件推送给用户正在开发的程序，用户正在开发的程序会自动加载最终文件并做出响应操作，客户端会实时展示正在开发的程序的结果状态，完成了对正在开发的程序的自动更新处理。网络通信模块可以基于Node.js插件，使HTTP插件开启HTTP服务，WS插件开启websocket服务，监听用户设置配置的端口号，进而实现正在开发的程序与本发明所述的开发工具之间的文件传输。

本发明中添加、修改、删除这些操作不是开发工具做的，是用户自己执行的，在没有本开发工具的时候，用户在开发程序是必须要做这些操作，比如：用户在自己的程序中某一个页面显示一个图标，或一段文本，然后用户有了新需求：需要加几张图片，或者把原来正在显示的图片修改一下，或者去掉几个已经在显示的图片，这些需求都会导致用户去操作资源文件，没有使用本发明所述的开发工具的时候，用户操作完资源文件之后，需要自己去重新编译打包程序，然后运行程序看效果并测试，使用了本发明所述的开发工具之后，本发明所述的开发工具会自动去监听用户的这些操作，然后帮用户省去“重新编译打包程序，然后运行程序看效果并测试”这些繁琐的步骤。

本发明所述的开发工具与客户端之间建立TCP、HTTP持久连接，可以达到高效实时的控制客户端更新开发程序，http服务为客户端提供开发阶段的自动化文件操作服务，以及静态资源(包含需要监听的资源文件)的托管服务。本发明不局限于TCP或HTTP，可以通过蓝牙，红外等其他通信手段，但需要做出更多的通信协议相关的实现，只是会导致跨平台性不好。

本发明所述的开发工具使用Node.js编写，本质是一个运行在本机的Node.js服务器，通过一些系统或第三方插件实现计算机文件系统状态的监听，修改文件，运行脚本，向客户端推送修改消息。但是，本发明包括但不限于用Node.js实现，也可以使用其他服务器架构如：java，Python等。

本发明中可以读取用户填写的配置文件达到定制化目的，这个配置文件是一个JS文件，JS语言支持的所有特性都可以引入本工具的配置系统，也就是说这个配置系统是高度可扩展，规则完善的，学习成本低廉的。本发明也可以不使用JS语言，可以是任何可以表达「键名：值」这种赋值语义的文件，如：JSON，XML，甚至是开发者自定义的文件格式。本发明所述的开发工具可以使用C++，java，Python等其他语言来开发用户正在开发的程序。本发明的文件监听模块还可以使用java的第三方开发包：commons-io，C++的ReadDirectoryChangesW函数等实现。

本发明消减手动进行的大量重复性耗时工作，绕过客户端编译运行，实时更新资源文件，提高开发效率，每次编译客户端会耗时几秒到几分钟不等(由客户端的正在开发的程序的复杂程度决定)，使用本工具将会省去这些时间。本发明通过HTTP和TCP协议，与客户端进行便捷高效实时的资源文件数据交互，达到绕过客户端编译运行，快速高效的进行资源文件刷新展示的目的，提高软件开发效率。

本发明所述的开发工具自动监听资源文件的改动，自动运行用使用者定义的脚本操作，推送给客户端进行刷新操作，全部自动化，降低手动操作带来的开发错误率。

本发明所述的开发工具优选基于Node.js开发，网络通信基于HTTP，TCP，可以运行在所有平台下，适用于所有类型所有平台的客户端软件开发过程，增大适用范围。本发明为使用者提供友好的定制化接口，在使用者指定的时机运行使用者的脚本文件或插件程序，提高定制灵活度。

在另一技术方案中，最终文件根据配置文件的格式传输到网络通信模块，便于用户正在开发的程序快速加载最终文件。

在另一技术方案中，正在开发的程序做出的响应操作包括修改、刷新，这里的修改包含了用户根据自己的意愿使得正在开发的程序在加载最终文件时产生的任何复杂的操作。

在另一技术方案中，配置文件解析模块根据CommonJS文件来读取配置参数，CommonJS文件是一种JavaScript编程语言的规范，使用它可以把配置文件的编写权限交给用户。

在另一技术方案中，文件监听模块通过Chokidar插件进行监听，Chokidar插件属于 Node.js的插件。

在另一技术方案中，需要监听的资源文件内容包括xml、json、图片。

在另一技术方案中，配置参数包括需要监听的资源文件路径、需要执行的脚本程序，文件操作模块自动运行需要执行的脚本程序来处理需要监听的资源文件内容以获得最终文件。

本发明还提供一种全平台客户端软件适用的资源文件热重载方法，包括以下步骤：

步骤一、解析用户根据配置文件的格式填入的配置参数并储存；

步骤二、读取配置参数并获取需要监听的资源文件路径，并实时监听用户对于需要监听的资源文件是否有添加、修改、删除的操作；

步骤三、当监听到添加、修改、删除的操作时，通过需要监听的资源文件路径获取需要监听的资源文件内容，并读取配置参数，根据配置参数处理需要监听的资源文件内容，获得最终文件；

步骤四、将最终文件推送给用户正在开发的程序，使正在开发的程序做出响应操作。

本发明中处于客户端的用户在开发程序时，根据配置文件填入自己想要设置的配置参数，这里配置参数是用户根据自己的意愿去开发程序而填入的信息，比如具体依靠CommonJS的文件引入规范，按照规范读取使用者指定的配置文件，将用户填入的配置参数信息转化为本发明所述的开发工具的程序运行数据，已达到用户可以灵活配置的目的；

然后，实时监听用户对于需要监听的资源文件是否有添加、修改、删除的操作，用户正在开发的程序中包含了需要监听的资源文件，对于需要监听的资源文件，读取配置参数并获取需要监听的资源文件路径，比如具体根据Node.js的第三方插件：Chokidar监听文件进行监听，获取的需要监听的资源文件路径对应会得到文件内容，用户可以看到这些信息；

当监听到用户执行了添加、修改、删除的操作时，通过需要监听的资源文件路径获取需要监听的资源文件内容，并读取配置参数，根据配置参数处理需要监听的资源文件内容，获得最终文件，配置参数中有一段脚本程序，自动运行该脚本程序获得最终文件，最终文件就是用户在开发程序时的按照自己的意愿得到的文件；

将最终文件推送给用户正在开发的程序，用户正在开发的程序会自动加载最终文件并做出响应操作，客户端会实时展示正在开发的程序的结果状态，完成了对正在开发的程序的自动更新处理。本发明可以基于Node.js插件，使HTTP插件开启HTTP服务，WS插件开启websocket服务，监听用户设置配置的端口号，进而实现正在开发的程序与本发明所述的开发工具之间的文件传输。

本发明中添加、修改、删除这些操作不是开发工具做的，是用户自己执行的，在没有本开发工具的时候，用户在开发程序是必须要做这些操作，比如：用户在自己的程序中某一个页面显示一个图标，或一段文本，然后用户有了新需求：需要加几张图片，或者把原来正在显示的图片修改一下，或者去掉几个已经在显示的图片，这些需求都会导致用户去操作资源文件，没有使用本发明所述的开发工具的时候，用户操作完资源文件之后，需要自己去重新编译打包程序，然后运行程序看效果并测试，使用了本发明所述的开发工具之后，本发明所述的开发工具会自动去监听用户的这些操作，然后帮用户省去“重新编译打包程序，然后运行程序看效果并测试”这些繁琐的步骤。

本发明所述的开发工具与客户端之间建立TCP、HTTP持久连接，可以达到高效实时的控制客户端更新开发程序，http服务为客户端提供开发阶段的自动化文件操作服务，以及静态资源(包含需要监听的资源文件)的托管服务。本发明不局限于TCP或HTTP，可以通过蓝牙，红外等其他通信手段，但需要做出更多的通信协议相关的实现，只是会导致跨平台性不好。

本发明所述的开发工具使用Node.js编写，本质是一个运行在本机的Node.js服务器，通过一些系统或第三方插件实现计算机文件系统状态的监听，修改文件，运行脚本，向客户端推送修改消息。但是，本发明包括但不限于用Node.js实现，也可以使用其他服务器架构如：java，Python等。

本发明中可以读取用户填写的配置文件达到定制化目的，这个配置文件是一个JS文件，JS语言支持的所有特性都可以引入本工具的配置系统，也就是说这个配置系统是高度可扩展，规则完善的，学习成本低廉的。本发明也可以不使用JS语言，可以是任何可以表达「键名：值」这种赋值语义的文件，如：JSON，XML，甚至是开发者自定义的文件格式。本发明所述的开发工具可以使用C++，java，Python等其他语言来开发用户正在开发的程序。本发明的文件监听模块还可以使用java的第三方开发包：commons-io，C++的ReadDirectoryChangesW函数等实现。

本发明消减手动进行的大量重复性耗时工作，绕过客户端编译运行，实时更新资源文件，提高开发效率，每次编译客户端会耗时几秒到几分钟不等(由客户端的正在开发的程序的复杂程度决定)，使用本工具将会省去这些时间。本发明通过HTTP和TCP协议，与客户端进行便捷高效实时的资源文件数据交互，达到绕过客户端编译运行，快速高效的进行资源文件刷新展示的目的，提高软件开发效率。

本发明所述的开发工具自动监听资源文件的改动，自动运行用使用者定义的脚本操作，推送给客户端进行刷新操作，全部自动化，降低手动操作带来的开发错误率。

本发明所述的开发工具优选基于Node.js开发，网络通信基于HTTP，TCP，可以运行在所有平台下，适用于所有类型所有平台的客户端软件开发过程，增大适用范围。本发明为使用者提供友好的定制化接口，在使用者指定的时机运行使用者的脚本文件或插件程序，提高定制灵活度。在另一技术方案中，步骤一中根据CommonJS文件来读取配置参数，CommonJS文件是一种JavaScript编程语言的规范，使用它可以把配置文件的编写权限交给用户；步骤二中通过Chokidar插件进行实时监听，步骤三中的最终文件根据配置文件的格式传输到网络通信模块，步骤四中正在开发的程序做出的响应操作包括修改、刷新，这里的修改包含了用户根据自己的意愿使得正在开发的程序在加载最终文件时产生的任何复杂的操作。

在另一技术方案中，需要监听的资源文件内容包括xml、json、图片。

尽管本发明的实施方案已公开如上，但其并不仅仅限于说明书和实施方式中所列运用，它完全可以被适用于各种适合本发明的领域，对于熟悉本领域的人员而言，可容易地实现另外的修改，因此在不背离权利要求及等同范围所限定的一般概念下，本发明并不限于特定的细节。

Claims (4)

1.全平台客户端软件适用的资源文件热重载开发工具，其特征在于，所述开发工具预先设有配置文件，所述开发工具包括：

配置文件解析模块，其用于解析用户根据配置文件的格式填入的配置参数并储存；

文件监听模块，其用于读取配置参数并获取需要监听的资源文件路径，并实时监听用户对于需要监听的资源文件是否有添加、修改、删除的操作；

文件操作模块，其用于当文件监听模块监听到添加、修改、删除的操作时，通过需要监听的资源文件路径获取需要监听的资源文件内容，并读取配置参数，根据配置参数处理需要监听的资源文件内容，获得最终文件；

网络通信模块，其用于将最终文件推送给用户正在开发的程序，使正在开发的程序做出响应操作；

配置文件解析模块根据CommonJS文件来读取配置参数；

文件监听模块通过Chokidar插件进行监听；

需要监听的资源文件内容包括xml、json、图片；

配置参数包括需要监听的资源文件路径、需要执行的脚本程序，文件操作模块自动运行需要执行的脚本程序来处理需要监听的资源文件内容以获得最终文件。

2.如权利要求1所述的全平台客户端软件适用的资源文件热重载开发工具，其特征在于，最终文件根据配置文件的格式传输到网络通信模块。

3.如权利要求1所述的全平台客户端软件适用的资源文件热重载开发工具，其特征在于，正在开发的程序做出的响应操作包括修改、刷新。

4.全平台客户端软件适用的资源文件热重载方法，其特征在于，包括以下步骤：

步骤一、解析用户根据配置文件的格式填入的配置参数并储存；

步骤二、读取配置参数并获取需要监听的资源文件路径，并实时监听用户对于需要监听的资源文件是否有添加、修改、删除的操作；

步骤三、当监听到添加、修改、删除的操作时，通过需要监听的资源文件路径获取需要监听的资源文件内容，并读取配置参数，根据配置参数处理需要监听的资源文件内容，获得最终文件；

步骤四、将最终文件推送给用户正在开发的程序，使正在开发的程序做出响应操作；

步骤一中根据CommonJS文件来读取配置参数，步骤二中通过Chokidar插件进行实时监听，步骤三中的最终文件根据配置文件的格式传输到网络通信模块，步骤四中正在开发的程序做出的响应操作包括修改、刷新；

需要监听的资源文件内容包括xml、json、图片。