Come utilizzare i file AAR nei plugin Capacitor

Volete integrare funzionalità Android nelle vostre Capacitor app? Questa guida spiega come utilizzare i file AAR (Archivio Android) nei plugin di Capacitor plugins per combinare la funzionalità Android nativa con le app web cross-platform.

Presempi chiave:

• Cos'è un file AAR? Pre-packaged Android libraries containing code, resources, and native files.
• risorse e file nativi. AAR files enable code reuse, simplify maintenance, and protect proprietary features.
• I file AAR consentono il riutilizzo di semplificano la manutenzione e proteggono le funzionalità proprietarie. Cosa è richiesto?, Gradle, e Node.js, più una configurazione del progetto corretta.
• Come integrare? Colloca i file AAR in libs, configura Gradle e collega i plugin Capacitor.

Passaggi veloci:

1. Configura il tuo ambiente: Installa gli strumenti richiesti e configura Android Studio.
2. Organizza il tuo progetto: Creare una struttura chiara per il tuo Capacitor plugin.
3. Aggiungi file AAR: Collocali in android/libs e aggiorna le dipendenze di Gradle.
4. Scrivi il plugin code: Collega la funzionalità AAR al JavaScript con Capacitor’s API.
5. Testa accuratamente: Usa il debugger di Android Studio per assicurarti di un'integrazione liscia.

Seguendo questa guida, puoi incorporare facilmente i file AAR nei tuoi plugin Capacitor, sbloccando le capacità native Android per le tue app web.

Come incorporare una libreria Android (file AAR) in un capacitor plugin

Requisiti di configurazione per l'ambiente di sviluppo

Prima di lavorare con i file AAR, assicurati di avere un ambiente di sviluppo configurato correttamente per evitare qualsiasi problema.

Software richiesto

Ecco il software di cui avrai bisogno per lavorare con i file AAR nei plugin Capacitor:

Inoltre, assicurati che i seguenti componenti siano inclusi nel tuo SDK Manager:

• L'SDK piattaforma Android 33 (Android 13.0)
• L'SDK strumenti di costruzione Android 33.0.0
• L'SDK strumenti di linea di comando Android
• L'emulatore Android
• L'SDK strumenti di piattaforma Android

I passaggi di configurazione del progetto

1. I passaggi di inizializzazione dell'ambiente di sviluppo

Inizia creando un nuovo directory con questa struttura:

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

2. Configura le impostazioni di Android Studio

Lancia Android Studio e regola le seguenti impostazioni:

• Imposta il JDK di Gradle alla versione 11 o superiore.
• Abilita la funzione di download automatico per i componenti Android SDK.
• Aggiorna le variabili di ambiente del sistema con il percorso corretto di Android SDK.

3. Preparare la struttura del tuo plugin

Aggiorna il android/build.gradle file con queste impostazioni per includere il supporto dei file AAR:

android {
    compileSdkVersion 33
    defaultConfig {
        minSdkVersion 22
        targetSdkVersion 33
    }

    repositories {
        flatDir {
            dirs 'libs'
        }
    }
}

4. Configurare il controllo delle versioni

Inizializza Git nel tuo directory di progetto e crea un .gitignore file per escludere file non necessari. Ecco un esempio .gitignore:

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

Una volta completati questi passaggi, sarai pronto a passare all'aggiunta dei tuoi file AAR.

Aggiungere file AAR al tuo plugin

Ottenere file AAR

AAR i file possono provenire da SDK di terze parti, librerie personalizzate o dipendenze Maven. È una buona idea documentare la loro origine, versione e scopo in un README file ubicato nella libs directory.

Una volta che i file AAR sono pronti e documentati, puoi configurare il tuo plugin per includerli.

Configurazione dei file del plugin

Organizza i file del tuo plugin per garantire un'integrazione liscia delle dipendenze AAR. Ecco un esempio di come la struttura del tuo plugin potrebbe essere:

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

Posizionamento dei file AAR

Per abilitare la funzionalità AAR, posiziona i file nella android/libs directory del tuo plugin seguendo questi passaggi:

• Utilizza un formato di denominazione chiaro e coerente, come libraryname-version.aar.
• Gestisci le versioni in un versions.properties file. Ad esempio:

library1=1.2.3
library2=2.0.0

• Aggiungi un dependencies.gradle file per altre dipendenze:

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

• Organizza i file specifici del fornitore in sottodirectory per una gestione migliore:

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

Tenere i file di configurazione nelle sottodirectory specifiche del fornitore aiuta a mantenere l'organizzazione e a evitare conflitti di build quando si lavora con più file AAR.

Gradle Passaggi di configurazione

Aggiornamento di build.gradle

Per integrare i file AAR nel tuo plugin Capacitor, è necessario configurare Gradle in modo appropriato. Inizia aggiungendo questi impostazioni di repository a android/build.gradle:

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

Quindi, includi le dipendenze AAR nel dependencies blocco:

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

Per una gestione delle versioni migliore, crea un gradle.properties carica il file nella radice del tuo progetto e definisci le versioni della tua libreria:

# Library versions
MY_LIBRARY_VERSION=1.2.3
CAPACITOR_VERSION=5.5.0

Se il file AAR viene fornito con dipendenze aggiuntive, dichiarale in questo modo: android/build.gradle Una volta apportate queste modifiche, sincronizza il tuo progetto per applicarle.

