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

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

1. 了解工具:

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

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 或 SwiftJSON.
   • Android: 使用Gradle添加依赖项，如Gson或AppCompat。

6. 优化性能:

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

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

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

工具快速比较:

Why it matters：有效地管理依赖项确保您的插件在各个平台上顺畅运行，节省时间并避免错误。让我们深入了解步骤。

How to create a 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 SDK location	/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

确保手动包含依赖项的同伴文件。测试所有依赖项以确认在Web和本机平台上兼容性。 package.json 管理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 依赖项

本节解释了如何在 __CAPGO_KEEP_0__ 插件中管理原生 iOS 依赖项 Capacitor plugins设置好 JavaScript 依赖后，下一步就是处理原生 iOS 依赖。

CocoaPods 设置

CocoaPods

cd ios
pod init

首先，在 iOS 目录中初始化 CocoaPods： 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'
    }
}

在项目级别

Repository Configuration

In your project-level 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允许开发人员无需app store审查即可推送依赖项和code的更新。更新使用端到端加密并符合苹果和安卓的合规标准

Capgo 更新特性

Capgo 简化了管理插件依赖项的这些功能:

来源： [1]

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

设置Capgo

以下是将Capgo集成到您的项目中的步骤：

1. 安装CapgoCLI

   在终端中运行以下命令：

   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();

“We practice agile development and @Capgo is mission-critical in delivering continuously to our users!” - Rodrigo Mantica

“我们实践敏捷开发，@Capgo 在持续交付给用户方面是 mission-critical!” - Rodrigo Mantica

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

结论

Managing dependencies for Capacitor plugins involves aligning the native components (iOS and Android) with their JavaScript counterparts to ensure smooth integration. This process includes platform-specific setups and managing JavaScript packages to achieve the best performance. Following the outlined steps will help maintain stable and efficient plugin functionality.

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

最佳实践

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

Capgo 的好处

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

以下是 Capgo 的性能表现:

Keep going from How to Add Dependencies in Capacitor Plugins

如果您正在使用 How to Add Dependencies in Capacitor Plugins 来规划原生插件工作，连接它与 Capgo 插件目录 为 Capgo 插件目录中的产品工作流程 Capacitor 插件由 Capgo 为 Capacitor 插件由 Capgo 的实现细节 添加或更新插件 添加或更新插件的实现细节 Ionic 企业插件替代品 了解Ionic 企业插件替代品的产品工作流程 Capgo 原生构建 了解Capgo 原生构建的产品工作流程