162023.2

跨界面数据同步更新:基于抽象数据源的前端数据管理模式

在一个应用中,同一个数据源被用在不同场景下,会被反复请求,数据更新后不太容易同步更新关联数据源,我们通过抽象数据源,提出了一套可充分管理数据的系统化方案。

前端开发中,从后端提供的接口请求数据和提交数据是非常基础的工作,但在我们很多业务中,我们会发现跨界面的数据同步更新成为非常棘手的问题。我认为,由于很大一部分前端对数据管理的方式非常粗糙,给后续很多开发工作和产品体验都带来了问题,要解决这一问题,我们需要从更深的层面去思考“前端数据管理”的设计问题。本文将结合我们腾讯投资项目组的实战经验,聊一聊我对这个问题的思考和实现方式。

背景

前端开发逐渐成熟,但于此同时也存在诸多问题。具体到本文的场景下,成熟是指我们的开发模块化、逻辑分离化,有很好的分层趋势,而诸多问题是指由于前端编程本身的一些局限以及生态的不成熟,在分层趋势下无法优秀的处理跨层级的通信传递问题。

我们以tapd的一个例子为例来看看。当我们在任务列表中更新了某个单的状态时,可以通过一个快捷弹窗进行更新,更新后新状态会被同步到列表中,这个体验非常好:

 

但是,当我们打开单的详情,在详情界面更新状态时,在点击关闭之后,状态却没有同步到列表,这个体验就不那么如人意:

 

当然,对于tapd团队来讲,他们可以有办法解决这个问题,甚至这个情况可能是他们的一个bug,漏掉了一段代码。但是,我们不针对tapd的这个情况,我们要思考的是,当我们在列表和详情两个页面进行操作时,如何在这两个界面之间同步数据的更新呢?

我们经常在一个页面,甚至跨层级的组件之间有类似的操作。在一个页面的某个角落里面进行了某个编辑,提交之后,要同步更新页面大老远的另外一个角落的数据,因为它们是关联的,可能其中一个是依赖另外一个进行计算得到的数据,当被依赖的数据发送变化时,依赖者应该及时更新,否则界面上就会出现数据不一致的问题,是明显的业务错误。

但是我们在开发时,往往这两个地方是分两个组件开发的,而且很有可能这两个组件之间跨了十万八千里的层级,想要轻易通信没那么容易。面对这样的场景,我们应该如何去思考,如何去找到一种合理的方式呢?

备选方案

愚公移山法

例如上面的两个组件我们称为A和B,其中B组件内可能发生更新,更新后需要同步更新A组件。我们通过在A上暴露出一个方法,通过组件网络,层层传递,把这个方法传入到B中,当B完成更新后,调用这个方法,这个方法会帮助A重新请求数据,并完成界面更新。

全局状态法

我们建立了一个全局状态,该状态同时被A和B使用,当B完成更新后,我们重新请求数据,把新的数据写入到全局状态,引起两个组件的同时更新。但是有一个问题,我们是否需要基于不同的业务对象ID存储无数个类似的全局状态?

事件通知法

使用类似EventBus一类的事件管理器,在B完成更新后,广播一个事件,A监听该事件,在监听回调中重新请求数据并更新界面。问题在于,我们怎么确保庞大的系统中,事件名是唯一的?

问题的本质

我们经常讲,界面是状态反映。在这中间,我们没有提到数据是什么。我们从后端拉取的数据是什么呢?是状态?是其他?这是问题其一。问题之二是,我们现有的编程技巧中,把数据请求回来作为渲染界面的依据,这种处理方式直接把数据的来源与界面进行了绑定,以至于对数据的过度依赖致使UI编程无法以纯粹的方式表达界面本身的呈现。另一方面,数据源和界面的点对点关系,忽略了数据本身的意义,破坏了数据本身的联动性,使得这种联动必须依赖于UI编程中的某种触发,而非其自己实现闭合回路。数据本身的生命形态被打破,UI编程又被数据锁死,这是导致本文所指问题的关键根源。

一种数据源管理服务层设计

万事不决,分离一层。

我认为,在我们纯粹的UI编程和数据之间缺少一层隔离,所以界面和数据源之间是直接点对点绑定的,就像电话两头一样,只能两个人参与。而我们所面临的问题需要我们像水管一样,水源来了,你可以洗手盆出水,也可以花洒出水,都是用水,但用法不同,是一对多分发式参与。

