uni-app
uni-app x
uniCloud
HBuilder
uni 小程序 sdk
uni-app x
uni-app
uni-app x
uniCloud
HBuilder
uni 小程序 sdk
简体中文
全局文件
配置项列表
UNI-APP-X配置
APP配置
DISTRIBUTE配置
Web配置
web router 配置项列表
web devServer 配置项列表
web optimization 配置项列表
web unipush 配置项列表
web sdkConfigs 配置项列表
展示全部

# manifest.json

manifest.json 是 uni-app x 项目的配置文件，用于设置应用的名称、版本、图标等信息。在 HBuilderX 中创建项目时此文件保存在根目录。

uni-app x 默认没有splash启动界面，因uni-app x打包后启动速度非常快，可以自己做一个简单的uvue页面来当做splash。HBuilderX3.99+版本新增支持配置splash启动界面，详情参考启动界面配置。

uni-app x 目前不提供内置模块选择，而是提供了摇树机制自动选择内置模块，详情参考模块配置。

# 配置项列表

属性 类型 默认值 兼容性 描述
appid string -
DCloud AppID 使用说明
name string -
应用名称
description string -
应用描述
versionName string -
应用版本名称
versionCode integer -
应用版本号，必须是整数，取值范围1~2147483647；升级时必须高于上一次设置的值。
locale '' -
默认语言
fallbackLocale '' -
默认回退语言
uni-app-x uni-app-x 配置项列表 -
存在uni-app-x节点则表示为uni-app x项目
app app 配置项列表 -
App平台（原生App）配置
web web 配置项列表 -
Web平台配置
mp-weixin mp-weixin 配置项列表 - - -
__hbuilderx __hbuilderx 配置项列表 -
用于HBuilderX可视化界面相关操作配置

注意

  • appid 由 DCloud 云端分配，主要用于 DCloud 相关的云服务，请勿自行修改。详见
  • uni-app-x 节点必须存在，它是一个项目是否是 uni-app x项目的核心标识。
    • 缺少该节点时，HBuilderX 会把项目识别为 uni-app js引擎版项目（方形项目图标）。
    • 含有该节点时，HBuilderX 会把项目识别为 uni-app x 项目，项目图标是圆形的。

# UNI-APP-X配置

存在uni-app-x节点则表示为uni-app x项目

属性 类型 默认值 兼容性 描述
flex-direction 'row' | 'row-reverse' | 'column' | 'column-reverse' "column" - uvue页面默认flex排列方向

# APP配置

App平台（原生App）配置

属性 类型 默认值 兼容性 描述
defaultAppTheme 'auto' | 'light' | 'dark' "light"
应用默认主题，可取值 light/dark/auto，默认值为 light。应用主题适配参考文档
distribute distribute 配置项列表 - - App平台发布配置
initPrivacyAuthorization 'auto' | 'agree' | 'disagree' "auto"
隐私协议初始状态，可取值 auto/agree/disagree，默认值为 auto。获取应用隐私协议状态相关api参考文档

uni-app 项目可配置原生的隐私弹框。这是因为开发者的js执行较慢，在原生代码获取隐私前来不及弹框，不能满足先弹隐私政策后采集数据的合规要求。

但uni-app x 项目是原生驱动执行的，开发者的代码执行非常快，无需再提供隐私政策弹框配置。自行弹框即可。

但开发者需注意在用户同意隐私政策前，不要采集涉及隐私的数据。如果违反当地法律或应用商店的要求，会无法上架应用商店甚至被处罚。

hello uni-app x中提供了基于dialogPage的隐私政策弹框示例代码，在app.uvue的代码中搜索uni.getPrivacySetting可见，详见

该示例代码在应用启动的onLauch中，判断隐私协议是否已经被同意，未同意的话通过dialogPage弹出一个页面，该页面有隐私协议的内容及同意、取消按钮。 其中同意按钮为button组件的open-type=agreePrivacyAuthorization

# DISTRIBUTE配置

App平台发布配置

