如何在Capacitor插件中使用AAR文件

想在您的web应用中 Capacitor app? 本指南解释了如何在 Capacitor 插件

中使用 AAR (Android Archive) 文件

• 将原生 Android 功能与跨平台 web 应用结合起来。 Pre-packaged Android libraries containing code, resources, and native files.
• 什么是 AAR 文件? 预先打包的 Android 库，包含 code、资源和原生文件。
• 为什么要使用它们? AAR 文件使 __CAPGO_KEEP_0__ 重用变得简单，简化了维护，并保护了专有功能。 需要什么?, Gradle和 Node.js,并且需要正确的项目设置。
• 如何进行集成？ 在项目中添加 AAR 文件 libs在 Gradle 中配置，并连接到 Capacitor 插件。

快速步骤：

1. 设置环境： 安装所需工具并配置 Android Studio。
2. 组织你的项目： 建立清晰的结构来组织你的 Capacitor 插件.
3. 添加 AAR 文件： 将它们放置在 android/libs 并更新 Gradle 依赖项。
4. 编写插件 code: 将 AAR 功能与 JavaScript 链接起来使用 Capacitor 的 API.
5. 进行彻底的测试： 使用 Android Studio 的调试器确保平滑的整合。

按照本指南，您可以无缝地将 AAR 文件嵌入到 Capacitor 插件中，从而为您的 web 应用开启 native Android 能力。

如何将 Android 库（AAR 文件）嵌入到 capacitor 插件

开发环境配置要求

在处理 AAR 文件之前，请确保您的开发环境已正确配置，以避免出现任何问题。

所需软件

以下是您需要在 Capacitor 插件中处理 AAR 文件所需的软件:

另外，请确保以下组件包含在您的SDK管理器中：

• Android SDK 平台 33 (Android 13.0)
• Android SDK 构建工具 33.0.0
• Android SDK 命令行工具
• Android 模拟器
• Android SDK 平台工具

项目设置步骤

1. 初始化您的开发环境

首先，创建一个新目录，结构如下：

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

2. 配置 Android Studio 设置

启动 Android Studio 并调整以下设置：

• 设置 Gradle JDK 至 11 或更高版本。
• 为 Android SDK 组件启用自动下载功能。
• 更新系统环境变量以包含正确的 Android SDK 路径。

3. 准备您的插件结构

更新 android/build.gradle 文件以包含 AAR 文件支持：

android {
    compileSdkVersion 33
    defaultConfig {
        minSdkVersion 22
        targetSdkVersion 33
    }

    repositories {
        flatDir {
            dirs 'libs'
        }
    }
}

4. 设置版本控制

在项目目录中初始化 Git 并创建一个 .gitignore 文件以排除不必要的文件。以下是示例 .gitignore:

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

完成这些步骤后，您将准备好添加 AAR 文件。

在插件中添加 AAR 文件

获取 AAR 文件

AAR文件可以来自第三方 SDK、自定义库或 Maven 依赖。建议在文件夹中记录它们的来源、版本和目的 README __CAPGO_KEEP_0__ libs __CAPGO_KEEP_0__

一旦您的AAR文件准备就绪并且已文档化，您就可以配置插件以包含它们。

设置插件文件

组织您的插件文件以确保AAR依赖项的顺利集成。以下是您的插件结构可能看起来的示例：

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

AAR文件位置

要启用AAR功能，请将文件放在 android/libs 目录中的您的插件，按照以下步骤：

• 使用清晰一致的命名格式，例如 libraryname-version.aar.
• 在 versions.properties 文件中管理版本。例如：

library1=1.2.3
library2=2.0.0

• 添加一个 dependencies.gradle 为其他依赖项添加文件：

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

• 将供应商特定的文件组织到子目录中以便更好的管理：

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

将配置文件放在供应商特定的子目录中有助于保持组织结构并避免在处理多个AAR依赖项时出现的构建冲突。

Gradle 配置步骤

更新build.gradle

为了将AAR文件集成到Capacitor插件中，您需要适当配置Gradle。首先，请在添加这些仓库设置中： android/build.gradle:

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

