【NG-Alain】组件Reuse-tab的前世今生

此文基于官方文档教程,是对其代码细节的解释文档。

reuse-tab组件位于【delon/abc】包中,这意味着多标签式选项卡组件是ng-alain内置的组件之一。 请注意,此组件不支持全部关闭,必须保留一个选项卡。

实现reuse-tab组件的基石

reuse-tab组件的原理是基于NG的RouteReuseStrategy服务在页面上输出一排按钮。

RouteReuseStrategy是angular的路由复用策略,用于可复用路由的判定与存取的操作。前提是你要清楚ng-alain项目的路由框架是“一个页面(URL)对应一个组件对应一个标签/选项卡”的事实,所以RouteReuseStrategy实际上缓存的就是组件对象。【对于一个页面内有两个以上的路由插槽的例外情况暂(bing)且(bu)不(zhi)表(chi)】。

关于路由复用策略的情况我不再赘述,请移步此处

代码执行概览

RouteReuseStrategy内有一个数组存储着所有被缓存的路由快照,通过点击reuse-tab在页面上生成的分别与这些快照对应的按钮,导航到相应的URL地址,这时候路由就不会生成新的组件对象而是使用缓存在RouteReuseStrategy服务内的路由快照。而当第一次访问某个URL(路由)时,会生成路由快照,此时reuse-tab会自动生成一个按钮(选项卡)。

路由判定可缓存

通过MenuService可以设置菜单列表,Menu对象的reuse属性指示当前路由可否被缓存。如果为true,则该菜单对应的URL(路由)必然会被复用。

这时候我们就会遇到一个问题,那就是并不是所有路由在左侧菜单栏都有对应的菜单项。此时没有Menu对象供我们设置它的reuse属性来指定路由可否被复用,难道真得向MenuService插入一个隐藏的菜单? 当然拒绝用这么low的方法,博主不甘心的仔细查阅reuse-tab组件,发现一个名为mode的枚举属性,我们可以通过指定此属性的值来决定reuse-tab的复用方式。

当值为ReuseTabMatchMode.Menu时,除非标记Menu对象的属性reuse为false否则都判定为可被复用。

当值为ReuseTabMatchMode.MenuFore时,除非标记Menu对象的属性reuse为true否则都判定不可被复用。

当值为ReuseTabMatchMode.URL时,任何URL(路由)都将判定为可被复用(可以通过excludes属性来指定不需要被复用的URL)。这并不妨碍你设置menu.reuse为false,因为Menu.reuse相当于css的行内样式,优先级很高。

是故我们设置reuse-tab组件的mode属性即可根据自身项目需求自定义reuse-tab的行为。友情提示 excludes与menu.reuse的设定请务必不要重复or互斥,如果出现不该被复用的路由被复用那可能就是这儿的问题。

mode的默认值

image
image

所以如上图所示,ng-alin项目中默认情况下除了/500设置reuse为false,其他都会缓存。因为mode的默认值就是Menu。

  
image

办法(二)

image

通常情况下,当模式为Menu时,我会朝不存在于MenuService的路由对象的date属性里添加一个类型为Boolean的属性,它指示是否复用此路由。

路由复用时存储

image

【@delon/abc】中实现RouteReuseStrategy接口并用来缓存路由快照的类型是ReuseTabCached。

image

ReuseTabService.store方法是用来缓存路由的快照。请注意,路由复用策略同时把路由的title缓存了,将在下文指出。

多标签式选项卡的标题

首先我们应该区分多标签式选项卡的标题与路由快照缓存的标题,但前者来自于后者。

image

ReuseItem是多标签式选项卡的元素类型,顾名思义title属性直接作用于选项卡标题。

请允许我再次申明:reuse-tab组件遍历了【ReuseItem数组】从而生成的按钮们与路由快照一一对应,而【ReuseItem数组】是基于【路由快照缓存数组】生成的,所以说有多少个被缓存的路由快照就有多少个标签式选项卡。

image

在路由快照存储时title就已经被感知到了,上图则是细节部分。

在显示多标签式选项卡标题时,优先使用通过ReuseTabService.title设置并存储在ReuseTabService._titleCached数组内的标题,然后使用路由的data对象的title,否则使用菜单的text属性,最后直接显示URL。

根据此方法最后两行代码,如果设置mode的值为ReuseTabMatchModel.URL时,请务必满足前两个条件之一,否则只会显示URL。

到此你会发现我们谈的一直都是路由快照缓存标题,但为什么又牵扯到多标签式选项卡标题呢?那是因为reuse-tab的数据源(ReuseItem[])基于路由快照缓存(ReuseTabCached)。

image

如上图所示,reuse-tab遍历了路由快照缓存生成ReuseItem,titile的值也来自于ResueTabCached.titile。

