Cara Menggunakan File AAR di Capacitor Plugin

Ingin mengintegrasikan fitur Android ke dalam aplikasi Anda yang menggunakan __CAPGO_KEEP_0__ Capacitor aplikasi? Panduan ini menjelaskan cara menggunakan file AAR (Android Archive) dalam Capacitor plugin untuk menggabungkan fungsi native Android dengan aplikasi web lintas platform.

Poin Utama:

• Apa itu file AAR? Bibliotek Android yang sudah di-packaging, mengandung code, sumber daya, dan file native.
• Mengapa menggunakan mereka? File AAR memungkinkan code penggunaan ulang, memudahkan perawatan, dan melindungi fitur properti.
• Apa yang dibutuhkan? Alat seperti Android Studio, Gradle, dan Node.js, plus pengaturan proyek yang tepat.
• Berikut cara mengintegrasikan: Tempatkan file AAR di libs, konfigurasi Gradle, dan hubungkan ke plugin-plugin Capacitor.

Langkah-Langkah Cepat:

1. Siapkan lingkungan Anda: Pasang alat-alat yang diperlukan dan konfigurasi Android Studio.
2. Organisir proyek Anda: Buat struktur yang jelas untuk Anda Capacitor plugin.
3. Tambahkan file AAR: Tempatkan mereka di android/libs dan perbarui dependensi Gradle.
4. Tulis plugin code: Hubungkan fungsi AAR ke JavaScript dengan Capacitor’s API.
5. Uji secara menyeluruh: Gunakan debugger Android Studio untuk memastikan integrasi lancar.

Dengan mengikuti panduan ini, Anda dapat menyematkan file AAR ke dalam plugin Capacitor Anda, sehingga memungkinkan Anda untuk mengakses kemampuan Android native di aplikasi web Anda.

Cara menyematkan library Android (file AAR) ke dalam capacitor plugin

Persyaratan Pengaturan Pengembangan

Sebelum bekerja dengan file-file AAR, pastikan lingkungan pengembangan Anda telah terkonfigurasi dengan baik untuk menghindari masalah.

Perangkat Lunak yang Diperlukan

Berikut adalah perangkat lunak yang Anda butuhkan untuk bekerja dengan file-file AAR di plugin-plugin Capacitor :

Additionally, make sure the following components are included in your SDK Manager:

• Sistem Operasi Android SDK 33 (Android 13.0)
• Tools Pembangunan Android SDK 33.0.0
• Tools Perintah Baris Android SDK
• Emulator Android
• Tools Platform Android SDK

Langkah-Langkah Pengaturan Proyek

1. Mulai dengan Membuat Direktori Baru dengan Struktur Berikut:

Pengaturan Pengaturan Android Studio

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

2. Luncurkan Android Studio dan atur pengaturan-pengaturan berikut:

Konfigurasi Pengaturan Android Studio

• Atur JDK Gradle ke versi 11 atau lebih tinggi.
• Aktifkan fitur download otomatis untuk komponen Android SDK.
• Perbarui variabel lingkungan sistem Anda dengan jalur Android SDK yang benar.

3. Siapkan Struktur Plugin Anda

Perbarui android/build.gradle file dengan pengaturan ini untuk mendukung file AAR:

android {
    compileSdkVersion 33
    defaultConfig {
        minSdkVersion 22
        targetSdkVersion 33
    }

    repositories {
        flatDir {
            dirs 'libs'
        }
    }
}

4. Siapkan Kontrol Versi

Inisialisasi Git di direktori proyek Anda dan buat sebuah .gitignore file untuk mengabaikan file yang tidak perlu. Berikut adalah contoh .gitignore:

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

Setelah langkah-langkah ini selesai, Anda akan siap untuk melanjutkan ke menambahkan file AAR.

Menambahkan File AAR ke Plugin Anda

Mengambil File AAR

AAR berkas dapat berasal dari SDK pihak ketiga, library kustom, atau dependensi Maven. Baiklah untuk mendokumentasikan sumber, versi, dan tujuan mereka dalam sebuah README berkas yang terletak di libs directory.

