Open UI5 前端开发框架配套的 Mock Server 工作原理解析

本文涉及的产品
云解析 DNS,旗舰版 1个月
全局流量管理 GTM,标准版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
简介: Open UI5 前端开发框架配套的 Mock Server 工作原理解析

笔者在公司使用 Open UI5 进行前端应用开发时,与后台的交互,90% 的场合都是消费后台暴露的 OData 服务来完成的。


Open UI5 初学者在学习 OData API 使用时,面临的一个问题是:如何找到一些公网可以免费使用的 OData 服务。


Northwind 无疑是极佳的选择之一,但是该服务不支持修改操作。


换个角度想,其实 Open UI5 自带了一个很容易使用的 Mock Server,可以用来在本地模拟 OData 服务提供者,响应 SAP UI5 应用发起的

OData 请求,并使用预先配置好的测试数据进行回复。


登录 Open UI5 官方网站,输入关键字 Mock Server,即可找到其使用文档

281df1838f74234797a836b30c90c0fc_format,png.png


Mock Server 的运行对于 Open UI5 应用来说是完全透明的,Open UI5 应用根本不知道自己发出的请求,到底是被真实的远端服务器响应,还是由 Mock Server 返回。


下面通过实际例子来介绍 Mock Server 的使用步骤。

(1) 在 Table 控制器里,新建一个 OData 模型实例,传入 OData 服务 url:

/here/goes/your/serviceUrl/

该 url 就是我们需要在 Mock Server 里模拟的 OData 服务地址。


(2) 本地工程文件里新建一个 test 文件夹,其内包含下列三个文件:

  • metadata.xml: OData 服务的元数据文件,定义了名为 Products 的 EntitySet,其类型为 Product,后者包含三个字段:
    a. ProductId
    b. Name
    c. Size


image.png


  • Products.json:包含了上图 metadata.xml 文件里定义的名为 Products 的 EntitySet 对应的数据。运行时,Mock Server 会自动到其工作目录查找同名的 .json 文件,读取其内容,返回给 OData 服务的消费者。


  • server.js:


从 sap/ui/core/util/MockServer 导入 Mock Server 的实现,将步骤一里 Open UI5 需要消费的 OData 服务 url,传入 Mock Server 的 rootUri 属性即可。

下图 autoRespondAfter 属性,定义了使用 Mock Server 响应 OData 请求的延时,即 1 秒后返回响应。

三个文件总共行数加起来不到 60行,却提供了一个功能完整的 Mock Server.

(3) 在该 Open UI5 应用的 index.html 里,使用 sap.ui.require 加载本地工程里的 Mock Server 实例,调用其 init 方法,即可启动该服务器。


将笔者上传到 Github 的代码克隆到本地,npm install 之后执行 node local.js:

即可在 Chrome 开发者工具里观察 Mock Server 的运行情况:

http://localhost:3002/tabledelete


(1) SAP UI5 表格控件请求 OData 服务的元数据。Mock Server 接收到该请求,将工作目录下的 metadata.xml 的内容,返回给调用者。


(2) OData 模型是服务器端模型,这意味着表格控件根本不知道当前到底有多少条数据需要显示。

因此 Open UI5 表格控件会发送另一条包含 $count 操作的 OData 请求,去查询 Products 总数。

最终在表格控件里显示的条目数,是 $count 操作的结果和 20 两个数字的较小值。20 是 OData 分页的默认尺寸。

因为我在 Mock Server 的 Products.json 里只维护了两条数据,故 $count 结果为 2.


(3) 现在表格控件已经明确了自己需要显示两条数据,故发起第三个 OData 数据请求,top=2, 意思是向服务器请求第一页的前两条数据。

Mock Server 接收到该请求,将 Products.json 里全部两条数据返回给表格控件。


(4) 当使用 Add Row 按钮添加一条新的数据之后,Open UI5 表格控件依次发送下列三条 OData 请求:

删除操作的执行逻辑类似,这里不再赘述。

Open UI5 Mock Server 的一些高级用法,可以通过查询 Mock Server 的帮助文档来获取。


568565c64b568e8ddc96dd39fe252709_format,png.png


例如,假设我们期望针对 Mock Server 返回给调用者的数据,进行一些自定义处理。此时可以在 Mock Server 提供的 attachAfter 钩子函数里编写自定义逻辑:

如上图所示,当 Products.json 文件的数据被 Mock Server 加载,准备返回给 OData 消费者之前,应用开发人员编写的 attachAfter 回调函数触发,将每个产品的 Name 字段值末尾,加上一个句号。

Open UI5 Mock Server 实际上基于著名的开源 Mock 框架 Sinon.js

Sinon 框架的命名,是为了向希腊联军与特洛伊人之间长达十年的战争期间涌现出的英雄战士 Sinon(西农) 致敬,就是下图这位:

为了攻破坚固的特洛伊城,希腊联军中的奥德修斯想出了“木马计”:在木马腹中藏匿士兵,待特洛伊人将木马拽入城后,等到夜深人静时,木马内的士兵一齐涌出,里应外合,拿下特洛伊城。


