Vue 3.x 设置全局属性/方法

1. provide/inject

  • 参数:

    • {string | Symbol} key
    • value
  • 返回值:

    • 应用实例
  • 用法:

    在应用实例上设置一个可以被注入到应用范围内所有组件中的值。当组件要使用应用提供的 provide 值时,必须用 inject 来接收

    provide/inject 的角度,应用程序为根级别的祖先,而根组件是其唯一的子级

    不要与 provide 组件选项 或组合式 API 中的 provide 方法 混淆。虽然它们也是 provide/inject 机制的一部分,但是是用来配置组件 provide 的值的。

// main.js
import { createApp } from 'vue'
import App from './App.vue'

// 创建应用实例
const app = createApp(App)

// 应用向根组件 App 中注入一个 property
app.provide('user', 'administrator')

选项式API:

// 应用内任意一个子组件
<template>
  <div>{{ user }}</div>
</template>

<script>
export default {
  name: 'Home',
  inject: ['user'],
  mounted() {
    console.log(this.user) // 'administrator'
  },
}
</script>

组合式 API:

// 模版部分与上面相同
<script>
import { inject, onMounted } from 'vue'
export default {
  setup() {
    const user = inject('user')
    onMounted(() => {
      console.log(user) // 'administrator'
    })
    return {
      user,
    }
  }
}
</script>

setup()内部,this不是该活跃实例的引用,因为setup()是在解析其它组件选项之前被调用的,所以setup()内的this的行为与其它选项中的this完全不同。
我们在setup()中一般不使用this而是用其他替代方法,且尽量把方法、生命周期钩子、计算属性等放到setup()内实现。避免与其它选项式 API 一起混用。

通过应用 provide 值在写插件时尤其有用,因为插件一般不能使用组件提供值。这是使用 globalProperties 的替代选择。

2. globalProperties

用来添加全局 property,命名冲突时,组件的 property 具有优先权。

  • 类型:[key: string]: any

  • 用法:只适用于选项式API

const app = createApp({})
app.config.globalProperties.foo = 'bar' 
app.config.globalProperties.$http = () => {}

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

app.component('child-component', {
  mounted() {
    console.log(this.foo) // 'bar'
  }
})

建议全局属性 key 名前面加上$(或者别的自定义标注),便于和组件属性区分。

那如何在setup()里使用通过globalProperties挂载的全局属性呢?
在如果想在setup()内部访问组件实例,需要用到 getCurrentInstance

import { getCurrentInstance } from 'vue'

const MyComponent = {
  setup() {
    const internalInstance = getCurrentInstance()
    // 访问 globalProperties
    console.log(internalInstance.appContext.config.globalProperties) 
  }
}

getCurrentInstance 只能setup生命周期钩子中调用。

但这是 Vue3 提供给高阶场景(譬如库)的方案,非常不建议把它当作在组合式 API 中获取this的替代方案来使用。因此这里只做了解。

  • 延伸:全局过滤器
    Vue 3 中删除了过滤器filters,今后用方法调用或计算属性替代它们。
    如果在 Vue 2 版本迁移过程中,应用中存在全局注册的过滤器,你可以利用全局属性(globalproperties)在所有组件中使用它:
// main.js
const app = createApp(App)

app.config.globalProperties.$filters = {
  textFilter(text, length) {
    let shortText = text
    const len = length ? length : 20
    if (text && text.length > len) {
      shortText = text.substring(0, len) + '...'
    }
    return shortText
  }
}

然后就能通过$filters对象在模板中需要处理的地方使用:

<template>
  <p>{{ $filters.textFilter(user.introduction, 10) }}</p>
</template>

注⚠️:通过以上方式添加的全局属性在模版中访问都不需要this。在 选项API 中使用需要 this

其实还有一个 全局 mixin 可以实现全局属性的定义。但mixin是为组件逻辑重用设计的,在 Vue 3 的 组合式 API 出来后已经不建议在应用代码中使用了。

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

推荐阅读更多精彩内容