Wie man Cookies mit IronPDF in C# verwendet

Was ist die RequestContext-Eigenschaft?

Setzen Sie die RequestContext-Eigenschaft auf RequestContexts.Global, bevor Sie Cookies anwenden. Erstellen Sie die Klasse ChromeHttpLoginCredentials und übergeben Sie sie an die Methode ApplyCookies. Der Renderer rendert dann den HTML-Inhalt mit Cookies in PDF.

Die Eigenschaft RequestContext funktioniert mit HTTP-Anforderungsheadern und der Authentifizierung. Sie bestimmt die gemeinsame Nutzung von Cookies zwischen Rendering-Sitzungen, was für Anwendungen, die den Sitzungsstatus über mehrere PDF-Generationen hinweg beibehalten, entscheidend ist.

Wie verwende ich die Methode ApplyCookies?

Cookies mit IronPDF anwenden:

:path=/static-assets/pdf/content-code-examples/how-to/cookies-apply-cookies.cs

using IronPdf;

// Instantiate ChromePdfRenderer
ChromePdfRenderer renderer = new ChromePdfRenderer();

renderer.RenderingOptions.RequestContext = IronPdf.Rendering.RequestContexts.Global;

ChromeHttpLoginCredentials credentials = new ChromeHttpLoginCredentials() {
    NetworkUsername = "testUser",
    NetworkPassword = "testPassword"
};

string uri = "http://localhost:51169/Invoice";

// Apply cookies
renderer.ApplyCookies(uri, credentials);

Imports IronPdf

' Instantiate ChromePdfRenderer
Private renderer As New ChromePdfRenderer()

renderer.RenderingOptions.RequestContext = IronPdf.Rendering.RequestContexts.Global

Dim credentials As New ChromeHttpLoginCredentials() With {
	.NetworkUsername = "testUser",
	.NetworkPassword = "testPassword"
}

Dim uri As String = "http://localhost:51169/Invoice"

' Apply cookies
renderer.ApplyCookies(uri, credentials)

Dieser Ansatz funktioniert bei der Konvertierung von ASPX-Seiten in PDF, die eine Authentifizierung erfordern, oder bei ASP.NET MVC-Anwendungen.

Welchen RequestContext soll ich wählen?

RequestContexts Enum definiert Browser-Anfragekontexte, die Beziehungen zwischen Renderings herstellen. Sie verwaltet Cookies und Benutzereinstellungen.

• Isoliert: Erzeugt neue, isolierte Anfragekontexte. Verhindert, dass aktuelle Renderings von früheren Renderings beeinflusst werden. Ideal für Multi-Thread-PDF-Erzeugung.
• Global: Verwendet einen gemeinsamen globalen Anfragekontext für alle Renderings. Behält den Browserstatus zwischen den Renderings bei. Perfekt für die Beibehaltung von Sitzungsdaten bei PDF-Vorgängen.
• Auto : Standardmäßig wird IronPdf.Rendering.RequestContexts.Isolated verwendet. Wechselt zu IronPdf.Rendering.RequestContexts.Global, falls IronPdf.ChromePdfRenderer.ApplyCookies(System.String, IronPdf.ChromeHttpLoginCredentials) aufgerufen wurde.

Wenn Sie Cookies in Blazor Server-Anwendungen implementieren, wählen Sie den passenden RequestContext, um den korrekten Sitzungsstatus zwischen den serverseitigen Rendervorgängen zu erhalten.

Was sind benutzerdefinierte Cookies in IronPDF?

Benutzerdefinierte Cookies erfordern die Einstellung der Eigenschaft CustomCookies. Diese Eigenschaft akzeptiert String-Schlüssel-Wert-Paar-Wörterbücher. Benutzerdefinierte Cookies handhaben komplexe Authentifizierungssysteme oder übermitteln Daten auf Anwendungsebene während des Renderings.