因为理解不了reuse-tab组件源代码的初衷,所以我理的越来越乱。并且组件并没有我预期中的那么精致,我勉强能总结一下标题显示URL的问题。

  1. 当你的路由并不在左侧菜单中时,你要么设置ReuseTabService.title = '标题',要么设置路由的 data: { title : ‘标题’}。
  2. 当你设置mode为ReuseTabMatchMode.URL时。你要么设置ReuseTabService.title = '标题',要么设置路由的 data: { title : ‘标题’},Menu对象的text和i18n不会起作用,它只会显示URL。
  3. 不要纠结于ReuseTabService.mode和ReuseTabComponent.mode这两个的关系,请统一使用前者。
  4. 当你确定全部路由都不需要复用时,请从layout/default.component.html中移除reuse-tab标签。

reuse-tab选项卡切换

目前有个隐患就是,路由复用策略虽然能缓存缓存URL(路由)内的组件对象(一直存在),那么组件生命周期【OnDestroy】永远不会被触发,同时当被缓存的路由被激活后(切换选项卡)【OnInit】更不会触发。

image

是故reuse-tab组件内部有新的生命周期,用来支持路由快照被激活和被缓存这两个操作能被感知到。但如图所示组件仍需要实现OnInit,因为第一次并不会触发【_onReuseInit】。

ng-alain1.0.x之后必须由用户主动注册路由复用策略,具体请查阅ng-alain的更新日志或示例代码。

image

同时reuse-tab组件支持在选项卡被切换后、关闭后发起通知。除非点击reuse-tab组件在DOM上生成的按钮,不然仅点击左侧菜单是不会触发change事件的。

启用reuse-tab后的路由传参

在任意的单页面web应用程序中,涉及到【路由】的项目都必须严格按照框架推荐的方式进行传参。

而在ng-alain中,当reuse-tab被启用后(即便在启用之前),URL都不应该继续使用带有【?】的传参方式,无论【?】是在【#】之前还是之后。此规则是强制性要求,不遵守即必然出现错误,表现为参数会在页面切换或刷新后丢失。

当路由只需要一个参数时的正确做法:

Router:  { path: 'edit/:id', component: EditNewComponent, data: { reuse: true } }
...
Class {
  id: number;
  inputType: boolean;
  ngOnInit(): void { 
    this.id = parseInt(this.route.snapshot.params.id); this.inputType = !this.id || this.id <= 0;
  }
}

当路由只需要一个参数时,如上方的示例代码所示。使用【/:***】的方式传递参数。

当路由不需要或需要多个参数时的正确做法:

// 路由申明如下:
{ path: 'add', component: AddComponent, data: { reuse: true } }
...
@Component({
    selector: 'app-user-list',
    template: `
        <a [routerLink]="['/add', {id:1,cd:2}]">跳转方式一</a>
    `
})
export class UserListComponent implements OnInit {
    constructor(private route: ActivatedRoute,
        private router: Router) { }
    ngOnInit(): void {
        console.log('取餐方法一', this.route.snapshot.params);
        this.route.params.subscribe(params => console.log('取餐方法二', params));
    }
    /** 跳转方式二 */
    btnClick() {
        this.router.navigateByUrl('/user/add;id=1;cd=2');
    }
}

此时无需在路由中定义参数,只需页面内使用任意一种方式皆可获取到传入的参数。第一种示例代码强制要求必须传入id,而此种方式指示所有可能的参数都是可选的。术语叫做【矩阵参数(matrix parameters)】。

最后的问题

并不是每个路由在事先都能知道标题,也不是每个路由的标题在事后都一成不变。如何才能根据业务需求动态的改变多标签式选项卡的标题?似乎是只能将从服务器动态获取的菜单设为隐藏后添加到MenuService里,但这样做的限制是不能使用ReuseTabService.title和路由的data: { title : ‘标题’} 方式来设置标题。那么,该用何种方式才能写出不会损耗性能的优雅代码呢?

其余内容,待续……

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,294评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,780评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,001评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,593评论 1 289
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,687评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,679评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,667评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,426评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,872评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,180评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,346评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,019评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,658评论 3 323
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,268评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,495评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,275评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,207评论 2 352

推荐阅读更多精彩内容

  • 一、具体需求: 1. 页面布局 左侧导航,右侧侧边辅助菜单,中间主业务界面;左侧导航是根据用户权限动态生成的。 2...
    环零弦阅读 8,790评论 0 3
  • 简书,自己的自留地,高级实验田,想种啥种啥,日记、散文、小说、诗歌、游记、等等,都可以在这块实验田里耕种,不能成产...
    在听Yellow阅读 993评论 7 30
  • 一天,鸭子,乌龟,青蛙和公鸡准备到好朋友小山羊家里去做客。突然,一片乌云飘了过来,下起了大雨,小动物们只能冒着雨走...
    白浩泽阅读 402评论 0 1
  • 我以为还是那个年轻无少 还未尝出苦涩的味道 一切顺其自然指引着美好的方向 没想到一错再错 这都不是你自己的想象 小...
    云南啊帅阅读 268评论 0 2
  • 何处采蘋草? 南山小溪旁。 何处采水藻? 雨后积水坑。 采来如何装? 圆莒和方框。 采来如何煮? 三足无足锅。 何...
    黄耶鲁阅读 290评论 5 15