Zum Hauptinhalt springen

Wie man Abhängigkeiten in Capacitor-Plugins hinzufügt

Lernen Sie, die Abhängigkeitsverwaltung in Capacitor-Plugins über Plattformen zu optimieren, mit praktischen Schritten und Best Practices.

Wie man Abhängigkeiten in Capacitor-Plugins hinzufügt

__CAPGO_KEEP_0__ Capacitor Plugins können sich überwältigend anfühlen, aber es ist einfacher, wenn man sie in klare Schritte aufteilt. Hier ist, was Sie wissen müssen:

  1. Verstehen Sie die Werkzeuge:

    • JavaScript: Verwenden Sie npm um Abhängigkeiten zu verwalten.
    • iOS: Verwenden Sie CocoaPods oder Swift Package Manager (SPM).
    • Android: Verwenden Sie Gradle für die Abhängigkeitsverwaltung.
  2. Konfigurieren Sie Ihre Entwicklungsumgebung:

  3. Starten Sie Ihr Capacitor-Plugin-Projekt:

    • Verwenden Sie npm init @capacitor/plugin um ein neues Plugin zu erstellen.
  4. Fügen Sie JavaScript-Abhängigkeiten hinzu:

    • Verwenden Sie npm install zur Verwendung von Produktions- und Entwicklungsabhängigkeiten.
    • aktualisieren Sie package.json um Peer-Abhängigkeiten wie @capacitor/core.
  5. Behandeln Sie plattformabhängige Abhängigkeiten:

  6. Leistung optimieren:

    • Pins setzen, Abhängigkeiten überprüfen und Konflikte lösen, um Stabilität sicherzustellen.
  7. Verwenden Sie Werkzeuge wie Capgo live Updates:

    • Updates sofort ohne App-Store-Überprüfung pushen.

Schnelle Vergleich der Werkzeuge:

Plattform Werkzeug Beispiel-Abhängigkeit
JavaScript npm npm install lodash --save
iOS CocoaPods/SPM pod 'Alamofire', '~> 5.6.4'
Android Gradle implementation 'com.google.code.gson:gson:2.10.1'

Warum es wichtig ist: Effektive Abhängigkeitsverwaltung sichert die reibungslose Funktion Ihres Plugins auf allen Plattformen, spart Zeit und vermeidet Fehler. Lassen Sie uns tiefer in die Schritte eintauchen.

Wie Sie ein Capacitor Plugin für iOS/Android erstellen

Capacitor Framework Dokumentationswebsite

Entwicklungsumgebung einrichten

Vorbereiten Sie Ihre Umgebung mit den notwendigen Werkzeugen, um Capacitor-Plugin Abhängigkeiten effektiv zu handhaben.

Erforderliche Entwicklertools

Hier ist eine Liste der erforderlichen Werkzeuge:

Tool Version Zweck
Node.js 16.0.0+ JavaScript-Umgebung
npm 8.0.0+ Paketverwaltung
Xcode 14.0+ iOS-Entwicklung (nur Mac)
Android Studio Electric Eel+ Android-Entwicklung
CocoaPods 1.11.0+ iOS-Abhängigkeitsverwaltung
JDK 11+ Android-Build-Tools

Ein neues Plugin erstellen

Verwenden Sie die Capacitor CLI zum Starten Ihres Plugin-Projekts. Dies umfasst die Einrichtung von Plattformen und die Namensgebung Ihres Plugins mit einem rückwärtsgeordneten Domänenformat (z.B. com.mycompany.plugin):

  1. Führen Sie folgenden Befehl aus:
    npm init @capacitor/plugin
  2. Wählen Sie Ihre Zielplattformen (iOS/Android).
  3. Zuweisen Sie einem Namen für Ihr Plugin im umgekehrten Domänenformat.

