網(wǎng)絡
1. 服務器域名配置
每個微信小程序需要事先設置通訊域名,小程序只可以跟指定的域名與進行網(wǎng)絡通信。包括普通 HTTPS 請求(wx.request)、上傳文件(wx.uploadFile)、下載文件(wx.downloadFile) 和 WebSocket 通信(wx.connectSocket)。
從基礎庫 2.4.0 開始,網(wǎng)絡接口允許與局域網(wǎng) IP 通信,但要注意 不允許與本機 IP 通信。
從 2.7.0 開始,提供了 UDP 通信(wx.createUDPSocket)。
配置流程
服務器域名請在 「小程序后臺-開發(fā)-開發(fā)設置-服務器域名」 中進行配置,配置時需要注意:
- 域名只支持
https(wx.request、wx.uploadFile、wx.downloadFile) 和wss(wx.connectSocket) 協(xié)議; - 域名不能使用 IP 地址(小程序的局域網(wǎng) IP 除外)或 localhost;
- 可以配置端口,如 https://myserver.com:8080,但是配置后只能向 https://myserver.com:8080 發(fā)起請求。如果向 https://myserver.com、https://myserver.com:9091 等 URL 請求則會失敗。
- 如果不配置端口。如 https://myserver.com,那么請求的 URL 中也不能包含端口,甚至是默認的 443 端口也不可以。如果向 https://myserver.com:443 請求則會失敗。
- 域名必須經(jīng)過 ICP 備案;
-
出于安全考慮,
api.weixin.qq.com不能被配置為服務器域名,相關API也不能在小程序內(nèi)調(diào)用。 開發(fā)者應將 AppSecret 保存到后臺服務器中,通過服務器使用getAccessToken接口獲取access_token,并調(diào)用相關 API; - 對于每個接口,分別可以配置最多 20 個域名。
2. 網(wǎng)絡請求
超時時間
- 默認超時時間和最大超時時間都是 60s;
- 超時時間可以在
app.json或game.json中通過networktimeout配置。
使用限制
- 網(wǎng)絡請求的
refererheader 不可設置。其格式固定為https://servicewechat.com/{appid}/{version}/page-frame.html,其中{appid}為小程序的 appid,{version}為小程序的版本號,版本號為0表示為開發(fā)版、體驗版以及審核版本,版本號為devtools表示為開發(fā)者工具,其余為正式版本; - wx.request、wx.uploadFile、wx.downloadFile 的最大并發(fā)限制是 10 個;
- wx.connectSockt 的最大并發(fā)限制是 5 個。
- 小程序進入后臺運行后,如果 5s 內(nèi)網(wǎng)絡請求沒有結束,會回調(diào)錯誤信息
fail interrupted;在回到前臺之前,網(wǎng)絡請求接口調(diào)用都會無法調(diào)用。
返回值編碼
- 建議服務器返回值使用 UTF-8 編碼。對于非 UTF-8 編碼,小程序會嘗試進行轉(zhuǎn)換,但是會有轉(zhuǎn)換失敗的可能。
- 小程序會自動對 BOM 頭進行過濾(只過濾一個BOM頭)。
回調(diào)函數(shù)
- 只要成功接收到服務器返回,無論
statusCode是多少,都會進入success回調(diào)。請開發(fā)者根據(jù)業(yè)務邏輯對返回值進行判斷。
3. 常見問題
HTTPS 證書
小程序必須使用 HTTPS/WSS 發(fā)起網(wǎng)絡請求。請求時系統(tǒng)會對服務器域名使用的 HTTPS 證書進行校驗,如果校驗失敗,則請求不能成功發(fā)起。由于系統(tǒng)限制,不同平臺對于證書要求的嚴格程度不同。為了保證小程序的兼容性,建議開發(fā)者按照最高標準進行證書配置,并使用相關工具檢查現(xiàn)有證書是否符合要求。
對證書要求如下:
- HTTPS 證書必須有效;
- 證書必須被系統(tǒng)信任,即根證書被已系統(tǒng)內(nèi)置
- 部署 SSL 證書的網(wǎng)站域名必須與證書頒發(fā)的域名一致
- 證書必須在有效期內(nèi)
- 證書的信任鏈必需完整(需要服務器配置)
-
iOS不支持自簽名證書; -
iOS下證書必須滿足蘋果 App Transport Security (ATS) 的要求; - TLS 必須支持 1.2 及以上版本。部分舊
Android機型還未支持 TLS 1.2,請確保 HTTPS 服務器的 TLS 版本支持 1.2 及以下版本; - 部分 CA 可能不被操作系統(tǒng)信任,請開發(fā)者在選擇證書時注意小程序和各系統(tǒng)的相關通告。
證書有效性可以使用
openssl s_client -connect example.com:443命令驗證,也可以使用其他在線工具。
除了網(wǎng)絡請求 API 外,小程序中其他 HTTPS 請求如果出現(xiàn)異常,也請按上述流程進行檢查。如 https 的圖片無法加載、音視頻無法播放等。
跳過域名校驗
在微信開發(fā)者工具中,可以臨時開啟 開發(fā)環(huán)境不校驗請求域名、TLS版本及HTTPS證書 選項,跳過服務器域名的校驗。此時,在微信開發(fā)者工具中及手機開啟調(diào)試模式時,不會進行服務器域名的校驗。
在服務器域名配置成功后,建議開發(fā)者關閉此選項進行開發(fā),并在各平臺下進行測試,以確認服務器域名配置正確。
如果手機上出現(xiàn) “打開調(diào)試模式可以發(fā)出請求,關閉調(diào)試模式無法發(fā)出請求” 的現(xiàn)象,請確認是否跳過了域名校驗,并確認服務器域名和證書配置是否正確。