属性 类型 默认值 兼容性 描述
syncDebug boolean "false" - 是否为自定义调试基座
icons icons 配置项列表 - - Android、iOS平台应用图标配置。云打包后生效，建议在HBuilderX中 manifest.json 的可视化界面操作，不推荐手动在源码视图中修改。
splashScreens splashScreens 配置项列表 - - Android、iOS平台应用启动界面配置。云端打包后生效，建议在HBuilderX中 manifest.json 的可视化界面操作 参考文档
android android 配置项列表 - - App-Android平台发布配置
ios ios 配置项列表 - - IOS配置
modules modules 配置项列表 - - app内置模块配置
# App端图标配置

Android、iOS平台应用图标配置。云打包后生效，建议在HBuilderX中 manifest.json 的可视化界面操作，不推荐手动在源码视图中修改。

属性 类型 默认值 兼容性 描述
android android 配置项列表 - - Android图标配置
ios ios 配置项列表 - - iOS图标配置

注意

  • App端图片相关配置，建议在HBuilderX中 manifest.json 的可视化界面操作，不推荐手动在源码视图中修改
  • manifest中只能配置一个icon。如需在应用发布后动态修改icon，可在插件市场搜索动态图标插件。
# Android图标配置
属性 类型 默认值 兼容性 描述
hdpi string - - 高分屏设备程序图标，分辨率要求72x72
xhdpi string - - 720P高分屏设备程序图标，分辨率要求96x96
xxhdpi string - - 1080P高分屏设备程序图标，分辨率要求144x144
xxxhdpi string - - 2K屏设备程序图标，分辨率要求192x192

必须使用 png 格式图标

# iOS图标配置
属性 类型 默认值 兼容性 描述
appstore string - - iPhone/iPad设备应用图标，分辨率要求 1024x1024

必须使用 png 格式图标，图片中不能存在透明区域

# App端启动界面配置

Android、iOS平台应用启动界面配置。云端打包后生效，建议在HBuilderX中 manifest.json 的可视化界面操作 参考文档

# Android平台启动界面配置
属性 类型 默认值 兼容性 描述
ldpi string - - 适用于（mdpi）密度屏幕（~120dpi），建议分辨率 240x320。此类设备不常见，通常可以不用配置此项。
mdpi string - - 适用于（mdpi）密度屏幕（~160dpi），建议分辨率 320x480。此类设备不常见，通常可以不用配置此项。
hdpi string - - 适用于（hdpi）密度屏幕（~240dpi），建议分辨率 480x800。此类设备不常见，通常可以不用配置此项。
xhdpi string - - 适用于（xhdpi）密度屏幕（~320dpi），建议分辨率 720x1280
xxhdpi string - - 适用于（xxhdpi）密度屏幕（~480dpi），建议分辨率 1080x1920
xxxhdpi string - - 适用于（xxxhdpi）密度屏幕（~640dpi），建议分辨率 2160x3840
# Android12启动界面配置

适配支持Android12启动界面。无此配置项表示不适配支持Android12启动界面。

属性 类型 默认值 兼容性 描述
background string - - 仅在Android12及以上设备生效，默认值为白色
icon icon 配置项列表 - - Android12启动界面中部Logo图标
brand brand 配置项列表 - - Android12启动界面底部品牌图标
# Android12启动界面Logo图标配置
属性 类型 默认值 兼容性 描述
xhdpi string - - 适用于（xhdpi）密度屏幕（~320dpi），建议分辨率 480x480
xxhdpi string - - 适用于（xxhdpi）密度屏幕（~480dpi），建议分辨率 720x720
xxxhdpi string - - 适用于（xxxhdpi）密度屏幕（~640dpi），建议分辨率 960x960
# Android12启动界面底部品牌图标
属性 类型 默认值 兼容性 描述
xhdpi string - - 适用于（xhdpi）密度屏幕（~320dpi），建议分辨率 400x160
xxhdpi string - - 适用于（xxhdpi）密度屏幕（~480dpi），建议分辨率 600x240
xxxhdpi string - - 适用于（xxxhdpi）密度屏幕（~640dpi），建议分辨率 800x320
# ANDROID配置