然后，在块中包含AAR依赖项： dependencies 为了更好的版本管理，请创建一个

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

For better version management, create a __CAPGO_KEEP_0__ file for other dependencies: gradle.properties 在你的项目根目录下创建一个文件并定义你的库版本:

# Library versions
MY_LIBRARY_VERSION=1.2.3
CAPACITOR_VERSION=5.5.0

如果 AAR 文件包含额外的依赖项，请在这里声明它们: android/build.gradle 如上所示:

android {
    defaultConfig {
        minSdkVersion 21
        targetSdkVersion 33
    }

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

完成这些更改后，同步你的项目以应用它们。

运行 Gradle Sync

在 Android Studio 中打开你的项目并等待 Gradle 自动同步。如果它没有启动，请点击工具栏上的“Sync Project with Gradle Files”按钮。

同步后，请检查以下内容:

如果同步失败，请检查您的配置。例如，请确保这些设置处于以下位置：

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

    lintOptions {
        abortOnError false
    }
}

对于大型 AAR 文件，您可能需要增加 Gradle 的内存分配 gradle.properties:

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

同步完成后，AAR 文件应该完全集成并准备好测试

将 AAR 特性连接到 Capacitor

编写插件类

一旦 Gradle 文件同步完成，接下来就是连接 AAR 功能的时间了。通过扩展 Plugin 类来实现这一步，JavaScript 与原生 Android 的关联就建立了。 初始化 AAR 库所需的内容是： 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());
    }
}

目的

创建插件方法

接下来，在您的插件中使用注解定义方法。这些方法处理JavaScript和Java之间的数据交换。 @PluginMethod 需要异步运行的任务:

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

以下是JavaScript和Java之间常见类型的转换方式:

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

JavaScript类型

资源清理，重写 handleOnDestroy __CAPGO_KEEP_0__：

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

这些方法配置完成后，原生桥接就准备好了。测试您的实现在 Android Studio 的调试环境中，以确保一切正常工作。

测试和修复问题

在 Android Studio

要在 Android Studio 中调试 AAR 集成，首先在您的项目中启用调试模式： build.gradle __CAPGO_KEEP_0__：

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

在插件方法中添加断点，以跟踪数据流并识别潜在问题：

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

在 Android Studio 的 Debug 面板中监控关键区域：

如果调试无法解决问题，请按照下一节的故障排除步骤进行。

故障排除步骤

当单纯的调试不足以解决问题时，请使用以下步骤来解决常见问题：

1.依赖项冲突

检查您的 build.gradle 文件中是否存在版本冲突。您可以强制使用特定版本来解决冲突：

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

2.缺失的本机库

确保AAR包含所需的 .so 文件，例如：

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

3.清单合并问题

如果您遇到清单冲突，请在文件中包含以下内容以覆盖问题库： AndroidManifest.xml 4. 运行时崩溃和内存管理

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

在 Android Studio 中使用 Performance tab 监视运行时稳定性。对于初始化问题，务必小心处理异常：

为了防止内存泄漏，确保资源被正确释放。使用 Android Studio 中的 Memory Profiler 跟踪堆使用情况并识别任何泄漏。

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

概要

要将 AAR 文件集成到 __CAPGO_KEEP_0__ 插件中，您需要设置 Android 环境、正确放置 AAR 文件、准确配置 Gradle 以及进行彻底的测试。

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.

阶段

掌握这些基础后，你可以探索更高级的技术

下一步

为了提高插件的性能，重点关注以下方面：

• 性能优化
  使用 Android Studio 的 profiler 监控内存使用情况并确保资源被清理干净。

• 发布准备
  记录所有 AAR 配置，生成 API 文档，并测试与 Android API 29–34 版本的兼容性。

• 维护策略
  自动化测试，使用版本控制管理 AAR 版本，维护更改日志，并设置错误报告以解决生产问题。

如果您打算公开分享您的插件，请确保提供详细的 AAR 特定设置和任何平台限制的文档。这将使其他开发者更容易采用和使用您的插件。