Jak konwertować widoki na pliki PDF w C# ASP.NET Core MVC

Dlaczego potrzebuję zarówno IronPDF, jak i pakietu rozszerzeń?

Główny pakiet IronPDF zawiera podstawowy silnik renderowania plików PDF oraz podstawowe funkcje, natomiast pakiet Extensions.Mvc.Core zapewnia specjalistyczną integrację z systemem renderowania widoków ASP.NET Core MVC. Takie rozdzielenie pozwala na lepszą modułowość i gwarantuje, że uwzględnisz tylko te funkcje, które są potrzebne w danym typie projektu. Pakiet rozszerzenia zawiera interfejs IRazorViewRenderer i implementację potrzebną do konwersji widoków Razor na HTML przed generowaniem PDF.

Którą wersję pakietu NuGet należy użyć?

Zawsze używaj pasujących wersji IronPDF i IronPdf.Extensions.Mvc.Core, aby zapewnić zgodność. Najnowsze stabilne wersje i informacje o kompatybilności wersji znajdziesz w dokumentacji pakietów NuGet. Podczas aktualizacji należy upewnić się, że oba pakiety są aktualizowane razem, aby zachować prawidłowe działanie.

Jakie są typowe problemy związane z instalacją?

Typowe problemy z instalacją obejmują niezgodności wersji między pakietami podstawowymi a rozszerzeniami, brakujące zależności lub wymagania specyficzne dla platformy. W razie problemów upewnij się, że projekt jest przeznaczony dla obsługiwanej wersji .NET, i zapoznaj się z przeglądem instalacji, aby uzyskać informacje na temat rozwiązywania problemów.

Zainstaluj za pomocą NuGet

Install-Package IronPdf.Extensions.Mvc.Core

nuget.org/packages/IronPdf.Extensions.Mvc.Core/

Jakiego typu projekt powinienem użyć?

Aby uzyskać optymalną kompatybilność z funkcjami renderowania widoku IronPDF, należy użyć szablonu aplikacji internetowej ASP.NET Core (Model-View-Controller). Ten typ projektu zapewnia infrastrukturę niezbędną do renderowania widoków, w tym silnik widoków Razor i odpowiednie routowanie. W przypadku istniejących projektów należy upewnić się, że są one zgodne z wzorcem MVC i mają zainstalowane wymagane funkcje renderowania widoku.

Czy mogę z tego korzystać przy minimalnym wykorzystaniu API?

Chociaż Minimal API nie obsługują wbudowanych widoków, nadal można korzystać z funkcji konwersji HTML na PDF w IronPDF. W przypadku generowania plików PDF na podstawie widoku należy zastosować tradycyjne podejście MVC lub rozważyć Razor Pages jako alternatywę.

Dlaczego potrzebuję modelu do generowania plików PDF?

Modele dostarczają dane strukturalne, które mogą być przekazywane do widoków w celu renderowania. Takie rozdzielenie zadań gwarantuje, że logika generowania plików PDF pozostaje przejrzysta i łatwa w utrzymaniu. Model pełni rolę umowy między kontrolerem a widokiem, zapewniając bezpieczeństwo typów i umożliwiając obsługę IntelliSense w widokach Razor.

Jakie typy danych najlepiej sprawdzają się w widokach?

Do generowania plików PDF najlepiej nadają się proste typy danych i kolekcje. Można używać złożonych obiektów zagnieżdżonych, ale może to wymagać dodatkowej logiki widoku. Aby uzyskać optymalną wydajność, spłaszcz złożone struktury danych w kontrolerze przed przekazaniem ich do widoku. Jeśli modele domenowe są zbyt złożone, warto rozważyć użycie ViewModels zaprojektowanych specjalnie do generowania plików PDF.

Oto przykład bardziej złożonej struktury modelu, odpowiedniej do generowania plików PDF:

public class InvoiceViewModel
{
    public string InvoiceNumber { get; set; }
    public DateTime InvoiceDate { get; set; }
    public decimal TotalAmount { get; set; }
    public List<InvoiceLineItem> LineItems { get; set; }
    public CustomerInfo Customer { get; set; }

    // Computed property for PDF display
    public string FormattedTotal => TotalAmount.ToString("C");
}

public class InvoiceLineItem
{
    public string Description { get; set; }
    public int Quantity { get; set; }
    public decimal UnitPrice { get; set; }
    public decimal LineTotal => Quantity * UnitPrice;
}

public class CustomerInfo
{
    public string Name { get; set; }
    public string Email { get; set; }
    public string Address { get; set; }
}

public class InvoiceViewModel
{
    public string InvoiceNumber { get; set; }
    public DateTime InvoiceDate { get; set; }
    public decimal TotalAmount { get; set; }
    public List<InvoiceLineItem> LineItems { get; set; }
    public CustomerInfo Customer { get; set; }

    // Computed property for PDF display
    public string FormattedTotal => TotalAmount.ToString("C");
}

public class InvoiceLineItem
{
    public string Description { get; set; }
    public int Quantity { get; set; }
    public decimal UnitPrice { get; set; }
    public decimal LineTotal => Quantity * UnitPrice;
}

public class CustomerInfo
{
    public string Name { get; set; }
    public string Email { get; set; }
    public string Address { get; set; }
}

Public Class InvoiceViewModel
    Public Property InvoiceNumber As String
    Public Property InvoiceDate As DateTime
    Public Property TotalAmount As Decimal
    Public Property LineItems As List(Of InvoiceLineItem)
    Public Property Customer As CustomerInfo

    ' Computed property for PDF display
    Public ReadOnly Property FormattedTotal As String
        Get
            Return TotalAmount.ToString("C")
        End Get
    End Property
End Class

Public Class InvoiceLineItem
    Public Property Description As String
    Public Property Quantity As Integer
    Public Property UnitPrice As Decimal
    Public ReadOnly Property LineTotal As Decimal
        Get
            Return Quantity * UnitPrice
        End Get
    End Property
End Class

Public Class CustomerInfo
    Public Property Name As String
    Public Property Email As String
    Public Property Address As String
End Class

Czym jest usługa IRazorViewRenderer?

IRazorViewRenderer jest interfejsem usługowym zapewnionym przez pakiet IronPdf.Extensions.Mvc.Core, który obsługuje konwersję widoków Razor na HTML. Integruje się z silnikiem widoków ASP.NET Core w celu przetwarzania plików .cshtml wraz z powiązanymi modelami, wykonując całą składnię Razor i generując ostateczny kod HTML, który IronPDF konwertuje do formatu PDF.

Dlaczego warto sprawdzić metodę POST przed renderowaniem?

Sprawdzanie POST gwarantuje, że plik PDF zostanie wygenerowany tylko wtedy, gdy zostanie to wyraźnie zlecone poprzez przesłanie formularza. Zapobiega to przypadkowemu generowaniu plików PDF podczas ładowania stron i pozwala, aby ta sama akcja obsługiwała zarówno widok HTML (przy GET), jak i pobieranie pliku PDF (przy POST). Ten wzorzec jest zgodny z zasadami RESTful i zapewnia lepsze wrażenia użytkownika.

Jak mogę dostosować plik PDF?

IronPDF oferuje szerokie możliwości dostosowywania poprzez właściwość RenderingOptions. Oto przykład z bardziej zaawansowanymi ustawieniami:

// Advanced rendering configuration example
var renderer = new ChromePdfRenderer();

// Page setup
renderer.RenderingOptions.PaperSize = IronPdf.Rendering.PdfPaperSize.A4;
renderer.RenderingOptions.MarginLeft = 20;
renderer.RenderingOptions.MarginRight = 20;