Projekt-Einrichtungsschritte

  1. Aktualisieren package.json

    Ändern Sie Ihren package.json um Folgendes zu enthalten:

    {
      "capacitor": {
        "ios": {
          "src": "ios"
        },
        "android": {
          "src": "android"
        }
      },
      "peerDependencies": {
        "@capacitor/core": "^5.0.0"
      }
    }
  2. Plattform-spezifische Einrichtung

    • Für iOS, stellen Sie sicher, dass Ihr Podfile Folgendes enthält:

      platform :ios, '13.0'
      use_frameworks!
    • Für Android, überprüfen Sie Ihren build.gradle enthält:

      android {
          compileSdkVersion 33
          defaultConfig {
              minSdkVersion 22
          }
      }
  3. Umgebungsvariablen einrichten

    Konfigurieren Sie die folgenden Umgebungsvariablen für Ihre Entwicklungstools:

    Variablenname Zweck Beispielwert
    ANDROID_HOME Standort von Android SDK /Users/username/Library/Android/sdk
    JAVA_HOME JDK-Installationspfad /Library/Java/JavaVirtualMachines/jdk-11.0.12.jdk/Contents/Home
    XCODE_SELECT Xcode-Befehlszeilenwerkzeuge /Applications/Xcode.app/Contents/Developer

Einmal Ihr Projekt eingerichtet ist, sind Sie bereit, sich auf die Verwaltung von JavaScript-Abhängigkeiten zu konzentrieren.

JavaScript-Abhängigkeiten

Die effektive Verwaltung von JavaScript-Abhängigkeiten ist entscheidend für die Gewährleistung einer stabilen Plugin-Leistung.

npm Paketinstallation

npm

Um Abhängigkeiten zu installieren, verwenden Sie die folgenden Befehle:

# Add a production dependency
npm install lodash --save

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

Stellen Sie sicher, dass Sie die Abhängigkeiten von Peer-Abhängigkeiten manuell in Ihrem Datei einbeziehen. package.json Testen Sie alle Abhängigkeiten, um die Kompatibilität auf beiden Web- und Native-Plattformen zu bestätigen.

Verwalten von package.json

Hier ist ein Beispiel package.json Konfiguration:

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

Um Konsistenz zu gewährleisten, sollten Sie die Versionsnummern von Abhängigkeiten entsprechend festlegen:

Abhängigkeits-Typ Beispiel Verwendungszweck
Genau “5.0.0” Für kritische Abhängigkeiten, die eine bestimmte Version erfordern
Caret “^5.0.0” Ermöglicht kleine Updates und Patches
Tilde “~5.0.0” Beschränkt Updates auf Patches nur

Verwendung von JavaScript-Bibliotheken

Wenn Sie Bibliotheken importieren, konzentrieren Sie sich darauf, die Größe des Bundles zu reduzieren:

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

Stellen Sie außerdem sicher, dass Sie Fehlerbehandlung und Typüberprüfung ordnungsgemäß durchführen:

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

Als Nächstes erfahren Sie, wie Sie Plattform-spezifische Abhängigkeiten für iOS handhaben.

iOS-Abhängigkeiten

In dieser Abschnitt wird erklärt, wie Sie native iOS-Abhängigkeiten in __CAPGO_KEEP_0__-Plugins verwalten. Capacitor pluginsErmöglicht kleine Updates und Patches

iOS-Abhängigkeiten Einrichtung

CocoaPods

Beginnen Sie mit der Initialisierung von CocoaPods in Ihrem iOS-Verzeichnis:

cd ios
pod init

Dann aktualisieren Sie Ihr Plugin.podspec Dokument mit den folgenden Konfigurationen:

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

Nach der Initialisierung von CocoaPods konfigurieren Sie das Podfile, um Capacitor und weitere dritte Bibliotheken einzuschließen:

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

Hier sind einige häufige Abhängigkeitskonfigurationsmuster:

Beschränkungstyp Beispiel Verwendungsfall
genauer Version pod 'KeychainAccess', '4.2.2' When genauere Kontrolle erforderlich ist, wie bei Sicherheitskomponenten
Kleine Version pod 'Alamofire', '~> 5.6' Für stabile APIs, die möglicherweise Patch-Updates erhalten
Hauptversion pod 'SwiftyJSON', '> 5.0' Wenn Flexibilität bei Updates akzeptabel ist

Abhängigkeiten von Swift-Paketen

Wenn Sie CocoaPods nicht verwenden möchten, ist der Swift Package Manager (SPM) eine gute Alternative. Fügen Sie SPM-Abhängigkeiten direkt in Xcode mit der folgenden Konfiguration in Ihrem Package.swift Datei:

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

Um SPM-Abhängigkeiten in Ihrem Plugin code zu verwenden, importieren Sie sie und integrieren Sie sie wie erforderlich. Zum Beispiel:

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

