vue3注册添加全局实例属性的方法,如何在setup函数中调用

简介: vue3注册添加全局实例属性的方法,如何在setup函数中调用

Vue 3 中,你可以使用全局 API 的 createApp 方法来创建 Vue 应用,并通过该应用的 config.globalProperties 属性来添加全局实例属性。这样,你就可以在任何组件内部通过 this 访问这些属性。

但是,需要注意的是,在 Vue 3 的 Composition API 中,this 关键字不再在 setup 函数内部可用。因此,如果你正在使用 Composition API,你需要使用 getCurrentInstance 函数来获取当前实例,并访问其属性。

以下是如何在 Vue 3 中注册全局实例属性的步骤

1. 使用 createApp 方法创建 Vue 应用

import { createApp } from 'vue';
import App from './App.vue';

const app = createApp(App);

2. 通过 config.globalProperties 添加全局实例属性

app.config.globalProperties.$myGlobalProperty = 'Hello, World!';

3. 在组件中使用全局实例属性

export default {
    mounted() {
      console.log(this.$myGlobalProperty); // 输出 "Hello, World!"
    }
  }`
  // 如果你使用的是 Composition API:
  
  // 你需要从 `vue` 包中导入 `getCurrentInstance` 函数,并使用它来访问全局实例属性。
import { getCurrentInstance } from 'vue';
  
  export default {
    setup() {
      const instance = getCurrentInstance();
      
      if (instance) {
        console.log(instance.appContext.config.globalProperties.$myGlobalProperty); // 输出 "Hello, World!"
      }
    }
  }

注意:使用全局实例属性时应该谨慎,避免命名冲突,并确保这些属性不会意外地被组件修改。

另外,Vue 3 提供了更灵活和可维护的替代方案,如使用 Provide/Inject API 或 Vuex 进行状态管理,这可能更适合大型应用或需要更严格状态管理的场景。

注意:getCurrentInstance 主要用于库/高级用途,并可能在未来的 Vue 版本中发生变化或被移除。在常规应用开发中,应优先考虑使用其他 API 和模式。

更新:在 Vue 3.2+ 中,你可以使用 provideinject API 来更安全、更明确地共享状态。这是推荐的方法,因为它提供了更好的封装和类型支持。

// 在根组件或父组件中
import { provide, ref } from 'vue';

export default {
  setup() {
    const myGlobalProperty = ref('Hello, World!');
    provide('myGlobalProperty', myGlobalProperty);
  }
};

// 在任何子组件中
import { inject } from 'vue';

export default {
  setup() {
    const myGlobalProperty = inject('myGlobalProperty');
    console.log(myGlobalProperty.value); // 输出 "Hello, World!"
  }
};

使用 provideinject 可以避免全局状态的潜在问题,并使得状态管理更加明确和可预测。

总的来说,选择哪种方法取决于你的具体需求和偏好。

注意:在 Vue 3.x 中,provide 和 inject 只能在 setup 函数内部使用,因为它们是基于 Composition API 的。如果你使用的是 Options API,你可能需要将你的逻辑迁移到 Composition API,或者使用其他方法(如 mixins、Vuex 等)来共享状态。

希望这可以帮助你理解如何在 Vue 3 中注册和使用全局实例属性!

4. 方式对比

  1. 方式一

在 Vue 2 中, Vue.prototype 通常用于添加所有组件都能访问的 property。 在 Vue 3

等同于config.globalProperties。这些 property 将被复制到应用中作为实例化组件的一部分

// 之前 - Vue 2
 Vue.prototype.$http = () => {}

// 之后 - Vue 3 
const app = createApp({})
app.config.globalProperties.$http = () => {} ```

上面是官方给得说明

下面是我的具体用法:

在vue3中注册一个全局实例方法

  import {createApp} from 'vue'
  import App from './App.vue'
  
  const app = createApp(App)
  app.config.globalProperties.$translate = key => {
      return key.split('.').reduce((o, i) => {
        if (o) return o[i]
      }, i18n)
    }

在vue实例的setup()函数中没有this对象,如何调用实例方法$translate呢:

  import {getCurrentInstance} from "vue";
  
  const internalInstance = getCurrentInstance();
    const request =
        internalInstance.appContext.config.globalProperties.$translate;

哦了

  1. 第二种方式:通过provide注入

与在 2.x 根实例中使用 provide 选项类似,Vue 3 应用实例也提供了可被应用内任意组件注入的依赖项:

    //入口处全局导入
        app.provide("dayjs", dayjs)
        app.provide("request",request)