在数据源和具体界面之间,并非一对一的关系,而且很多情况下,一个界面不一定只依赖一个数据源。因此,我们应该可以有这样一种形态:界面只管取数据来用,数据从哪里来我并不关心;于此同时,数据变了,我界面跟着变。通过这种隔离,让数据本身的生命由数据层自己掌控,让UI界面编程不在乎后端接口的绑架,从而做到两端的分离。

我们举个例子来感受一下:

我现在有了一个数据,它的格式为 { name: string, count: number },那么在任何界面中,我都可以将它取出来用,至于这个数据从哪里来,此刻我们并不关心。我们的组件需要用到这个数据,因此,我们把它读取出来。当这个数据发生变化(比如提交了更新,或者websocket推送了新数据)的时候,我们的界面随之变化。我们的组件只是像某个东西索取了这份数据,并且基于typescript,我们知道这份数据的格式和类型,至于这份数据是怎么来的,是从后端接口拉取的还是从缓存读取的,是由单一接口还是多个接口组合而来的,对于我组件而言,我不关心,我只关心我能拿到这份数据。

function SomeComponent() {
  const [data] = useDataSource(SomeDataSource)
  const { name, count } = data

  return (
    <div>{name}: {count}</div>
  )
}

那么这个数据是怎么来的呢?当然是从我们的后端接口来的了。

const SomeDataSource = source(async () => {
  const data = await fetch('...')
  return data
}, { name: '', count: 0 })

这个数据可能发生变化,什么时候发生变化呢?当然是某次更新操作之后。

await postData(data)
await renew(SomeDataSource)

当执行 `renew` 时,SomeDataSource 中的请求函数会被再次执行,新拿到的数据将作为 SomeDataSource 的新数据,由于这一变更会带来 useDataSource 内部实现的状态变更,从而引起 SomeComponent 的重新渲染。

假如,我们在另外一个组件中也使用了该数据源:

function Some2Component() {
  const [data] = useDataSource(SomeDataSource)
  ...
}

那么,当 SomeDataSource 中对应数据的变化,就回同时带来 Some2Component 的重新渲染。

你可能会说,这有什么,感觉完全没什么难度。但是一旦你开始按照这种思路去设计和架构你的代码,你就会发现,数据和组件开始分离,组件专注于使用数据,而数据有了自己的生命形态。

数据源管理服务层

在腾讯投资项目中,我们建立了一层服务层,专门用于管理对应的数据源,称之为数据源管理服务层。数据源管理和数据请求是两个层面的事物,数据请求负责从服务端拉取数据,二数据源管理负责管理这些数据。“数据源”是一个抽象,例如我们有一个叫做“项目详情”的数据源,但它并不代表一个具体的接口数据,而是代表项目这个概念的数据,抽象和具体的关系,类似interface和implements的关系。这个“项目详情”数据源,可能对应无数个具体项目的数据,但是它是一个源,它内部组织着不同项目数据的存储,所以它是一个管理工具。

数据源对象维持着数据,这些数据在组件中被读取。但是,在没有组件之前,我们就可以对数据源进行编程。我们以某些具体的需求为目标,建立数据源,数据源的目标是像下游提供数据,所以它只关心输出的数据是准确的,而不关心数据从哪里来。数据源定义拉取数据时,我们可以从两个接口挑选对应数据组合起来作为数据源对应的数据。例如一个具体的项目详情,它需要包含项目的基本信息,也需要包含这个项目内的交易信息,但是对于后端而言,这两个信息是分开的,由两个接口提供,因此,我们在建这个数据源时,我们从这两个接口拿到数据,并合并为一个数据,存储在数据源中等待被使用。

projectDetail = source(async (projectId: string) => {
  const [project, transactions] = await Promise.all([
    fetch('project info', projectId),
    fetch('transactions info', projectId),
  ])
  return { ...project, transactions }
}, )

上面这段演示代码演示了我们如何创建这个数据源。当然,这不是一个标准做法,因为我们的数据可能从各种渠道来,甚至是本地持久化存储。

接下来,我们要讨论的就是“数据自己的生命循环体”。

