How to Use AAR Files in Capacitor Plugins

Androidの機能をウェブアプリに組み込みたい場合はどうしたらいいですか? Capacitor app? このガイドでは、Capacitorプラグインで使用するAndroidアーカイブ(AAR)ファイルについて説明します。 Capacitor プラグイン Androidのネイティブ機能とクロスプラットフォームのWebアプリを組み合わせるために使用します。

重要なポイント:

• AARファイルとは? Pre-packaged Android libraries containing code, resources, and native files.
• なぜ使用する? AARファイルはcodeの再利用、メンテナンスの簡素化、秘密の機能の保護を可能にします。
• どのようなものが必要? Android Studioなどのツール __CAPGO_KEEP_0__, Gradle, and Node.js, plus proper project setup.
• How to integrate? AARファイルを置く場所 libsGradleを設定し、Capacitor プラグインに接続する

Quick Steps:

1. 環境を設定する: 必要なツールをインストールし、Android Studioを設定する
2. プロジェクトを整理する: プロジェクトの構造を明確にする Capacitor プラグイン.
3. AARファイルを追加する: を置く: android/libs Gradle依存関係を更新する。
4. プラグインcodeを書く: __CAPGO_KEEP_0__の__CAPGO_KEEP_1__を使用して、AAR機能をJavaScriptとリンクする。 Capacitor’s API.
5. Android Studioのデバッガーを使用して、Smoothな統合を確認する。 このガイドを参考にすると、AARファイルを__CAPGO_KEEP_0__プラグインに組み込むことができます。 これにより、WebアプリケーションにネイティブのAndroid機能を使用できます。

Androidライブラリ(AARファイル)をCapacitorに埋め込む方法

AARファイル capacitor プラグイン

開発環境の設定要件

AARファイルを使用する前に、開発環境を適切に設定して、障害を避けるようにしてください。

必要なソフトウェア

ここでは、Capacitor プラグインでAARファイルを使用するために必要なソフトウェアを紹介します。

さらに、次のコンポーネントが SDK マネージャーに含まれていることを確認してください。

• Android SDK プラットフォーム 33 (Android 13.0)
• Android SDK ビルドツール 33.0.0
• Android SDK コマンドラインツール
• Android エミュレータ
• Android SDK プラットフォームツール

プロジェクト設定の手順

1. 開発環境の初期化

最初に、次の構造を持つ新しいディレクトリを作成してください。

my-plugin/
├── android/
│   ├── src/
│   └── build.gradle
├── src/
│   └── definitions.ts
└── package.json

2. Android Studioの設定を構成する

Android Studioを起動し、次の設定を調整する

• Gradle JDKをバージョン11以上に設定してください。
• Android SDKコンポーネントの自動ダウンロード機能を有効にします。
• システム環境変数を正しいAndroid SDKパスで更新してください。

3. プラグイン構造を準備してください。

AARファイルのサポートを含む設定を含むファイルを更新してください。 android/build.gradle バージョン管理を設定してください。

android {
    compileSdkVersion 33
    defaultConfig {
        minSdkVersion 22
        targetSdkVersion 33
    }

    repositories {
        flatDir {
            dirs 'libs'
        }
    }
}

4. プロジェクトディレクトリでGitを初期化し、不要なファイルを除外するためのファイルを作成してください。

ここに示すサンプルを参考にしてください。 .gitignore これらの手順が完了したら、AARファイルを追加する準備が整います。 .gitignore:

android/build/
node_modules/
dist/
*.iml
.idea/
.gradle/
local.properties

プラグインにAARファイルを追加してください。

AARファイルを取得してください。

AARファイルの追加

AARファイルは、第三のパーティーSDK、カスタムライブラリ、またはMaven依存関係から来ることができます。 そのソース、バージョン、目的をドキュメントすることは、良いアイデアです。 README AARファイルのソースは、以下のディレクトリに保存されます。 libs ソースタイプ

AARファイルが用意でき、ドキュメントが完了したら、プラグインを設定してAARファイルを含めることができます。

プラグインファイルの設定

プラグインファイルを整理して、AAR依存関係の平滑な統合を確保しましょう。以下の例では、プラグイン構造の例を示します。

my-plugin/
├── android/
│   ├── libs/        # AAR files with README
│   ├── src/
│   └── build.gradle
├── src/
│   └── definitions.ts
└── package.json
{
    "files": [
        "android/libs/*.aar",
        "android/src/**/*",
        "src/**/*"
    ]
}

AARファイルの配置

AAR機能を有効にするには、以下の手順に従ってプラグインのディレクトリにファイルを配置してください。 android/libs 明確で一貫した命名形式を使用しましょう。例えば

