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。

具体用法可以看另一篇。

相关文章
|
11天前
|
存储 数据采集 供应链
属性描述符初探——Vue实现数据劫持的基础
属性描述符还有很多内容可以挖掘,比如defineProperty与Proxy的区别,比如vue2与vue3实现数据劫持的方式有什么不同,实现效果有哪些差异等,这篇博文只是入门,以后有时间再深挖。 博客不应该只有代码和解决方案,重点应该在于给出解决方案的同时分享思维模式,只有思维才能可持续地解决问题,只有思维才是真正值得学习和分享的核心要素。如果这篇博客能给您带来一点帮助,麻烦您点个赞支持一下,还可以收藏起来以备不时之需,有疑问和错误欢迎在评论区指出~
|
4月前
|
存储 缓存 JavaScript
如何在大型 Vue 应用中有效地管理计算属性和侦听器
在大型 Vue 应用中,合理管理计算属性和侦听器是优化性能和维护性的关键。本文介绍了如何通过模块化、状态管理和避免冗余计算等方法,有效提升应用的响应性和可维护性。
|
5月前
|
JavaScript Java API
vue3知识点:setup
vue3知识点:setup
51 5
|
4月前
Vue3 项目的 setup 函数
【10月更文挑战第23天】setup` 函数是 Vue3 中非常重要的一个概念,掌握它的使用方法对于开发高效、灵活的 Vue3 组件至关重要。通过不断的实践和探索,你将能够更好地利用 `setup` 函数来构建优秀的 Vue3 项目。
|
4月前
|
前端开发 JavaScript
简记 Vue3(一)—— setup、ref、reactive、toRefs、toRef
简记 Vue3(一)—— setup、ref、reactive、toRefs、toRef
|
5月前
|
JavaScript API
vue3知识点:ref函数
vue3知识点:ref函数
81 2
|
5月前
|
JavaScript API
vue3知识点:自定义hook函数
vue3知识点:自定义hook函数
50 2
|
5月前
|
API
vue3知识点:reactive函数
vue3知识点:reactive函数
65 1
|
3月前
|
JavaScript
vue使用iconfont图标
vue使用iconfont图标
177 1
|
21天前
|
JavaScript 前端开发 算法
vue渲染页面的原理
vue渲染页面的原理
96 56