Wie verwendet man IronPdfEngine mit Node.js
IronPdfEngine ist ein gRPC-Server, der alle PDF-Operationen – Erstellung, Bearbeitung und Lesen – im Namen des Node.js-Clients handhabt. Das @ironsoftware/ironpdf-Paket ist ein schlanker API-Wrapper, der über gRPC mit IronPdfEngine kommuniziert; jeder Methodenaufruf in Ihrem Node.js-Code wird innerhalb dieses Serverprozesses ausgeführt. Standardmäßig startet IronPDF for Node.js die IronPdfEngine als lokalen Unterprozess, aber Sie können sie auch auf eine extern gehostete Instanz für geteilte oder containerisierte Bereitstellungen verweisen.
Schnellstart: Einrichten von IronPdfEngine for Node.js
Installieren Sie das Paket und IronPdfEngine wird bei der ersten PDF-Operation automatisch ausgeführt:
//:path=shell
npm install @ironsoftware/ironpdf
//:path=shell
npm install @ironsoftware/ironpdf
Minimaler Arbeitsablauf (5 Schritte)
- Installieren Sie das IronPDF Node.js Paket mit
npm install @ironsoftware/ironpdf. - Beim ersten Lauf erkennt IronPDF Ihre Plattform und lädt die korrekten IronPdfEngine-Binaries herunter.
- Für Offline- oder schnellere Start-Deployments installieren Sie ein plattformspezifisches Engine-Paket wie
@ironsoftware/ironpdf-engine-windows-x64. - Überprüfen Sie die erforderliche Engine-Version mit der
IronPdfGlobalConfig.ironPdfEngineVersionEigenschaft, bevor Sie eine Remote-Instanz bereitstellen. - Für eine Remote-Engine rufen Sie
IronPdfGlobalConfig.setConfig({ ironPdfEngineDockerAddress: "host:port" })auf, bevor irgendeine PDF-Operation ausgeführt wird.
Warum erfordert IronPDF for Node.js IronPdfEngine?
IronPDF for Node.js enthält keinen eigenständigen PDF-Renderer. Das Node.js-Paket ist ein gRPC-Client, und IronPdfEngine ist der Server, der die tatsächliche Render-, Bearbeitungs- und Leseaufgabe durchführt. Wenn Ihre Anwendung irgendeine IronPDF-Methode aufruft, reist die Anfrage über gRPC zum Engine-Prozess, der das Ergebnis an Ihren Node.js-Code zurückgibt.
Diese Architektur hält das Node.js-Paket leicht und isoliert die Render-Umgebung. Es bedeutet auch, dass die Engine-Version genau mit der Paketversion übereinstimmen muss – versionsübergreifende Kombinationen werden nicht unterstützt.
@ironsoftware/ironpdf erfordert die IronPdfEngine derselben Version. Überprüfen Sie die Kompatibilität, indem Sie die Eigenschaft IronPdfGlobalConfig.ironPdfEngineVersion lesen, bevor Sie ein Engine-Update bereitstellen.Wie führen Sie IronPdfEngine lokal aus?
Lokale Bereitstellung ist der Standardmodus. IronPDF for Node.js startet IronPdfEngine als Unterprozess beim Start und kommuniziert damit, bis Ihre Anwendung heruntergefahren wird. Es stehen zwei Installationsansätze zur Verfügung, die jeweils unterschiedliche Kompromisse erfordern.
Option 1: IronPdfEngine zur Laufzeit herunterladen
Nach der Installation von @ironsoftware/ironpdf sind keine weiteren Pakete erforderlich. Beim ersten Start erkennt IronPDF die Hostplattform (z.B. Windows x64) und lädt die passenden IronPdfEngine-Binärdateien aus dem Internet herunter.
//:path=shell
npm install @ironsoftware/ironpdf
//:path=shell
npm install @ironsoftware/ironpdf
Vorteile:
- Hält das Anwendungs-Paket klein.
- Wird auf mehreren Plattformen ohne plattformspezifische Konfiguration bereitgestellt.
Nachteile:
- Benötigt bei den ersten Ausführungen Internetzugang.
- Langsamere Startzeit bei der ersten Ausführung, während Binärdateien abgerufen werden.
Option 2 (Empfohlen): Installieren Sie IronPdfEngine als Abhängigkeit
IronPDF for Node.js unterstützt dedizierte Engine-Pakete, die das IronPdfEngine-Binärdatei für eine bestimmte Plattform bündeln. Installieren Sie eines oder mehrere dieser Pakete neben der Hauptbibliothek, um den Laufzeit-Download zu vermeiden.
ironpdf und ironpdf-engine-xxx-xxx müssen dieselbe Version haben. Die Versionsnummer des Engine-Pakets bezieht sich auf die IronPDF-Veröffentlichung, nicht auf den internen Engine-Build.Windows x64:
//:path=shell
npm install @ironsoftware/ironpdf-engine-windows-x64
//:path=shell
npm install @ironsoftware/ironpdf-engine-windows-x64
Windows x86:
//:path=shell
npm install @ironsoftware/ironpdf-engine-windows-x86
//:path=shell
npm install @ironsoftware/ironpdf-engine-windows-x86
Linux x64:
//:path=shell
npm install @ironsoftware/ironpdf-engine-linux-x64
//:path=shell
npm install @ironsoftware/ironpdf-engine-linux-x64
macOS x64:
//:path=shell
npm install @ironsoftware/ironpdf-engine-macos-x64
//:path=shell
npm install @ironsoftware/ironpdf-engine-macos-x64
macOS arm64:
//:path=shell
npm install @ironsoftware/ironpdf-engine-macos-arm64
//:path=shell
npm install @ironsoftware/ironpdf-engine-macos-arm64
Vorteile:
- Schnellere Startzeit — kein Download bei Laufzeit erforderlich.
- Nach Installation der Abhängigkeit ist kein Internetzugang mehr erforderlich.
Nachteile:
- Größere Paketgröße der Anwendung.
- Erfordert die Spezifizierung der Zielplattformen zur Build-Zeit.
Wie verbinden Sie sich mit einer Remote-IronPdfEngine?
Remote-Bereitstellung ist geeignet, wenn die PDF-Erstellung ein Shared-Service ist — zum Beispiel in einer containerisierten Microservices-Architektur, einem Kubernetes-Cluster, bei dem mehrere Node.js-Dienste ein Engine-Pod teilen, oder in jeder Umgebung, in der die Zentralisierung des Rendering-Prozesses den Pro-Dienst-Overhead reduziert. Bevor Sie sich verbinden, ziehen Sie das IronPdfEngine Docker-Image und starten Sie es, indem Sie Wie man IronPdfEngine zieht und ausführt folgen.
Wie überprüfen Sie die erforderliche Engine-Version?
Die Engine-Version muss mit der Node.js-Paketversion übereinstimmen. Lesen Sie die Eigenschaft ironPdfEngineVersion, um zu überprüfen, welche Version abgerufen werden soll:
//:path=get-started/use-ironpdfengine/check-version.js
const ironPdfEngineVersion = IronPdfGlobalConfig.ironPdfEngineVersion;
console.log(`Required IronPdfEngine version: ${ironPdfEngineVersion}`);
//:path=get-started/use-ironpdfengine/check-version.js
const ironPdfEngineVersion = IronPdfGlobalConfig.ironPdfEngineVersion;
console.log(`Required IronPdfEngine version: ${ironPdfEngineVersion}`);
Verwenden Sie die gedruckte Versionsnummer beim Festlegen des Docker-Image-Tags. Das Ausführen einer nicht übereinstimmenden Version wird gRPC-Kommunikationsfehler verursachen.
Wie konfigurieren Sie die Remote-Verbindung?
Gehen Sie davon aus, dass IronPdfEngine unter 123.456.7.8:33350 läuft. Platzieren Sie den Konfigurationsaufruf am Anfang Ihrer Anwendung — bevor Sie eine IronPDF-Methode aufrufen.
//:path=get-started/use-ironpdfengine/remote-config.js
IronPdfGlobalConfig.setConfig({
ironPdfEngineDockerAddress: "123.456.7.8:33350"
});
//:path=get-started/use-ironpdfengine/remote-config.js
IronPdfGlobalConfig.setConfig({
ironPdfEngineDockerAddress: "123.456.7.8:33350"
});
Die Adresse muss vom Node.js-Host aus erreichbar sein. Stellen Sie sicher, dass keine Firewall-Regel den Port 33350 zwischen dem Anwendungsserver und dem Engine-Host blockiert.
ironpdf-engine-xxx-xxx-Abhängigkeitspaket installieren. Die lokale Engine wird vollständig umgangen, sobald ironPdfEngineDockerAddress gesetzt ist.Was sind die nächsten Schritte?
Das Einrichten von IronPdfEngine ist die Grundlage für alle PDF-Arbeiten in Node.js. Sobald die Engine läuft — lokal oder remote — steht die gesamte IronPDF-API zur Verfügung: Konvertieren Sie HTML in PDF, zusammenführen von Dokumenten, Hinzufügen von Stempeln und Wasserzeichen, Extraktion von Text und vieles mehr.
- Starten Sie eine kostenlose Testlizenz, um alle Funktionen ohne Wasserzeichen freizuschalten.
- Kaufen Sie eine Lizenz für Produktionsbereitstellungen.
- Fahren Sie mit dem vollständigen Node.js Einstiegstutorial fort: IronPDF for Node.js — Erste Schritte.
Häufig gestellte Fragen
Was ist IronPdfEngine und warum wird es for Node.js benötigt?
IronPdfEngine ist ein gRPC-Server, der alle PDF-Rendering-, Bearbeitungs- und Leseoperationen durchführt. Das @ironsoftware/ironpdf Node.js-Paket ist ein Client-Wrapper, der mit IronPdfEngine über gRPC kommuniziert, daher muss die Engine - lokal oder remote - ausgeführt werden, damit eine PDF-Operation erfolgreich sein kann.
Wie installiere ich IronPDF for Node.js?
Führen Sie npm install @ironsoftware/ironpdf in Ihrem Projektverzeichnis aus. Bei der ersten Ausführung erkennt IronPDF die Hostplattform und lädt die passenden IronPdfEngine-Binärdateien automatisch herunter.
Was ist der Unterschied zwischen der Laufzeit-Download-Option und der gebündelten Abhängigkeitsoption?
Die Laufzeit-Download-Option erfordert keine zusätzlichen Pakete, benötigt jedoch beim ersten Start Internetzugang und hat einen langsameren Anfangsstart. Die gebündelte Abhängigkeitsoption (Option 2, empfohlen) installiert ein plattformspezifisches Paket wie @ironsoftware/ironpdf-engine-windows-x64, das die Engine-Binärdatei bündelt, sodass der Start schneller erfolgt und kein Internetzugang nach der Installation erforderlich ist - auf Kosten eines größeren Pakets.
Wie stelle ich sicher, dass die IronPdfEngine-Version zu meiner IronPDF-Paketversion passt?
Lesen Sie die Eigenschaft IronPdfGlobalConfig.ironPdfEngineVersion zur Laufzeit, um die genau benötigte Versionszeichenfolge zu erhalten. Das ironpdf Paket und jede ironpdf-engine-xxx-xxx Abhängigkeit müssen die gleiche Version haben; Kombinationen von unterschiedlichen Versionen werden nicht unterstützt.
Wann sollte ich eine Remote-IronPdfEngine anstelle einer lokalen verwenden?
Eine Remote-IronPdfEngine ist geeignet für containerisierte Microservice-Architekturen, Kubernetes-Bereitstellungen, bei denen mehrere Node.js-Dienste ein einzelnes Rendering-Pod teilen, oder in jedem Szenario, in dem die Zentralisierung der PDF-Verarbeitung den Ressourcenüberhang pro Service reduziert.
Wie verbinde ich Node.js mit einer Remote-IronPdfEngine?
Rufen Sie IronPdfGlobalConfig.setConfig({ ironPdfEngineDockerAddress: "host:port" }) zu Beginn Ihrer Anwendung auf, bevor eine IronPDF-Methode gerufen wird. Ersetzen Sie host:port durch die IP-Adresse und den Port der Remote-Engine (Standard: 33350). Stellen Sie sicher, dass die Adresse erreichbar und nicht durch eine Firewall blockiert ist.
Muss ich ein Engine-Abhängigkeitspaket installieren, wenn ich eine Remote-IronPdfEngine verwende?
Nein. Wenn ironPdfEngineDockerAddress gesetzt ist, umgeht IronPDF jegliche lokale Engine vollständig. Es ist nicht nötig, ein ironpdf-engine-xxx-xxx Paket für Remote-Bereitstellungen zu installieren.
Welche Plattformen unterstützt IronPdfEngine?
Plattformspezifische Engine-Pakete sind verfügbar für Windows x64, Windows x86, Linux x64, macOS x64 und macOS arm64. Installieren Sie das Paket, das Ihrem Bereitstellungsziel entspricht, oder verwenden Sie die Laufzeit-Download-Option, um mehrere Plattformen mit einer einzelnen Installation zu unterstützen.
Kann ich mehrere plattformspezifische Engine-Pakete im selben Projekt installieren?
Ja. Sie können mehr als ein ironpdf-engine-xxx-xxx Paket im selben Projekt installieren. IronPDF wählt zur Laufzeit die korrekte Binärdatei für die Hostplattform aus, was nützlich für Projekte ist, die auf mehreren Betriebssystemen gebaut und bereitgestellt werden.
Welchen Port verwendet IronPdfEngine für gRPC-Kommunikation?
IronPdfEngine hört standardmäßig auf Port 33350. Beim Konfigurieren einer Remote-Verbindung fügen Sie diesen Port in den ironPdfEngineDockerAddress-Wert ein und verifizieren, dass der Port zwischen dem Node.js-Host und dem Engine-Host offen ist.

