基于NodeJS的前后端分离的思考与实践（三）轻量级的接口配置建模框架(nodejs cgi)

编辑：rootadmin

推荐整理分享基于NodeJS的前后端分离的思考与实践（三）轻量级的接口配置建模框架(nodejs cgi)，希望有所帮助，仅作参考，欢迎阅读内容。

文章相关热门搜索词:基于nodejs的前后端分离,nodejs在前端中的作用,nodejs怎么写后端,nodejs前后端数据交互,nodejs怎么写后端,基于nodejs的前后端框架,基于nodejs的前后端框架,nodejs前后端数据交互,内容如对您有帮助，希望把文章链接给更多的朋友！

前言

使用Node做前后端分离的开发模式带来了一些性能及开发流程上的优势, 但同时也面临不少挑战。在淘宝复杂的业务及技术架构下，后端必须依赖Java搭建基础架构，同时提供相关业务接口供前端使用。Node在整个环境中最重要的工作之一就是代理这些业务接口，以方便前端(Node端和浏览器端)整合数据做页面渲染。如何做好代理工作，使得前后端开发分离之后，仍然可以在流程上无缝衔接，是我们需要考虑的问题。本文将就该问题做相关探讨，并提出解决方案。

由于后端提供的接口方式可能多种多样，同时开发人员在编写Node端代码访问这些接口的方式也有可能多种多样。如果我们在接口访问方式及使用上不做统一架构处理，则会带来以下一些问题：

1. 每一个开发人员使用各自的代码风格编写接口访问代码，造成工程目录及编码风格混乱，维护相对困难。2. 每一个开发人员编写自己的mock数据方式，开发完毕之后，需要手工修改代码移除mock。3. 每一个开发人员为了实现接口的不同环境切换(日常，预发，线上)，可能各自维护了一些配置文件。4. 数据接口调用方式无法被各个业务model非常方便地复用。5. 对于数据接口的描述约定散落在代码的各个角落，有可能跟后端人员约定的接口文档不一致。6. 整个项目分离开发之后，对于接口的联调或者测试回归成本依然很高，需要涉及到每一个接口提供者和使用者。于是我们希望有这样一个框架，通过该框架提供的机制去描述工程项目中依赖的所有外部接口，对他们进行统一管理，同时提供灵活的接口建模及调用方式，并且提供便捷的线上环境和生产环境切换方法，使前后端开发无缝结合。ModelProxy就是满足这样要求的轻量级框架，它是Midway Framework 核心构件之一，也可以单独使用。使用ModelProxy可以带来如下优点：

1. 不同的开发者对于接口访问代码编写方式统一，含义清晰，降低维护难度。2. 框架内部采用工厂+单例模式，实现接口一次配置多次复用。并且开发者可以随意定制组装自己的业务Model(依赖注入)。3. 可以非常方便地实现线上，日常，预发环境的切换。4. 内置river-mock和mockjs等mock引擎，提供mock数据非常方便。5. 使用接口配置文件，对接口的依赖描述做统一的管理，避免散落在各个代码之中。6. 支持浏览器端共享Model，浏览器端可以使用它做前端数据渲染。整个代理过程对浏览器透明。7. 接口配置文件本身是结构化的描述文档，可以使用river工具集合，自动生成文档。也可使用它做相关自动化接口测试，使整个开发过程形成一个闭环。

ModelProxy工作原理图及相关开发过程图览

在上图中，开发者首先需要将工程项目中所有依赖的后端接口描述，按照指定的json格式，写入interface.json配置文件。必要时，需要对每个接口编写一个规则文件，也即图中interface rules部分。该规则文件用于在开发阶段mock数据或者在联调阶段使用River工具集去验证接口。规则文件的内容取决于采用哪一种mock引擎（比如 mockjs, river-mock 等等）。配置完成之后，即可在代码中按照自己的需求创建自己的业务model。

下面是一个简单的例子：

【例一】

第一步在工程目录中创建接口配置文件interface.json, 并在其中添加主搜接口json定义

第二步在代码中创建并使用model