uni-env

在 uni-app 中优雅地判断当前环境。

本库把 uni-app 注入的环境变量导出为带类型的常量,用来判断当前平台与构建信息。

安装

npm i @uni-helper/uni-env

使用

import { appId, isH5, isMpWeixin, platform } from '@uni-helper/uni-env'

CommonJS 同样可用:

const { isMp, platform } = require('@uni-helper/uni-env')

导出

平台

导出含义
platformprocess.env.UNI_PLATFORM,类型为 BuiltInPlatform
builtInPlatforms全部内置平台名的数组
vueAppPlatformprocess.env.VUE_APP_PLATFORM,uni-app 为兼容旧版本注入的别名
appPlatformprocess.env.UNI_APP_PLATFORM,值为 android、ios、harmony 或 undefined
subPlatformprocess.env.UNI_SUB_PLATFORM,快应用的子平台
utsPlatformprocess.env.UNI_UTS_PLATFORM

平台判断

导出为真时
isH5platform 为 h5 或 web
isWebplatform 为 web 或 h5
isH5WeixinH5 且在微信内置浏览器
isH5WeiboH5 且在微博客户端
isH5AlipayH5 且在支付宝客户端
isAppplatform 为 app
isAppPlusplatform 为 app-plus
isAppHarmonyplatform 为 app-harmony
isAppAndroidappPlatform 为 android,或 utsPlatform 为 app-android
isAppIOSappPlatform 为 ios,或 utsPlatform 为 app-ios
isMpplatform 匹配 ^mp-
isMpWeixin微信小程序
isMpAlipay支付宝小程序
isMpBaidu百度小程序
isMpKuaishou快手小程序
isMpQQQQ 小程序
isMpToutiao抖音小程序
isMpJD京东小程序
isMpXHS小红书小程序
isMpHarmony鸿蒙小程序
isMp360360 小程序
isMpLark飞书小程序
isQuickappplatform 匹配 ^quickapp-webview
isQuickappUnion快应用联盟
isQuickappHuawei华为快应用

应用信息

导出来源
appIdmanifest 的 appid,未配置时为空字符串
appNamemanifest 的 name,未配置时为空字符串
appVersionNamemanifest 的 versionName,未配置时为空字符串
appVersionCodemanifest 的 versionCode,未配置时为空字符串
debugmanifest 的 debug,布尔值

构建与目录

导出来源
inputDirprocess.env.UNI_INPUT_DIR
outputDirprocess.env.UNI_OUTPUT_DIR
cliContextprocess.env.UNI_CLI_CONTEXT
compilerVersionprocess.env.UNI_COMPILER_VERSION
sourcemap / hasSourcemapprocess.env.SOURCEMAP
minimize / isMinimizeprocess.env.UNI_MINIMIZE
runByHBuilderXprocess.env.RUN_BY_HBUILDERX,布尔值

其余导出与 uni-app 内部的 process.env.* 一一对应,例如 uvue、appX、appPackType、automatorPort。完整名单与注释见 src/index.ts。

读取规则

本库按两条规则选择读取方式:

  • 已注册的键用 process.env.X。uni-app 在构建期把这些键静态替换为字面量,所有目标都能拿到正确值,并能触发 dead-code elimination,裁掉其他平台的死代码。
  • 未注册的键用 std-env 的 env.X。这些键不会被静态替换,运行时经 Proxy 依次回退读取 process?.env、import.meta.env、Deno、__env__、globalThis。这样在没有 process 全局的环境里不会抛 process is not defined。

规则来自 uni-app packages/uni-cli-shared/src/env/define.ts 的 initDefine。开发约定见 CONTRIBUTING.md。

误用后果:

  • 未注册键写成 process.env.X,会在没有 process 全局的运行时报错。
  • 已注册键写成 env.X,读不到构建期注入的值,也无法被 tree-shaking。