亲宝软件园·资讯

展开

uniapp 获取系统信息的方法小结

moranjl 人气:0

uni-app提供了异步(uni.getSystemInfo)和同步(uni.getSystemInfoSync)的2个API获取系统信息。

系统信息返回的内容非常多,各操作系统、各家小程序、各浏览器对它们的定义也不相同。uni-app里重新梳理了这些概念,同时为了向下兼容也保留了这些平台原来的概念,但不推荐使用。

按照运行环境层级排序,从底层向上,uni-app有6个概念:

一、uni.getSystemInfo(OBJECT)

异步获取系统信息

OBJECT 参数说明:

参数名类型必填说明
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

#success 返回参数说明

参数分类参数说明App平台值域Web平台值域小程序平台值域备注uni框架最低版本要求
devicedeviceId设备 id 。由 uni-app 框架生成并存储,清空 Storage 会导致改变     
 deviceType设备类型。如phonepadpcunknow详见phonepadpcunknowphonepadpc uni-app 3.4.10+
 deviceBrand设备品牌。如:applehuawei 不支持  uni-app 3.4.10+
 deviceModel设备型号 部分设备无法获取  uni-app 3.4.10+
 deviceOrientation设备方向竖屏 portrait横屏 landscape竖屏 portrait横屏 landscape竖屏 portrait横屏 landscape。仅微信百度小程序支持 uni-app 3.4.13+
 devicePixelRatio设备像素比    uni-app 3.4.13+
ososName系统名称ios、androidios、android、windows、macos、linuxios、android、windows、macos uni-app 3.4.10+
 osVersion操作系统版本。如 ios 版本,andriod 版本    uni-app 3.4.10+
 osLanguage操作系统语言详见Android仅支持主语言+地区:zh-CN 中文简体、iOS支持主语言+次语言+地区zh-Hans-CN 中文简体与浏览器语言一致不支持 uni-app 3.4.10+
 osTheme操作系统主题light、dark。iOS平台只有将应用主题设置为跟随系统时才能获取到系统的主题不支持不支持 uni-app 3.4.10+
 osAndroidAPILevelAndroid 系统API库的版本。详情参考Android 官方文档(opens new window)仅 Android 支持不支持不支持 uni-app 3.4.10+
romromNamerom 名称Android 部分机型获取不到值,详见。iOS 不支持不支持不支持 uni-app 3.4.13+
 romVersionrom 版本Android 部分机型获取不到值,详见。iOS 不支持不支持不支持 uni-app 3.4.13+
browserbrowserName浏览器名称或App的webview名称chrome(android)、wkwebview(ios)、x5webview(app打包x5引擎)chrome、edge、safari、firefox不支持 uni-app 3.4.10+
 browserVersion浏览器版本、webview 版本  不支持 uni-app 3.4.10+
hosthostName小程序宿主或uniMPSDK的集成宿主名称,如:WeChatFeiShu仅 UniMPSDK 支持不支持详见微信小程序真机运行才有真值uni-app 3.4.10+
 hostVersion宿主版本。如:微信版本号仅 UniMPSDK 支持不支持小程序宿主版本 uni-app 3.4.10+
 hostLanguage宿主语言仅 UniMPSDK 支持不支持小程序宿主语言 uni-app 3.4.10+
 hostTheme宿主主题lightdark。仅 UniMPSDK 支持不支持lightdark。前提是微信小程序全局配置"darkmode":true时才能获取 uni-app 3.4.10+
 hostFontSizeSetting用户字体大小设置。以“我-设置-通用-字体大小”中的设置为准,单位:px不支持不支持微信小程序、支付宝小程序、百度小程序、QQ小程序、字节小程序(2.53.0+) uni-app 3.4.13+
 hostPackageName小程序宿主包名仅 UniMPSDK 支持不支持不支持 uni-app 3.4.10+
 hostSDKVersionuni小程序SDK版本、小程序客户端基础库版本仅 UniMPSDK 支持不支持  uni-app 3.4.13+
