Provide/Inject 通过 Symbol 键实现插件配置安全透传,支持响应式提供、读写分离、组合式函数封装及 SSR 默认值降级。
插件开发中常遇到配置要从根组件一路透传到深层 UI 组件的问题,比如主题色、API 前缀、国际化语言等。Provide / Inject 正是为这类场景设计的——它让插件内部组件能直接“认领”祖先提供的配置,跳过中间所有无关层。
多个插件可能都提供名为 theme 或 apiBase 的配置,字符串 key 极易覆盖。必须用 Symbol 作为注入标识:
export const PluginConfigKey = Symbol('my-plugin-config')
provide(PluginConfigKey, reactive({ theme: 'blue', apiBase: '/v2' }))
inject(PluginConfigKey) 获取,不会被其他插件同名 key 干扰只读配置容易维护,但插件有时需动态切换(如用户点选主题)。推荐拆分暴露:
computed(() => ({ ...config.value })) 包裹后 provide,防止下游意外修改updateConfig 方法,命名清晰、意图明确,例如:provide('updateMyPluginConfig', (newOpts) => { Object.assign(config.value, newOpts) })
把 provide/inject 逻辑收进组合式函数,让插件使用者无感接入:
useMyPlugin:在 setup 中自动调用 provide,并返回初始化方法import { useMyPlugin } from 'my-plugin',调用 useMyPlugin({ theme: 'dark' }) 即完成全局配置下发const ctx = inject(PluginConfigKey) 拿配置,不再关心来源层级插件要能在服务端渲染和独立使用场景下正常工作:
inject(PluginConfigKey, () => ({ theme: 'light', locale: 'zh-CN' })),未 provide 时自动降级provide 在组件挂载前执行(通常在 setup 顶层或 createApp 阶段完成)ref 或 reactive