// Headers and footers with merge fields
renderer.RenderingOptions.HtmlHeader = new HtmlHeaderFooter()
{
    Height = 25,
    HtmlFragment = "<div style='text-align: center; font-size: 12px;'>Page {page} of {total-pages}</div>"
};

// JavaScript execution delay for dynamic content
renderer.RenderingOptions.WaitFor = new WaitFor()
{
    RenderDelay = 500, // Wait 500ms for JS execution
    NetworkIdle = NetworkIdleTypes.NetworkIdle0 // Wait for network requests
};

// Apply watermark
renderer.RenderingOptions.TextHeader = new TextHeaderFooter()
{
    DrawDividerLine = true,
    CenterText = "CONFIDENTIAL",
    Font = new FontTypes() { FontSize = 16 }
};

// Advanced rendering configuration example
var renderer = new ChromePdfRenderer();

// Page setup
renderer.RenderingOptions.PaperSize = IronPdf.Rendering.PdfPaperSize.A4;
renderer.RenderingOptions.MarginLeft = 20;
renderer.RenderingOptions.MarginRight = 20;

// Headers and footers with merge fields
renderer.RenderingOptions.HtmlHeader = new HtmlHeaderFooter()
{
    Height = 25,
    HtmlFragment = "<div style='text-align: center; font-size: 12px;'>Page {page} of {total-pages}</div>"
};

// JavaScript execution delay for dynamic content
renderer.RenderingOptions.WaitFor = new WaitFor()
{
    RenderDelay = 500, // Wait 500ms for JS execution
    NetworkIdle = NetworkIdleTypes.NetworkIdle0 // Wait for network requests
};

// Apply watermark
renderer.RenderingOptions.TextHeader = new TextHeaderFooter()
{
    DrawDividerLine = true,
    CenterText = "CONFIDENTIAL",
    Font = new FontTypes() { FontSize = 16 }
};

' Advanced rendering configuration example
Dim renderer As New ChromePdfRenderer()

' Page setup
renderer.RenderingOptions.PaperSize = IronPdf.Rendering.PdfPaperSize.A4
renderer.RenderingOptions.MarginLeft = 20
renderer.RenderingOptions.MarginRight = 20

' Headers and footers with merge fields
renderer.RenderingOptions.HtmlHeader = New HtmlHeaderFooter() With {
    .Height = 25,
    .HtmlFragment = "<div style='text-align: center; font-size: 12px;'>Page {page} of {total-pages}</div>"
}

' JavaScript execution delay for dynamic content
renderer.RenderingOptions.WaitFor = New WaitFor() With {
    .RenderDelay = 500, ' Wait 500ms for JS execution
    .NetworkIdle = NetworkIdleTypes.NetworkIdle0 ' Wait for network requests
}

' Apply watermark
renderer.RenderingOptions.TextHeader = New TextHeaderFooter() With {
    .DrawDividerLine = True,
    .CenterText = "CONFIDENTIAL",
    .Font = New FontTypes() With {.FontSize = 16}
}

Jakie są typowe błędy kontrolera?

Typowe błędy to wyjątki odwołania do wartości null, gdy usługi nie są poprawnie wstrzykiwane, problemy ze ścieżkami podczas określania lokalizacji widoków oraz problemy z powiązaniem modeli. Upewnij się, że wszystkie wymagane usługi są zarejestrowane w Program.cs i używaj ścieżek względnych od katalogu głównego projektu przy określaniu lokalizacji widoków. W celu rozwiązywania problemów należy włączyć szczegółowe komunikaty o błędach w trybie programowania.

Dlaczego warto używać FormMethod.Post do generowania plików PDF?

Używanie POST do generowania PDF przestrzega najlepszych praktyk sieciowych, czyniąc akcję eksplicytą i zapobiegając niechcianemu generowaniu PDF przy odświeżeniu przeglądarki lub zakładkach URL. Żądania GET powinny być idempotentne (nie zmieniać stanu serwera), podczas gdy żądania POST wskazują na akcję przynoszącą rezultat - w tym przypadku generowanie dokumentu PDF.