Diese Methode ermöglicht es Ihnen, zwischen CocoaPods und Swift Package Manager basierend auf Ihren Projektanforderungen zu wählen.

Abhängigkeiten für Android

Stellen Sie die Abhängigkeiten für Android ein, um eine glatte native Integration sicherzustellen. Hier erfahren Sie, wie Sie die Abhängigkeiten für Ihr Capacitor-Plugin verwalten können.

Gradle Abhängigkeiten

Gradle Build Tool Interface

Fügen Sie die folgenden Konfigurationen in Ihrem build.gradle Datei:

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')
}

Definieren Sie zusätzliche Versionen im buildscript Block:

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

Sobald Abhängigkeiten konfiguriert sind, stellen Sie sicher, dass Sie die notwendigen Repositories einrichten.

Repository-Konfiguration

In Ihrem Projekt-Level build.gradle, einschließen Sie die erforderlichen Maven-Repositories:

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

Wenn Sie benutzerdefinierte oder private Maven-Repositories verwenden, fügen Sie wie folgt Anmeldeinformationen hinzu:

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

Mit den Repositories eingerichtet, beheben Sie etwaige Abhängigkeitskonflikte.

Kompabilitätsprobleme beheben

Um Abhängigkeitskonflikte zu handhaben, wenden Sie Versionserweiterungen in Ihrem build.gradle:

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

Hier sind Strategien zur Auflösung häufiger Abhängigkeitsprobleme:

Problemtyp Strategie Beispiel
Versionskonflikt Eine spezifische Version zwingen force 'com.google.code.gson:gson:2.10.1'
Mehrere Versionen Ein Modul ausschließen exclude group: 'org.json', module: 'json'
Transitive Probleme Verwenden Sie strenge Versionen strictly 'androidx.core:core-ktx:1.10.1'

Beispielsweise können Sie konkurrierende Module wie folgt ausschließen:

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

Schließlich optimieren Sie Ihren Build-Prozess, indem Sie Caching und parallele Ausführung in gradle.properties:

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

Capgo Integration

Capgo Live Update Dashboard Interface

Mit Capgo und native sowie JavaScript-Abhängigkeitsverwaltung können Sie Ihre Plugin-Updates schneller und einfacher durchführen.

Über Capgo

Capgo ist eine Live-Update-Plattform, die für Capacitor-Plugins und -Apps konzipiert ist. Mit über 23,5 Millionen Updates, die in 750 Produktanwendungen verteilt wurden [1]Capgo ermöglicht es Entwicklern, Updates für Abhängigkeiten und code sofort zu pushen - ohne dass eine App-Store-Überprüfung erforderlich ist. Die Updates werden mit Ende-zu-Ende-Verschlüsselung gesichert und erfüllen sowohl die Apple- als auch die Android-Kompatibilitätsstandards.

Capgo Update-Funktionen

Capgo vereinfacht die Verwaltung von Plugin-Abhängigkeiten mit diesen Funktionen:

Funktion Was es tut Schlüsselmetrik
Live-Updates Push-Updates in Minuten 95% Benutzeraktualisierungsrate in 24 Stunden
Teilaktualisierungen Nur geänderte Dateien herunterladen 434ms DurchschnittsAPI-Antwortzeit
Versionskontrolle Mehrere Versionen verwalten 82% globale Erfolgsrate
Kanal-System Ziel spezifische Benutzergruppen Unterstützt mehrere Bereitstellungskanäle

Quelle: [1]

Capgo funktioniert reibungslos mit CI/CD-Tools wie GitHub Actions, GitLab CI und Jenkins, automatisiert Abhängigkeitsaktualisierungen und sichert konsistente Pluginversionen. Diese Tools erleichtern die Integration von Capgo in Ihren Workflow.

Einrichten von Capgo

Folgen Sie diesen Schritten, um Capgo in Ihr Projekt einzubinden:

  1. Installieren Sie das Capgo CLI

    Führen Sie den folgenden Befehl in Ihrem Terminal aus:

    npx @capgo/cli init
  2. Konfigurieren Sie die Aktualisierungspräferenzen

    Verwenden Sie das Capgo-Dashboard, um Bereitstellungskanäle und Präferenzen einzurichten. Beide cloudbasierte und selbstgeführte Konfigurationen sind unterstützt.

  3. Hinzufügen von Aktualisierungslogik

    Fügen Sie diesen code in Ihrer Haupt-Plugin-Datei hinzu, um Updates zu aktivieren:

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