Setelah Anda memiliki file AAR yang siap dan terdokumentasi, Anda dapat mengonfigurasi plugin Anda untuk menyertakan mereka.

Mengatur File Plugin

Susun file plugin Anda untuk memastikan integrasi AAR yang lancar. Berikut adalah contoh struktur plugin Anda mungkin terlihat:

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

Penempatan File AAR

Untuk mengaktifkan fungsi AAR, tempatkan file-file di android/libs dari plugin Anda dengan mengikuti langkah-langkah berikut:

• Gunakan format penamaan yang jelas dan konsisten, seperti libraryname-version.aar.
• Kelola versi di versions.properties file. Misalnya:

library1=1.2.3
library2=2.0.0

• Menggunakan file untuk dependensi lain: dependencies.gradle Mengorganisir file vendor spesifik ke subdirektori untuk manajemen yang lebih baik:

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

• Menggunakan subdirektori untuk menyimpan file konfigurasi vendor membantu menjaga organisasi dan menghindari konflik saat build dengan dependensi AAR yang berbeda.

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

Gradle

Langkah-Langkah Konfigurasi Interface Gradle Build Tool

Untuk mengintegrasikan file AAR ke dalam plugin __CAPGO_KEEP_0__ Anda, Anda perlu mengonfigurasi Gradle dengan benar. Mulai dengan menambahkan pengaturan repository berikut ke

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

blok: dependencies Menggunakan subdirektori untuk mengelola versi dengan lebih baik:

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

Organize vendor-specific files into subdirectories for better management: gradle.properties file di root proyek Anda dan tentukan versi library Anda:

# Library versions
MY_LIBRARY_VERSION=1.2.3
CAPACITOR_VERSION=5.5.0

Jika file AAR datang dengan dependensi tambahan, deklarasikan mereka di android/build.gradle seperti ini:

android {
    defaultConfig {
        minSdkVersion 21
        targetSdkVersion 33
    }

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

Setelah Anda membuat perubahan-perubahan ini, sinkronkan proyek Anda untuk menerapkan perubahan-perubahan tersebut.

Jalankan Gradle Sync

Buka proyek Anda di Android Studio dan tunggu sampai Gradle sinkronisasi secara otomatis. Jika tidak, klik tombol "Sinkronkan Proyek dengan File Gradle" di toolbar.

Setelah sinkronisasi, verifikasi hal-hal berikut:

Jika sinkronisasi gagal, periksa kembali konfigurasi Anda. Misalnya, pastikan pengaturan-pengaturan berikut sudah ada:

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

    lintOptions {
        abortOnError false
    }
}

Untuk file AAR yang besar, Anda mungkin perlu meningkatkan alokasi memori Gradle di gradle.properties:

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

Setelah sinkronisasi selesai dengan sukses, file AAR Anda seharusnya sudah terintegrasi sepenuhnya dan siap untuk diuji.

Menghubungkan Fitur AAR ke Capacitor

Membuat Kelas Plugin

Setelah file Gradle Anda disinkronisasi, saatnya untuk menghubungkan fungsi AAR dengan mengembangkan kelas Plugin . Langkah ini menghubungkan JavaScript dengan 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());
    }
}

Ini yang Anda butuhkan untuk menginisialisasi library AAR:

Membuat Metode Plugin

Selanjutnya, definisikan metode-metode dalam plugin menggunakan @PluginMethod pengamatan. Metode-metode ini mengelola pertukaran data antara JavaScript dan 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);
    }
}

Untuk tugas-tugas yang perlu dijalankan secara asinkron:

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

Berikut adalah cara tipe-tipe umum dikonversi antara JavaScript dan Java:

Untuk membersihkan sumber daya, override metode: handleOnDestroy metode:

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

Dengan metode-metode ini, jembatan asli Anda sudah siap. Tes implementasi Anda di lingkungan debug Android Studio untuk memastikan semuanya berjalan seperti yang diharapkan.