Benutzerdefinierte Cookies unterscheiden sich von Standard-HTTP-Cookies, da sie eine beliebige Definition von Schlüssel-Wert-Paaren zulassen. Diese Flexibilität eignet sich für moderne Webanwendungen, die JWT-Tokens, Sitzungs-IDs oder benutzerdefinierte Authentifizierungsmechanismen verwenden.

Wie implementiere ich benutzerdefinierte Cookies?

Anwenden von benutzerdefinierten Cookies mit IronPDF:

:path=/static-assets/pdf/content-code-examples/how-to/cookies-apply-custom-cookies.cs

using IronPdf;
using System;
using System.Collections.Generic;

// Instantiate ChromePdfRenderer
ChromePdfRenderer renderer = new ChromePdfRenderer();

Dictionary<string, string> customCookies = new Dictionary<string, string>();

// Apply custom cookies
renderer.RenderingOptions.CustomCookies = customCookies;

var uri = new Uri("https://localhost:44362/invoice");
PdfDocument pdf = renderer.RenderUrlAsPdf(uri);

Imports IronPdf
Imports System
Imports System.Collections.Generic

' Instantiate ChromePdfRenderer
Private renderer As New ChromePdfRenderer()

Private customCookies As New Dictionary(Of String, String)()

' Apply custom cookies
renderer.RenderingOptions.CustomCookies = customCookies

Dim uri As New Uri("https://localhost:44362/invoice")
Dim pdf As PdfDocument = renderer.RenderUrlAsPdf(uri)

Dieser Ansatz eignet sich für JavaScript-lastige Websites, die auf Cookies für die Statusverwaltung angewiesen sind oder angepasste Protokollierungslösungen implementieren.

Wann sollte ich benutzerdefinierte Cookies gegenüber Standard-Cookies verwenden?

Benutzerdefinierte Cookies behandeln spezifische Sitzungsdaten oder Authentifizierungs-Token, die nicht durch Standard-HTTP-Anmeldeinformationen verwaltet werden. Verwenden Sie sie mit benutzerdefinierten Authentifizierungssystemen oder um Benutzereinstellungen während der PDF-Generierung beizubehalten.

Standard-Cookies (über die Methode ApplyCookies) sind geeignet:

• Grundlegende HTTP-Authentifizierung
• Windows-Authentifizierungsumgebungen
• Einfache Sitzungsverwaltung

Benutzerdefinierte Cookies eignen sich besonders für:

• JWT-Token-basierte Authentifizierung
• Komplexe Sitzungsverwaltung mit mehreren Parametern
• Authentifizierungsanbieter von Drittanbietern (OAuth, SAML)
• Pflege von Benutzerpräferenzen und Einstellungen
• Anforderungen an Analytik und Tracking

Was sind häufige Probleme bei der Implementierung von Cookies?

Häufige Probleme sind beispielsweise, dass Cookies zwischen den Renderings mit dem Kontext Isolated nicht erhalten bleiben, Authentifizierungsfehler aufgrund falscher Cookie-Werte und Timing-Probleme, bei denen Cookies vor der PDF-Generierung ablaufen. Überprüfen Sie die Gültigkeit des Cookies und berücksichtigen Sie den Kontext Global für persistente Sitzungen.

Tipps zur Fehlerbehebung:

1. Cookie-Ablauf: Überprüfen Sie, dass Cookies nicht abgelaufen sind. Implementierung einer Aktualisierungslogik für kurzlebige Token.
2. Domäneneinschränkungen: Stellen Sie sicher, dass die Cookie-Domänen mit der gerenderten URL übereinstimmen.
3. Sichere Cookies: Konfigurieren Sie sichere Cookies richtig, wenn Sie HTTPS-URLs wiedergeben.
4. SameSite-Richtlinien: Berücksichtigen Sie die SameSite-Cookie-Richtlinien des Browsers, die Cross-Origin-Anfragen betreffen.

Für fortgeschrittene Authentifizierungs- und Cookie-Szenarien siehe die Dokumentation der Wiedergabeoptionen, die alle verfügbaren Einstellungen zur Anpassung der PDF-Erzeugung enthält.