Cómo utilizar archivos AAR en plugins de Capacitor

¿Desea integrar características de Android en su Capacitor app? Esta guía explica cómo utilizar archivos AAR (Android Archive) en Capacitor plugins para combinar funcionalidad nativa de Android con aplicaciones web de múltiples plataformas.

Toma de notas clave:

• ¿Qué son los archivos AAR? Bibliotecas de Android preempaquetadas que contienen code, recursos y archivos nativos.
• ¿Por qué utilizarlos? Los archivos AAR permiten el code de reutilización, simplifican la mantenimiento y protegen características propietarias.
• ¿Qué se requiere? Herramientas como Android Studio, Gradle, y Node.js, más una configuración de proyecto adecuada.
• ¿Cómo integrar? Coloque los archivos AAR en libs, configure Gradle y conecte a los plugins Capacitor.

Pasos rápidos:

1. Configura tu entorno: Instala las herramientas necesarias y configura Android Studio.
2. Organiza tu proyecto: Crea una estructura clara para tu Capacitor plugin.
3. Agregar archivos AAR: Colóquelos en android/libs y actualice las dependencias de Gradle.
4. Escriba el plugin code: Enlaza la funcionalidad de AAR con JavaScript con Capacitor’s API.
5. Pruebe exhaustivamente: Utilice el depurador de Android Studio para asegurarse de una integración suave.

Siguiendo esta guía, puede incorporar archivos AAR de manera fluida en sus plugins Capacitor, desbloqueando capacidades nativas de Android para sus aplicaciones web.

Cómo incorporar una biblioteca de Android (archivo AAR) en un capacitor plugin

Requisitos de configuración para el entorno de desarrollo

Antes de trabajar con archivos AAR, asegúrese de que su entorno de desarrollo esté correctamente configurado para evitar cualquier problema.

Software requerido

Aquí está el software que necesitará para trabajar con archivos AAR en plugins de Capacitor:

Además, asegúrese de que los siguientes componentes estén incluidos en su SDK Manager:

• Plataforma de Android SDK 33 (Android 13.0)
• Herramientas de construcción de Android SDK 33.0.0
• Herramientas de línea de comandos de Android SDK
• Emulador de Android
• Herramientas de plataforma de Android SDK

Pasos para configurar el proyecto

1. Inicie su entorno de desarrollo

Comience creando un nuevo directorio con esta estructura:

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

2. Configure los ajustes de Android Studio

Inicie Android Studio y ajuste los siguientes ajustes:

• Establezca la JDK de Gradle en versión 11 o superior.
• Habilite la característica de descarga automática para los componentes Android SDK.
• Actualice las variables de entorno de su sistema con la ruta correcta de Android SDK.

3. Prepare su estructura de plugin

Actualice el android/build.gradle archivo con estas configuraciones para incluir el soporte de archivo AAR:

android {
    compileSdkVersion 33
    defaultConfig {
        minSdkVersion 22
        targetSdkVersion 33
    }

    repositories {
        flatDir {
            dirs 'libs'
        }
    }
}

4. Configuración de Control de Versión

Inicialice Git en su directorio de proyecto y cree un .gitignore archivo para excluir archivos innecesarios. Aquí hay un ejemplo .gitignore:

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

Una vez que haya completado estos pasos, estará listo para pasar a agregar sus archivos AAR.

Agregar archivos AAR a su plugin

Obtener archivos AAR

Los archivos AAR pueden provenir de SDKs de terceros, bibliotecas personalizadas o dependencias de Maven. Es una buena idea documentar su origen, versión y propósito en un README __CAPGO_KEEP_0__ libs archivo ubicado en el

Una vez que estén listos y documentados tus archivos AAR, puedes configurar tu plugin para que los incluya.

Configuración de Archivos de Plugin

Organiza tus archivos de plugin para asegurar una integración suave de dependencias AAR. Aquí tienes un ejemplo de cómo podría estructurarse tu plugin:

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

Ubicación de Archivos AAR

Para habilitar la funcionalidad AAR, coloca los archivos en el android/libs directorio de tu plugin siguiendo estos pasos:

• Utiliza un formato de nombres claro y consistente, como libraryname-version.aar.
• Administra versiones en un versions.properties archivo. Por ejemplo:

library1=1.2.3
library2=2.0.0

• Agregar un archivo para otras dependencias: dependencies.gradle Organizar archivos específicos de proveedor en subdirectorios para una mejor gestión:

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

• Mantener archivos de configuración en subdirectorios específicos de proveedor ayuda a mantener la organización y evita conflictos de compilación al trabajar con múltiples dependencias AAR:

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

Para mantener la organización y evitar conflictos de compilación al trabajar con múltiples dependencias AAR, es recomendable mantener los archivos de configuración en subdirectorios específicos de proveedor:

Gradle Pasos de configuración

Actualizar build.gradle

Para integrar archivos AAR en tu plugin Capacitor, debes configurar Gradle adecuadamente. Comienza agregando estos ajustes de repositorio a android/build.gradle:

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