App-Android平台发布配置

属性 类型 默认值 兼容性 描述
permissions Array<string> -
额外添加的权限 参考文档
excludePermissions Array<string> -
强制移除的权限 参考文档
minSdkVersion integer 21
应用兼容的最低Android版本（API等级） 参考文档
targetSdkVersion integer 32
应用适配的目标Android版本（API等级），部分应用市场要求设置较高的targetSdkVersion才能提交审核 参考文档
abiFilters Array<'armeabi-v7a' | 'arm64-v8a' | 'x86' | 'x86_64'> ["arm64-v8a"]
应用支持的CPU类型 参考文档
enableResourceOptimizations boolean "true"
是否开启Android原生res资源文件优化，开启后res资源文件名称会被混淆 参考文档
aaptOptions Array<string> -
aaptOptions 配置项 参考文档
buildFeatures Array<string> -
buildFeatures 配置项 参考文档
packagingOptions Array<string> -
packagingOptions 配置项 参考文档
# manifestPlaceholders

manifest.json中不提供配置 manifestPlaceholders 数据，如果应用使用的插件或三方SDK需要使用，可在项目的 nativeResources/android/manifestPlaceholders.json 文件中配置，详情参考Android原生应用清单文件和资源。

# IOS配置
属性 类型 默认值 兼容性 描述
devices 'iphone' | 'ipad' | 'universal' "auto"
iOS支持的设备
CFBundleName string "UniAppX"
应用内部名称（可作为开发者标识），最多可使用15个字符，详情参考
UIRequiresFullScreen boolean "false"
在iPad设备是否全屏显示，设置为false表示应用能够与其他应用共享屏幕显示（分屏显示） 详情参考
# distribute modules 配置项列表

app内置模块配置

属性 类型 默认值 兼容性 描述
uni-ad uni-ad 配置项列表 -
uni-ad广告联盟模块
uni-canvas object -
canvas画布组件模块（HBuilderX4.0+）
uni-cloud-client object -
uniCloud云函数/云对象模块（HBuilderX4.25+）
uni-createRequestPermissionListener object -
监听权限申请模块（HBuilderX4.0+）
uni-createWebviewContext object -
创建web-view 组件的上下文对象模块
uni-facialRecognitionVerify object -
uni实人认证模块
uni-fileSystemManager object -
文件管理模块
uni-location uni-location 配置项列表 -
系统定位模块, HBuilderX 4.61- 之前是uni-getLocation
uni-getNetworkType object -
获取网络类型模块
uni-installApk object -
安装apk模块
uni-payment uni-payment 配置项列表 -
请求支付模块
uni-getProvider object -
获取服务供应商模块
uni-push object -
统一推送模块
uni-media object -
多媒体模块
uni-network object -
网络请求（文件上传/下载）模块
uni-virtualPayment object -
虚拟支付模块
uni-video object -
video视频组件模块
uni-websocket object -
WebSocket模块
uni-verify object -
一键登录模块
# uni-ad 配置项列表

uni-ad广告联盟模块

属性 类型 默认值 兼容性 描述
gdt object - - 腾讯优量汇广告联盟
gm object - - 穿山甲GroMore
ks object - - 快手广告联盟
sgm object - - Sigmob广告联盟
bd object - - 百度百青藤广告联盟
# uni-location 配置项列表
# uni-payment 配置项列表

请求支付模块

属性 类型 默认值 兼容性 描述
alipay object -
支付宝支付
wxpay wxpay 配置项列表 -
微信支付
# uni-payment-wxpay 配置项列表

微信支付

属性 类型 默认值 兼容性 描述
android object - - android平台微信支付配置信息
ios ios 配置项列表 - - ios平台微信支付配置信息
# wxpay ios 配置项列表

ios平台微信支付配置信息

属性 类型 默认值 兼容性 描述
appid string - - 微信开放平台申请的应用ID（AppID）
universalLink string - - 通用链接（Universal Link），配置方式参考：iOS通用链接