Jak mogę stylizować przycisk drukowania w pliku PDF?

Zastosuj styl przycisku PRINT za pomocą klas CSS i ulepsz go za pomocą JavaScript, aby zapewnić użytkownikom lepsze wrażenia. Oto ulepszona wersja:

@using (Html.BeginForm("Persons", "Home", FormMethod.Post, new { @class = "pdf-form" }))
{
    <button type="submit" class="btn btn-primary pdf-download-btn">
        <i class="fas fa-file-pdf"></i> Download as PDF
    </button>
}

<style>
    .pdf-download-btn {
        background-color: #dc3545;
        color: white;
        padding: 10px 20px;
        border: none;
        border-radius: 5px;
        cursor: pointer;
        transition: background-color 0.3s ease;
    }

    .pdf-download-btn:hover {
        background-color: #c82333;
    }

    .pdf-download-btn:active {
        transform: translateY(1px);
    }
</style>

<script>
    // Optional: Show loading indicator during PDF generation
    document.querySelector('.pdf-form').addEventListener('submit', function() {
        const button = this.querySelector('button');
        button.innerHTML = '<i class="fas fa-spinner fa-spin"></i> Generating PDF...';
        button.disabled = true;
    });
</script>

@using (Html.BeginForm("Persons", "Home", FormMethod.Post, new { @class = "pdf-form" }))
{
    <button type="submit" class="btn btn-primary pdf-download-btn">
        <i class="fas fa-file-pdf"></i> Download as PDF
    </button>
}

<style>
    .pdf-download-btn {
        background-color: #dc3545;
        color: white;
        padding: 10px 20px;
        border: none;
        border-radius: 5px;
        cursor: pointer;
        transition: background-color 0.3s ease;
    }

    .pdf-download-btn:hover {
        background-color: #c82333;
    }

    .pdf-download-btn:active {
        transform: translateY(1px);
    }
</style>

<script>
    // Optional: Show loading indicator during PDF generation
    document.querySelector('.pdf-form').addEventListener('submit', function() {
        const button = this.querySelector('button');
        button.innerHTML = '<i class="fas fa-spinner fa-spin"></i> Generating PDF...';
        button.disabled = true;
    });
</script>

Jakie szablony widoku najlepiej sprawdzają się w przypadku plików PDF?

Szablony List i Details szczególnie dobrze sprawdzają się do generowania PDF, ponieważ dostarczają ustrukturyzowane układy. Najlepsze wyniki często dają niestandardowe szablony zaprojektowane specjalnie do generowania plików PDF. Rozważ utworzenie dedykowanych widoków PDF, które są zoptymalizowane pod kątem układu wydruku, a nie wyświetlania na ekranie, usuwając elementy nawigacyjne i skupiając się na prezentacji treści.

Dlaczego akcja asp musi być dokładnie dopasowana?

Atrybut asp-action używa pomocników znaczników ASP.NET Core do generowania poprawnego URL na podstawie konfiguracji tras. Dokładne dopasowanie gwarantuje, że link przekierowuje do właściwej akcji kontrolera. Niezgodności powodują błędy 404 lub przekierowanie do niezamierzonych działań. System tag helperów rozróżnia wielkość liter i musi dokładnie odpowiadać nazwie metody w kontrolerze.

Co się stanie, jeśli linki nawigacyjne nie będą pasować?

Gdy linki nawigacyjne nie odpowiadają akcjom kontrolera, użytkownicy napotykają błędy 404 lub są przekierowywani na nieprawidłowe strony. Podczas tworzenia aplikacji strona wyjątków programistycznych ASP.NET Core wyświetla szczegółowe błędy routingu. W środowisku produkcyjnym użytkownicy widzą ogólne strony błędów. Zawsze sprawdzaj, czy linki nawigacyjne dokładnie odpowiadają nazwom akcji kontrolera, aby uniknąć problemów z obsługą strony.

