Comment utiliser les fichiers AAR dans les plugins Capacitor

Vous souhaitez intégrer des fonctionnalités Android dans vos Capacitor app? Cette guide explique comment utiliser les fichiers AAR (archive Android) dans les Capacitor plugins

pour combiner la fonctionnalité native Android avec des applications web cross-plateformes.

• Rappels clés : Pre-packaged Android libraries containing code, resources, and native files.
• Les fichiers AAR sont des bibliothèques Android pré-conçues contenant __CAPGO_KEEP_0__, des ressources et des fichiers natifs. AAR files enable code reuse, simplify maintenance, and protect proprietary features.
• Les fichiers AAR permettent le réemploi de __CAPGO_KEEP_0__, simplifient la maintenance et protègent les fonctionnalités propriétaires. Qu'est-ce qui est requis ? Des outils comme l'Android Studio, Gradle, et Node.js, ainsi qu'une configuration de projet appropriée.
• Comment intégrer ? Placez les fichiers AAR dans libs, configurez Gradle et connectez-les aux plugins Capacitor.

Étapes rapides :

1. Configurez votre environnement : Installez les outils requis et configurez Android Studio.
2. Organisez votre projet : Créez une structure claire pour votre Capacitor plugin.
3. Ajoutez des fichiers AAR : Placez-les dans android/libs et mettez à jour les dépendances Gradle.
4. Écrivez le plugin code : Liez la fonctionnalité AAR à JavaScript avec Capacitor’s API.
5. Testez soigneusement : Utilisez le débogueur d'Android Studio pour vous assurer d'une intégration fluide.

En suivant ce guide, vous pouvez incorporer de manière fluide des fichiers AAR dans vos plugins Capacitor , débloquant ainsi les capacités Android natives pour vos applications web.

Comment intégrer une bibliothèque Android (fichier AAR) dans un capacitor plugin

Exigences de configuration de l'environnement de développement

Avant de travailler avec les fichiers AAR, assurez-vous que votre environnement de développement est correctement configuré pour éviter tout problème.

Logiciels requis

Voici les logiciels dont vous aurez besoin pour travailler avec les fichiers AAR dans les plugins Capacitor :

En outre, assurez-vous que les composants suivants sont inclus dans votre SDK Manager :

• L'Android SDK Plateforme 33 (Android 13.0)
• L'outil de construction Android SDK 33.0.0
• L'outil de ligne de commande Android SDK
• L'émulateur Android
• L'outil de plateforme Android SDK

Étapes de configuration du projet

1. Initialiser votre environnement de développement

Commencez par créer un nouveau répertoire avec cette structure :

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

2. Configurer les paramètres d'Android Studio

Lancer Android Studio et ajustez les paramètres suivants :

• Configurez le JDK Gradle en version 11 ou supérieure.
• Activez la fonctionnalité de téléchargement automatique pour les composants Android SDK.
• Mettez à jour les variables d'environnement système avec le chemin correct du composant Android SDK.

3. Préparez la structure de votre plugin.

Mettez à jour le android/build.gradle fichier avec ces paramètres pour inclure le support des fichiers AAR :

android {
    compileSdkVersion 33
    defaultConfig {
        minSdkVersion 22
        targetSdkVersion 33
    }

    repositories {
        flatDir {
            dirs 'libs'
        }
    }
}

4. Configurer le Contrôle de Version

Initialisez Git dans votre répertoire de projet et créez un .gitignore fichier pour exclure les fichiers inutiles. Voici un exemple .gitignore:

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

Une fois ces étapes complétées, vous serez prêt à passer à l'ajout de vos fichiers AAR.

Ajouter des fichiers AAR à votre plugin.

Obtenir des fichiers AAR

AAR les fichiers peuvent provenir de SDK tiers, de bibliothèques personnalisées ou de dépendances Maven. Il est une bonne idée de documenter leur source, leur version et leur but dans un README répertoire. libs Type de source

Une fois que vos fichiers AAR sont prêts et documentés, vous pouvez configurer votre plugin pour les inclure.

Configuration des fichiers de plugin

Organisez vos fichiers de plugin pour garantir une intégration fluide des dépendances AAR. Voici un exemple de la structure de votre plugin qui pourrait ressembler à ceci :

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

Emplacement des fichiers AAR

Pour activer la fonctionnalité AAR, placez les fichiers dans le android/libs répertoire de votre plugin en suivant ces étapes :

• Utilisez un format de nommage clair et cohérent, tel que libraryname-version.aar.
• Gérez les versions dans un versions.properties fichier. Par exemple :

library1=1.2.3
library2=2.0.0

• ajouter un fichier pour les autres dépendances : dependencies.gradle Organiser les fichiers spécifiques au fournisseur dans des sous-dossiers pour une meilleure gestion :

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

• Maintenir les fichiers de configuration dans des sous-dossiers spécifiques au fournisseur aide à maintenir l'organisation et évite les conflits de construction lors du travail avec plusieurs dépendances AAR.

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

Gradle

Étapes de configuration Interface de l'outil de construction Gradle

Pour intégrer les fichiers AAR dans votre plugin __CAPGO_KEEP_0__, vous devez configurer Gradle en conséquence. Commencez par ajouter ces paramètres de référentiel à

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

block : dependencies Pour une meilleure gestion de version, créez un

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

un fichier gradle.properties le fichier dans votre dossier racine et définissez les versions de votre bibliothèque :

# Library versions
MY_LIBRARY_VERSION=1.2.3
CAPACITOR_VERSION=5.5.0

Si le fichier AAR est accompagné de dépendances supplémentaires, déclarez-les dans android/build.gradle comme ceci :