• バージョン管理を行う libraryname-version.aar.
• ファイルを作成します。例えば versions.properties バージョン管理ファイル

library1=1.2.3
library2=2.0.0

• 依頼する dependencies.gradle 他の依存関係の

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.aar'])
    implementation 'com.example:dependency:1.0.0'
}

• ファイルを追加する:

android/libs/
├── vendor1/
│   ├── feature.aar
│   └── config.json
└── vendor2/
    ├── module.aar
    └── settings.xml

ベンダー固有のファイルをサブディレクトリに分類して、管理の向上を実現する:

ベンダー固有のサブディレクトリに設定ファイルを置くと、複数のAAR依存関係を扱う際にビルドの競合を回避し、整理を保つことができる。 Gradle

Gradleビルドツールインターフェース

To integrate AAR files into your Capacitor plugin, you need to configure Gradle appropriately. Start by adding these repository settings to android/build.gradle:

repositories {
    google()
    mavenCentral()
    flatDir {
        dirs 'libs'
    }
}

CapacitorプラグインにAARファイルを統合するには、Gradleを適切に設定する必要がある。まず、次のリポジトリ設定を追加することから始める。 dependencies 次に、AAR依存関係を含める

dependencies {
    implementation files('libs/your-library.aar')
    implementation fileTree(dir: 'libs', include: ['**/*.aar'])
    implementation "com.getcapacitor:core:${capacitorVersion}"
    implementation "androidx.appcompat:appcompat:1.6.1"
}

ブロックに追加する: gradle.properties プロジェクトのルートディレクトリにファイルを追加し、ライブラリのバージョンを定義してください:

# Library versions
MY_LIBRARY_VERSION=1.2.3
CAPACITOR_VERSION=5.5.0

AARファイルに付随する追加の依存関係がある場合、次のように宣言してください: android/build.gradle 次のように記述してください:

android {
    defaultConfig {
        minSdkVersion 21
        targetSdkVersion 33
    }

    packagingOptions {
        exclude 'META-INF/DEPENDENCIES'
        exclude 'META-INF/LICENSE'
    }
}

これらの変更を適用するには、プロジェクトを同步してください。

Gradle Syncを実行する

Android Studioでプロジェクトを開き、Gradleが自動的に同期されるのを待ってください。同期が始まらない場合は、ツールバーの「Gradleファイルとプロジェクトを同期する」ボタンをクリックしてください。

同期が完了したら、次のことを確認してください:

同期が失敗した場合、設定を確認してください。たとえば、次の設定が有効になっていることを確認してください。

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }

    lintOptions {
        abortOnError false
    }
}

大きなAARファイルの場合、Gradleのメモリ割り当てを増やす必要があるかもしれません。 gradle.properties:

org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m

同期が正常に完了したら、AARファイルが完全に統合され、テスト用に準備されています。

AAR機能をCapacitorに接続する

プラグインクラスの書き方

Gradleファイルが同期されたら、AAR機能を接続するためにプラグインクラスを拡張する時間です。 プラグイン class. This step links JavaScript to the native Android code.

@NativePlugin(
    permissions = {
        Manifest.permission.REQUIRED_PERMISSION
    }
)
public class YourPlugin extends Plugin {
    private YourAARLibrary libraryInstance;

    @Override
    public void load() {
        super.load();
        libraryInstance = new YourAARLibrary(getContext());
    }
}

このステップは、JavaScriptをネイティブのAndroid__CAPGO_KEEP_0__とリンクします。

プラグインメソッドの作成

次に、プラグインでメソッドを定義するには、 @PluginMethod 注釈を使用します。これらのメソッドは、JavaScriptとJavaの間でデータの交換を処理します。

@PluginMethod
public void performAction(PluginCall call) {
    try {
        // Get data from JavaScript
        String inputData = call.getString("inputKey");

        // Call AAR library method
        YourLibraryResult result = libraryInstance.processData(inputData);

        // Return result to JavaScript
        JSObject ret = new JSObject();
        ret.put("value", result.getValue());
        call.resolve(ret);
    } catch (Exception e) {
        call.reject("Error processing data", e);
    }
}

非同期に実行する必要があるタスクの場合:

@PluginMethod(returnType = PluginMethod.RETURN_CALLBACK)
public void startContinuousOperation(PluginCall call) {
    call.setKeepAlive(true);

    libraryInstance.setCallback(new LibraryCallback() {
        @Override
        public void onUpdate(String data) {
            JSObject ret = new JSObject();
            ret.put("data", data);
            call.resolve(ret);
        }
    });
}

