From 8dd0e592c246c3161623e6ac590745192d8e362f Mon Sep 17 00:00:00 2001 From: tianjiaxing Date: Fri, 8 Apr 2022 12:40:21 +0800 Subject: [PATCH] fix: add --- docs/tutorial/migration-to-vue3.md | 611 +++++++++++++++-------------- 1 file changed, 324 insertions(+), 287 deletions(-) diff --git a/docs/tutorial/migration-to-vue3.md b/docs/tutorial/migration-to-vue3.md index ebb99ace5..bc27363c9 100644 --- a/docs/tutorial/migration-to-vue3.md +++ b/docs/tutorial/migration-to-vue3.md @@ -4,318 +4,321 @@ ## main.js - - 创建应用实例 - - ::: preview - - > Vue2 - - ```JS - // 之前 - Vue 2 - import Vue from 'vue' - import App from './App' - Vue.config.productionTip = false // vue3 不再需要 - App.mpType = 'app' // vue3 不再需要 - const app = new Vue({ - ...App - }) - app.$mount() - ``` - - > Vue3 +创建应用实例 + +::: preview + +> Vue2 + +```JS +// 之前 - Vue 2 +import Vue from 'vue' +import App from './App' +Vue.config.productionTip = false // vue3 不再需要 +App.mpType = 'app' // vue3 不再需要 +const app = new Vue({ +...App +}) +app.$mount() +``` + +> Vue3 + +```JS +import App from './App' +import { createSSRApp } from 'vue' +export function createApp() { + const app = createSSRApp(App) + return { + app + } +} +``` + +::: + +## 全局属性，例如：全局网络请求 + +```js +// 之前 - Vue 2 +Vue.prototype.$http = () => {}; + +// 之后 - Vue 3 +const app = createApp({}); +app.config.globalProperties.$http = () => {}; +``` + +## 插件使用，例如：使用 vuex 的 store + +```js +// 之前 - Vue 2 +import store from "./store"; +Vue.prototype.$store = store; + +// 之后 - Vue 3 +import store from "./store"; +const app = createApp(App); +app.use(store); +``` + +## 项目根目录必需创建 index.html 文件，粘贴复制如下内容： + +```html + + + + + + + + + + +
+ + + +``` + +## 只支持使用 ES6 模块规范，commonJS 需改为 ES6 模块规范 + +### 导入模块, 例如： - ```JS - import App from './App' - import { createSSRApp } from 'vue' - export function createApp() { - const app = createSSRApp(App) - return { - app - } - } - ``` - - ::: - - - 全局属性，例如：全局网络请求 - - ```js - // 之前 - Vue 2 - Vue.prototype.$http = () => {}; + ```js + // 之前 - Vue 2, 使用 commonJS + var utils = require("../../../common/util.js"); - // 之后 - Vue 3 - const app = createApp({}); - app.config.globalProperties.$http = () => {}; - ``` + // 之后 - Vue 3， 只支持 ES6 模块 + import utils from "../../../common/util.js"; + ``` - - 插件使用，例如：使用 vuex 的 store +### 模块导出，例如： - ```js - // 之前 - Vue 2 - import store from "./store"; - Vue.prototype.$store = store; - - // 之后 - Vue 3 - import store from "./store"; - const app = createApp(App); - app.use(store); - ``` + ```js + // 之前 - Vue 2, 依赖如使用 commonJS 方式导出 + module.exports.X = X; -- 项目根目录必需创建 index.html 文件，粘贴复制如下内容： - - ```html - - - - - - - - - - -
- - - + // 之后 - Vue 3， 只支持 ES6 模块 + export default { X }; ``` -- 只支持使用 ES6 模块规范，commonJS 需改为 ES6 模块规范 +## vuex 用法 - - 导入模块, 例如： +::: preview - ```js - // 之前 - Vue 2, 使用 commonJS - var utils = require("../../../common/util.js"); +> Vue2 - // 之后 - Vue 3， 只支持 ES6 模块 - import utils from "../../../common/util.js"; - ``` +```js +import Vue from "vue"; +import Vuex from "vuex"; +Vue.use(Vuex); +const store = new Vuex.Store({ + state: {}, +}); +export default store; +``` - - 模块导出，例如： +> Vue3 - ```js - // 之前 - Vue 2, 依赖如使用 commonJS 方式导出 - module.exports.X = X; +```js +import { createStore } from "vuex"; +const store = createStore({ + state: {}, +}); +export default store; +``` - // 之后 - Vue 3， 只支持 ES6 模块 - export default { X }; - ``` +::: -- vuex 用法 +## 避免在同一元素上同时使用 v-if 与 v-for - ::: preview +> 而 Vue3 中，v-if 总是优先于 v-for 生效。以上写法将会在 Vue3 中与预期不符合，由于语法上存在歧义，建议避免在同一元素上同时使用两者（[更多](https://v3.cn.vuejs.org/guide/migration/v-if-v-for.html#%E6%A6%82%E8%A7%88)）。 - > Vue2 +## 生命周期的适配 - ```js - import Vue from 'vue' - import Vuex from 'vuex' - Vue.use(Vuex) - const store = new Vuex.Store({ - state: {} - }) - export default store - ``` +在 Vue3 中组件卸载的生命周期被重新命名 - > Vue3 +- `destroyed` 修改为 `unmounted` +- `beforeDestroy` 修改为 `beforeUnmount` - ```js - import { createStore } from 'vuex' - const store = createStore({ - state: {} - }) - export default store - ``` +## 事件的适配 - ::: - -- 避免在同一元素上同时使用 v-if 与 v-for - - > 而 Vue3 中，v-if 总是优先于 v-for 生效。以上写法将会在 Vue3 中与预期不符合，由于语法上存在歧义，建议避免在同一元素上同时使用两者（[更多](https://v3.cn.vuejs.org/guide/migration/v-if-v-for.html#%E6%A6%82%E8%A7%88)）。 +Vue3 现在提供了一个`emits`选项，类似于现有`props`选项。此选项可用于定义组件可以向其父对象发出的事件， [更多](https://v3.cn.vuejs.org/guide/migration/emits-option.html#overview) -- 生命周期的适配 +**强烈建议使用`emits`记录每个组件发出的所有事件。** - 在 Vue3 中组件卸载的生命周期被重新命名 +这一点特别重要，因为去除了`.native`修饰符。`emits` 现在在未使用声明的事件的所有侦听器都将包含在组件的中`$attrs`，默认情况下，该侦听器将绑定到组件的根节点。 - - `destroyed` 修改为 `unmounted` - - `beforeDestroy` 修改为 `beforeUnmount` +```html + + +``` -- 事件的适配 +## v-model 的适配 - Vue3 现在提供了一个`emits`选项，类似于现有`props`选项。此选项可用于定义组件可以向其父对象发出的事件， [更多](https://v3.cn.vuejs.org/guide/migration/emits-option.html#overview) +Vue3 的 v-model 相对 Vue2 来说 ，有了较大的改变。可以使用多 `model`,相应语法也有变化。[更多](https://v3.cn.vuejs.org/guide/migration/v-model.html#%E6%A6%82%E8%A7%88) - **强烈建议使用`emits`记录每个组件发出的所有事件。** +### 修改 modelValue - 这一点特别重要，因为去除了`.native`修饰符。`emits` 现在在未使用声明的事件的所有侦听器都将包含在组件的中`$attrs`，默认情况下，该侦听器将绑定到组件的根节点。 + 用于自定义组件时，Vue3 v-model prop 和事件默认名称已更改 `props.value` 修改为 `props.modelValue` ,`event.value` 修改为 `update:modelValue` - ```html - - + ```javascript + export default { + props: { + // value:String, + // 替换 value 为 modelValue + modelValue: String, + }, + }; ``` -- v-model 的适配 - - Vue3 的 v-model 相对 Vue2 来说 ，有了较大的改变。可以使用多 `model`,相应语法也有变化。[更多](https://v3.cn.vuejs.org/guide/migration/v-model.html#%E6%A6%82%E8%A7%88) - - - 修改 modelValue - 用于自定义组件时，Vue3 v-model prop 和事件默认名称已更改 `props.value` 修改为 `props.modelValue` ,`event.value` 修改为 `update:modelValue` +## 事件返回 - ```javascript - export default { - props: { - // value:String, - // 替换 value 为 modelValue - modelValue: String, - }, - }; - ``` +将之前的 `this.$emit('input')` 修改为 `this.$emit('update:modelValue')` ，vue3 中将省略这一步骤 -- 事件返回 +自定义组件上的 v-model 相当于传递了 modelValue prop 并接收抛出的 update:modelValue 事件： - 将之前的 `this.$emit('input')` 修改为 `this.$emit('update:modelValue')` ，vue3 中将省略这一步骤 +```html + - 自定义组件上的 v-model 相当于传递了 modelValue prop 并接收抛出的 update:modelValue 事件： + - ```html - + +``` - +若需要更改 model 名称，作为组件内 model 选项的替代，现在我们可以将一个 argument 传递给 v-model： - - ``` +```html + - 若需要更改 model 名称，作为组件内 model 选项的替代，现在我们可以将一个 argument 传递给 v-model： + - ```html - + +``` - +## 插槽的适配 - - ``` +Vue3 将不支持 `slot="xxx"` 的用法 ，请使用 `v-slot:xxx` 用法。[更多](https://v3.cn.vuejs.org/guide/component-slots.html#%E5%85%B7%E5%90%8D%E6%8F%92%E6%A7%BD) -- 插槽的适配 +::: preview - Vue3 将不支持 `slot="xxx"` 的用法 ，请使用 `v-slot:xxx` 用法。[更多](https://v3.cn.vuejs.org/guide/component-slots.html#%E5%85%B7%E5%90%8D%E6%8F%92%E6%A7%BD) +> Vue2 - ::: preview +```html + + + + + + +``` - > Vue2 +> Vue3 - ```html - - - +```html + + + + +``` - ::: +::: -- 从 Vue 3.0 开始，过滤器已删除，不再支持，建议用方法调用或计算属性替换它们。[更多](https://v3.cn.vuejs.org/guide/migration/filters.html#%E6%A6%82%E8%A7%88) +## 不再支持过滤器 -- 在 Vue3 中，处理 API `Promise 化` 调用结果的方式不同于 Vue2。[更多](https://uniapp.dcloud.io/api/#api-promise-化) +从 Vue 3.0 开始，过滤器已删除，不再支持，建议用方法调用或计算属性替换它们。[更多](https://v3.cn.vuejs.org/guide/migration/filters.html#%E6%A6%82%E8%A7%88) - - Vue3 中，调用成功会进入 then 方法，调用失败会进入 catch 方法 - - Vue2 中，调用无论成功还是失败，都会进入 then 方法，返回数据的第一个参数是错误对象，第二个参数是返回数据 +## 在 Vue3 中，处理 API `Promise 化` 调用结果的方式不同于 Vue2。[更多](https://uniapp.dcloud.io/api/#api-promise-化) - ::: preview +- Vue3 中，调用成功会进入 then 方法，调用失败会进入 catch 方法 +- Vue2 中，调用无论成功还是失败，都会进入 then 方法，返回数据的第一个参数是错误对象，第二个参数是返回数据 - > Vue2 + ::: preview - ```js - // Vue 2 转 Vue 3, 在 main.js 中写入以下代码即可 - function isPromise(obj) { - return ( - !!obj && - (typeof obj === "object" || typeof obj === "function") && - typeof obj.then === "function" - ); - } + > Vue2 - uni.addInterceptor({ - returnValue(res) { - if (!isPromise(res)) { - return res; - } - return new Promise((resolve, reject) => { - res.then((res) => { - if (res[0]) { - reject(res[0]); - } else { - resolve(res[1]); - } - }); + ```js + // Vue 2 转 Vue 3, 在 main.js 中写入以下代码即可 + function isPromise(obj) { + return ( + !!obj && + (typeof obj === "object" || typeof obj === "function") && + typeof obj.then === "function" + ); + } + + uni.addInterceptor({ + returnValue(res) { + if (!isPromise(res)) { + return res; + } + return new Promise((resolve, reject) => { + res.then((res) => { + if (res[0]) { + reject(res[0]); + } else { + resolve(res[1]); + } }); - }, - }); - ``` - - > Vue3 + }); + }, + }); + ``` - ```js - // Vue 3 转 Vue 2, 在 main.js 中写入以下代码即可 - function isPromise(obj) { - return ( - !!obj && - (typeof obj === "object" || typeof obj === "function") && - typeof obj.then === "function" - ); - } + > Vue3 - uni.addInterceptor({ - returnValue(res) { - if (!isPromise(res)) { - return res; - } - const returnValue = [undefined, undefined]; - return res - .then((res) => { - returnValue[1] = res; - }) - .catch((err) => { - returnValue[0] = err; - }) - .then(() => returnValue); - }, - }); - ``` + ```js + // Vue 3 转 Vue 2, 在 main.js 中写入以下代码即可 + function isPromise(obj) { + return ( + !!obj && + (typeof obj === "object" || typeof obj === "function") && + typeof obj.then === "function" + ); + } + + uni.addInterceptor({ + returnValue(res) { + if (!isPromise(res)) { + return res; + } + const returnValue = [undefined, undefined]; + return res + .then((res) => { + returnValue[1] = res; + }) + .catch((err) => { + returnValue[0] = err; + }) + .then(() => returnValue); + }, + }); + ``` - ::: + ::: - - uni-app 生命周期钩子在 Vue3 组合式 API 中的使用方式如下： +## uni-app 生命周期钩子在 Vue3 组合式 API 中的使用方式如下： - 在 Vue3 组合式 API 中，也需要遵循 uni-app 生命周期钩子规范, 如 onLaunch 等应用生命周期仅可在 App.vue 中监听，使用中请注意生命周期钩子的适用范围。[查看全部生命周期钩子](https://uniapp.dcloud.net.cn/collocation/frame/lifecycle) - 只能在 ` +``` + + + +```html + +``` -- GitLab