如何在 Capacitor 插件中添加依赖项

添加依赖项到 Capacitor 插件可能会让人感到混乱，但当分解为清晰的步骤时会更容易。您需要了解以下内容：

1. 了解工具:

   • JavaScript: 使用 npm 管理依赖项。
   • iOS使用 Capgo CocoaPods 或使用 Swift Package Manager (SPM)。
   • 安卓使用 Capgo Gradle 依赖管理。

2. 设置开发环境:

   • 安装像 Node.js, npm, Xcode、Android Studio、CocoaPods和JDK。, 开始你的__CAPGO_KEEP_0__插件项目

3. 使用 Capacitor plugin project:

   • 添加JavaScript依赖项 npm init @capacitor/plugin 使用

4. 生产和开发依赖项。:

   • 更新 npm install 包括像
   • 的同级依赖项 package.json 使用 @capacitor/core.

5. 处理平台特定的依赖项:

   • iOS: 使用 CocoaPods 或 SPM 配置类似于 Alamofire 或 SwiftyJSON.
   • Android: 使用 Gradle 添加依赖项，如 Gson 或 AppCompat。

6. 优化性能:

   • 固定版本、审计依赖项并解决冲突以确保稳定性。

7. 使用工具如 Capgo 实时更新:

   • 无需等待应用商店审核即可即刻推送更新。

工具快速比较:

为什么它很重要:有效地管理依赖项确保您的插件在各个平台上顺畅运行，节省时间并避免错误。让我们深入了解步骤。

如何创建一个 Capacitor iOS/Android

设置您的开发环境

为处理 Capacitor 插件 依赖项有效地。

必备开发工具

以下是您需要的工具列表：

开始一个新插件

使用 Capacitor CLI 来启动您的插件项目。包括设置平台和使用反向域名格式命名您的插件（例如， com.mycompany.plugin):

1. 运行以下命令：
   npm init @capacitor/plugin
2. 选择您的目标平台（iOS/Android）。
3. 为您的插件分配一个反向域名格式的名称。

项目设置步骤

1. 更新 package.json

   修改您的 package.json 以包含以下内容:

   {
     "capacitor": {
       "ios": {
         "src": "ios"
       },
       "android": {
         "src": "android"
       }
     },
     "peerDependencies": {
       "@capacitor/core": "^5.0.0"
     }
   }

2. 平台特定设置

   • 对于 现在iOS, 确保您的Podfile包含:

     platform :ios, '13.0'
     use_frameworks!

   • 对于 现在Android, 验证您的 build.gradle 包含:

     android {
         compileSdkVersion 33
         defaultConfig {
             minSdkVersion 22
         }
     }

3. 设置请求参数的请求参数

   设置请求参数的为一个请求参数的请求参数

   变量	目的	示例值
   ANDROID_HOME	Android SDK 安装位置	/Users/username/Library/Android/sdk
   JAVA_HOME	JDK 安装路径	/Library/Java/JavaVirtualMachines/jdk-11.0.12.jdk/Contents/Home
   XCODE_SELECT	Xcode 命令行工具	/Applications/Xcode.app/Contents/Developer

您的项目设置好后，您就可以开始管理 JavaScript 依赖项了。

JavaScript 依赖项

有效地管理 JavaScript 依赖项是保持插件性能稳定的关键。

npm 包安装

要安装依赖项，请使用以下命令：

# Add a production dependency
npm install lodash --save

# Add a development dependency
npm install @types/lodash --save-dev

确保手动在文件中包含依赖项的同伴。 package.json 测试所有依赖项以确认其在 Web 和本机平台上都兼容。

管理 package.json

以下是一个示例 package.json 配置：

{
  "name": "my-capacitor-plugin",
  "version": "1.0.0",
  "dependencies": {
    "lodash": "^4.17.21"
  },
  "devDependencies": {
    "@types/lodash": "^4.14.195",
    "@capacitor/core": "^5.0.0"
  },
  "peerDependencies": {
    "@capacitor/core": "^5.0.0"
  }
}

