Cómo utilizar archivos AAR en plugins de Capacitor

¿Quieres integrar características de Android en tu Capacitor ¿Qué son los AAR? Archivos de biblioteca Android preempaquetados que contienen código, recursos y archivos nativos. Capacitor plugins Los archivos AAR permiten el reutilización de código, simplifican la mantenimiento y protegen características propietarias.

¿Qué se requiere?

• ¿Quieres integrar características de Android en tu aplicación? Pre-packaged Android libraries containing code, resources, and native files.
• Resultados clave: AAR files enable code reuse, simplify maintenance, and protect proprietary features.
• ¿Por qué utilizarlos? Herramientas como Android Studio, Gradle, y Node.js, más una configuración de proyecto adecuada.
• Cómo integrar? Coloque archivos AAR en libsconfigure Gradle y conecte a los módulos Capacitor.

Pasos rápidos:

1. Configuración de entorno: Instale las herramientas necesarias y configure Android Studio.
2. Organiza tu proyecto: Crear una estructura clara para tu Capacitor plugin.
3. Agregar archivos AAR: Colócalos en android/libs y actualiza las dependencias de Gradle.
4. Escrita del plugin code: Enlaza la funcionalidad de AAR con JavaScript con Capacitor’s API.
5. Prueba exhaustivamente: Utiliza el depurador de Android Studio para asegurar una integración suave.

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

How to embed an Android library (AAR file) into a capacitor plugin

Requisitos de configuración de 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 compilació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 de configuración del 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. Configura los ajustes de Android Studio

Lanzar Android Studio y ajustar los siguientes ajustes:

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

3. Preparar la estructura de tu plugin

Actualiza el archivo con estos ajustes para incluir el soporte de archivos AAR: android/build.gradle Configura el control de versiones

android {
    compileSdkVersion 33
    defaultConfig {
        minSdkVersion 22
        targetSdkVersion 33
    }

    repositories {
        flatDir {
            dirs 'libs'
        }
    }
}

4. Inicializa Git en el directorio de tu proyecto y crea un archivo para excluir archivos innecesarios. Aquí tienes un ejemplo:

Una vez que hayas completado estos pasos, estarás listo para pasar a agregar tus archivos AAR. .gitignore Configura el control de versiones .gitignore:

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

Inicializa Git en el directorio de tu proyecto y crea un archivo para excluir archivos innecesarios. Aquí tienes un ejemplo de archivo .gitignore:

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 archivo ubicado en el directorio README Tipo de origen libs Descripción

Una vez que sus archivos AAR estén listos y documentados, puede configurar su plugin para incluirlos.

Configuración de Archivos de Plugin

Organice sus archivos de plugin para garantizar una integración suave de dependencias AAR. Aquí hay un ejemplo de cómo podría verse la estructura de su 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, coloque los archivos en el android/libs directorio de su plugin siguiendo estos pasos:

• Utilice un formato de nombre claro y consistente, como libraryname-version.aar.
• Administrar versiones en un versions.properties archivo. Por ejemplo:

library1=1.2.3
library2=2.0.0

• Agregar un dependencies.gradle archivo para otras dependencias:

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

• Organizar archivos específicos de proveedores en subdirectorios para una mejor gestión:

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

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

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

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 archivo en la raíz de tu proyecto y define las versiones de tus bibliotecas: gradle.properties Si el archivo AAR viene con dependencias adicionales, decláralas de la siguiente manera:

# Library versions
MY_LIBRARY_VERSION=1.2.3
CAPACITOR_VERSION=5.5.0

Una vez que hayas realizado estos cambios, sincroniza tu proyecto para aplicarlos. android/build.gradle Ejecutar Sincronización de Gradle

android {
    defaultConfig {
        minSdkVersion 21
        targetSdkVersion 33
    }

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

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:

Punto de Verificación

Resultado Esperado

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

Escrebiendo la clase del plugin

Una vez que se sincronizan los archivos Gradle, es hora de conectar la funcionalidad de AAR extendiendo la clase Plugin class de plugin. Este paso vincula JavaScript con la aplicación nativa de 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());
    }
}

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 el @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 Resolución 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 de su proyecto: build.gradle Agregar puntos de interrupción en sus métodos de plugin para seguir el flujo de datos y identificar posibles problemas:

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

file

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

Utilice la pestaña de depuración en Android Studio para supervisar áreas clave:

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

Pasos de depuración

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

1. Conflictos de dependencias

Verifica conflictos de versión 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 las bibliotecas nativas requeridas .so archivos en los directorios adecuados, como:

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

3. Problemas con la fusión de manifestos

Si encuentra conflictos de manifestos, incluya lo siguiente en su AndroidManifest.xml archivo para superar bibliotecas problemáticas:

<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. Ralentizaciones del sistema y gestión de memoria

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

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

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

Resumen

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

Fases de Implementación Clave

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.

Sigue adelante desde Cómo utilizar archivos AAR en Capacitor Plugins

If you are using Cómo utilizar archivos AAR en plugins de Capacitor para planificar el trabajo de plugins nativos, conecte con Capgo Directorio de Plugins para el flujo de trabajo del producto en Capgo Directorio de Plugins, Capacitor Plugins por Capgo para los detalles de implementación en Capacitor Plugins por Capgo, Agregar o Actualizar Plugins para los detalles de implementación en Agregar o Actualizar Plugins, Alternativas de Plugins de Ionic Enterprise para el flujo de trabajo del producto en Alternativas de Plugins de Ionic Enterprise, y Capgo Compilaciones Nativas para el flujo de trabajo del producto en Capgo Nativas de compilación.