微信開放給第三方的 iOS SDK,整體結構其實不複雜,一共 19 個類別,可以切成三大區塊來理解:請求與回應、介面函數與協議、多媒體資料物件。把這三塊分清楚,接入時就不容易迷路。
一、請求與回應類別
這組類別負責描述「誰對誰說了什麼」,涵蓋微信終端與第三方程式之間、以及第三方程式與微信伺服器之間的雙向溝通。
請求(以 Req 結尾)
- BaseReq:所有請求類別的基底類別。
- GetMessageFromWXReq:微信終端向第三方程式索取內容的請求類型。
- LaunchFromWWXReq:微信終端打開第三方程式時送出的請求類型。
- SendMessageToWXReq:第三方程式把訊息傳給微信終端的介面。
- ShowMessageFromWXReq:要求第三方程式顯示的訊息結構。
回應(以 Resp 結尾)
- BaseResp:所有回應類別的基底類別。
- GetMessageFromWXResp:第三方回覆給微信終端的處理結果。
- SendMessageToWXResp:微信處理完第三方請求後的回覆結果。
- ShowMessageFromWXResp:第三方程式處理完顯示請求後的回覆。
二、介面函數與協議
- WXApi:微信 API 的對外函數類別,註冊、發送請求、處理回呼都从这里進入。
- <WXApiDelegate>:接收並處理來自微信終端的事件訊息,通常在 AppDelegate 中實作。
三、多媒體訊息的資料物件
這一組都是承載多媒體內容的容器,搭配 WXMediaMessage 使用:
- WXMediaMessage:多媒體訊息的整體結構,包含標題、描述、縮圖與媒體物件。
- WXImageObject:圖片資料。
- WXMusicObject:音樂資料。
- WXVideoObject:影片資料。
- WXWebpageObject:網頁資料。
- WXFileObject:檔案資料。
- WXEmotionObject:表情資料。
- WXAppExtendObject:承載 App 專屬的延伸資料,可用來在自家 App 之間傳遞資訊。
接入時的順序建議
實際開發時,先在 AppDelegate 的 application:openURL:sourceApplication:annotation: 中把 URL 轉交給 WXApi handleOpenURL:delegate:,再於回呼方法中依 BaseResp 的 errCode 判斷結果。發送內容時,記得 WXMediaMessage 有 10KB 左右的資料大小限制,圖片與縮圖都需要事先壓縮,否則會在 sendReq: 階段直接失敗。
由於 SDK 版本迭代較快,實際接入前建議以微信官方開放平台的最新文件為準,此處僅作為整體結構的導覽。