How to Add Dependencies in Capacitor Plugins

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

1. 了解工具:

   • JavaScript: 使用 npm 来管理依赖项。
   • iOS: 使用 或 Swift Package Manager (SPM)。 Android
   • : 使用Gradle plugins can feel overwhelming, but it’s easier when broken into clear steps. Here’s what you need to know: 为了依赖管理。

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 Capacitor

设置开发环境

为有效管理__CAPGO_KEEP_0__插件的依赖项，准备好必要的工具 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	Android sdk 位置
   /Users/username/Library/Android/__CAPGO_KEEP_0__	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 和 native 平台上都兼容。

管理 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 pluginsiOS 依赖项

本节解释了如何在 __CAPGO_KEEP_0__ 插件中管理本机 iOS 依赖项。 设置

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

cd ios
pod init

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

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

初始化CocoaPods后，配置Podfile以包含__CAPGO_KEEP_0__和任何额外的第三方库:

After initializing CocoaPods, configure the Podfile to include Capacitor and any additional third-party libraries:

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")
]

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

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 中设置依赖项以确保原生集成的顺畅。以下是如何管理您的 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与native和JavaScript依赖管理一起使用，可以更快更容易地更新您的插件

关于Capgo

Capgo是一款实时更新平台，专为Capacitor插件和应用程序设计。该平台已成功为750个生产应用程序推送超过2,350万次更新 [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！”- Rodrigo Mantica

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

结论

流程审查

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

最佳实践

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

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

Capgo 优势

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

以下是 Capgo 的性能表现：

继续阅读如何在Capacitor插件中添加依赖

如果您正在使用 如何在Capacitor插件中添加依赖 计划原生插件工作时，连接它与 Capgo插件目录 Capgo插件目录中的产品工作流程 Capacitor插件由Capgo Capacitor插件的实现细节由Capgo 添加或更新插件 添加或更新插件的实现细节 Ionic Enterprise Plugin Alternatives 为 Ionic Enterprise Plugin Alternatives 的产品工作流程 Capgo 原生构建 为 Capgo 原生构建 的产品工作流程