<script>
import {toRef, nextTick, inject, ref, computed} from "vue"
export default {
  //普通用法
  inject: ['dayjs'],
  setup(props, {emit}) {
  //setup中的用法
    const dayjs = inject("dayjs")
    return {
    }
  }
}
</script>

使用 provide 在编写插件时非常有用,可以替代 globalProperties。

在应用之间共享配置

上面也是官方推荐得方式,但是他举得这个例子有点瞎b。

具体用法可以看另一篇。

相关文章
|
5月前
|
JavaScript 前端开发 安全
Vue 3
Vue 3以组合式API、Proxy响应式系统和全面TypeScript支持,重构前端开发范式。性能优化与生态协同并进,兼顾易用性与工程化,引领Web开发迈向高效、可维护的新纪元。(238字)
813 139
|
10月前
|
缓存 JavaScript PHP
斩获开发者口碑!SnowAdmin:基于 Vue3 的高颜值后台管理系统,3 步极速上手!
SnowAdmin 是一款基于 Vue3/TypeScript/Arco Design 的开源后台管理框架,以“清新优雅、开箱即用”为核心设计理念。提供角色权限精细化管理、多主题与暗黑模式切换、动态路由与页面缓存等功能,支持代码规范自动化校验及丰富组件库。通过模块化设计与前沿技术栈(Vite5/Pinia),显著提升开发效率,适合团队协作与长期维护。项目地址:[GitHub](https://github.com/WANG-Fan0912/SnowAdmin)。
1216 5
|
5月前
|
缓存 JavaScript 算法
Vue 3性能优化
Vue 3 通过 Proxy 和编译优化提升性能,但仍需遵循最佳实践。合理使用 v-if、key、computed,避免深度监听,利用懒加载与虚拟列表,结合打包优化,方可充分发挥其性能优势。(239字)
428 1
|
6月前
|
开发工具 iOS开发 MacOS
基于Vite7.1+Vue3+Pinia3+ArcoDesign网页版webos后台模板
最新版研发vite7+vue3.5+pinia3+arco-design仿macos/windows风格网页版OS系统Vite-Vue3-WebOS。
708 12
|
5月前
|
JavaScript 安全
vue3使用ts传参教程
Vue 3结合TypeScript实现组件传参,提升类型安全与开发效率。涵盖Props、Emits、v-model双向绑定及useAttrs透传属性,建议明确声明类型,保障代码质量。
492 0
|
7月前
|
缓存 前端开发 大数据
虚拟列表在Vue3中的具体应用场景有哪些?
虚拟列表在 Vue3 中通过仅渲染可视区域内容,显著提升大数据列表性能,适用于 ERP 表格、聊天界面、社交媒体、阅读器、日历及树形结构等场景,结合 `vue-virtual-scroller` 等工具可实现高效滚动与交互体验。
721 1
|
7月前
|
缓存 JavaScript UED
除了循环引用,Vue3还有哪些常见的性能优化技巧?
除了循环引用,Vue3还有哪些常见的性能优化技巧?
404 0
|
8月前
|
JavaScript
vue3循环引用自已实现
当渲染大量数据列表时,使用虚拟列表只渲染可视区域的内容,显著减少 DOM 节点数量。
198 0
|
10月前
|
JavaScript API 容器
Vue 3 中的 nextTick 使用详解与实战案例
Vue 3 中的 nextTick 使用详解与实战案例 在 Vue 3 的日常开发中,我们经常需要在数据变化后等待 DOM 更新完成再执行某些操作。此时,nextTick 就成了一个不可或缺的工具。本文将介绍 nextTick 的基本用法,并通过三个实战案例,展示它在表单验证、弹窗动画、自动聚焦等场景中的实际应用。
967 17
|
10月前
|
JavaScript 前端开发 API
Vue 2 与 Vue 3 的区别:深度对比与迁移指南
Vue.js 是一个用于构建用户界面的渐进式 JavaScript 框架,在过去的几年里,Vue 2 一直是前端开发中的重要工具。而 Vue 3 作为其升级版本,带来了许多显著的改进和新特性。在本文中,我们将深入比较 Vue 2 和 Vue 3 的主要区别,帮助开发者更好地理解这两个版本之间的变化,并提供迁移建议。 1. Vue 3 的新特性概述 Vue 3 引入了许多新特性,使得开发体验更加流畅、灵活。以下是 Vue 3 的一些关键改进: 1.1 Composition API Composition API 是 Vue 3 的核心新特性之一。它改变了 Vue 组件的代码结构,使得逻辑组
2172 0