Dlaczego warto rejestrować usługi jako singletony?

Usługi singleton są tworzone raz i ponownie używane przez cały czas życia aplikacji, dzięki czemu są wydajne dla usług bezstanowych, takich jak IRazorViewRenderer. Ten wzorzec zmniejsza obciążenie pamięci i poprawia wydajność, ponieważ usługa renderowania widoku nie utrzymuje stanu specyficznego dla żądania. IHttpContextAccessor musi być singleton, aby był dostępny w różnych okresach życia usług.

Do czego służy ITempDataProvider?

ITempDataProvider umożliwia tymczasowe przechowywanie danych między żądaniami, często używane do wyświetlania komunikatów po przekierowaniach. W kontekście generowania PDF zapewnia, że stan widoku jest odpowiednio zachowany przy renderowaniu widoków na PDF. CookieTempDataProvider przechowuje te tymczasowe dane w zaszyfrowanych plikach cookie, zapewniając bezpieczny mechanizm zarządzania stanem.

Czy mogę używać usług zasięgu zamiast tego?

Chociaż można używać usług zasięgu w niektórych scenariuszach, IRazorViewRenderer działa najlepiej jako singleton, ponieważ nie przechowuje stanu specyficznego dla żądania. Używanie usług zasięgu powodowałoby tworzenie nowych instancji dla każdego żądania, zwiększając zużycie pamięci bez korzyści. Jednak jeśli potrzebujesz wstrzykiwać usługi zasięgu do swoich widoków, zapewnij odpowiednie zarządzanie czasem życia usług, aby uniknąć błędów w trakcie działania.

Uruchom projekt

To pokazuje, jak uruchomić projekt i wygenerować dokument PDF. Kiedy uruchomisz aplikację, przejdź do strony Persons korzystając z górnego menu nawigacyjnego, a następnie kliknij przycisk Print Person, aby wygenerować i pobrać PDF.

Co zawiera przykładowy projekt?

Przykładowy projekt zawiera w pełni skonfigurowaną aplikację ASP.NET Core MVC z integracją IronPDF, demonstrując przekształcanie widoków na PDF. Zawiera model Person, HomeController z logiką generowania PDF, widok Persons z poprawną składnią Razor oraz wszystkie niezbędne rejestracje usług w Program.cs. Projekt zawiera również przykładowe style i konfiguracje układu zoptymalizowane dla wyników PDF.

Jaką wersję Visual Studio powinienem używać?

Visual Studio 2022 (wersja 17.0 lub późniejsza) jest zalecana dla najlepszych wrażeń z projektami .NET 6+. Visual Studio Code z rozszerzeniami C# również dobrze sprawdza się w rozwoju międzyplatformowym. Upewnij się, że masz zainstalowany pakiet pracy ASP.NET i web development. Projekt domyślnie celuje w .NET 6.0, ale może być zaktualizowany do nowszych wersji.

Jak rozwiązywać problemy z konfiguracją projektu?

Typowe problemy z konfiguracją obejmują brakujące pakiety NuGet, nieprawidłowe wersje SDK .NET lub problemy z konfiguracją. Najpierw przywróć pakiety NuGet przy użyciu dotnet restore lub poprzez Menedżera Pakietów Visual Studio. Upewnij się, że twoja wersja .NET SDK pasuje do wymagań projektu, używając dotnet --version. W kwestii problemów licencyjnych, zobacz dokumentację kluczy licencyjnych. Jeśli wystąpią problemy z renderowaniem, sprawdź przewodnik rozwiązywania problemów dla rozwiązań.

Gotowy, aby sprawdzić, co jeszcze możesz zrobić? Sprawdź naszą stronę z samouczkami tutaj: Konwersja PDF-ów