# Web配置

Web平台配置

属性 类型 默认值 兼容性 描述
title string - - 默认为应用名称
template string - - 默认为空可定制生成的html代码，参考：https://uniapp.dcloud.net.cn/collocation/manifest.html#h5-template
router router 配置项列表 - - -
devServer devServer 配置项列表 - - -
optimization optimization 配置项列表 - - -
unipush unipush 配置项列表 - - -
sdkConfigs sdkConfigs 配置项列表 - - -
darkmode boolean - - 是否开启暗黑模式

# web router 配置项列表

属性 类型 默认值 兼容性 描述
mode 'hash' | 'history' - - hash history，二选一
base string - - 例：/web/，代表在域名的/web/目录下部署运行。如设为./，则代表相对路径，支持file协议打开，此时路由模式强制为hash模式。

# web devServer 配置项列表

属性 类型 默认值 兼容性 描述
port integer - - 参考：https://uniapp.dcloud.net.cn/collocation/manifest.html#devserver
https boolean - -

# web optimization 配置项列表

属性 类型 默认值 兼容性 描述
treeShaking treeShaking 配置项列表 - - -
# treeShaking 配置项列表
属性 类型 默认值 兼容性 描述
enable boolean - -

# web unipush 配置项列表

属性 类型 默认值 兼容性 描述
enable boolean - -

# web sdkConfigs 配置项列表

属性 类型 默认值 兼容性 描述
maps maps 配置项列表 - -
# 定位和地图（只能选一个）
属性 类型 默认值 兼容性 描述
tencent tencent 配置项列表 - -
google google 配置项列表 - -
amap amap 配置项列表 - - -
# 腾讯地图，旧配置项为qqmap
属性 类型 默认值 兼容性 描述
key string - -
# 谷歌地图
属性 类型 默认值 兼容性 描述
key string - -
# samap 配置项列表
属性 类型 默认值 兼容性 描述
key string - -
securityJsCode string - -
serviceHost string - -

# mp-weixin 配置项列表

属性 类型 默认值 兼容性 描述
appid string - - 微信小程序的AppID，登录 https://mp.weixin.qq.com 申请
setting object - - 微信小程序项目设置，参考 https://uniapp.dcloud.net.cn/collocation/manifest?id=setting
functionalPages boolean - - 微信小程序是否启用插件功能页，默认关闭
requiredBackgroundModes array - - 微信小程序需要在后台使用的能力,详见 https://developers.weixin.qq.com/miniprogram/dev/framework/config.html#requiredbackgroundmodes
plugins object - - 使用到的插件，详见 https://developers.weixin.qq.com/miniprogram/dev/framework/plugin/using.html
resizable boolean - - 在iPad上小程序是否支持屏幕旋转，默认关闭
navigateToMiniProgramAppIdList array - - 需要跳转的小程序列表，详见 https://developers.weixin.qq.com/minigame/dev/reference/configuration/app.html#navigateToMiniProgramAppIdList
permission object - - 微信小程序接口权限相关设置，比如申请位置权限必须填此处详见 https://developers.weixin.qq.com/miniprogram/dev/framework/config.html
workers string - - Worker 代码放置的目录。 详见 https://developers.weixin.qq.com/miniprogram/dev/framework/workers.html
optimization object - - 对微信小程序的优化配置
cloudfunctionRoot string - - 配置云开发目录，参考 https://uniapp.dcloud.net.cn/collocation/manifest?id=cloudfunctionRoot
scopedSlotsCompiler string - - Vue2 作用域插槽编译模式，uni-app 3.1.19+ 开始支持，可选：legacy、auto、augmented，默认：auto
mergeVirtualHostAttributes boolean - - 合并由 Vue 组件编译而成的小程序组件虚拟节点外层属性，目前仅支持 id（v4.42+）、style（v3.5.1+）、class（v3.5.1+）以及 v-show 指令生成的 hidden（v4.41+） 属性
slotMultipleInstance boolean - - 模拟单个作用域插槽渲染为多个实例，此配置仅限 Vue2 环境 3.7.12+，Vue3 环境已默认支持
embeddedAppIdList array - - 要半屏跳转的小程序appid。详见 https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html
requiredPrivateInfos array - - 地理位置相关接口。详见 https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#requiredPrivateInfos
lazyCodeLoading string - - 目前仅支持值 requiredComponents，代表开启小程序按需注入特性，详见 https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#lazyCodeLoading
enableVirtualHost boolean - - 是否为组件启用virtualHost，默认启用
darkmode boolean - - 是否开启暗黑模式

