mPaaS プラグインは、グラフィカルインターフェイスを提供し、Android プロジェクトへの mPaaS の迅速な統合と各種機能の利用を支援します。
mPaaS プラグインには、ネイティブ AAR インテグレーション、コンポーネントベースのインテグレーション、基本ツール、ヘルプ、ビルド などの機能が含まれています。
ネイティブ AAR インテグレーション と コンポーネントベースのインテグレーション:プロジェクトに mPaaS を追加するためのステップバイステップ形式のパネルです。統合後、同じパネルからベースラインのアップグレードやコンポーネントの管理を行うことができます。
基本ツール:ホットパッチ、暗号化画像の生成 (Apsara Stack 設定ファイル)、UC Key 署名情報の生成、ブルーシールド暗号化画像の生成 が含まれます。これらのツールを使用して、mPaaS 機能に必要なアセットを準備します。
基本ツール には、コンソール用署名付き APK の生成 も含まれます。これを使用して、完全なプロジェクトビルドが利用可能になる前に、署名パラメータから最小限の署名付き APK を生成します。
ヘルプ:ログ診断ツール、よくある質問、ドキュメントの表示 が含まれます。問題が発生した際に、これらのツールを使用してサポートを受けることができます。
ビルド:統合後にプロジェクトをビルドします。
設定ファイルの追加
設定ファイルの追加は、主要な統合タスクです。mPaaS プラグインは 手動インポート をサポートしています。コンソールから設定ファイルをダウンロードし、プラグインを通じてプロジェクトにインポートします。
手動インポート
前提条件
作業を開始する前に、次の条件を満たしていることを確認してください。
Ant Group または Alibaba Cloud アカウントで、mPaaS サービスが有効化されていること
mPaaS コンソールでアプリケーションが作成されていること。詳細については、「コンソールでの mPaaS アプリケーションの作成」をご参照ください
Android Studio で Android プロジェクトが開かれていること
手順
Android Studio でプロジェクトを開き、[mPaaS] > [ネイティブ AAR インテグレーション] または [コンポーネントベースのインテグレーション] を選択します。統合パネルで、[Import App Config] の下にある [Start import] をクリックします。
[I have downloaded the configuration file (Ant-mPaaS-xxxx.config) from the console and am ready to import it into the project] を選択し、[Next] をクリックします。
設定ファイルを選択し、[Finish] をクリックします。インポートが完了すると、成功メッセージが表示されます。
ネイティブ AAR インテグレーション
手順
Android Studio でプロジェクトを開き、[mPaaS] > [ネイティブ AAR インテグレーション] を選択します。
アプリケーション設定をインポートします。統合パネルで [Start import] をクリックし、手動インポート の方法を使用して設定ファイルを追加します。
次のステップ
コンポーネントベースのインテグレーション
手順
Android Studio でプロジェクトを開き、[mPaaS] > [コンポーネントベースのインテグレーション] を選択します。
アプリケーション設定をインポートします。統合パネルで [Start import] をクリックし、手動インポート の方法を使用して設定ファイルを追加します。
プロジェクトを変換します。プロジェクトがネイティブ Android プロジェクトの場合、統合パネルで [Install mPaaS Portal] をクリックします。[Install mPaaS Portal] ウィンドウで、元のプロジェクトの場所と設定ファイルを選択し、[OK] をクリックします。
次のステップ
ベースラインの統合/アップグレード
通常のベースラインへのアップグレード
手順
[mPaaS] > [ネイティブ AAR インテグレーション] または [コンポーネントベースのインテグレーション] を選択します。統合パネルで、[Integrate/Upgrade baseline] の下にある [Start configuration] をクリックします。
対象のベースラインバージョンを選択し、[OK] をクリックします。アップグレードが成功すると、成功メッセージが表示されます。
次のステップ
統合パネルで [Upgrade baseline] をクリックし、新しいベースラインのバージョン番号を確認します。
カスタムベースラインへのアップグレード
標準ベースライン (10.1.32、10.1.60、10.1.68 など) は、すべてのお客様で共有されています。mPaaS 機能をカスタマイズするには、mPaaS の担当者に要件を提出してください。mPaaS チームがカスタムベースラインを作成し、カスタムベースライン ID を提供します。このプラグインでこの ID を入力して、カスタムベースラインを取得します。
前提条件
Android Studio mPaaS プラグインのバージョンが V2.19111217 以降である必要があります。現在のバージョンを確認してプラグインをアップグレードする方法については、「mPaaS プラグインの更新」をご参照ください。
手順
Android Studio プロジェクトから
mpaas_package.jsonファイルを削除します。[mPaaS] > [ネイティブ AAR インテグレーション] または [コンポーネントベースのインテグレーション] を選択します。統合パネルで、[Integrate/Upgrade baseline] の下にある [Start configuration] をクリックします。
[Baseline Upgrade] ダイアログボックスで、[Custom baseline] チェックボックスを選択し、受け取ったカスタムベースライン ID を入力します。
[OK] をクリックして、カスタムベースラインをインポートします。
コンポーネントの設定/更新
mPaaS コンポーネント管理 (AAR)
前提条件
ベースラインのアップグレードが完了していること。
手順
[mPaaS] > [ネイティブ AAR インテグレーション] を選択します。統合パネルで、[Configure/Update components] の下にある [Start configuration] をクリックします。
管理ウィンドウで、[mPaaS Component Management] をクリックします。管理するモジュールを選択し、追加するコンポーネントを選択して、[OK] をクリックします。プロジェクトに複数のモジュールがある場合は、各モジュールを個別に設定してください。
コンポーネントを追加した後、[OK] をクリックします。
コンポーネント管理
手順
[mPaaS] > [コンポーネントベースのインテグレーション] を選択します。統合パネルで、[Configure/Update components] の下にある [Start configuration] をクリックします。
[Component Management] ウィンドウで、ボタンをクリックして必要なコンポーネントをインストールします。
基本ツール
[基本ツール] メニューには、[ホットパッチ]、[暗号化画像の生成 (Apsara Stack 設定ファイル)]、[コンソール用署名付き APK の生成]、[UC Key 署名情報の生成]、[ブルーシールド暗号化画像の生成] が含まれています。
ホットパッチ
この機能を使用する前に、アプリでホットパッチを有効にしてください。セットアップ手順については、「ホットパッチ管理: Android 統合—ホットパッチ」をご参照ください。
ホットパッチの生成
[ホットパッチの生成] 機能を使用して、ホットパッチパッケージをビルドします。手順は、統合方法によって異なります。
-
統合方法に基づいて、パッケージの入力を選択します。
-
ネイティブ AAR プロジェクトの場合、バグを含むオンライン
APKパッケージと修正済みのAPKパッケージを提供してください。プラグインは、両者のコードの差分からホットパッチ パッケージを生成します。注:
[新しいバンドル] フィールドに、修正済みの
APKパッケージのローカルパスを入力します。[古いバンドル] フィールドに、バグのある
APKパッケージのローカルパスを入力します。[Whitelist] フィールドに、ホワイトリストを入力します。
-
コンポーネントベース (Portal & Bundle) プロジェクト の場合、現在使用中の、バグを含むバンドルパッケージ と 修正済みのバンドルパッケージ を指定します。
注:
バンドルの出力パスは、メインモジュールのディレクトリ内の
build/intermediates/bundle/xxxx-raw.jarです。リリースパッケージの場合、パスには-rawは含まれません。[New bundle]:バグ修正を含むパッケージのパスを選択します。
[Old bundle]:バグを含むパッケージのパスを選択します。
ホワイトリスト:修正するクラスを指定する
.txt設定ファイルを選択します。 ファイル形式のルールについては、「ホワイトリスト設定ファイルのルール」をご参照ください。 このオプションは、ネイティブ AAR プロジェクトでは強く推奨されます。[Patch file dir]:パッチパッケージの出力パス。
-
[Use dexPatch]:dexPatch ホットパッチ方式を使用するかどうかを選択します。プラグインは、Andfix と dexPatch の両方をサポートしています。バージョンをリリースする前に、ホットパッチパッケージが有効であることを確認してください。
未選択:Andfix ホットパッチパッケージを生成します。アプリを再起動せずに即座に有効になります。Andfix は、デバイスモデルの互換性の問題から、修正できるシナリオに多くの制限があります。
選択:dexPatch ホットパッチパッケージを生成します。有効にするにはプロセスを終了する必要があります。dexPatch は、Andfix よりも多くの修正シナリオに対応しており、デバイスの互換性の問題が少なくなります。
-
-
署名情報を入力して、ホットパッチパッケージを生成します。
重要ホットパッチパッケージの生成に使用する署名ファイルは、実行中の
APKおよびイメージ生成用に選択されたAPKの署名ファイルと一致する必要があります。生成されたイメージを Portal プロジェクトのres/drawableフォルダーに配置し、yw_1222.jpgという名前にします。
ホワイトリスト設定ファイルのルール
ホワイトリスト設定ファイル (.txt 形式) は、ホットパッチパッケージをビルドする際にパッチを適用するクラスを指定します。 以下のフィールドを順番に含めてください:
パッチを適用するクラスは、
Lで始まり、その後に難読化されたクラス名が続く形式で、1 行に 1 つずつ記述します。 例:Lxxx.xxx.clazzX。パッチタイプを dexpatch に設定します。たとえば、
PatchType: dexpatchです。静的バンドルにするかどうかを設定します。デフォルト値は
trueです。例:HostDex: true。Android 11 に対応します。たとえば、
android-phone-mobilesdk-quinox-Configs: ForceEnableQSecondDex-trueのようになります。ここで、android-phone-mobilesdk-quinoxはバンドル名です。コンポーネントベースの Portal & Bundle プロジェクトの場合、これを実際のバンドル名に置き換えます。AAR 統合 (バンドルプロジェクトがない場合) では、android-phone-mobilesdk-quinoxをそのまま使用します。
パッチのマージ
特定のアプリケーションバージョンでは、一度に 1 つのホットパッチパッケージのみを実行できます。クライアントバージョンに 2 つのバグがある場合、[パッチのマージ] を使用して、2 つのホットパッチパッケージを 1 つに結合してからリリースします。
例:特定のバージョンに対してホットパッチパッケージ A をすでにリリースしており、その後別のバグが見つかった場合、ローカルでホットパッチパッケージ B を生成し、A と B をマージしてから、マージされたパッケージをリリースします。
このセクションは、コンポーネントベース (Portal & Bundle) プロジェクトにのみ適用されます。ネイティブ AAR プロジェクトの場合は、元の未修正パッケージをベースに、修正を含む新しいパッチを作成してください。
手順
-
ホットパッチパッケージのパスを設定します。
マージディレクトリ: マージするすべてのホットパッチパッケージを含むディレクトリを選択します。パッケージ名は
.jarまたは.apkで終わる必要があります。[Patch file dir]:マージされたパッケージの出力ディレクトリを選択します。
署名情報を設定します。
マージが完了すると、成功メッセージが表示されます。
暗号化画像の生成 (Apsara Stack 設定ファイル)
セキュリティ上の理由から、一部の mPaaS コンポーネントは、ネットワークにアクセスする際にコンテンツを暗号化する必要があります。
yw_1222.jpgという特別な名前の画像が、暗号化と復号化のキーを提供します。 mPaaS コンポーネントは、この画像を暗号化と復号化に自動的に使用するため、追加の操作は必要ありません。この暗号化画像は、パブリッククラウド環境では非推奨です。パブリッククラウドユーザーは、このセクションをスキップできます。
前提条件
暗号化画像は APK 署名に紐付けられています。続行する前に、Portal プロジェクト用の署名付き APK を準備してください。署名手順については、Android 開発者サイトの「アプリへの署名」をご参照ください。
APK は、公開バージョンの APK と同じ署名ファイルを使用する必要があります。
生成された暗号化画像は、その APK プロジェクトでのみ機能します。
手順
mPaaS プラグインを使用して暗号化画像を生成します。
Android Studio で、[mPaaS] > [基本ツール] > [暗号化画像の生成 (Apsara Stack 設定ファイル)] を選択します。
[Release Apk] フィールドで、Portal プロジェクトの署名付き APK ファイルを選択します。[RSA] フィールドは自動的に入力されます。
[mPaaS 設定ファイル] フィールドで、Portal プロジェクトの
.configファイルを選択します。 workSpaceId、appId、および packageName フィールドは自動的に入力されます。 入力されない場合は、プロジェクトの.configファイルから入力します。-
appsecretを入力します。注: サーバー側の管理者として、コンソールで
appidに対応するappsecretを照会してください。 -
[jpg Version] フィールドに、Security Guard 画像のバージョン番号を入力します。
説明Portal プロジェクトのメインモジュールの
build.gradleファイルでsecurityguardのバージョンを確認します。バージョンが 5.4 未満の場合は、4 を入力します。たとえば、ベースラインでsecurityguard-build:5.1.38.180402194514が提供されている場合は、4 を入力します。それ以外の場合は、5 を入力します。 [outPath] フィールドで、
yw_1222.jpgのローカルの出力パスを選択します。[OK] をクリックして、暗号化画像を生成します。
使用方法
yw_1222.jpgを Portal プロジェクトのres/drawableフォルダーに保存します。-
ProGuard を使用する場合、暗号化画像が難読化されないようにしてください。
-
build.gradleに、以下が設定されているか確認します。minifyEnabled true shrinkResources true -
この設定が存在する場合、暗号化された画像を難読化から除外するには、
keep.xmlファイルをres/rawディレクトリに作成します:<?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 の値が空の場合は、[ブルーシールドイメージの生成] 操作を実行してください。これは Apsara Stack のシナリオに適用されます。
パブリッククラウド環境で absBase64Code の値が空の場合は、まず正しく署名された APK をアップロードしてから、.config ファイルを再度ダウンロードします。 詳細については、「設定情報を入力して署名済み APK をアップロードする」をご参照ください。
[mPaaS] > [基本ツール] > [ブルーシールド暗号化画像の生成] を選択し、必要な情報を入力して画像を生成します。
主なパラメータ:
[Release Apk]:mPaaS が統合されたプロジェクトの署名付きリリース APK。
MD5: リリース APK をアップロードすると、自動的に入力されます。これは APK パッケージの
public md5 keyです。mPaaS 設定ファイル: mPaaS コンソールで[設定のダウンロード]をクリックしてダウンロードした
.configファイルを、ここで指定します。[appSecret]:この値は mPaaS コンソールで確認してください。
appId、packageName、outPathは、上記の情報を入力すると、自動的に検出され入力されます。
生成された画像をプロジェクトの assets ディレクトリに追加します。
コンソール用署名付き APK の生成
mPaaS コンソールから設定ファイルを取得する際、署名付き APK をアップロードする必要があります。まだプロジェクトを作成していない、または署名付き APK をコンパイルしていない場合、この要件のために作業を進めることができません。[コンソール用署名付き APK の生成] 機能は、署名関連のパラメータのみを使用して署名付き APK を生成することで、この問題を解決します。
生成
[mPaaS] > [基本ツール] > [コンソール用署名付き APK の生成] を選択して、[Construct Signed APK] ページを開きます。
必要な設定情報を入力します。
[OK] をクリックして、署名付き APK ファイルを生成します。
-
[Finder で表示] をクリックして、生成されたファイル
mpaas-signed.apkを特定します。この APK ファイルは小さく、すでに署名されています。
UC Key 署名情報の生成
UC SDK の統合により、さまざまなベンダーのブラウザとの互換性の問題が解決されます。UC SDK を追加する前に、UC SDK の承認を申請してください。この機能は、承認を迅速に取得するのに役立ちます。以下のセクションでは、UC SDK 承認を申請するためのエンドツーエンドの手順について説明します。
この機能は V2.20062211 以降で利用可能です。詳細については、「V2.20062211 リリースノート」をご参照ください。
手順
プロジェクトに UC Kernel (UCCORE) 依存関係を追加します。
アプリケーションの Android ネイティブパッケージ名を提供します。
[mPaaS] > [基本ツール] > [UC Key 署名情報の生成] を選択して、[Query Signature Information] ページを開きます。
必要な設定情報を入力し、[Next] をクリックします。
取得した SHA1 情報をコピーします。
-
UC キー申請フォーム に記入して送信します。
説明製品戦略の変更により、UC は公開申請を受け付けなくなりました。2022 年 12 月 1 日以降、UC Keys の公開申請はサポートされていません。関連情報をフォームに記入してください。mPaaS チームが申請内容を確認し、フィードバックを返します。
-
取得したキーを Portal プロジェクトの
AndroidManifest.xmlファイルに追加します:<meta-data android:name="UCSDKAppKey" android:value="申請したキー"/>。説明UC SDK 承認は、APK の パッケージ名 と 署名 に紐付けられています。UCWebView が動作しない場合、署名とパッケージ名が申請時に使用したものと一致していることを確認してください。
ヘルプ
ログ診断ツール
[mPaaS] > [ヘルプ] > [ログ診断ツール] を選択します。
ログの内容を入力ボックスに貼り付けて、[Next] をクリックします。
分析が完了するまで待ちます。
結果を確認します。各結果には 原因 と 解決策 が含まれています。提供された具体的な情報に基づいてコードを更新してください。
変更を行った後、[Finish] をクリックしてウィンドウを閉じます。
よくある質問
[mPaaS] > [ヘルプ] > [よくある質問] を選択して、「Android 統合のよくある質問」を開きます。ここには、統合中に発生する一般的な問題が記載されています。
ドキュメントの表示
[mPaaS] > [ヘルプ] > [ドキュメントの表示] を選択して、「mPaaS ドキュメントセンター」を開き、各コンポーネントのドキュメントを参照します。
ビルド
Android Studio で、[mPaaS] > [ビルド] を選択して、プロジェクトをビルドします。