如何实现Vue2项目升级Vue3?

Vue3正式版已经发布有两年多了,如今它也已成为Vue的默认开发版本,如果你想要对之前Vue2项目进行升级重构,可以从以下几个维度入手:

① 构建工具
② 入口文件
③ 插件
④ 指令
⑤ 路由
⑥ 状态管理
⑦ 其他


一、构建工具

Vue3推荐使用Vite作为构建工具,相对Webpack来说Vite超快的热更新速度能极大提高开发效率,项目越大效果越明显。

1. 安装

npm i vite -g
npm create vite@latest

更多详情可以看我之前写的一篇文章 → Vue3+Vite初体验

初始项目结构大致如下:


然后我们可以将Vue2项目的src目录下的内容直接复制粘贴到新创建项目的src目录下,然后再继续接下来的重构操作。

2. 修改配置文件

默认配置文件vite.config.js如下:

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [vue()]
})

我们可以根据项目需求来新增一些内容,例如:

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import { resolve } from 'path'

// https://vitejs.dev/config/
export default defineConfig({
  base: './',  // 开发或生产环境服务的公共基础路径
  plugins: [vue()],
  resolve: {
    alias: {  // 配置路径别名
      '@': resolve('src')
    },
  },
  css: {
    preprocessorOptions: {   // css预处理器
      less: {
        // 引入全局的Less库,有关lib.less请看 → https://www.jianshu.com/p/b13e2a2204b2
        additionalData: '@import "./src/assets/less/lib.less";'
      },
    },
  }
})

这里需要注意的是,在Vue2项目配置vue.config.js中,我们是使用CommonJs的require()语法来导入相关依赖,而在Vue3项目配置vite.config.js中我们使用的是原生ES6的import语法来导入的。

二、入口文件

1. index.html

Vite项目的HTML入口文件是放在项目根目录下的,而且需要手动引入main.js才行,而main.js就是JS的入口文件。

<script type="module" src="./src/main.js"></script>

2. main.js

① 创建并挂载根实例

我们需要在main.js创建Vue实例,而Vue3创建实例的方式与Vue2有所不同,它使用的是createApp()来创建,例如:

import { createApp } from "vue";
import App from "./App.vue";
const app = createApp(App);

然后我们还需要将创建的实例挂载在页面上显示出来:

app.mount("#app");

需要注意的是,Vue3中的挂载方法不再是$mount()而是mount()

② 使用路由和状态管理

如果需要用到路由和状态管理,我们还需要用到vue-routervuex,使用use()方法来注册。

import router from "./router";
import store from "./store";
app.use(router)
   .use(store);

有关routerstore实例的创建,后面内容会讲到。

3. App.vue

App.vue通常是作为页面根组件,我们会在其中放置路由组件<router-view>,而页面路由切换时我们可能会给其加上一些动画效果,比如渐隐渐现,我们就可以用到内置的<transition>组件来实现,例如:

<router-view class="page" v-slot="{ Component }">
  <transition name="route" mode="out-in">
    <component :is="Component"></component>
  </transition>
</router-view>

更多<transition>相关内容请查看 → https://router.vuejs.org/zh/guide/advanced/transitions.html

另外<keep-alive>组件在与<router-view>搭配使用时也类似,需要用到v-slot指令,例如:

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

三、插件

插件定义方式与Vue2差不多,就是参数有所不同,例如:

export default {
    install(app, options) {
        // 注入一个全局可用的$isMobile()方法,用户判断是否是移动设备
        app.config.globalProperties.$isMobile = () => 'ontouchstart' in window;
    }
}

install()方法的第一个参数是Vue实例,我们可以向app.config.globalProperties中添加一些全局实例属性或方法,类似于Vue2中的Vue.prototype

四、指令

我们知道v-model不仅可以用在表单组件上,还能用在自定义组件上,但是在Vue3中v-model与Vue2不同,它是modelValue属性和update:modelValue事件的组合语法糖,例如:

<CustomInput v-model="searchText" />

它相当于:

<CustomInput
  :modelValue="searchText"
  @update:modelValue="newValue => searchText = newValue"
/>

组件内部定义:

<!-- CustomInput.vue -->
<script>
export default {
  props: ['modelValue'],
  emits: ['update:modelValue']
}
</script>

<template>
  <input
    :value="modelValue"
    @input="$emit('update:modelValue', $event.target.value)"
  />
</template>

五、路由

Vue Router从v3到v4在迁移的过程中可能改动地方比较多,这里只是简单例举了几个常见的变化,详情可以参考官方文档 → https://router.vuejs.org/zh/guide/migration/index.html#%E7%A0%B4%E5%9D%8F%E6%80%A7%E5%8F%98%E5%8C%96

1. 安装

npm install vue-router@4

2. 创建Router实例

import { createRouter, createWebHashHistory } from "vue-router";
export default createRouter({   // 替代之前的 new Router()
  history: createWebHashHistory(),  // 替代之前的 mode,这里使用的是hash模式
  routes: [
    {
      path: '/',
      component: () => import("@/views/Home/index.vue")
    }
  ],
  scrollBehavior(to, from, savedPosition) {
    if (savedPosition) {
      return savedPosition;
    } else {
      return { top: 0 };  // 以前的x改成left,y改成top
    }
  }
});

六、状态管理

1. 安装

npm install vuex@next

2. 创建Store实例

import { createStore } from 'vuex';

export default createStore({  // 替代之前的 new Vuex.Store()
  state: {
  },
  mutations: {
  },
  actions: {
  }
});

七、其他

在Vue2项目升级Vue3的过程中,除了以上列举的那些常见需要注意修改的点之外,还有一些其他需要注意的,比如Vue3中删除了filter过滤器,如果之前项目中有用到的话,需要使用computedmethods中的方法替代;删除了一些API属性和方法,如$on()$off()$once()$set()$delete()$destroy()Vue.exend()$children等。


总结

最后,用一张表对本文简单地做个总结:

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

推荐阅读更多精彩内容