Menguji dan Mengatasi Masalah

Menggunakan Debug di Android Studio

Untuk mengdebug integrasi AAR Anda di Android Studio, mulai dengan mengaktifkan mode debug di file: build.gradle file:

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

Tambahkan titik henti di metode-metode plugin Anda untuk mengikuti aliran data dan mengidentifikasi potensi masalah:

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

Gunakan panel Debug di Android Studio untuk memantau area kunci:

Jika debugging tidak dapat menyelesaikan masalah, ikuti langkah-langkah troubleshooting di bagian berikutnya.

Langkah-Langkah Troubleshooting

Jika debugging sendiri tidak cukup, gunakan langkah-langkah ini untuk menangani masalah umum:

1. Konflik Dependensi

Periksa konflik versi pada file Anda. Anda dapat memaksa versi tertentu untuk menyelesaikan konflik: build.gradle 2. Libray Nativ Tidak Tersedia

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

Pastikan AAR mencakup file yang diperlukan di direktori yang tepat, seperti:

3. Masalah Penggabungan Manifest .so __CAPGO_KEEP_0__

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

__CAPGO_KEEP_0__

If Anda mengalami konflik manifest, termasuklah hal-hal berikut dalam file Anda untuk mengatasi library yang bermasalah: AndroidManifest.xml 4. Kecelakaan Runtime dan Pengelolaan Memori

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

Pakai tab Performance di Android Studio untuk memantau stabilitas runtime. Untuk masalah inisialisasi, tangani kecemasan dengan hati-hati:

Mencegah kebocoran memori, pastikan sumber daya dilepaskan dengan benar. Gunakan Profiler Memori di Android Studio untuk mengikuti penggunaan heap dan identifikasi kebocoran apa pun.

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

Ringkasan

Untuk mengintegrasikan file-file AAR ke dalam __CAPGO_KEEP_0__ plugin, Anda perlu mengatur lingkungan Android, menempatkan file AAR dengan benar, mengkonfigurasi Gradle dengan tepat, dan melakukan tes secara menyeluruh.

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.

Fase

Setelah Anda telah menguasai dasar-dasar ini, Anda dapat menjelajahi teknik-teknik yang lebih maju.

Langkah-Langkah Selanjutnya

Untuk meningkatkan plugin Anda, fokus pada area ini:

• Optimasi Kinerja
  Pakai Profiler Android Studio untuk memantau penggunaan memori dan pastikan sumber daya dibersihkan dengan benar.

• Persiapan Distribusi
  Dokumentasikan semua konfigurasi AAR, buat API dokumentasi, dan tes kompatibilitas dengan Android API level 29–34.

• Strategi Pemeliharaan
  Automatisasi tes, kelola versi AAR dengan kontrol versi, simpan catatan perubahan, dan atur laporan kesalahan untuk menangani masalah produksi.

Jika Anda berencana untuk membagikan plugin Anda secara publik, pastikan untuk menyediakan dokumentasi rinci tentang pengaturan AAR khusus dan keterbatasan platform. Ini akan membuatnya lebih mudah bagi pengembang lain untuk menerima dan menggunakan plugin Anda secara efektif.

Teruslah dari Cara Menggunakan File AAR di Capacitor Plugin

Jika Anda menggunakan Cara Menggunakan File AAR di Capacitor Plugin untuk merencanakan pekerjaan plugin native, hubungkannya dengan Capgo Direktori Plugin untuk alur kerja produk di Capgo Direktori Plugin, Capacitor Plugin oleh Capgo untuk detail implementasi di Capacitor Plugin oleh Capgo, Menambahkan atau Mengupdate Plugin untuk detail implementasi di Menambahkan atau Mengupdate Plugin, Alternatif Plugin Enterprise Ionic untuk alur kerja produk di Alternatif Plugin Enterprise Ionic, dan Capgo Bangun Native untuk alur kerja produk di Capgo Bangun Native.