uniapp 獲取系統資訊的方法小結

uni-app提供了非同步(uni.getSystemInfo)和同步(uni.getSystemInfoSync)的2個API獲取系統資訊。

系統資訊返回的內容非常多，各作業系統、各家小程式、各瀏覽器對它們的定義也不相同。uni-app裡重新梳理了這些概念，同時為了向下相容也保留了這些平臺原來的概念，但不推薦使用。

按照執行環境層級排序，從底層向上，uni-app有6個概念：

• device：執行應用的裝置，如iphone、huawei
• os：裝置的作業系統，如 ios、andriod、windows、mac、linux
• rom：基於作業系統的客製化，Android系統特有概念，如miui、鴻蒙
• host：執行應用的宿主程式，即OS和應用之間的執行環境，如瀏覽器、微信等小程式宿主、整合uniMPSDK的App。uni-app直接開發的app沒有host概念
• uni：uni-app框架相關的資訊，如uni-app框架的編譯器版本、執行時版本
• app：開發者的應用相關的資訊，如應用名稱、版本

一、uni.getSystemInfo(OBJECT)

非同步獲取系統資訊

OBJECT 引數說明：

#success 返回引數說明

#某些小程式特殊的返回引數

#不推薦使用的返回引數，僅為向下相容保留

#uniPlatform 返回值說明

uniCompileVersion編譯器版本 和 uniRuntimeVersion執行時版本，正常情況應該是一樣的值，即uni-app的版本。

如果使用HBuilder自帶的uni-app開發，該值即等同於HBuilder的版本；如果使用單獨的uni-app cli開發，則等同於cli版本。

但在App平臺，uniCompileVersion 和 uniRuntimeVersion 在某些情況的值會不一樣：

• App雲打包選擇了不匹配的打包機版本，比如HBuilder版本較老，雲端已經沒有對應打包機，此時打包後uniCompileVersion會小於uniRuntimeVersion
• App離線打包，使用了不匹配的離線SDK
• App wgt升級，即手機上安裝的App是老版的uniRuntimeVersion，wgt的新版使用了不同版本的HBuilder或uni-app cli版本，並且實施了應用資源升級

#romName 返回值說明

注意：不同rom的版本號規則不同，比如MIUI版本號是V130，而HarmonyOS的版本號是2.0.0

#hostName 返回值說明

#safeArea 返回值說明

safeAreaInsets 的結構

#language 返回值說明

language的國際規範是BCP47規範，分為三段，主語言-次語言-地區。例如zh-Hans-CN，表示 中文-簡體-中國大陸

但除了主語言外，後兩者均可省略。在不同平臺，它們的省略規則也不相同。

• app-ios，不省略，返回zh-Hans-CN
• app-android、web、微信小程式，省略次語言，返回zh-CN
• uni-app框架和應用的多語言，以及支付寶小程式，則用zh-Hans來表示簡體中文

所以獲取語言後，不能直接字串比較，需要拆段比較，npm上也有專門做BCP47語言規範比較的庫。

#deviceId 返回值說明

Web、小程式、iOS，屬於對使用者隱私保護比較嚴格的平臺，在這些平臺很難獲取有效的裝置唯一標記。

Android也已經改進使用者隱私保護。在極老的手機上可以無限制獲取imei，在次老的手機上，獲取imei等隱私資訊時需要彈框讓使用者授權。新的Android手機（Android10以上）已經徹底無法獲取imei了。

所以標記裝置，大多隻能依靠本地儲存一個亂數來標記。

deviceId，在app-android平臺，會根據優先使用imei、mac（僅在使用者已授權的情況下，如果發現需要授權或未授權，則跳過此步驟），如果沒有獲取到就使用隨機生成的標識。其他平臺是直接使用隨機生成的標識。

當使用本地存貯的亂數時，發生以下情況將導致deviceId失效：

• 解除安裝App
• Android上重置App資料
• 瀏覽器清空快取或開啟隱私模式，

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，官方會盡快進行適配。

#其他注意

• deviceType：

  • app-ios 只支援 phone、pad。

  • app-android 支援 phone、pad、tv、car、watch、vr、appliance、undefined、unknown，關於各個型別的更詳細解釋參考Android官方檔案 (opens new window)。

  • 其中，app-android 平臺下 pad 型別的判斷，在國產pad等非google官方裝置上並不一定準確。如果有需要開發者可自行根據型號或螢幕大小判斷。uni-app框架原始碼中判斷pad的java程式碼如下，供參考：

  • public static boolean isTablet(Context context) {
    	return (context.getResources().getConfiguration().screenLayout & Configuration.SCREENLAYOUT_SIZE_MASK) >= Configuration.SCREENLAYOUT_SIZE_LARGE;
    }

     

• osTheme：app-ios 只有將應用主題設定為跟隨系統時才能獲取到系統的主題。小程式也有類似限制。
• 螢幕高度 = 原生NavigationBar高度（含狀態列高度）+ 可使用視窗高度 + 原生TabBar高度
• windowHeight不包含NavigationBar和TabBar的高度
• Web端，windowTop等於NavigationBar高度，windowBottom等於TabBar高度
• App端，windowTop等於透明狀態NavigationBar高度，windowBottom等於透明狀態TabBar高度
• 高度相關資訊，要放在 onReady 裡獲取。太早取不到。

本API在其他小程式的檔案連結：

• 微信小程式(opens new window)
• 支付寶小程式(opens new window)
• 百度小程式(opens new window)
• 位元組小程式(opens new window)
• 飛書小程式(opens new window)
• QQ小程式(opens new window)
• 快手小程式(opens new window)
• 京東小程式(opens new window)
• 華為快應用(opens new window)

#範例

呼叫程式碼範例

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

在不同平臺 getSystemInfo 的返回值（表格較長，可縮放頁面後拖動橫向卷軸）

標明 - 的都為 undefined，其他值都與所列出項相同

二、uni.getSystemInfoSync()

獲取系統資訊的同步介面。呼叫引數和返回值同上getSystemInfo。

三、總結

uni.getSystemInfo()  

(1) deviceType 獲取裝置型別，phone、pad、pc

(2) deviceOrientation 獲取裝置方向，豎屏 portrait、橫屏 landscape

(3) osName 獲取系統名稱，ios、android、windows、macos （APP只有ios、android）