android {
    defaultConfig {
        minSdkVersion 21
        targetSdkVersion 33
    }

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

Une fois ces modifications effectuées, synchronisez votre projet pour les appliquer.

Exécution de Gradle Sync

Ouvrez votre projet dans Android Studio et attendez que Gradle se synchronise automatiquement. Si cela ne démarre pas, cliquez sur le bouton « Synchroniser le projet avec les fichiers Gradle » dans la barre d'outils.

Après synchronisation, vérifiez les éléments suivants :

Si la synchronisation échoue, vérifiez à nouveau votre configuration. Par exemple, assurez-vous que ces paramètres sont en place :

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

    lintOptions {
        abortOnError false
    }
}

Pour les grands fichiers AAR, vous devrez peut-être augmenter l'allocation de mémoire de Gradle dans gradle.properties:

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

Une fois la synchronisation terminée avec succès, vos fichiers AAR devraient être intégrés pleinement et prêts à l'essai.

Brancher les fonctionnalités AAR à Capacitor

Écrire la classe du plugin

Une fois que vos fichiers Gradle sont synchronisés, il est temps de connecter votre fonctionnalité AAR en étendant la classe Plugin Cette étape relie JavaScript à l'code Android natif.

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

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

Voici ce dont vous avez besoin pour initialiser la bibliothèque AAR :

Créer des méthodes de plugin

Ensuite, définissez des méthodes dans votre plugin à l'aide de @PluginMethod l'annotation. Ces méthodes gèrent l'échange de données entre JavaScript et 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);
    }
}

Pour les tâches qui nécessitent d'être exécutées de manière asynchrone :

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

Ici, voici comment les types courants sont convertis entre JavaScript et Java :

Pour la suppression des ressources, surcharger la méthode : handleOnDestroy méthode :

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

Avec ces méthodes en place, votre pont natif est prêt. Testez votre mise en œuvre dans l'environnement de débogage d'Android Studio pour vous assurer que tout fonctionne comme prévu.

Test et correction des problèmes

Débogage dans Android Studio

Pour déboguer votre intégration AAR dans Android Studio, commencez par activer le mode débogage dans votre projet's build.gradle fichier :

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

Ajoutez des points d'arrêt dans vos méthodes de plugin pour suivre le flux de données et identifier les problèmes potentiels :

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

Utilisez le panneau de débogage dans Android Studio pour surveiller les zones clés :

Si la débogage ne résout pas le problème, suivez les étapes de dépannage de la section suivante.

Étapes de dépannage

Lorsque la débogage seul ne suffit pas, utilisez ces étapes pour résoudre les problèmes courants :

1. Conflits de dépendances

Vérifiez les conflits de versions dans votre build.gradle Vous pouvez forcer des versions spécifiques pour résoudre les conflits :

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

2. Manquantes des bibliothèques natives

Assurez-vous que l’AAR inclut les fichiers requis dans les répertoires appropriés, tels que : .so 3. Problèmes de fusion de manifeste

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

3. Problèmes de fusion de manifeste

If vous rencontrez des conflits de manifeste, incluez les éléments suivants dans votre AndroidManifest.xml fichier pour contourner les bibliothèques problématiques :

<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 et gestion de la mémoire en temps de exécution

Utilisez l'onglet Performance dans Android Studio pour surveiller la stabilité en temps de exécution. Pour les problèmes d'initialisation, gérez les exceptions avec soin :

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

Pour prévenir les fuites de mémoire, assurez-vous que les ressources sont libérées correctement. Utilisez le Profiler de la mémoire dans Android Studio pour suivre l'utilisation de la pile et identifier toute fuite.

Résumé

Pour intégrer les fichiers AAR dans les plugins Capacitor , vous devrez configurer l'environnement Android, placer les fichiers AAR correctement, configurer Gradle avec précision et tester soigneusement.

Phases d'implémentation clés

Une fois que vous avez maîtrisé ces bases, vous pouvez explorer des techniques plus avancées.

Étapes suivantes

Pour améliorer votre plugin, concentrez-vous sur ces domaines :

• Optimisation de la performance
  Utilisez le profilateur d'Android Studio pour surveiller la consommation de mémoire et vous assurer que les ressources sont nettoyées correctement.

• Préparation de la distribution
  Documentez toutes les configurations AAR, générerz API documentation, et testez la compatibilité avec les niveaux d'Android API 29–34.

• Stratégie de maintenance
  Automatisez les tests, gérez les versions AAR avec le contrôle de version, maintenez un journal des modifications et configurez la notification d'erreur pour résoudre les problèmes en production.

Si vous prévoyez de partager votre plugin publiquement, assurez-vous de fournir une documentation détaillée sur les paramètres AAR spécifiques et les limitations de plateforme. Cela facilitera l'adoption et l'utilisation de votre plugin par d'autres développeurs.

Continuez de la section « Comment utiliser les fichiers AAR dans les plugins Capacitor »

Si vous utilisez Comment utiliser les fichiers AAR dans les plugins Capacitor Afin de planifier le travail de plugin natif, connectez-l’à Répertoire de plugin Capgo pour le flux de travail du produit dans le Répertoire de plugin Capgo Capacitor Plugins par Capgo pour le détail d'implémentation dans Capacitor Plugins par Capgo Ajouter ou Mettre à Jour les Plugins pour le détail d'implémentation dans Ajouter ou Mettre à Jour les Plugins Alternatives de Plugins d'Entreprise Ionic pour le flux de travail du produit dans Alternatives de Plugins d'Entreprise Ionic, et Capgo Builds Natives pour le flux de travail du produit dans Capgo Builds Natives.