uni-app框架uniPlatformuni-app 运行平台,与条件编译平台相同。详见appwebh5各家小程序,如mp-weixin uni-app 3.4.10+
 uniCompileVersionuni 编译器版本号。详见3.4.103.2.9 等3.4.103.2.9 等3.4.103.2.9 等 uni-app 3.4.10+
 uniRuntimeVersionuni 运行时版本。详见3.4.103.2.9 等3.4.103.2.9 等3.4.103.2.9 等 uni-app 3.4.10+
appappIdmanifest 中应用appid,即DCloud appid。    uni-app 3.4.10+
 appNamemanifest 中应用名称   字节跳动小程序字段冲突,字节跳动小程序原字段与hostName一致uni-app 3.4.10+
 appVersionmanifest 中应用版本名称。    uni-app 3.4.10+
 appVersionCodemanifest 中应用版本名号。    uni-app 3.4.10+
 appWgtVersion应用资源(wgt)的版本名称。    uni-app 3.4.15+
 appLanguage应用设置的语言enzh-Hanszh-Hantfresenzh-Hanszh-Hantfresenzh-Hanszh-Hantfres uni-app 3.4.13+
其他uauserAgent标识  不支持 uni-app 3.4.10+
 screenWidth屏幕宽度     
 screenHeight屏幕高度     
 windowWidth可使用窗口宽度     
 windowHeight可使用窗口高度     
 windowTop可使用窗口的顶部位置     
 windowBottom可使用窗口的底部位置     
 statusBarHeight手机状态栏的高度     
 safeArea在竖屏正方向下的安全区域。由于此属性理解和使用比较困难,更推荐使用 safeAreaInsets 属性。详见  微信、百度(开发者工具暂不支持,真机有效)、字节跳动、飞书、快手小程序、华为快应用  
 safeAreaInsets在竖屏正方向下的安全区域插入位置。与小程序定义的 safeArea 用途相同,但是规范参考 iOS 平台的 safeAreaInsets (opens new window)更利于理解和使用。详见  微信、百度(开发者工具暂不支持,真机有效)、字节跳动、飞书、快手小程序、华为快应用 uni-app 2.5.3+

#某些小程序特殊的返回参数

参数说明平台差异说明
benchmarkLevel设备性能等级。取值为:-2 或 0(该设备无法运行小游戏),-1(性能未知),>=1(设备性能值,该值越高,设备性能越好,目前最高不到50)微信小程序Android版、QQ小程序Android版
batteryLevel剩余电量百分比(仅 iOS 有效)微信小程序
currentBattery当前电量百分比支付宝小程序
navigationBarHeight导航栏的高度百度小程序
titleBarHeight标题栏高度支付宝小程序
albumAuthorized允许微信使用相册的开关(仅 iOS 有效)微信小程序
cameraAuthorized允许微信使用摄像头的开关微信小程序
locationAuthorized允许微信使用定位的开关微信小程序
microphoneAuthorized允许微信使用麦克风的开关微信小程序
notificationAuthorized允许微信通知的开关微信小程序
notificationAlertAuthorized允许微信通知带有提醒的开关(仅 iOS 有效)微信小程序
notificationBadgeAuthorized允许微信通知带有标记的开关(仅 iOS 有效)微信小程序
notificationSoundAuthorized允许微信通知带有声音的开关(仅 iOS 有效)微信小程序
bluetoothEnabled蓝牙的系统开关微信小程序
locationEnabled地理位置的系统开关微信小程序
wifiEnabledWi-Fi 的系统开关微信小程序
cacheLocation上一次缓存的位置信息百度小程序(安卓端最低基础库版本 3.40.4 ;iOS 最低支持版本 3.70.2)
storage设备磁盘容量支付宝小程序

#不推荐使用的返回参数,仅为向下兼容保留