为了保持一致性，请适当锁定依赖项版本:

使用 JavaScript 库

当导入库时，应关注减少打包大小：

// Import only the required function
import { isEqual } from 'lodash';

export class MyPlugin {
  async compare(options: { value1: any, value2: any }): Promise<boolean> {
    return isEqual(options.value1, options.value2);
  }
}

另外，请确保正确处理错误处理和类型检查：

import { Plugin } from '@capacitor/core';
import { validate } from 'your-validation-library';

@Plugin({
  name: 'MyPlugin',
  platforms: ['web', 'ios', 'android']
})
export class MyPlugin {
  async validateData(data: unknown): Promise<void> {
    try {
      if (!validate(data)) {
        throw new Error('Invalid data format');
      }
      // Continue processing if valid
    } catch (error) {
      throw new Error(`Validation failed: ${error.message}`);
    }
  }
}

接下来，了解如何处理 iOS 平台特定的依赖项。

iOS 依赖项

本节解释了如何管理本机 iOS 依赖项在 Capacitor插件。 一旦您设置了 JavaScript 依赖项，下一步就是处理本机 iOS 依赖项。

CocoaPods 设置

首先，在 iOS 目录中初始化 CocoaPods：

cd ios
pod init

然后，更新 Plugin.podspec 文件中的以下配置：

Pod::Spec.new do |s|
  s.name = 'MyCapacitorPlugin'
  s.version = '1.0.0'
  s.summary = 'Your plugin description'
  s.platform = :ios, '13.0'
  s.dependency 'Capacitor'
  # Include your iOS dependencies here
  s.dependency 'Alamofire', '~> 5.6.4'
end

Podfile 配置

在初始化 CocoaPods 后，配置 Podfile 以包含 Capacitor 和任何其他第三方库：

platform :ios, '13.0'
use_frameworks!

def capacitor_pods
  pod 'Capacitor', :path => '../../node_modules/@capacitor/ios'
  pod 'CapacitorCordova', :path => '../../node_modules/@capacitor/ios'
end

target 'Plugin' do
  capacitor_pods
  # Add third-party dependencies
  pod 'KeychainAccess', '~> 4.2.2'
  pod 'SwiftyJSON', '~> 5.0.1'
end

target 'PluginTests' do
  capacitor_pods
end

以下是常见的依赖项配置模式：

Swift Package Dependencies

如果您不想使用CocoaPods，Swift Package Manager（SPM）是一个不错的替代方案。您可以直接在Xcode中使用SPM依赖项，配置如下： Package.swift 文件：

// Package.swift
dependencies: [
    .package(url: "https://github.com/Alamofire/Alamofire.git", .upToNextMajor(from: "5.6.4")),
    .package(url: "https://github.com/SwiftyJSON/SwiftyJSON.git", from: "5.0.1")
]

要在您的插件code中使用SPM依赖项，请导入它们并根据需要进行集成。例如：

import Capacitor
import Alamofire

@objc(MyPlugin)
public class MyPlugin: CAPPlugin {
    @objc func makeRequest(_ call: CAPPluginCall) {
        AF.request("https://api.example.com/data").response { response in
            // Process the response
            call.resolve([
                "data": response.data
            ])
        }
    }
}

这种方法允许您根据项目需求选择CocoaPods和Swift Package Manager。

Android Dependencies

Set up Android dependencies to ensure smooth native integration. Here’s how to manage dependencies for your Capacitor plugin.

Gradle 依赖项

将以下配置添加到您的文件： build.gradle file:

android {
    defaultConfig {
        minSdkVersion 22
        targetSdkVersion 33
    }
}

dependencies {
    implementation "androidx.appcompat:appcompat:1.6.1"
    implementation "com.google.code.gson:gson:2.10.1"
    implementation "org.jetbrains.kotlin:kotlin-stdlib:1.8.20"
    implementation project(':capacitor-android')
}

在此处定义额外的版本 buildscript 块：

