动手实现基于 JSON 和 OData 两种数据模型的 Web 应用表格控件行项目的添加和删除
文章标题描述的需求是笔者在工作和网络上经常收到的前端开发领域的咨询话题之一。Web 应用的表格控件,在切换到编辑模式下之后,给用户提供了行项目的添加和删除功能。基于 MVC 和 MVVM 框架的前端控件,都离不开 Model 即数据模型层。
笔者工作中使用最多的模型层实现技术,即 JSON 模型和 OData 模型。因此本文就来分享这两套笔者最熟悉的数据模型下的表格行项目添加和删除实现,基于的前端开发框架是 UI5.
首先了解这两个模型的区别。
UI5 官网对 JSON
模型的定义:
The JSON model is a client-side model and, therefore, intended for small data sets, which are completely available on the client. The JSON model does not support mechanisms for server-based paging or loading of deltas. It supports, however, two-way binding. Also, client-side models like the JSON model have no built-in support for sending data back to the server. The apps have to use, for example, model.getData() and jQuery.ajax() to send updated data to the server.
JSON 模型是客户端模型,因此适用于在客户端完全可用的小规模数据集。JSON 模型不支持基于服务器实现的分页或增量加载机制。同 OData 模型不同,JSON 模型没有原生支持的将数据发送回服务器的功能。应用开发人员必须手动调用 model.getData()
和 jQuery.ajax()
将客户端更新的数据发送回服务器。
UI5 官网对 OData
模型的定义:
The OData model is a server-side model, meaning that the data set is only available on the server and the client only knows the currently visible (requested) data. Operations, such as sorting and filtering, are done on the server. The client sends a request to the server and shows the returned data.
OData 模型属于服务器端模型。在 Web 开发中,Server-Side Model
是指在服务器端进行数据处理和运算的模型。这种模型的主要优点是可以处理大量数据,同时也可以利用服务器的强大计算能力。
在 Server-Side Model
中,服务器接收到客户端的请求后,会进行一系列的处理,如查询数据库、执行算法等,然后将处理结果返回给客户端。这种处理方式相对于在客户端执行处理(例如,使用 JavaScript 在浏览器中执行处理)有很多优点。其中最主要的优点是,服务器端的计算能力通常远超客户端,可以处理更复杂的任务和更大的数据量。此外,由于所有的处理都在服务器端完成,敏感的数据和算法不会被发送到客户端,从而降低了数据被窃取或篡改的风险。
所以如果一个 Web 应用选择服务器端数据模型,就意味着完整的数据集仅保存在服务器上,客户端只能感知到当前请求的数据。排序和过滤等操作都是在服务器上完成的。客户端向服务器发送请求并显示返回的数据。
OData 模型支持增量加载机制(或称 Lazy Loading,延迟加载,懒加载)。
首先来学习在基于 OData 模型的 SAP UI5 表格控件里如何实现行项目的增添和删除需求。
这个例子的全部源代码,在我的 Github 上。
将整个代码仓库克隆到本地,执行命令行 npm install, 然后执行 node local.js:
然后浏览器访问 http://localhost:3002/tabledelete/ 即可:
上图的表格控件,绑定到了 OData 服务 Products entitySet 包含的两个字段:Name 和 Size.
在 Table 控制器的 onInit 方法里,我使用 ODataModel 的构造器,创建了一个 OData 模型实例,将其通过 setModel 方法赋给表格实例 oTable. 模型构造器需要传入一个 OData 服务的路径,这里我传入的路径 /here/goes/your/serviceUrl, 指向的是我本地 MockServer 提供的虚拟 OData 服务。
表格控件行项目的添加和删除,直接调用 OData 服务对应的 create 和 remove 方法即可,如下图高亮代码行所示。
OData 模型的 create 和 remove 方法调用后,会发送对应的 HTTP 请求到对应的服务器。注意,在添加和删除行项目的事件处理代码里,我们并未手动编写表格控件的刷新操作,因为 OData 模型是一个服务器端模型,当我们调用 OData 模型的 create 和 remove 方法执行完毕之后,OData 模型会自动发起另一个 read 请求,从服务器端获取最新的数据,并自动刷新表格控件。
下面再实现基于 JSON 模型的表格控件行项目的添加和删除。
本例的完整源代码我放在了我的 Github上。
新建 JSON 模型实例,并绑定到表格控件实例的代码如下图所示。其中 this.data.Products 数组变量,维护的是该 JSON 模型硬编码的全部本地数据:
用户在界面点击按钮试图添加和删除行项目,我们需要做的操作是修改 JSON 模型绑定的 Products 数组,然后调用 JSON 模型的 refresh 方法,手动触发 UI 的刷新。刷新模型数据之后,通过 JSON 模型的双向绑定机制,就能自动实现 UI 界面的同步刷新。
总结
从以上 JSON 模型的实现可以看出,该表格显示的全部数据,均位于客户端维护的 this.data.Products 数组里。正如 SAP UI5 官网所言,JSON 模型只适合数据量较小的表格内容展示。如果表格的数据源来自 SAP 系统后台,采用 JSON 模型实现的表格应用,将会遇到可扩展性(scalability) 问题。在这种情形下,OData 模型是更好的选择。