android {
    defaultConfig {
        minSdkVersion 21
        targetSdkVersion 33
    }

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

Esecuzione di Sync Gradle

Apri il tuo progetto in Android Studio e attendi che Gradle sincronizzi automaticamente. Se non inizia, clicca sul pulsante "Sincronizza Progetto con File Gradle" nella barra degli strumenti.

Dopo aver sincronizzato, verifica i seguenti punti:

Punto di Controllo

Se il sincronizzazione fallisce, controlla nuovamente la tua configurazione. Ad esempio, assicurati che questi impostazioni siano presenti:

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

    lintOptions {
        abortOnError false
    }
}

Per grandi file AAR, potresti dover aumentare l'allocazione di memoria di Gradle in gradle.properties:

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

Una volta completata con successo la sincronizzazione, i tuoi file AAR dovrebbero essere completamente integrati e pronti per le prove.

Collegamento delle funzionalità AAR a Capacitor

Scrittura della classe del plugin

Una volta sincronizzati i file Gradle, è il momento di collegare la tua funzionalità AAR estendendo la classe Plugin 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());
    }
}

Ecco cosa ti serve per inizializzare la libreria AAR:

Crea metodi del plugin

Successivamente, definisci metodi nel tuo plugin utilizzando il @PluginMethod segno di annotazione. Questi metodi gestiscono l'interscambio di dati tra JavaScript e 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);
    }
}

Per le attività che richiedono l'esecuzione in modo asincrono:

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

Ecco come sono convertiti i tipi comuni tra JavaScript e Java:

For la pulizia delle risorse, sovrascrivi il handleOnDestroy metodo:

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

Con questi metodi in posizione, il tuo ponte nativo è pronto. Testa la tua implementazione nel ambiente di debug di Android Studio per assicurarti che tutto funzioni come previsto.

Test e Risoluzione dei Problemi

Debugging in Studio Android

Per debuggare l'integrazione AAR in Android Studio, inizia abilitando il debug nel file del tuo progetto: build.gradle Aggiungi breakpoint nei metodi del tuo plugin per tracciare il flusso dei dati e identificare potenziali problemi:

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

Utilizza il pannello Debug in Android Studio per monitorare le aree chiave:

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

Area di Debugging

Se la debug non risolve il problema, segui i passaggi di risoluzione dei problemi nella sezione successiva.

Passaggi di risoluzione dei problemi

Quando la sola debug non è sufficiente, utilizza questi passaggi per risolvere i problemi comuni:

1. Conflitti di dipendenza

Controlla i conflitti di versione nei tuoi build.gradle file. Puoi forzare versioni specifiche per risolvere i conflitti:

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

2. Librerie native mancanti

Assicurati che l'AAR includa i file richiesti nei directory appropriati, come ad esempio: .so 3. Problemi di fusione del manifesto

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

4. Problemi di conflitto di versione

If si incontra conflitti di manifesto, includere i seguenti nel tuo AndroidManifest.xml file per sovrascrivere le librerie problematiche:

<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. Crashes di esecuzione e gestione della memoria

Utilizza la scheda Performance in Android Studio per monitorare la stabilità di esecuzione. Per problemi di inizializzazione, gestisci le eccezioni con cura:

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

Per prevenire le perdite di memoria, assicurati che le risorse vengano rilasciate correttamente. Utilizza il Profilo della Memoria in Android Studio per tracciare l'uso della memoria e identificare eventuali perdite.

Riepilogo

Per integrare i file AAR nei plugin Capacitor , avrai bisogno di configurare l'ambiente Android, posizionare i file AAR correttamente, configurare Gradle con precisione e testare accuratamente.

Fasi di Implementazione Chiave

Una volta padroneggiati questi concetti base, potrai esplorare tecniche più avanzate.

Passaggi successivi

Per migliorare il tuo plugin, concentrati su queste aree:

• Optimizzazione delle prestazioni
  Utilizza il profiler di Android Studio per monitorare l'uso della memoria e assicurati che le risorse vengano pulite correttamente.

• Preparazione della distribuzione
  Documenta tutte le configurazioni AAR, genera API documentazione e testa la compatibilità con i livelli Android API 29–34.

• Strategia di manutenzione
  Automatizza i test, gestisci le versioni AAR con il controllo delle versioni, mantiene un changelog e configura il reporting degli errori per affrontare le questioni di produzione.

Se hai l'intenzione di condividere il tuo plugin pubblicamente, assicurati di fornire una documentazione dettagliata sulle impostazioni AAR specifiche e su eventuali limitazioni del sistema operativo. Ciò renderà più facile per gli altri sviluppatori adottare e utilizzare il tuo plugin in modo efficace.

Continua da Come utilizzare i file AAR nei plugin Capacitor

Se stai utilizzando Come utilizzare i file AAR nei plugin Capacitor per pianificare il lavoro dei plugin nativi, connettilo con Capgo Directory dei Plugin per il flusso di lavoro del prodotto nel Capgo Directory dei Plugin Capacitor Plugin da Capgo per i dettagli di implementazione in Capacitor Plugin da Capgo Aggiungere o Aggiornare i Plugin per i dettagli di implementazione in Aggiungere o Aggiornare i Plugin Alternative per Plugin Enterprise di Ionic per il flusso di lavoro del prodotto in Alternative per Plugin Enterprise di Ionic, e Capgo Costruzioni native per il flusso di lavoro del prodotto in Capgo Costruzioni native.