“Wir praktizieren agiles Entwicklung und @Capgo ist mission-kritisch bei der ständigen Lieferung an unsere Benutzer!” - Rodrigo Mantica

Capgo bietet auch eine Analyse-Tabelle für Echtzeit-Einsichten in die Erfolgsraten von Updates und die Aktivität der Benutzer. Funktionen wie eine Rückkehr auf einen Klick und die Fehlerüberwachung helfen, Probleme schnell zu lösen, und halten Ihre Plugin-Updates reibungslos laufen.

Zusammenfassung

Prozess-Überprüfung

Die Verwaltung von Abhängigkeiten für Capacitor-Plugins beinhaltet die Abstimmung der native Komponenten (iOS und Android) mit ihren JavaScript-Gegenstücken, um eine glatte Integration sicherzustellen. Dieser Prozess umfasst plattform-spezifische Einstellungen und die Verwaltung von JavaScript-Paketen, um die beste Leistung zu erzielen. Durch die Ausführung der aufgeführten Schritte können Sie eine stabile und effiziente Plugin-Funktionalität aufrechterhalten.

Best Practices

Um Abhängigkeiten effektiv zu verwalten, sollten Sie diese Praktiken beachten:

Praxis Vorteil Umsetzung
Version-Pinning Vermeidet unerwartete Probleme Verwenden Sie feste Versionen in package.json
Plattform-Isolierung Minimiert Konflikte Trennt native Abhängigkeiten
Regelmäßige Updates Verbessert die Sicherheit Wendet kritische Patches zeitnah an
Abhängigkeitsprüfung Ermittelt Risiken Ausführen npm audit häufig

Mit Hilfe von Live-Update-Tools wie Capgo können diese Praktiken weiter vereinfacht und verbessert werden, indem Echtzeit-Updates ermöglicht werden.

Capgo Vorteile

Capgo vereinfacht den Abhängigkeitsmanagementprozess und liefert eine starke Leistung. Es erreicht einen beeindruckenden 95% Benutzeraktualisierungsrate innerhalb von 24 Stunden und hält eine globale API Antwortzeit von 434ms [1]. Mit Ende-zu-Ende-Verschlüsselung stellt es sicher, dass sichere Updates bereitgestellt werden, die sowohl den Apple- als auch den Android-Richtlinien entsprechen. Für Teams, die mehrere Plugin-Versionen verwalten, ermöglicht Capgo's Kanal-System gezielte Bereitstellungen für bestimmte Benutzergruppen.

Hier ist ein schneller Überblick über die Leistung von Capgo:

Messwert Wert
Globale API Antwortzeit 434ms
Aktualisierungs Erfolgsrate 82%
Benutzeraktualisierungsrate (24 Stunden) 95%

Fahren Sie mit How to Add Dependencies in Capacitor Plugins fort

Wenn Sie __CAPGO_KEEP_0__ verwenden How to Add Dependencies in Capacitor Plugins um native Plugin-Arbeit zu planen, verbinden Sie es mit Capgo Plugin-Verzeichnis für das Produktworkflow in Capgo Plugin-Verzeichnis Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo Hinzufügen oder Aktualisieren von Plugins für die Implementierungsdetails in Hinzufügen oder Aktualisieren von Plugins Alternativen zum Ionic Enterprise Plugin für das Produktworkflow in Alternativen zum Ionic Enterprise Plugin und Capgo Native Builds für das Produktworkflow in Capgo Native Builds.

Live-Updates für Capacitor-Apps

Wenn ein Web-Schicht-Bug aktiv ist, schicken Sie die Reparatur über Capgo anstatt Tage für die Genehmigung des App-Store abzuwarten. Die Benutzer erhalten die Aktualisierung im Hintergrund, während native Änderungen im normalen Review-Prozess bleiben.

Menschliche Unterstützung von Martin

Los geht's jetzt

Neueste von unserem Blog

Capgo gibt Ihnen die besten Einblicke, die Sie benötigen, um ein wirklich professionelles Mobiltelefon-App zu erstellen.