我们在项目中创建了一个 DataService 的基类,该类内部实现了上述数据源管理的能力。我们通过一个具体的 DataService 来管理某一组有关联的数据源,它们之间构成了数据自己的生命循环体。我们来看下例子:

class ProjectService extends DataService {
  // 项目详情
  projectDetail = this.source(async (projectId: string) => {
    const [project, transactions] = await Promise.all([
      fetch('project info', projectId),
      fetch('transactions info', projectId),
    ])
    return { ...project, transactions }
  }, {})

  // 项目列表
  projectList = this.source(async () => {
    const data = await fetchProjectList()
    return data
  }, [])

  // 更新项目基本信息
  updateProject = this.action(async (projectId: string, data: IProjectData) => {
    await httpPut(`.../${projectId}`, data)
    await Promise.all([
      this.renew(this.projectDetail, projectId),
      this.renew(this.projectList),
    ])
  })
}

我们用这个最简单的例子来说明。对于项目而言,我们往往需要读取项目列表,和某个具体的项目详情,同时有更新项目基本信息,实际上,我们还会有更多,例如获取项目的某些统计数据等等。

当我们更新项目基本信息的时候,我们需要 renew 项目详情和项目列表数据。

关键的来了。

“我们现在已经对项目相关的数据了如指掌,且它们已经自成体系了。”以往,我们很难表达这种感觉,就是我们还没有去考虑交互上的点击提交等操作之前,我们的数据自己已经动起来了,而且形成了完整的闭环。即使脱离了界面的环境,这部分代码都非常有价值。对于 ProjectService 而言,它可以被实例化,以维持数据,也可以被垃圾回收,释放内存。

我们弱化了“请求”这个动作,强调了“数据”这个存在。以往我们要为一个字段的选项列表提供数据,我们常常是在组件中创建一个状态,然后用一个请求把列表拉回来,再给这个状态,把这个状态作为选项列表。但是,在我们项目中,我们强调数据,一个数据源是一个对象,因此可以被作为一件物品进行传递,在组件中我们接收这个对象,从该源对象中读取数据,过程中,我们不关心请求这个动作。

这种有价值的数据管理,在我们项目中,被独立为数据源管理服务层,它向应用中的很多地方提供数据,不单单是组件里面,还有一些计算,一些判断查询,还有模型中提供某个字段的选项列表,它形成了一套独立的服务体系。

业务模块的组织

在我们的代码中,我们习惯于将相关的代码放在一起,用以表达某种高内聚的关联关系。在我们的项目中,我们有两种组织的单元,一种称为Subject,它和具体的界面无关,甚至和应用的呈现无关,它具有纯粹的业务描述,基于DDD的理念进行建模;另一种是Module,是基于某个具体业务而组织在一起的代码,狭义的理解,你可以把一个Module理解为应用中某个模块,例如项目模块、付款模块、签署模块等等。而“数据源管理服务层”虽然被称为一层,但并不代表数据源的定义代码被集中放在一起管理,相反,我们遵循上述组织单元的原则,Subject中有自己的数据源管理服务,Module中也有自己的数据源管理服务。

业务与UI分离

数据源管理服务层是通用的,且与业务逻辑一起,被放在公共实现部分,基于这一设计,不同端不需要重复实现相同的数据请求,当然,实际上在我们实现UI时,我们会忘记“请求”这个概念,我们不“请求”,而是“索要”,向数据源索要需要的数据。感官上,我们在写组件时,很难直接与数据请求打交道,甚至脑海中不需要有“请求”的概念,只有当我们再做骨架屏,需要一个加载状态时,需要数据源管理服务层暴露一个 loading 的状态给到组件使用。

当写组件更纯粹的专注于UI和交互本身,而不是处理一大堆和请求、数据、业务逻辑相关的东西时,我们的写作会被解放出来。随着数据管理的清晰化,前后端在某种层面上形成了一种规范,例如每一个实体需要提供对应的详情、列表、编辑、更新、选项等接口,基于这一规范,开发效率也会有所提升。

跨组件数据联动

数据的动作,和前端没有直接关系,甚至不一定是前端提交数据带来的,例如系统中有一个定时机制,在特定时间会更新数据。在上面的示例代码中,我们有 projectDetail 和 projectList 两个数据源。我们往往在两个不同的界面中使用这两个数据。但当某个项目发生变化时,这两个界面都应该被实时更新。

