[发明专利]根据源文件目录结构生成请求路由的Web服务器框架方法

说明书

本发明涉及Web应用技术，具体为一种根据源文件目录结构生成请求路由的Web服务器框架方法，包括如下步骤：步骤一：建立工程的目录结构；步骤二：在工程目录结构下的/routes下存放路由处理源文件及请求数据描述文件，/services下存放服务层模块定义源文件，/models下存放数据模型定义源文件，/utils下存放实用工具模块源文件；步骤三：路由的定义是通过对Express进行封装，将路由处理源文件所在路径作为请求路由，将其文件名作为请求方法；步骤四：路由处理源文件所在路径即其所需要处理的路由，以大括号括起的文件夹名称代表路径参数；路由处理源文件的名称为请求方法，输出为一个函数。

技术领域

本发明涉及Web应用技术，具体为一种根据源文件目录结构生成请求路由的Web服务器框架方法。

背景技术

在开发Web应用时，路由设计和配置是Web应用开发首先要进行的工作，目前在使用Node.js开发Web应用时主要是以Express、Koa等作为开发框架，这些框架主要解决的正是路由规则的定义。对于大规模Web应用，随着开发工作的推进，应用规模不断增长，以下问题将逐渐显现：1、路由配置源文件过于臃肿；2、多人编辑路由配置源文件容易导致冲突；3、重复的路由规则不容易被发现；4、路由与业务实现源文件的关系不直观，不便于维护；

如今Web应用设计模式以SaaS为主，API文档不可或缺，如何能让API文档内容与代码逻辑保持一致（如有请求路径是什么，哪些参数，各参数有哪些要求，返回什么样的数据），是否可以根据代码自动生成API文档，这也是一个Web框架应该解决的问题。然而上述主流框架仅提供了中间件机制，要实现以上目标，开发者必须自己实现相应的中间件并对每个路由进行配置。

另外，在Web应用开发过程中势必要对业务逻辑进行分层，形成不同类型的模块，如控制器、服务、数据模型、实用工具等，不同类型模块之间依赖的约束和调用方式也是大型Web应用开发过程中要考虑的问题。例如，根据Web开发规范，模块间不得跨级调用，这就需要我们定义一套规则来区分模块类型，并通过框架来约束模块之间的调用。再如，企业级应用开发过程中，Node.js中的模块一般不会作为NPM包发布，这就需要通过指定路径引入，这不仅会降低代码的可读性（可能会产生多层的相对路径），同时也不利于项目的维护（例如移动一个文件可能会对多个依赖该文件的代码造成影响）。

发明内容

本发明的目的是为了解决上述技术不足，提供了一种根据源文件目录结构生成请求路由的Web服务器框架方法，可对多个功能模块进行封装、整合，通过定义一套简单的规则，规范Web应用的开发，提高多人协作开发模式的开发效率。

为解决上述技术问题，本发明所采用的技术方案为：一种根据源文件目录结构生成请求路由的Web服务器框架方法，包括如下步骤：

步骤一：建立工程的目录结构；

步骤二：在工程目录结构下的/routes下存放路由处理源文件及请求数据描述文件，/services下存放服务层模块定义源文件，/models下存放数据模型定义源文件，/utils下存放实用工具模块源文件；

步骤三：路由的定义是通过对Express进行封装，将路由处理源文件所在路径作为请求路由，将其文件名作为请求方法；

步骤四：路由处理源文件所在路径即其所需要处理的路由，以大括号括起的文件夹名称代表路径参数；路由处理源文件的名称为请求方法，输出为一个函数；

步骤五：通过在路由处理源文件所在路径下设置一个与路由处理源文件名称相同，扩展名为json的描述文件，来定义该路由的名称、说明、可接收的客户端请求数据的形式及响应数据的形式；

步骤六：客户端请求被路由到路由处理源文件所定义的处理逻辑前将会根据该描述文件对请求数据进行检查，如果不符合要求则会返回错误；