Sinon 则勇敢地担当了诱使特洛伊人将木马拖进城的艰巨任务。他成功地扮演了一名间谍 (Spy) 的角色,凭借出色的演技使得特洛伊国王坚信,木马对特洛伊城来说,是个“吉祥物”。

image.png

在基于 Sinon 的 Open UI5 Mock Server 通过 init 方法启动时,会调用 Sinon.useFakeXMLHttpRequest,将 Sinon 伪造的 FakeXMLHttpRequest 实现,替换 Window 全局的 XMLHttpRequest, 完成了偷天换日。


这个替换,一般的 Open UI5 开发人员如果不对 Sinon 源代码进行单步调试,就不会知情。这个情形有点像昔日希腊联军的士兵们,藏匿在特洛伊-木-马中,神不知鬼不觉地潜入特洛伊城的场景。


值得一提的是,Sinon 的工作原理,和 Java 以及 Angular 里的 HTTP Intercept(拦截器)是不同的。在 HTTP 拦截器的工作场景中,HTTP 请求在两个时间点内,可以被框架或者应用开发人员编写的拦截器处理:


  • 程序代码调用 API 发送 HTTP 请求后,在 HTTP 请求实际从浏览器发出之前,由拦截器进行预处理
  • 应用程序得到远端的服务器响应后,在交给其回调函数处理之前,由拦截器进行预处理
  • 拦截器对 HTTP 请求的预处理,其类型包括但不局限于:全局错误处理,统一的身份验证机制,或者增添额外的业务逻辑等等。

而 Sinon 的工作场景下,因为真实的 XMLHttpRequest 已经被 FakeXMLHttpRequest 替换了,所以根本就没有真实的 HTTP 请求产生,因此 Chrome 开发者工具 network 标签页内也就根本观察不到任何网络请求。


Open UI5 应用和 Mock Server 之间的交互,纯粹是基于 FakeXMLHttpRequest 在内存中的一问一答而已。


希望本文能够帮助大家更深入地理解 Open UI5 Mock Server 的使用步骤,工作原理,以及 Mock Server 背后基于的 Sinon 框架的命名由来。

相关文章
|
21天前
|
存储 缓存 Java
什么是线程池?从底层源码入手,深度解析线程池的工作原理
本文从底层源码入手,深度解析ThreadPoolExecutor底层源码,包括其核心字段、内部类和重要方法,另外对Executors工具类下的四种自带线程池源码进行解释。 阅读本文后,可以对线程池的工作原理、七大参数、生命周期、拒绝策略等内容拥有更深入的认识。
什么是线程池?从底层源码入手,深度解析线程池的工作原理
|
10天前
|
存储 前端开发 JavaScript
前端基础(十二)_函数高级、全局变量和局部变量、 预解析(变量提升)、函数返回值
本文介绍了JavaScript中作用域的概念,包括全局变量和局部变量的区别,预解析机制(变量提升),以及函数返回值的使用和类型。通过具体示例讲解了变量的作用域、函数的返回值、以及如何通过return关键字从函数中返回数据。
12 1
前端基础(十二)_函数高级、全局变量和局部变量、 预解析(变量提升)、函数返回值
|
8天前
|
前端开发 开发者 UED
前端只是切图仔?来学学给开发人看的UI设计
该文章针对前端开发者介绍了UI设计的基本原则与实践技巧,覆盖了布局、色彩理论、字体选择等方面的知识,并提供了设计工具和资源推荐,帮助开发者提升产品的视觉与交互体验。
|
5天前
|
存储 缓存 关系型数据库
redo log 原理解析
redo log 原理解析
11 0
redo log 原理解析
|
10天前
|
前端开发 Python
Flask原理解析
Flask原理解析
|
10天前
with open as f原理解析
with open as f原理解析
salt之pillar原理解析
salt之pillar原理解析
|
15天前
|
测试技术 开发者 Python
深入浅出:Python中的装饰器使用与原理解析
【9月更文挑战第20天】本文深入探讨Python中一个强大而神秘的功能——装饰器。通过浅显易懂的语言和生动的比喻,我们将一步步揭开装饰器的面纱,理解其背后的原理,并通过实际代码示例掌握如何运用装饰器来增强我们的函数功能。无论你是初学者还是有一定基础的开发者,这篇文章都将带给你新的启发和思考。
28 7
|
2月前
|
监控 网络协议 Java
Tomcat源码解析】整体架构组成及核心组件
Tomcat,原名Catalina,是一款优雅轻盈的Web服务器,自4.x版本起扩展了JSP、EL等功能,超越了单纯的Servlet容器范畴。Servlet是Sun公司为Java编程Web应用制定的规范,Tomcat作为Servlet容器,负责构建Request与Response对象,并执行业务逻辑。
Tomcat源码解析】整体架构组成及核心组件
|
2月前
|
存储 NoSQL Redis
redis 6源码解析之 object
redis 6源码解析之 object
58 6

推荐镜像

更多
下一篇
无影云桌面