「react缓存页面」从需求到开源(我是怎么样让产品小姐姐刮目相看的)
Posted 前端Sharing
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了「react缓存页面」从需求到开源(我是怎么样让产品小姐姐刮目相看的)相关的知识,希望对你有一定的参考价值。
一 一切根源都从产品小姐姐无厘头需求开始
最近在开发业务项目的时候,产品小姐姐突然来到我身边,然后就对着电脑一顿操作,具体场景大致是这样的。
场景一:
如上图所示,当在数万级别的数据中,选择一条,点击查看,跳转到当前数据的详情页,当点击按钮返回返回来,或者是浏览器前进后退等其他操作,返回到列表页的时候。要记录当前列表的位置。也就是要还原点击查看查看前的页面。但是当点击tab菜单按钮的时候,要清除页面信息。
场景二:
如上图所示,当我们编辑内容的时候,一些数据可能从其他页面获得,所以要求,无论切换路由,切换页面,当前页面的编辑信息均不能被置空,只有点击确定 ,重置,表单才内容置空。
场景三:场景一 + 场景二 是更复杂的缓存页面信息场景。
二 梳理需求
接这个需求的时候,咋眼一看,what ,好像是 vue
中的 keepalive
+ vue router
功能,但是,我们几个项目技术栈是react
,react
, react
! react
中没有对应的 keepalive
内置 api
,后来上GitHub
上搜索相关项目,感觉有很多不符合业务需求的情况。还有一些潜在的风险。瞬间慌了~~~。内心有一种万只神兽奔腾的感觉。
在漂亮产品小姐姐面前,怎么能说不,那不显得研发能力差,强行装了一波说很简单,只能硬着头皮接下来了。产品小姐姐临走前还说还鬼魅的笑了笑,说可以把几个项目的部分页面都加上这种效果。
1 解决方案
1 数据状态缓存到公共管理可行性
这个需求首先让我想到的是用redux
或者是mobx
来把页面的状态缓存起来,然后切换页面的时候,把这些数据缓存进去,再次切换回来的时候,将数据取出来,这样就一个问题,即便能缓存state
层,但是如果一些表单组件是非受控组件,是无法缓存下来的,还有一些dom
状态是缓存不了的,比如手动添加的一些样式等。还有就是实际情况比较复杂,有富文本组件,你是无法直接获取绑定的state
的。
第二个原因就是有好几个项目,而且页面比较多,如果都建立数据管理,那么工作量会非常的大。所以数据状态缓存的可行性不高,即便可以实现,也需要大量的复制粘贴,这不是我们的追求。
2 react-keepalive-router诞生
所以我们只能选择自己开发一个项目,然后把它开源,并应用在公司项目中来。既然选择缓存页面,那么为什么不在react-router
中的 Route
组件和Switch
组件中做文章呢,我们需要对Route
和 Switch
组件做一些功能性的拓展,正好笔者之前自己研究过react-router
源码,并写了一篇(这一次彻底弄懂react-router路由原理)[https://juejin.cn/post/6886290490640039943#comment] ,感兴趣的同学可以三连一波,因为项目是在router
路由层面,所以给它起了一个名字react-keepalive-router
。接下来就要对整个项目做一个系统的设计。
三设计阶段
1 了解react-fiber
为什么我们的项目要提到react-fiber
呢,这里我先说一下,react-fiber
, React Fiber
是从 v16 版本开始对 Stack Reconciler
进行的重写,是 v16 版本的核心算法实现。react
在初始化构建过程中,会产生一个由child
指向子fiber
,sibling
指向兄弟fiber
,return
指向父fiber
三个指针构建的fiber
树结构,里面保存着dom
信息,update
信息,props
信息等,我们核心思想就是,在切换页面的时候,组件销毁,但是作为渲染调度的react fiber
保存keepalive
状态。只要fiber
存活,就能获取到dom
元素,数据层state
等信息。
2 基于 react-router-dom 和 react 16.8
首先我们需要对react-router
库中的 Route
组件和Switch
组件作出改造,可以通过路由层面实现缓存路由功能。因为在设计之初,我就想着将用不同的状态管理keepalive
状态,这样的好处是,后续可以给缓存路由组件,增加一些额外的声明周期,比如说vue
中 activated
和 deactivated
一样。因为设计思想是状态管理,项目依赖中不想引入redux
等第三方库,所以这里选了react-hooks
中 useReducer
恰到好处。这就是react
基础库 16.8+
的原因之一。另外一个原因就是hooks
中有useMemo
这样防止渲染穿透的api,有助于调节路由组件的更新次数。
工作流程分析
受到react-router-cache-route
开源项目的启发,我在设计整个流程的时候,采取了交换dom
树的方式。
初始化 :整体设计思路第一次切入缓存页面的时候,会自动生成一个容器组件,缓存Route
会把组件,交给容器组件来挂载,然后容器组件生成fiber
,render
之后生成对应的dom
树,将dom
树交给Route
组件(也就是我们的正常的页面)。
切换页面:切换页面的时候,路由组件是肯定卸载的,这时候需要将我们的dom
还给容器组件,然后容器组件进入冻结状态。
再次切换到缓存页面:再次进入路由页面的时候,首先从容器中,发现有该页面的缓存,那么将容器解封状态,然后将dom
树,还给当前路由页面。完成keepalive
状态。
缓存销毁::项目支持销毁缓存功能,调用销毁方法,会卸载当前缓存容器,进一步销毁fiber
和 dom
,完成整个销毁功能。
工作流程图
工作原理图
设计的优势在哪里?
设计优势:
1 因为内部运用了 useReducer
状态管理,管理缓存状态,可以更灵活,操纵缓存路由组件,采用react hooks
全新api
,渲染节流,手动解除缓存,增加了缓存的状态周期,监听函数等。
2 这套缓存页面的思想,不仅仅可以用在路由页面级别,后期可以迁移的component
组件级别上来。也是后续维护和开发的方向。
四 使用简介 + 快速上手
我们开始设计项目的用法,api,已经应用场景。通过上述工作原理,讲述了 keepliveRouteSwitch
和 keepliveRoute
在整个缓存过程中的作用,
下载
因为我们是把项目上传到了npm
方便其他项目用,所以可以直接从 npm
上下载。
npm install react-keepalive-router --save
# or
yarn add react-keepalive-router
使用
1 基本用法
KeepaliveRouterSwitch
KeepaliveRouterSwitch
可以理解为常规的Switch,也可以理解为 keepaliveScope
,我们确保整个缓存作用域,只有一个 KeepaliveRouterSwitch
就可以了。
常规用法
import { BrowserRouter as Router, Route, Redirect ,useHistory } from 'react-router-dom'
import { KeepaliveRouterSwitch ,KeepaliveRoute ,addKeeperListener } from 'react-keepalive-router'
const index = () => {
useEffect(()=>{
/* 增加缓存监听器 */
addKeeperListener((history,cacheKey)=>{
if(history)console.log('当前激活状态缓存组件:'+ cacheKey )
})
},[])
return <div >
<div >
<Router >
<Meuns/>
<KeepaliveRouterSwitch>
<Route path={'/index'} component={Index} ></Route>
<Route path={'/list'} component={List} ></Route>
{ /* 我们将详情页加入缓存 */ }
<KeepaliveRoute path={'/detail'} component={ Detail } ></KeepaliveRoute>
<Redirect from='/*' to='/index' />
</KeepaliveRouterSwitch>
</Router>
</div>
</div>
}
这里应该注意⚠️的是对于复杂的路由结构。或者KeepaliveRouterSwitch 包裹的子组件不是Route ,我们要给 KeepaliveRouterSwitch
增加特有的属性 withoutRoute
就可以了。如下例子
以上是关于「react缓存页面」从需求到开源(我是怎么样让产品小姐姐刮目相看的)的主要内容,如果未能解决你的问题,请参考以下文章