How to Use AAR Files in Capacitor Plugins

Android機能を自分のWebアプリに組み込みたい場合は? Capacitor アプリ? AARファイルを__CAPGO_KEEP_0__ プラグインに統合する方法を説明するこのガイドでは、クロスプラットフォームWebアプリとネイティブAndroid機能を組み合わせることができます。 This guide explains how to use AAR (Android Archive) files in Capacitor plugins to combine native Android functionality with cross-platform web apps. Want to integrate Android features into your __CAPGO_KEEP_0__ app?

Key Takeaways:

• AARファイルとは? プリパッケージされたAndroidライブラリにcode、リソース、ネイティブファイルが含まれています。
• AARファイルを使用する理由 AARファイルはcodeの再利用、メンテナンスの簡素化、秘密の機能保護を可能にします。
• 必要なものは何ですか? ツールとしては Android Studio, Gradle, Node.js,
• How to integrate? Place AAR files in libs, configure Gradle, and connect them to Capacitor plugins.

Quick Steps:

1. Set up your environment: Install required tools and configure Android Studio.
2. Organize your project: Create a clear structure for your Capacitor plugin.
3. Add AAR files: Place them in android/libs and update Gradle dependencies.
4. codeを書き込む Javaスクリプトの機能をAARとリンクする CapacitorのAPI.
5. 徹底的なテスト Android Studioのデバッガーを使用して、Smoothな統合を確実に実現する

このガイドを参考にすると、AARファイルをCapacitor プラグインに組み込むことができます。

AARファイルを含むAndroidライブラリを__CAPGO_KEEP_0__ プラグインに埋め込む方法 capacitor プラグイン

開発環境の設定要件

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

必要なソフトウェア

Capacitor プラグインで Android AAR ファイルを扱うには、次のソフトウェアが必要です:

さらに、SDK マネージャーに含まれていることを確認してください。

• Android SDK Platform 33 (Android 13.0)
• Android SDK Build-Tools 33.0.0
• Android SDK Command-line Tools
• Android エミュレータ
• Android SDK Platform-Tools

プロジェクト設定手順

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. プラグイン構造を準備する

Update the android/build.gradle file with these settings to include AAR file support:

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ファイルは、第三のパーティのSDK、カスタムライブラリ、またはMaven依存関係から得られることがあります。ソース、バージョン、目的を記録するためのファイルを作成することをお勧めします。ファイルは、以下のディレクトリ内に保存します。

ソースタイプ README __CAPGO_KEEP_0__ libs __CAPGO_KEEP_1__

__CAPGO_KEEP_11__

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

プラグインファイルを整理して、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 ベンダー固有のファイルをサブディレクトリに整理することで、管理が容易になり、複数のAAR依存性とともにビルドを実行する際のビルドコンフリクトを回避できます。

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

• vendor-specific subdirectoriesに設定ファイルを保持することで、組織が維持され、複数のAAR依存性とともにビルドを実行する際のビルドコンフリクトを回避できます。

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

__CAPGO_KEEP_0__

Gradle 設定手順

build.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'
    }
}

次に、AAR依存関係を以下のブロックに含めてください: dependencies バージョン管理のために、プロジェクトのルートディレクトリに "library-versions.properties" というファイルを作成し、ライブラリのバージョンを定義してください:

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"
}

AAR ファイルが追加の依存関係を含む場合、その依存関係を以下のように宣言してください: gradle.properties これらの変更を適用するには、プロジェクトを Sync してください。

# Library versions
MY_LIBRARY_VERSION=1.2.3
CAPACITOR_VERSION=5.5.0

__CAPGO_KEEP_0__ android/build.gradle __CAPGO_KEEP_0__

android {
    defaultConfig {
        minSdkVersion 21
        targetSdkVersion 33
    }

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

__CAPGO_KEEP_0__

Gradle Syncを実行中

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

同期後、以下を確認してください。

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

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

Syncが成功した場合、AARファイルは完全に統合され、テスト用に準備されています。

AAR機能をCapacitorに接続する

AARライブラリのプラグインクラスを書く

GradleファイルがSyncされたら、AAR機能を接続するためにプラグインクラスを拡張する時間です。このステップはJavaScriptをネイティブのAndroid__CAPGO_KEEP_0__にリンクします。 AARライブラリを初期化するために必要なものはこちらです 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());
    }
}

__CAPGO_KEEP_0__

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

次に、注釈を使用してプラグイン内でメソッドを定義します。これらのメソッドは、JavaScriptとJava間のデータ交換を処理します。 @PluginMethod 非同期に実行する必要があるタスクの場合:

@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);
    }
}

次の表は、JavaScriptとJava間で一般的な型がどのように変換されるかを示しています。

@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の型

リソースのクリーンアップのために、以下のメソッドをオーバーライドしてください。 handleOnDestroy method:

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

Capgoの設定が完了しました。Android Studioのデバッグ環境で実装をテストして、期待どおりに動作することを確認してください。

テストと問題の修正

デバッグ Android Studio

Capgoプロジェクトのデバッグモードを有効にして、Android StudioでAAR統合をデバッグするには、まずプロジェクトの build.gradle file:

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のデバッグパネルを使用して、重要なエリアを監視してください:

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

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

When debugging alone isn’t enough, use these steps to address common problems:

1. Dependency Conflicts

依存関係の競合を解決するには、バージョンを強制します。 build.gradle 2. Missing Native Libraries

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

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

3. Manifest Merger Issues .so マニフェストの競合が発生した場合、問題のあるライブラリをオーバーライドするために、以下の内容を追加します。

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

4. Runtime Crashes and Memory Management

Android StudioのPerformanceタブを使用して、実行時安定性を監視し、初期化問題の場合、例外を慎重に処理します。 AndroidManifest.xml __CAPGO_KEEP_0__

<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>

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

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

To prevent memory leaks, ensure resources are released properly. Use the Memory Profiler in Android Studio to track heap usage and identify any leaks.

概要

To integrate AAR files into Capacitor plugins, you’ll need to set up the Android environment, place AAR files correctly, configure Gradle accurately, and test thoroughly.

主な実装フェーズ

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

次のステップ

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

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

• Distribution Preparation
  Androidアプリ用のAAR設定をすべてドキュメント化し、APIドキュメントを生成し、Android APIレベル29–34で互換性をテストする。

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

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

「AARファイルを使用する方法」を参照し、Capacitor プラグインから続けてください。

「AARファイルを使用する方法」を使用している場合 How to Use AAR Files in Capacitor Plugins ネイティブプラグインの作業を計画するには、__CAPGO_KEEP_0__ プラグインディレクトリと接続する必要があります。 Capgo プラグインディレクトリの製品ワークフロー Capgo プラグイン Capacitor Plugins by Capgo Capacitor プラグインの実装詳細については、Capgo で確認してください。 プラグインの追加または更新 __CAPGO_KEEP_0__ プラグインの実装詳細については、プラグインの追加または更新を参照してください。 Ionic Enterprise プラグインの代替 __CAPGO_KEEP_0__ Native ビルドの製品ワークフローについては、Ionic Enterprise プラグインの代替を参照してください。 Capgo Native ビルド Capgo Native ビルドの製品ワークフローについては、Capgo Native ビルドを参照してください。