如何在Capacitor插件中添加依赖

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

1. 了解工具:

   • JavaScript: 使用 npm 来管理依赖项。
   • iOS: 使用 或Swift Package Manager (SPM)。 Android
   • : 使用Gradle __CAPGO_KEEP_0__ 依赖管理。

2. 设置您的开发环境:

   • 安装工具如 Node.js, npm, Xcode, Android Studio, CocoaPods, 和 JDK。

3. 开始您的 Capacitor:

   • 插件项目 npm init @capacitor/plugin 使用

4. 添加 JavaScript 依赖项:

   • 使用 npm install 用于生产和开发依赖项。
   • 更新 package.json 以包含像 @capacitor/core.

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

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

6. 优化性能:

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

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

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

工具快速比较:

是吧对义我了一个代理为一个系统机为一个系统机了很给一分我的日期和重起的错起，请使用一个系统机的给计一个一个系统机了很给一分我的日期和重起的错起，请使用一个系统机的给计一个一个系统机了很给一分我的日期和重起的错起，请使用一个系统机的给计一个一个系统机了很给一分我的日期和重起的错起，请使用一个系统机的给计一个一个系统机了很给一分我的日期和重起的错起，请使用一个系统机的给计一个一个系统机了很给一分我的日期和重起的错起平安代理为一个系统机了很给一分我的日期和重起的错起，请使用一个系统机的给计一个一个系统机了很给一分我的日期和重起的错起

代理为一个系统机了很给一分我的日期和重起的错起，请使用一个系统机的给计一个一个系统机了很给一分我的日期和重起的错起 Capacitor 代理为一个系统机了很给一分我的日期和重起的错起，请使用一个系统机的给计一个一个系统机了很给一分我的日期和重起的错起

设置您的开发环境

准备好必要的工具来处理 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!

   • 对于 安卓, 验证您的 build.gradle 包含:

     android {
         compileSdkVersion 33
         defaultConfig {
             minSdkVersion 22
         }
     }

3. 设置环境变量

   为您的开发工具配置以下环境变量:

   变量	目的	示例值
   ANDROID_HOME	安卓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 Setup

首先在 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包依赖

如果您不想使用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依赖项

设置Android依赖项以确保原生集成顺畅。以下是如何为您的Capacitor插件管理依赖项的说明。

Gradle 依赖项

在你的 build.gradle 文件:

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 万次更新，Capgo 允许开发者立即推送依赖项和 Capacitor 的更新 - 无需等待应用商店审查。 [1], Capgo allows developers to push updates for dependencies and code instantly - no app store review required. Updates are secured with end-to-end encryption and meet both Apple and Android compliance standards.

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

Capgo Live Update Dashboard Interface

来源： [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！” - Rodrigo Mantica

Capgo 还提供了一个实时分析仪表板，用于获取更新成功率和用户活动的实时见解。类似于一键回滚和错误跟踪的功能有助于快速解决任何问题，保持您的插件更新顺畅。

结论

过程审查

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

最佳实践

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

使用实时更新工具，如 Capgo，可以进一步简化和改进这些实践，通过实时更新来实现。

Capgo 的好处

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

以下是 Capgo 的性能表现：