function ListPage() {
  const service = useService(ProjectService)
  const [listData] = useDataSource(service.projectList)
  // 使用 listData
}

在列表页使用列表数据。

function DetailPage() {
  const { projectId } = useRouteParams()
  const service = useService(ProjectService)
  const [detailData] = useDataSource(service.projectDetail, projectId)
  // 使用 detailData
}

在详情页使用详情数据。

我们把系统中的所有 Service 设计为可使用单例的对象,所以上面两个组件实际上使用了相同的 ProjectService 的单例。

上面这两个页面在数据使用上,看似没有任何联系,但在 DataService 层面,它们是有联系的,当项目数据发生变化时,详情和列表都会更新。但对于组件的开发者,并不需要去关心这一点,组件开发者只需要关心自己使用了自己需要的数据。这符合 Clear Architecture 的理念,我们在写内层的实现时,不应该考虑外层的应用。

function ProjectEditForm(props) {
  const { projectId } = props
  const service = useService(ProjectService)
  
  const handleSubmit = async () => {
    const data = generatePostData()
    await service.request(service.updateProject, projectId, data)
  }

  // ...
}

在表单中更新项目基本信息。

当更新完成之后,在 ProjectService 里面,它调用 renew 来更新当前项目和项目列表的数据,从而让 ListPage 和 DetailPage 作出对应的变更。上面三个组件中,我们不需要去处理它们相互之间的联动关系,因为这个动作是由数据层完成的,而非表现层。而且,实际上,除了表现层可能用到这些数据,逻辑层也可能用到,这意味着除了界面的变更,实际上我们在逻辑层的处理也可以被重新执行。

前端项目的分层设计让不同部分的职责更单一,前端框架则负责在各个层之间建立响应式关系。

效果预览

在投资信息中,投资方和被投方有约见记录,录入约见记录是一个非常简单的操作。我们来看下,在这个录入操作下,使用上述方案的实际效果。

 

约见记录列表陈列了该公司已有的约见,当点击添加约见时,会进入到一个新页面(新路由),完成添加之后,会回到这个页面,而回来时,我们新增的约见被读取了出来。在两个页面之间进行不同的数据存取操作,虽然动作本身是分开的,但是它们存在内在的联系。在 DataService 中,将这两种内在联系绑定在一起,因此,完成提交操作时,列表数据源需要随即进行更新。但在组件开发时,我们不需要去关心这种内在联系,因为对于列表组件而言,我们不需要也不应该想着数据的更新,同时,添加表单组件也不可能穷举出自己需要联动触发哪些组件更新。对于这两个组件而言,它们只专注做自己的事情,把数据的联动交给数据源管理服务层。

结语

在腾讯投资相关系统中,经常使用这种模式。无论PC端还是APP端,使用这种模式进行开发可以让我们比较轻松的完成跨界面的数据联动。这种模式,首先将数据管理从UI编程中独立出来,建立一层数据源管理服务层,并且在该层中构建了数据自身的生命循环体;接着,借助框架的能力,让数据管理工具具备响应式能力,并通过hooks封装,让组件可以在数据发生变化时进行更新;最后,在UI编程时,开发者不需要思考自己的动作会触发其他哪些组件的变更,也不需要记着自己需要依赖其他组件的动作来重新渲染,开发者专注完成自己的实现,而把这种跨组件的联动交给数据源管理服务层和封装的hooks函数来实现。前端数据层在以往我们很少去深入思考,无非就是请求数据,但是,在这种数据管理模式下,我们实现了架构上的分层,让数据自治,把数据的管理从组件体系中分离出来,这使得数据本身更封闭更聚合,同时当为其他部分(UI或某些逻辑判断)提供服务时,具有更开放更简洁的出口。当然,这一模式在某种程度上,依赖项目代码的整体架构设计,没有分层的架构设计理念,很难适应这种模式,同时,它也依赖于某些技术上的实现,不然没法做到那么高程度的封装。不过,相信这种设计在很多业务系统中,需要跨组件跨界面实现数据联动的场景下,具有不错的借鉴意义。

09:56:33 已有0条回复
022023.2

vscode里面命名下划线替换为驼峰

方法很简单,利用替换功能实现

基于正则,注意大小写

11:10:34 已有0条回复