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。

具体用法可以看另一篇。

相关文章
|
6月前
|
JavaScript 前端开发 安全
Vue 3
Vue 3以组合式API、Proxy响应式系统和全面TypeScript支持,重构前端开发范式。性能优化与生态协同并进,兼顾易用性与工程化,引领Web开发迈向高效、可维护的新纪元。(238字)
930 139
|
6月前
|
缓存 JavaScript 算法
Vue 3性能优化
Vue 3 通过 Proxy 和编译优化提升性能,但仍需遵循最佳实践。合理使用 v-if、key、computed,避免深度监听,利用懒加载与虚拟列表,结合打包优化,方可充分发挥其性能优势。(239字)
524 1
|
7月前
|
开发工具 iOS开发 MacOS
基于Vite7.1+Vue3+Pinia3+ArcoDesign网页版webos后台模板
最新版研发vite7+vue3.5+pinia3+arco-design仿macos/windows风格网页版OS系统Vite-Vue3-WebOS。
848 11
|
6月前
|
JavaScript 安全
vue3使用ts传参教程
Vue 3结合TypeScript实现组件传参,提升类型安全与开发效率。涵盖Props、Emits、v-model双向绑定及useAttrs透传属性,建议明确声明类型,保障代码质量。
584 0
|
7月前
|
JavaScript
Vue中如何实现兄弟组件之间的通信
在Vue中,兄弟组件可通过父组件中转、事件总线、Vuex/Pinia或provide/inject实现通信。小型项目推荐父组件中转或事件总线,大型项目建议使用Pinia等状态管理工具,确保数据流清晰可控,避免内存泄漏。
665 2
|
6月前
|
缓存 JavaScript
vue中的keep-alive问题(2)
vue中的keep-alive问题(2)
563 137
|
10月前
|
人工智能 JavaScript 算法
Vue 中 key 属性的深入解析:改变 key 导致组件销毁与重建
Vue 中 key 属性的深入解析:改变 key 导致组件销毁与重建
1084 0
|
10月前
|
JavaScript UED
用组件懒加载优化Vue应用性能
用组件懒加载优化Vue应用性能
|
11月前
|
JavaScript 数据可视化 前端开发
基于 Vue 与 D3 的可拖拽拓扑图技术方案及应用案例解析
本文介绍了基于Vue和D3实现可拖拽拓扑图的技术方案与应用实例。通过Vue构建用户界面和交互逻辑,结合D3强大的数据可视化能力,实现了力导向布局、节点拖拽、交互事件等功能。文章详细讲解了数据模型设计、拖拽功能实现、组件封装及高级扩展(如节点类型定制、连接样式优化等),并提供了性能优化方案以应对大数据量场景。最终,展示了基础网络拓扑、实时更新拓扑等应用实例,为开发者提供了一套完整的实现思路和实践经验。
1530 78
|
9月前
|
人工智能 JSON JavaScript
VTJ.PRO 首发 MasterGo 设计智能识别引擎,秒级生成 Vue 代码
VTJ.PRO发布「AI MasterGo设计稿识别引擎」,成为全球首个支持解析MasterGo原生JSON文件并自动生成Vue组件的AI工具。通过双引擎架构,实现设计到代码全流程自动化,效率提升300%,助力企业降本增效,引领“设计即生产”新时代。
672 1