Luego, incluye las dependencias AAR en el dependencies bloque:

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

Para una mejor gestión de versiones, crea un gradle.properties archivo en la raíz de tu proyecto y define las versiones de tu biblioteca:

# Library versions
MY_LIBRARY_VERSION=1.2.3
CAPACITOR_VERSION=5.5.0

Si el archivo AAR viene con dependencias adicionales, decláralas en android/build.gradle de la siguiente manera:

android {
    defaultConfig {
        minSdkVersion 21
        targetSdkVersion 33
    }

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

Una vez que hayas realizado estos cambios, sincroniza tu proyecto para aplicarlos.

Ejecutar Sincronización de Gradle

Abre tu proyecto en Android Studio y espera a que Gradle se sincronice automáticamente. Si no comienza, haz clic en el botón "Sincronizar proyecto con archivos de Gradle" en la barra de herramientas.

Después de sincronizar, verifica lo siguiente:

Si la sincronización falla, revisa tu configuración. Por ejemplo, asegúrate de que estos ajustes estén en su lugar:

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

    lintOptions {
        abortOnError false
    }
}

Para archivos AAR grandes, es posible que debas aumentar la asignación de memoria de Gradle en gradle.properties:

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

Una vez que la sincronización se complete con éxito, tus archivos AAR deberían estar completamente integrados y listos para la prueba.

Conectando características de AAR a Capacitor

Escribiendo la clase del plugin

Una vez que se sincronizan los archivos Gradle, es hora de conectar la funcionalidad de AAR extendiendo la clase Plugin Este paso vincula JavaScript con el Android nativo 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());
    }
}

Aquí está lo que necesitas para inicializar la biblioteca de AAR:

Crear métodos de plugin

A continuación, define métodos en tu plugin utilizando la @PluginMethod anotación. Estos métodos manejan el intercambio de datos entre JavaScript y 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);
    }
}

Para tareas que necesitan ejecutarse de manera asíncrona:

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

Aquí se muestra cómo se convierten los tipos comunes entre JavaScript y Java:

Para la limpieza de recursos, sobreescriba el handleOnDestroy método:

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

Con estos métodos en su lugar, su puente nativo está listo. Pruebe su implementación en el entorno de depuración de Android Studio para asegurarse de que todo funciona como se espera.

Pruebas y solución de problemas de problemas

Depuración en Android Studio

Para depurar su integración de AAR en Android Studio, comience habilitando el modo de depuración en el archivo build.gradle archivo:

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

Agregue puntos de interrupción en sus métodos de plugin para seguir el flujo de datos y identificar posibles problemas:

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

Use la pestaña de depuración de Android Studio para monitorear áreas clave:

Si la depuración no resuelve el problema, sigue los pasos de depuración en la sección siguiente.

Pasos de depuración

Cuando la depuración sola no es suficiente, utiliza estos pasos para abordar problemas comunes:

1. Conflictos de dependencias

Revisa conflictos de versiones en tu build.gradle archivo. Puedes forzar versiones específicas para resolver conflictos:

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

2. Bibliotecas nativas faltantes

Asegúrate de que el AAR incluya los archivos requeridos .so en los directorios adecuados, como:

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

3. Problemas con la fusión del manifiesto

Si encuentra conflictos de manifiesto, incluya lo siguiente en su archivo para superar bibliotecas problemáticas: AndroidManifest.xml 4. Ralentizaciones y Gestión de Memoria

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

Utilice la pestaña de rendimiento en Android Studio para monitorear la estabilidad de tiempo de ejecución. Para problemas de inicialización, maneje excepciones con cuidado:

Para prevenir fugas de memoria, asegúrese de que los recursos se liberan correctamente. Utilice el Profilador de Memoria en Android Studio para rastrear el uso de la pila y identificar cualquier fuga.

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

Resumen

Para integrar archivos AAR en plugins de __CAPGO_KEEP_0__, necesitará configurar el entorno de Android, colocar archivos AAR correctamente, configurar Gradle con precisión y probar exhaustivamente.

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

Una vez que hayas dominado estos conceptos básicos, puedes explorar técnicas más avanzadas.

Pasos siguientes

Para mejorar tu plugin, enfócate en estas áreas:

• Optimización de rendimiento
  Utiliza el perfilador de Android Studio para monitorear el uso de memoria y asegurarte de que los recursos se limpien correctamente.

• Preparación de distribución
  Documenta todas las configuraciones de AAR, genera API documentación y prueba la compatibilidad con los niveles de Android API 29–34.

• Estrategia de mantenimiento
  Automatiza las pruebas, gestiona las versiones de AAR con control de versiones, mantiene un registro de cambios y configura el informe de errores para abordar problemas de producción.

Si planeas compartir tu plugin públicamente, asegúrate de proporcionar documentación detallada sobre las configuraciones específicas de AAR y cualquier limitación de plataforma. Esto facilitará a otros desarrolladores adoptar y utilizar tu plugin de manera efectiva.