参数说明平台差异说明
pixelRatio设备像素比 
brand设备品牌。uni-app 3.4.10+ 后该字段为全小写,可能要做兼容处理App、微信小程序、百度小程序、字节跳动小程序、飞书小程序、QQ小程序
model设备型号全平台支持。Web 端部分设备无法获取具体型号
system操作系统名称及版本,如Android 10 
language应用设置的语言 
version引擎版本号Web不支持
platform客户端平台,值域为:iosandroidmac(3.1.10+)windows(3.1.10+)linux(3.1.10+) 
host宿主平台百度小程序
SDKVersion客户端基础库版本支付宝小程序和Web不支持
swanNativeVersion宿主平台版本号百度小程序
app当前运行的客户端支付宝小程序
AppPlatformApp平台QQ小程序
fontSizeSetting用户字体大小设置。以“我-设置-通用-字体大小”中的设置为准,单位:px微信小程序、支付宝小程序、百度小程序、QQ小程序、字节小程序(2.53.0+)

#uniPlatform 返回值说明

生效条件
appApp
webWeb
mp-weixin微信小程序
mp-alipay支付宝小程序
mp-baidu百度小程序
mp-toutiao字节跳动小程序
mp-lark飞书小程序
mp-qqQQ小程序
mp-kuaishou快手小程序
mp-jd京东小程序
mp-360360小程序
quickapp-webview快应用通用(包含联盟、华为)
quickapp-webview-union快应用联盟
quickapp-webview-huawei快应用华为

uniCompileVersion编译器版本 和 uniRuntimeVersion运行时版本,正常情况应该是一样的值,即uni-app的版本。

如果使用HBuilder自带的uni-app开发,该值即等同于HBuilder的版本;如果使用单独的uni-app cli开发,则等同于cli版本。

但在App平台,uniCompileVersion 和 uniRuntimeVersion 在某些情况的值会不一样:

#romName 返回值说明

解释
MIUI小米
EMUI华为
HarmonyOS华为鸿蒙
Magic OS荣耀
ColorOSoppo
Funtouch OSvivo
FLymeOS魅族
SmartisanOS锤子

注意:不同rom的版本号规则不同,比如MIUI版本号是V130,而HarmonyOS的版本号是2.0.0

#hostName 返回值说明

解释
WeChat微信
wxwork微信企业版
百度宿主平台枚举值列表(opens new window)百度
alipay支付宝
amap高德
DINGTALK钉钉
UCUC浏览器
QUARK夸克浏览器
AK阿里健康
YK优酷
字节宿主平台枚举值列表(opens new window)字节跳动系列
qqQQ
KUAISHOU快手

#safeArea 返回值说明

参数类型说明
leftNumber安全区域左上角横坐标
rightNumber安全区域右下角横坐标
topNumber安全区域左上角纵坐标
bottomNumber安全区域右下角纵坐标
widthNumber安全区域的宽度,单位逻辑像素
heightNumber安全区域的高度,单位逻辑像素

safeAreaInsets 的结构

参数类型说明
leftNumber安全区域左侧插入位置
rightNumber安全区域右侧插入位置
topNumber安全区顶部插入位置
bottomNumber安全区域底部插入位置

#language 返回值说明

language的国际规范是BCP47规范,分为三段,主语言-次语言-地区。例如zh-Hans-CN,表示 中文-简体-中国大陆

但除了主语言外,后两者均可省略。在不同平台,它们的省略规则也不相同。

所以获取语言后,不能直接字符串比较,需要拆段比较,npm上也有专门做BCP47语言规范比较的库。

#deviceId 返回值说明

Web、小程序、iOS,属于对用户隐私保护比较严格的平台,在这些平台很难获取有效的设备唯一标记。

Android也已经改进用户隐私保护。在极老的手机上可以无限制获取imei,在次老的手机上,获取imei等隐私信息时需要弹框让用户授权。新的Android手机(Android10以上)已经彻底无法获取imei了。

所以标记设备,大多只能依靠本地存储一个随机数来标记。

deviceId,在app-android平台,会根据优先使用imei、mac(仅在用户已授权的情况下,如果发现需要授权或未授权,则跳过此步骤),如果没有获取到就使用随机生成的标识。其他平台是直接使用随机生成的标识。

当使用本地存贮的随机数时,发生以下情况将导致deviceId失效:

app下需要广告追踪的场景,在iOS上可以使用idfa (opens new window)、部分国产Android手机可以使用OAID(opens new window)

#deviceModel 返回值说明