JavaScriptの型とJavaの型の間でよく使われる型はどれでしょうか?

リソースのクリーンアップのために、オーバーライドする handleOnDestroy メソッド:

@Override
protected void handleOnDestroy() {
    if (libraryInstance != null) {
        libraryInstance.cleanup();
        libraryInstance = null;
    }
    super.handleOnDestroy();
}

これらのメソッドを実装すると、ネイティブブリッジが使用可能になります。Android Studioのデバッグ環境で実装をテストして、期待どおりに動作することを確認してください。

テストと問題の修正

デバッグ Android Studio

Android StudioでAARの統合をデバッグするには、プロジェクトのデバッグモードを有効にする必要があります。 build.gradle ファイル:

android {
    buildTypes {
        debug {
            debuggable true
            minifyEnabled false
        }
    }
}

プラグインのメソッドでブレークポイントを追加して、データフローのトラッキングと潜在的な問題の特定を行います:

@PluginMethod
public void yourMethod(PluginCall call) {
    // Set a breakpoint here to inspect input data
    String inputValue = call.getString("key");
    // Another breakpoint here to check method calls to the AAR
    libraryInstance.someMethod(inputValue);
}

Android Studioのデバッグパネルを使用して、重要なエリアを監視します:

デバッグが解決しない場合は、次のセクションのトラブルシューティング手順に従ってください。

トラブルシューティング手順

デバッグだけでは十分ではない場合は、以下の手順を使用して一般的な問題を解決します。

1.依存関係の競合

バージョンが競合しているかどうかを確認するには、ファイルを確認してください。バージョンを強制することで競合を解決できます: build.gradle 2.ネイティブライブラリの欠如

configurations.all {
    resolutionStrategy {
        force 'com.google.android:android:4.1.1.4'
        // Add other forced versions as needed
    }
}

AARファイルが必要なファイルを含むことを確認し、適切なディレクトリに配置していることを確認します。

3.マニフェストマージの問題 .so 3.マニフェストマージの問題

• jniLibs/armeabi-v7a/
• jniLibs/arm64-v8a/
• jniLibs/x86/
• jniLibs/x86_64/

3.マニフェストマージの問題

Capacitor プラグインで AAR ファイルを使用する方法 AndroidManifest.xml 問題のあるライブラリをオーバーライドするには、次の内容を含める必要があります。

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    package="your.plugin.package">
    <uses-sdk tools:overrideLibrary="conflicting.library.package"/>
</manifest>

4. ランタイムクラッシュとメモリ管理

Android Studio の Performance タブを使用して、ランタイムの安定性を監視します。初期化問題の場合、例外を慎重に処理してください。

try {
    libraryInstance = new YourAARLibrary(getContext());
} catch (Exception e) {
    Log.e("PluginError", "Failed to initialize library: " + e.getMessage());
    return;
}

メモリリークを防ぐには、リソースを適切にリリースすることを確認してください。Android Studio の Memory Profiler を使用して、ヒープ使用量を追跡し、リークを特定します。

概要

AAR ファイルを Capacitor プラグインに統合するには、Android 環境を設定する必要があります。 AAR ファイルを正しく配置し、Gradle を正確に構成し、徹底的にテストする必要があります。

主な実装フェーズ

これらの基本をマスターしたら、より高度なテクニックを探索できます

次のステップ

プラグインを強化するには、以下の領域に焦点を当ててください。

• パフォーマンス最適化
  Android Studioのプロファイラーを使用して、メモリ使用量を監視し、リソースが適切にクリーンアップされることを確認してください。

• 配布準備
  すべてのAAR構成をドキュメント化し、API ドキュメントを生成し、Android API 29–34のレベルと互換性をテストしてください。

• メンテナンス戦略
  テストを自動化し、バージョン管理でAARバージョンを管理し、変更履歴を維持し、エラー報告を設定して生産的な問題を解決するようにしてください。

プラグインを公開する予定の場合は、AAR固有の設定とプラットフォーム制限に関する詳細なドキュメントを提供することを確認してください。これにより、他の開発者がプラグインを効果的に使用できるようにすることができます。

Keep going from How to Use AAR Files in Capacitor Plugins

Capacitor プラグインの AAR ファイルを使用する方法を使用している場合 How to Use AAR Files in Capacitor Plugins native プラグインの作業を計画するには、 Capgo プラグイン ディレクトリ Capgo プラグイン ディレクトリ内での製品ワークフロー Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, __CAPGO_KEEP_0__ プラグイン __CAPGO_KEEP_1__ プラグインの追加または更新 __CAPGO_KEEP_0__ プラグイン Capgo Native Builds for the product workflow in Capgo Native Builds.