Zum Hauptinhalt springen

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

Erhalten Sie praktische Schritte und Best Practices, um die Abhängigkeitsverwaltung in Capacitor-Plugins über Plattformen zu vereinfachen

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

Hinzufügen von Abhängigkeiten zu 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.

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.

Benötigte Entwicklertools

Hier ist eine Liste der erforderlichen Werkzeuge:

Werkzeug 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 im umgekehrten 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 Ihr 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:

    Variable Zweck Beispielwert
    ANDROID_HOME Android-SDK-Ort /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, seid Ihr bereit, auf das Verwalten von JavaScript-Abhängigkeiten zuzugehen.

JavaScript-Abhängigkeiten

Das effektive Verwalten 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 Peer-Abhängigkeiten manuell in Ihrem Projekt einbeziehen. package.json Testen Sie alle Abhängigkeiten, um die Kompatibilität auf beiden Web- und Native-Plattformen zu bestätigen.

Verwalten Sie package.json

Ein Beispielkonfiguration: package.json Um Konsistenz zu gewährleisten, passen Sie die Versionsnummern der Abhängigkeiten entsprechend an:

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

Abhängigkeitsart

Beispiel Verwendungszweck Genau
Für kritische Abhängigkeiten, die eine bestimmte Version erfordern “5.0.0” Karet
Sorgfältig “^5.0.0” Zulässige kleine Updates und Patches
Tilde “~5.0.0” Beschränkt Updates auf nur Patches

Verwendung von JavaScript-Bibliotheken

Wenn Sie Bibliotheken importieren, achten Sie 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

Diese Abschnitt erklärt, wie Sie native iOS-Abhängigkeiten in __CAPGO_KEEP_0__-Plugins Capacitor pluginsCocoaPods

Zulässige kleine Updates und Patches Einrichtung

CocoaPods

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

cd ios
pod init

Dann aktualisieren Sie Ihr Plugin.podspec Datei 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 die 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 zum Beispiel für 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 Plugin Capacitor verwalten können.

Gradle Abläufe

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

Stellen Sie sicher, dass Sie die notwendigen Repositories einrichten, sobald die Abhängigkeiten konfiguriert sind.

Repository-Konfiguration

In Ihrem Projekt-Level build.gradle, fügen Sie die erforderlichen Maven-Repositories ein:

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

Wenn Sie benutzerdefinierte oder private Maven-Repositories verwenden, fügen Sie die Zugangsdaten wie folgt 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, müssen Sie eventuell auftretende Abhängigkeitskonflikte lösen.

Kompatibilitätsprobleme beheben

Um Abhängigkeitskonflikte zu lösen, müssen Sie in Ihrem Projekt Versionen auflösen. 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 von häufigen Abhängigkeitsproblemen:

Problemtyp Strategie Beispiel
Versionenkonflikt Einen bestimmten Version zwingen force 'com.google.code.gson:gson:2.10.1'
Multiple Versionen Eine Modul ausschließen exclude group: 'org.json', module: 'json'
Transitive Probleme Verwenden Sie strikte Versionen strictly 'androidx.core:core-ktx:1.10.1'

Für den Fall, dass Sie beispielsweise konkurrierende Module ausschließen möchten, können Sie das wie folgt tun:

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

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

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

Capgo Integration

Capgo Live-Update-Dashboard-Oberfläche

Mit Capgo zusammen mit der native und JavaScript-Abhängigkeitsverwaltung wird das Aktualisieren Ihres Plugins schneller und einfacher.

About Capgo

Capgo ist eine lebendige Update-Plattform, die für Capacitor-Plugins und -Apps konzipiert ist. Mit über 23,5 Millionen Updates, die in 750 Produktionsanwendungen übermittelt wurden. [1], Capgo ermöglicht Entwicklern, Updates für Abhängigkeiten zu pushen und code sofort - keine Bewertung durch das App-Store erforderlich. Updates werden mit Ende-zu-Ende-Verschlüsselung gesichert und erfüllen sowohl die Apple- als auch die Android-Kompatibilitätsstandards.

Capgo Aktualisierungsmerkmale

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

Funktion Was es tut Schlüsselmetrik
Live-Updates Push-Updates in Minuten 95% Benutzeraktualisierungsrate innerhalb von 24 Stunden
Teilaktualisierungen Nur geänderte Dateien herunterladen 434ms Durchschnittszeit für API
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. Einstellungen für Updates

    Verwenden Sie das Capgo-Dashboard, um Bereitstellungskanäle und Vorlieben einzurichten. Beide cloudbasierte und selbstgehostete Konfigurationen werden unterstützt.

  3. Hinzufügen von Update-Logik

    code fügen Sie 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.

Beste Praktiken

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

Praxis Vorteil Umsetzung
Version-Pinning Vermeidet unerwartete Probleme Verwende feste Versionen in package.json
Plattform-Isolierung Minimiert Konflikte Trenne native Abhängigkeiten
Regelmäßige Updates Bessere Sicherheit Anwende kritische Patches rechtzeitig
Abhängigkeitsprüfung Erkennung von 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ängigkeitsmanagement-Prozess und bietet 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 Richtlinien von Apple als auch von Android 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
Update Erfolgsrate 82%
Benutzeraktualisierungsrate (24 Stunden) 95%

Fortsetzen Sie mit: Wie Sie Abhängigkeiten in Capacitor-Plugins hinzufügen

Wenn Sie __CAPGO_KEEP_0__ verwenden Wie Sie Abhängigkeiten in Capacitor-Plugins hinzufügen um native Plugin-Arbeit zu planen, verbinden Sie es mit __CAPGO_KEEP_0__-Plugin-Verzeichnis Capgo-Plugin-Verzeichnis für den Produktworkflow in Capgo-Plugin-Verzeichnis Capgo-Plugins von __CAPGO_KEEP_1__ um die Implementierungsdetails in Capacitor-Plugins von Capgo zu erhalten for the implementation detail in Capacitor Plugins by Capgo, um die Implementierungsdetails in Hinzufügen oder Aktualisieren von Plugins zu erhalten Hinzufügen oder Aktualisieren von Plugins Ionic Enterprise Plugin Alternativen für das Produktworkflow in Ionic Enterprise Plugin Alternativen, und Capgo Native Builds für das Produktworkflow in Capgo Native Builds.

Live-Updates für Capacitor-Anwendungen

Wenn ein Web-layer-Bug live ist, schicken Sie die Reparatur über Capgo anstatt Tage für die Genehmigung des App-Stores zu warten. 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-Anwendungsprogramm zu erstellen.