# HBuilderX配置

用于HBuilderX可视化界面相关操作配置

属性 类型 默认值 兼容性 描述
channel_list array -
云端打包时配置的自定义渠道信息

# App其它设置

# 渠道信息

HBuilder4.31版本新增支持

uni-app x 的渠道信息配置，云端需在“App打包”界面配置，详情参考配置渠道包。 离线打包时需在原生工程中配置，详情参考Android平台配置应用渠道包。

# URL Scheme

uni-app x 项目 manifest.json 文件不再提供 url scheme 配置，HBuilderX4.18及以上版本支持在 app 原生应用配置文件中进行设置，详情参考：

注意

  • uni-app x项目标准基座已配置 url scheme 值："uniappx"
  • 配置 url scheme 需提交云端打包才能生效

标准基座可通过此网页体验 Url Scheme 启动 App：https://uniappx.dcloud.net.cn/scheme.html

# Android权限配置

uni-app x 的权限配置，需要在项目下的AndroidManifest.xml中配置。

使用uni内置模块时，云端打包会自动添加模块需要的Android权限，不需要在AndroidManifest.xml中配置。

  • HBuilderX3.97+版本标准基座已经包含了所有Android权限，在 uvue 页面中直接通过 uts 调用需要权限的 Android 系统 API 时，使用标准基座真机运行可直接通过UTSAndroid.requestSystemPermission申请；
  • 使用自定义基座则需要在项目的AndroidManifest.xml中配置要使用的权限，重新提交云端打包。

# iOS隐私信息访问的许可描述

uni-app x 的隐私信息访问的许可描述配置，需要在项目下的Info.plist中配置。

使用uni内置模块时，云端打包回自动添加模块需要的隐私信息访问的许可描述，但许可描述信息是通用描述，不一定适合应用的实际使用场景描述，需根据应用的实际情况在Info.plist中配置准确的许可描述。

uni-app x 项目 manifest.json 文件不再提供 iOS 平台的 通用链接（universal link）相关配置，HBuilderX4.18及以上版本支持在 iOS原生应用配置文件中通过 关联域（Associated Domains） 配置通用链接，详情参考：

注意

  • uni-app x项目标准基座已配置 universal link 值："https://uniappx.dcloud.net.cn/ulink"，但重签名会使得通用链接配置失效，无法通过通用链接启动标准基座
  • 配置 universal link 需提交云端打包才能生效

# 示例

{
  "name" : "uni-app x",
  "appid" : "__UNI__XXXXXXX",
  "description" : "描述信息",
  "versionName" : "1.0.0",
  "versionCode" : "100",
  "uni-app-x":{
    "flex-direction": "column"
  },
  "vueVersion" : "3",
  "app": {
    "distribute": {
      "syncDebug": true,
      "android": {
        "abiFilters": [
          "armeabi-v7a","arm64-v8a"
        ],
        "minSdkVersion": "21",
        "targetSdkVersion": "32"
      },
      "ios": {
        "UIRequiresFullScreen": false
      }
    }
  }
}

# 参见

相关 Bug

本页导读
配置项列表
UNI-APP-X配置
APP配置
DISTRIBUTE配置
Web配置
web router 配置项列表
web devServer 配置项列表
web optimization 配置项列表
web unipush 配置项列表
web sdkConfigs 配置项列表
mp-weixin 配置项列表
HBuilderX配置
App其它设置
渠道信息
URL Scheme
Android权限配置
iOS隐私信息访问的许可描述
iOS通用链接（universal link）
示例
参见