- API 路由统一: 移除 /api/h5/,统一 /api/pms/ 入口 - 二进制改名: api-server -> pms-api(与服务名一致) - nginx: 合并 /api/ + /pms/api/ 为 /api/pms/ - 新增 docs/API.md 接口文档 - 后端: CabinetDetail 增加 rssi/pow_fail/address/soc 等字段 - Redis 管道批量读取仓体实时数据(SOC/电压/电流/功率) - DB: 所有 TIMESTAMP 列改为 DATETIME(修复类型不匹配) - 用户管理: 新增创建时间/修改时间列,状态改用 Switch - 角色管理/用户管理: 操作按钮改为图标 - PC 设备详情: 基本信息补全 RSSI/ICCID/电源/地址 - PC 卡片: 通道统计改用 Lucide 图标,颜色统一 - PC 二维码: canvas 渲染,含编号文字,支持右键下载 - H5: 按 uni-app 规范修正导航(navigateTo 替代 reLaunch) - H5: 详情页加返回导航条 - H5: 扫码支持摄像头(jsQR)+ ?id= 参数 - H5: 底部 tabBar 在所有页面常显 - H5: 首页统计改为 6 项(设备/通道/空闲/充电/充满/故障) - H5: 下拉刷新 / 上拉加载 - 产品首页: 添加业务联系 - 文档: 清理过时文件,补充缺失规范章节
3.4 KiB
Prefer provide/inject Over Global Properties in Plugins
Rule
When creating Vue plugins, prefer using app.provide() to make plugin functionality available to components instead of attaching properties to app.config.globalProperties.
Why This Matters
-
globalProperties don't work in setup(): Properties attached to
globalPropertiesare only accessible viathisin Options API. They are NOT available in the Composition API'ssetup()function. -
Type safety:
provide/injectintegrates better with TypeScript and requires less type augmentation boilerplate. -
Testability: Injected dependencies are easier to mock in tests compared to global properties.
-
Code clarity: Explicit
inject()calls make dependencies visible, while global properties can appear "magic". -
Scoping:
provide/injectfollows Vue's component hierarchy, making it easier to provide different values to different parts of your app.
Bad Practice
// plugins/i18n.ts
export default {
install(app, options) {
// Attaching to globalProperties - only works with Options API
app.config.globalProperties.$translate = (key: string) => {
return key.split('.').reduce((o, i) => o?.[i], options)
}
}
}
// In component - requires type augmentation for TypeScript
// Also DOES NOT work in <script setup>
export default {
mounted() {
console.log(this.$translate('greeting.hello'))
}
}
Good Practice
// plugins/i18n.ts
import type { InjectionKey, App } from 'vue'
export interface I18nOptions {
[key: string]: string | I18nOptions
}
export interface I18n {
translate: (key: string) => string
options: I18nOptions
}
export const i18nKey: InjectionKey<I18n> = Symbol('i18n')
export default {
install(app: App, options: I18nOptions) {
const translate = (key: string): string => {
return key.split('.').reduce((o, i) => o?.[i], options) as string ?? key
}
// Use provide for Composition API compatibility
app.provide(i18nKey, { translate, options })
}
}
// In component - works in setup() and has full type safety
<script setup lang="ts">
import { inject } from 'vue'
import { i18nKey } from '@/plugins/i18n'
const i18n = inject(i18nKey)
console.log(i18n?.translate('greeting.hello'))
</script>
Hybrid Approach
If you must support both APIs (e.g., for backwards compatibility), provide both:
export default {
install(app: App, options: I18nOptions) {
const i18n = {
translate: (key: string) => /* ... */
}
// For Composition API
app.provide(i18nKey, i18n)
// For Options API (use sparingly)
app.config.globalProperties.$i18n = i18n
}
}
TypeScript Type Augmentation (if using globalProperties)
If you must use globalProperties, you need proper type augmentation:
// types/vue.d.ts
export {}
declare module 'vue' {
interface ComponentCustomProperties {
$translate: (key: string) => string
}
}
Important: The file MUST contain export {} or another top-level export/import. Without it, the augmentation will OVERWRITE types instead of augmenting them.