mPaaS 外掛程式通過圖形化介面,協助您快速地接入 mPaaS 並便捷地使用 mPaaS 的功能。
mPaaS 外掛程式的功能主要包括 原生 AAR 方式、組件化接入、基礎工具、協助 和 構建。
原生 AAR 接入、組件化接入 分別提供了接入面板,在接入面板中的接入嚮導會協助您將 mPaaS 以不同的接入方式接入到您的工程中。在完成接入後,您還可以在接入面板進行 基準升級 和 組件管理。
在 基礎工具 中,mPaaS 提供了 產生加密圖片(專有雲設定檔)、 產生 UC Key 簽名資訊 和 產生藍盾圖片 的功能,方便快速完成使用 mPaaS 功能前的資訊準備。
在 協助 中,mPaaS 提供了 日誌診斷工具、常見問題、和 查看文檔 的功能,方便在使用 mPaaS 過程中遇到問題時快速獲得支援。
構建,完成接入 mPaaS 後構建工程。
添加設定檔
接入過程的主要工作是將設定檔添加到工程中,mPaaS 外掛程式支援 手動匯入 的方式添加設定檔。手動匯入需要在控制台下載設定檔後,再通過 mPaaS 外掛程式手動添加到工程裡。
手動匯入
前提條件
已建立了螞蟻或阿里雲帳號並開通了 mPaaS 服務。
已在 mPaaS 控制台建立應用。更多關於建立應用的資訊,請參見 在控制台建立 mPaaS 應用 。
已有一個Android 開發工程。
操作步驟
在 Android Studio 中開啟已有工程,單擊 mPaaS > 原生 AAR 接入 或 組件化接入。在彈出的接入面板中,單擊 匯入 App 配置 下的 開始匯入。
選擇 我已經從控制台上下載設定檔(Ant-mPaaS-xxxx.config),準備匯入到工程,單擊 Next。
選擇設定檔後,單擊 Finish,即完成了設定檔的匯入。匯入成功後,將會收到匯入設定檔成功的提示資訊。
AAR 接入
操作步驟
在 Android Studio 中開啟已有工程,單擊 mPaaS > 原生 AAR 接入。
匯入 App 配置。在接入面板中,單擊 開始匯入,使用 手動匯入 的方式完成設定檔的添加。
後續步驟
組件化接入
操作步驟
在 Android Studio 中開啟已有工程,單擊 mPaaS > 組件化接入。
匯入 App 配置。在接入面板中,單擊 開始匯入,使用 手動匯入 的方式完成設定檔的添加。
轉換工程。如果您的工程是原生 Android 工程,還需要對工程進行轉換。在接入面板中,單擊 安裝 mPaaS Portal。在安裝 mPaaS Portal 視窗中,分別選擇原始工程的位置和設定檔,單擊 OK。
後續步驟
接入/升級基準
升級到常規基準
操作步驟
單擊 mPaaS > 原生 AAR 接入 或 組件化接入,在彈出的接入面板中,單擊接入/升級基準下的 開始配置。
選擇需要升級的基準版本,單擊 OK。 升級成功後,您將看到 基準升級成功 的提示。
後續步驟
單擊接入面板中的升級基準,在選擇基準視窗中將會看到您的基準版本號碼。
升級到自訂基準
通常情況下,我們提供的基準面向所有客戶,如 10.1.32、10.1.60、10.1.68。當您需要定製 mPaaS 的功能時,您可以向和您對接的 mPaaS 的工作人員提出需求,我們會按照您的需求為您定製基準。在交付時,mPaaS 的工作人員會向您提供定製基準的 ID,您只需要在 mPaaS 外掛程式中填寫該 ID,即可獲得此定製基準。
前提條件
確認您的 Android Studio mPaaS 版本為 V2.19111217 或以上。您可以參考 更新 mPaaS 外掛程式 以瞭解當前的 mPaaS 外掛程式版本和如何升級 mPaaS 外掛程式。
操作步驟
刪除您 Android Studio 工程裡已經存在的 mpaas_package.json 檔案。
單擊 mPaaS > 原生 AAR 接入 或 組件化接入,在彈出的接入面板中,單擊接入/升級基準下的 開始配置。
在基準升級對話方塊中勾選 自訂基準 並輸入您得到的定製基準 ID。
單擊 OK,即完成自訂基準的引入。
配置/更新群組件
mPaaS組件管理(AAR)
前提條件
您已完成基準升級。
操作步驟
單擊 mPaaS > 原生 AAR 接入,在彈出的接入面板中,單擊配置/更新群組件下的 開始配置。
在彈出的管理視窗中,單擊 mPaaS 組件管理,選擇要進行管理的 module,勾選要添加的組件,單擊 OK。如果您的工程中有多個 module,您可以在選擇不同的 module 後,分別為其添加組件。
組件添加完成後,單擊 OK。
組件管理
操作步驟
單擊 mPaaS > 組件化接入,在彈出的接入面板中,單擊配置/更新群組件下的 開始配置。
在彈出的組件管理視窗中,單擊按鈕安裝需要的組件。
基礎工具
基礎工具中包含 產生加密圖片(專有雲設定檔)、產生控制台用簽名 APK、產生 UC Key 簽名資訊、產生藍盾圖片 等功能。
產生加密圖片(專有雲設定檔)
為了安全,mPaaS 某些組件訪問網路時需要對內容進行加密。
具有特殊名稱
yw_1222.jpg
的圖片為加解密提供密鑰資訊。mPaaS 組件自動使用該圖片進行加解密,無需額外操作。由於公用雲端環境已棄用該加密圖片,故公用雲端使用者可忽略本節內容。
產生並使用加密圖片 yw_1222.jpg
的詳情如下。
準備
加密圖片與 APK 的簽名檔案有綁定關係。因此,需要準備 Portal 工程簽名之後的 APK。具體的簽名步驟,請參考 Android 官方網站:對應用進行簽名。
此處的 APK 應和 發布版本 的 APK 使用相同的簽名檔案。
產生的加密圖片只能用在該 APK 工程中。
產生
您可以通過 mPaaS 外掛程式 產生加密圖片。
在 Android Studio 中,單擊 mPaaS > 基礎工具 > 產生加密圖片(專有雲設定檔)。
在 Release Apk, 選擇 Portal 工程簽名之後的 APK 檔案, RSA 會自動填滿。
在 mPaaS Config File, 選擇 Portal 工程的
.config
檔案, workSpaceId、appId 和 packageName 會自動填滿。如果沒有,可以根據工程的.config
檔案中的配置填寫到對應輸入框中。填寫 appsecret 。
注意:作為服務端管理員,您可以從控制台中查詢 appid 所對應的 appsecret。
在 jpg Version 欄,填寫對應的無線保鏢圖片版本號碼。
說明查看 Portal 工程主 module 下
build.gradle
檔案中securityguard
版本,低於 5.4 的填 4(例如基準中給出的securityguard-build:5.1.38.180402194514
),其餘填 5 。在 outPath, 選擇無線保鏢圖片
yw_1222.jpg
的輸出路徑,即加密圖片產生的本地路徑。單擊 OK 產生加密圖片。
使用
加密圖片的使用步驟如下:
將加密圖片
yw_1222.jpg
存放到 Portal 工程的res/drawable
檔案夾中。如使用 ProGuard,需避免加密圖片被混淆。
檢查
build.gradle
中是否配置了如下內容:minifyEnabled true shrinkResources true
若有如上配置,為了避免加密圖片被混淆,需要在
res/raw
下建立keep.xml
檔案。檔案內容如下:<?xml version="1.0" encoding="utf-8"?> <resources xmlns:tools="http://schemas.android.com/tools" tools:keep="@drawable/yw_1222*" /><!--tools:discard="@layout/unused2"-->
產生藍盾圖片
如果您從 mPaaS 控制台下載的 .config
檔案中的 absBase64Code
值為空白,則需進行下面 產生藍盾圖片 的操作(適用於私人雲端情境)。
如果您在公用雲端環境下,從 mPaaS 控制台下載的 .config
檔案中的 absBase64Code
值為空白,請確認下載前已上傳簽名正確的 APK 並重新下載。詳情請參考 填寫配置資訊,並上傳簽名 APK。
單擊 mPaaS > 基礎工具 > 產生藍盾加密圖片,輸入相關資訊,即可產生藍盾圖片。
重點輸入項說明:
Release Apk : 接入 mPaaS 的工程打包出的 release apk 包,需要進行簽名。
MD5: release apk 包上傳之後會自動擷取填入,即 apk 包的
public md5 key
。mPaaS config File: mPaaS 控制台點擊下載配置即可下
.config
檔案並傳入。appSecret:mPaaS 控制台查看。
其他項 appId、packageName、outPath 傳入以上資訊後會自動識別填入。
最後將產生的圖片添加到工程的 assets
目錄下。
產生控制台用簽名 APK
在 mPaaS 控制台中擷取設定檔時,需要上傳簽名後的 APK 檔案。但在未建立工程或未編譯出簽名後的 APK 時,擷取設定檔的過程就會受阻而無法進行。為解決此問題,mPaaS 已將此過程簡化為 Android Studio mPaaS 外掛程式的 產生控制台用簽名 APK 功能。該功能可在只需輸入簽名相關的參數的前提下,產生簽名後的 APK。
產生
單擊 mPaaS > 基礎工具 > 產生控制台用簽名 APK,進入 建構簽章 APK 頁面。
在 建構簽章 APK 頁面,填寫相關配置資訊。
單擊 OK 即可產生簽名後的 APK 檔案。
單擊 Reveal in Finder 即可找到上述步驟產生的 APK 檔案,檔案名稱為
mpaas-signed.apk
。至此,簽名後的 APK 產生成功。開啟該 APK 檔案查看,會發現該檔案很小,且已經被簽名。
產生 UC Key 簽名資訊
在 Android 應用中接入 UC SDK 能夠有效解決各種廠商瀏覽器的相容性問題。為添加 UC SDK,您需要先申請 UC SDK 的授權。該功能能夠協助您快速獲得授權,下文介紹了申請 UC SDK 授權的全流程操作。
該功能自 V2.20062211 版本起加入。更多資訊,請參見 V2.20062211 發布說明。
操作步驟
在工程中,添加 UC 核心(UCCORE) 依賴。
提供應用的 Android native package 名稱(package name)。
單擊 mPaaS > 基礎工具 > 產生 UC Key 簽名資訊,進入 查詢簽名資訊 頁面。
在 查詢簽名資訊 頁面,填寫相關配置資訊。單擊 Next。
複製獲得的 SHA1 資訊。
填寫 UC key 申請表 並提交。
說明由於產品策略變更,UC 不再全面開放申請,從2022.12.01起不支援公開申請 UC Key。需要填寫表單相關資訊,工作人員會進行審核並反饋申請結果。
將擷取的 Key 填入 Portal 專案的
AndroidManifest.xml
檔案中:<meta-data android:name="UCSDKAppKey" android:value="您申請獲得的 key"/>
。說明UC SDK 的授權資訊與 APK 的 包名 以及 簽名 綁定。因此,如果 UCWebView 沒有生效,請檢查簽名和包名與申請時使用的資訊是否一致。
協助
日誌診斷工具
單擊 mPaaS > 協助 > 日誌診斷工具。
將您需要分析的日誌資訊 copy 到輸入框,單擊 Next。
等待分析結果。
查看分析結果。 分析結果中包含定位原因和解決方案 的資訊,您可以根據具體的定位資訊和解決方案來修改您的代碼。
修改完成後單擊 Finish 關閉彈窗。
常見問題
單擊 mPaaS > 協助 > 常見問題,即可跳轉至 接入 Android 常見問題,查看接入過程中的常見問題。
查看文檔
單擊 mPaaS > 協助 > 查看文檔,即可跳轉至 mPaaS 文檔中心,查看各組件的使用文檔。
構建
在 Android Studio 中選擇 mPaaS > 構建。即可構造工程。