Vue 代码 AST 转换升级实战 —— vue-router 篇

前言

最近我们发布了《阿里妈妈又做了新工具,帮你把 Vue2 代码改成 Vue3 的》这个 Vue2 升级工具,下面跟大家分享下我们如何利用GoGoCode对 VueRouter 进行代码升级的。

Vue Router是什么

贴一个官方介绍:
Vue Router 是 Vue.js 官方的路由管理器。它和 Vue.js 的核心深度集成,让构建单页面应用变得易如反掌

作为 Vue 开发的标配之一 ,Vue Router 跟随 Vue3 同步升级,API 定义与使用上有了一些破坏性的变化。为了实现一键 Vue2 升级 Vue3,我们把 Vue Router 的转换规则进行了拆解与研究,下面举几个使用 GoGoCode 的转换场景跟大家分享下:

利用 GoGoCode 升级 Vue Router

GoGoCode的使用可以参考这里

1. new Router 变成 createRouter

1.1 API的变化

Vue Router 不再是一个类,而是一组函数。现在你不用再写 new Router(),而是要调用
createRouter:

// 以前是
// import Router from 'vue-router'
import { createRouter } from 'vue-router'

const router = createRouter({
  // ...
})

1.2 使用 GoGoCode 转换

处理上面API的变化,我们只需要利用 GoGoCodereplace方法,两行代码搞定

// import 方式转换
ast.replace(`import $_$ from 'vue-router'`, 
            `import * as VueRouter from 'vue-router'`);

// 创建Router实例方法转换
ast.replace(`new Router($_$)`, `VueRouter.createRouter($_$)`);

我也来试试:地址

2. 新的 history 配置取代 mode

2.1 API 的变化

mode: 'history' 配置已经被一个更灵活的 history 配置所取代。根据你使用的模式,你必须用适当的函数替换它:

  • "history": createWebHistory()
  • "hash": createWebHashHistory()
  • "abstract": createMemoryHistory()
import { createRouter, createWebHistory } from 'vue-router'
// 还有 createWebHashHistory 和 createMemoryHistory

createRouter({
  history: createWebHistory(),
  routes: [],
})

2.2 使用 GoGoCode 转换

VueRouter 中的 mode 配置,可以通过 GoGoCodereplace方法,替换成history配置,如果没有mode配置,则使用默认配置:history:createWebHashHistory


if (ast.has(`{mode:$_$}`)) {
  // router定义中存在 mode 属性,replace替换
    ast.replace(`mode:'history'`, 
              `history: VueRouter.createWebHistory()`);
    ast.replace(`mode:'hash'`, 
              `history: VueRouter.createWebHashHistory()`);
    ast.replace(`mode:'abstract'`, 
              `history: VueRouter.createMemoryHistory()`);
} else {
  // router定义中不存在 mode 属性,默认采用 createWebHashHistory
    ast.replace(`{routes:$_$,$$$}`, 
              `{history: VueRouter.createWebHashHistory(),routes:$_$,$$$}`);
}

我也来试试:地址

3. 移动了 base 配置

3.1 API的变化

base配置被作为 createWebHistory (其他 history 也一样)的第一个参数传递:

import { createRouter, createWebHistory } from 'vue-router'
createRouter({
  history: createWebHistory('/base-directory/'),
  routes: [],
})

3.2 使用 GoGoCode 转换

通过GoGoCode通配符号$_$$$$,将base及其它代码进行乾坤大挪移,可以瞬间完成代码片段转移。

  ast.replace(`{$$$,history: VueRouter.createWebHistory(), base: $_$}`,
    `{$$$,history: VueRouter.createWebHistory($_$)}`)

我也来试试:地址

4. <router-view>、<keep-alive> 和 <transition>

4.1 API 的变化

transition 和 keep-alive 现在必须通过 v-slot API 在 RouterView 内部使用:

<router-view v-slot="{ Component }">
  <transition>
    <keep-alive>
      <component :is="Component" />
    </keep-alive>
  </transition>
</router-view>

4.2 使用 GoGoCode 转换

GoGoCode同样能处理html代码,我们将router-view节点转移到transition外层,同时保持原来的属性及内部元素结构不变,使用replace 可瞬间完成。

ast.replace(`<transition $$$1><router-view $$$2>$$$3</router-view></transition>`,
`<router-view v-slot="{ Component }" $$$2>
    <transition $$$1>
        <component :is="Component" >$$$3</component>
    </transition>
</router-view>`);

我也来试试:地址

最后

这里只是列举了四个比较典型的VueRouter使用场景上的变化,包含了js和html代码转换。其他转换规则可以看下我们的 GitHub。这些转换规则都是使用了 GoGoCode 之后极大地简化了操作AST对象成本,基本上一个replace方法就能搞定,遇到代码转换需求非常推荐大家使用 GoGoCode

如果在使用 GoGoCode 过程中遇到问题可以联系我们:
github: https://github.com/thx/gogocode/issues
钉钉群:34266233

感谢您的阅读,祝您有美好的一天!

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

推荐阅读更多精彩内容