Come utilizzare i file AAR nei plugin Capacitor

Vuoi integrare funzionalità Android nel tuo Capacitor app? Questa guida spiega come utilizzare i file AAR (Archivio Android) nei plugin Capacitor per combinare la funzionalità nativa Android con le app web cross-platform.

Punti chiave:

• Cos' sono i file AAR? Librerie Android preconfezionate contenenti code, risorse e file nativi.
• Perché utilizzarli? AAR files abilitano il code riutilizzo, semplificano la manutenzione e proteggono le funzionalità proprietarie.
• Cosa è richiesto? Gli strumenti come Android Studio, Gradle, e Node.js, più una configurazione del progetto corretta.
• Come integrare? Inserisci 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: Crea una struttura chiara per il tuo Capacitor plugin.
3. Aggiungi file AAR: Colloca loro 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 garantire un'integrazione liscia.

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

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

Requisiti di configurazione per lo sviluppo

Prima di lavorare con i file AAR, assicurati che il tuo ambiente di sviluppo sia correttamente configurato per evitare qualsiasi problema.

Software richiesto

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

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

• Piattaforma Android SDK 33 (Android 13.0)
• Strumenti di costruzione Android SDK 33.0.0
• Strumenti di riga di comando Android SDK
• Emulatore Android
• Strumenti di piattaforma Android SDK

Istruzioni per la configurazione del progetto

1. Inizia il tuo ambiente di sviluppo

Inizia creando un nuovo directory con la seguente struttura:

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

2. Configura le impostazioni di Android Studio

Avvia 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 la corretta percorso di Android SDK.

3. Prepara la struttura del tuo plugin

Aggiorna il android/build.gradle file con le seguenti impostazioni per includere il supporto per il file AAR:

android {
    compileSdkVersion 33
    defaultConfig {
        minSdkVersion 22
        targetSdkVersion 33
    }

    repositories {
        flatDir {
            dirs 'libs'
        }
    }
}

4. Configura il controllo delle versioni

Inizia 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 file AAR.

Aggiungere File AAR al Tuo Plugin

Ottenere File AAR

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

Una volta pronte e documentate le tue AAR, puoi configurare il tuo plugin per includerle.

Impostazione dei file del plugin

Organizza i tuoi file del plugin per garantire un'integrazione liscia delle dipendenze AAR. Ecco un esempio di come la tua struttura del 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 del file AAR

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

• Usa un formato di denominazione chiaro e coerente, ad esempio 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ù dipendenze AAR.

Gradle Passaggi di configurazione

Aggiornamento di build.gradle

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

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

Allora, 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 file gradle.properties in radice del tuo progetto e definisci le versioni delle tue librerie:

# Library versions
MY_LIBRARY_VERSION=1.2.3
CAPACITOR_VERSION=5.5.0

Se il file AAR viene fornito con dipendenze aggiuntive, dichiarale nel android/build.gradle come segue:

android {
    defaultConfig {
        minSdkVersion 21
        targetSdkVersion 33
    }

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

Una volta apportate queste modifiche, sincronizza il tuo progetto per applicarle.

Eseguire il Sync di Gradle

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

Se la 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
    }
}

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

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

Una volta che la sincronizzazione si è completata con successo, i tuoi file AAR dovrebbero essere completamente integrati e pronti per il testing.

Collegare le funzionalità AAR a Capacitor

Scrivere la classe del plugin

Una volta che i file Gradle sono sincronizzati, è tempo di collegare la tua funzionalità AAR estendendo la Plugin class. Questo passaggio collega JavaScript alla Android nativa 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 annotazione. Questi metodi gestiscono lo scambio 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 compiti 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:

Per 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 atto, il tuo ponte nativo è pronto. Testa la tua implementazione nell'ambiente di debug di Android Studio per assicurarti che tutto funzioni come previsto.

Test e Risoluzione dei Problemi

Debug in Android Studio

Per debuggare l'integrazione AAR in Android Studio, inizia abilitando il debug nel progetto's build.gradle file:

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

Aggiungi i punti di interruzione nei metodi del tuo plugin per tracciare il flusso dei dati e identificare potenziali problemi:

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

Utilizza il pannello di debug in Android Studio per monitorare aree chiave:

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

Passaggi di Risoluzione dei Problemi

Quando il debug da solo 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. Biblioteche native mancanti

Assicurati che l'AAR includa i file richiesti .so nella cartella appropriata, ad esempio:

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

3. Problemi di fusione del manifesto

Se si verificano conflitti di manifesto, includi i seguenti nella tua 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 di Capacitor è necessario 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, concentra l'attenzione su queste aree:

• Optimizzazione delle prestazioni
  Utilizza il profiler di Android Studio per monitorare l'uso della memoria e assicurarti 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 problematiche di produzione.

If sei pianifica di condividere pubblicamente il tuo plugin, assicurati di fornire una documentazione dettagliata sulle impostazioni AAR e su eventuali limitazioni di piattaforma. Ciò renderà più facile per gli altri sviluppatori adottare e utilizzare il tuo plugin in modo efficace.

Continua da Come utilizzare i file AAR in Capacitor Plugins

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