uni-app 3.5.1+ 版本规范了 deviceModel 返回值,例如之前返回 iPhone11ProMax 新版本返回值为 iPhone 11 Pro Max,各设备型号参考规范 (opens new window)中 Generation 对应的值

注意:新机型刚推出一段时间会显示 Unknown,官方会尽快进行适配。

#其他注意

本API在其他小程序的文档链接:

#示例

调用代码示例

uni.getSystemInfo({
	success: function (res) {
		console.log(res.appName)
	}
});

在不同平台 getSystemInfo 的返回值(表格较长,可缩放页面后拖动横向滚动条)

标明 - 的都为 undefined,其他值都与所列出项相同

字段名称App-AndroidApp-iOSh5Android uniMPsdkiOS uniMPsdkmp-weixinmp-alipaymp-baidump-toutiao
appId__UNI__8BB4001__UNI__8BB4001__UNI__8BB4001__UNI__8BB4001__UNI__8BB4001__UNI__8BB4001__UNI__8BB4001__UNI__8BB4001__UNI__8BB4001
appNametesttesttesttesttesttesttesttesttest
appVersion1.0.01.0.01.0.01.0.01.0.01.0.01.0.01.0.01.0.0
appVersionCode100100100100100100100100100
appLanguagezh-Hanszh-Hanszh-Hanszh-Hanszh-Hanszh-Hanszh-Hanszh-Hanszh-Hans
browserNamechromewkwebviewsafarichromewkwebview----
browserVersion96.0.4664.10413.4.1313.0.388.0.4324.9315.4----
deviceIdd3db0944da20f333F791564F-853B-47B6-8CB8-27FF5931505916518284854447835016c7eafa7ed8774c0dF791564F-853B-47B6-8CB8-27FF59315059165217828572038477316536215804846585135165335963981121358216538995501084056633
deviceBrandxiaomiapple-huaweiappleiphoneiphoneiphoneapple
deviceModelMi10ProiPhone13ProMaxiPhoneMXW-AN00iPhoneSimulatoriPhone6/7/8PlusiPhone14,3iPhone6/7/8iPhone6
deviceTypephonephonephonephonephonephonephonephonephone
deviceOrientationportraitportraitportraitportraitportraitportrait-portrait-
devicePixelRatio2.568750143051147532333322
hostName--safariMPLauncherV3uniMPDemoWeChat、wxworkalipay、amap、DINGTALK、UC、QUARK、AK、YKbaiduboxapp 等百度宿主平台枚举值列表(opens new window)Douyin、Toutiao、news_article_lite、live_stream、XiGua、PPX
hostVersion--13.0.31.01.0.08.0.510.2.232.45.06.6.3
hostLanguage--zh-CNzh-CNzh-Hans-CNzh-CNzh-CNzh-CN 
hostTheme---lightlight----
hostPackageName---com.example.mplauncherv3io.dcloud.hellounimp----
hostSDKVersion---3.4.133.4.132.24.22.7.63.450.162.49.0
osNameandroidiosiosandroidiosiosiosiosios
osVersion1215.513.2.31015.410.0.115.515.510.0.1
osLanguagezh-CNzh-Hans-CN-zh-CNzh-Hans-CN----
osThemelightlight-lightlight----
osAndroidAPILevel31--29-----
romNameMIUI--HarmonyOS-----
romVersionV130--2.0.0-----
uniPlatformappappwebappappmp-weixinmp-alipaymp-baidump-toutiao
uniCompileVersion3.4.133.4.133.4.133.4.133.4.133.4.133.4.133.4.133.4.13
uniRuntimeVersion3.4.133.4.133.4.133.4.133.4.133.4.133.4.133.4.133.4.13

二、uni.getSystemInfoSync()

获取系统信息的同步接口。调用参数和返回值同上getSystemInfo

三、总结

uni.getSystemInfo()  

(1) deviceType 获取设备类型,phone、pad、pc

(2) deviceOrientation 获取设备方向,竖屏 portrait横屏 landscape

(3) osName 获取系统名称,ios、android、windows、macos (APP只有ios、android)

加载全部内容

相关教程
猜你喜欢
用户评论