buildscript {
    ext {
        androidxCoreVersion = '1.10.1'
        kotlinVersion = '1.8.20'
    }
}

一旦依赖项配置完成，请确保设置必要的仓库

仓库配置

在项目级别 build.gradle，包括所需的Maven仓库：

allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url "https://jitpack.io" }
    }
}

如果您正在使用自定义或私有Maven仓库，请像这样添加凭据

maven {
    url "https://maven.example.com/releases"
    credentials {
        username = project.findProperty("mavenUsername") ?: System.getenv("MAVEN_USERNAME")
        password = project.findProperty("mavenPassword") ?: System.getenv("MAVEN_PASSWORD")
    }
}

配置仓库后，解决可能出现的依赖项冲突

修复兼容性问题

要处理依赖项冲突，请在您的 build.gradle:

configurations.all {
    resolutionStrategy {
        force "org.jetbrains.kotlin:kotlin-stdlib:1.8.20"
        force "androidx.core:core-ktx:1.10.1"
    }
}

中应用版本解析

例如，您可以像这样排除冲突模块：

dependencies {
    implementation('library:name:1.0.0') {
        exclude group: 'com.conflicting.dependency'
    }
}

最后，通过启用缓存和并行执行来优化您的构建过程： gradle.properties:

org.gradle.caching=true
org.gradle.parallel=true
org.gradle.jvmargs=-Xmx2048m

Capgo 集成

使用 Capgo 与原生和 JavaScript 依赖管理一起使用，更新您的插件会更快更容易。

关于 Capgo

Capgo 是一个为 Capacitor 插件和应用程序设计的实时更新平台。通过超过 750 个生产应用程序的 23.5 万次更新 [1]Capgo 允许开发人员无需等待应用商店审查即可推送依赖项和 code 的更新。更新使用端到端加密并符合苹果和安卓的合规标准。

Capgo 实时更新功能

Capgo 使用以下功能简化管理插件依赖项：

来源： [1]

Capgo与CI/CD工具如GitHub Actions、GitLab CI和Jenkins无缝集成，自动更新依赖项并确保插件版本的一致性。这些工具使得将Capgo集成到您的工作流程中变得更加容易。

设置 Capgo

请按照以下步骤将 Capgo 集成到您的项目中:

1. 安装 Capgo 的 CLI

   在终端中运行以下命令:

   npx @capgo/cli init

2. 配置更新偏好

   使用 Capgo 控制台来设置部署通道和偏好。支持云托管和自托管配置。

3. 添加更新逻辑

   将此 code 添加到您的主插件文件中以启用更新:

   import { Capgo } from '@capgo/capacitor-updater';
   
   // Initialize Capgo
   const capgo = new Capgo({
     appId: 'YOUR_APP_ID',
     channel: 'production'
   });
   
   // Check for updates
   await capgo.checkForUpdate();

“我们实践敏捷开发，@Capgo 在持续交付给用户方面是 mission-critical 的！” - 罗德里戈·曼蒂卡

Capgo 还提供了一个实时分析仪表板，用于查看更新成功率和用户活动的实时指标。功能如一键回滚和错误跟踪有助于快速解决任何问题，使您的插件更新顺利进行。

结论

流程审查

为 Capacitor 插件管理依赖项涉及将原生组件 (iOS 和 Android) 与 JavaScript 对应项对齐，以确保平滑的集成。这个过程包括平台特定的设置和管理 JavaScript 包以实现最佳性能。按照以下步骤将有助于维持稳定和高效的插件功能。

最佳实践

要有效地管理依赖项，请考虑以下实践：

Capgo 可以通过实时更新简化和改进这些实践。

Capgo Benefits

Capgo 简化依赖项管理过程，同时提供强大的性能。它实现了令人印象深刻的 95% 用户更新率在 24 小时内 并维持全球 API 响应时间 434ms [1]通过端到端加密，确保更新符合苹果和安卓的指南。对于管理多个插件版本的团队，Capgo的频道系统允许针对特定用户组的部署。

快速浏览一下Capgo的性能：