C# PNG'yi PDF'ye Dönüştürme (Kod Örnekleri Eğitimi)

Fluent Validation Anlamak

Fluent Validation, .NET için açık kaynaklı bir kütüphane olup model sınıflarınıza doğrulama kuralları oluşturmayı kolaylaştırır.

1. Doğrulayıcılar: Doğrulayıcılar, doğrulama mantığını kapsayan sınıflardır. Bunlar genellikle AbstractValidator<t> taban sınıfından türetilerek oluşturulur.
2. Kurallar: Kural, bir özelliğin sağlamak zorunda olduğu bir doğrulama koşuludur. Kurallar bir doğrulayıcı sınıfta RuleFor yöntemi kullanılarak tanımlanır.
3. Doğrulama Başarısızlıkları: Bir kural başarısız olursa, Fluent Validation hata hakkında ayrıntılar içeren, özellikle özellik adı ve hata mesajını içeren bir ValidationFailure nesnesi oluşturur.

Proje Kurulumu

Başlamak için, Visual Studio veya tercih ettiğiniz geliştirme ortamında yeni bir Konsol Uygulaması oluşturalım.

1. Visual Studio'yu açın ve Dosya > Yeni > Proje seçeneğine gidin.
2. Proje şablonu olarak "Konsol Uygulaması (ASP.NET Core)" seçin ve projenize bir isim verin.

Yeni Konsol Uygulaması Oluştur

3. Sonraki düğmesine tıklayın ve projenizi adlandırarak ve depo konumunu seçerek yapılandırın.

Yeni uygulamayı yapılandırın

4. Sonraki butonuna tıklayın ve .NET Framework sürümünü seçin. En yeni .NET Framework (7) önerilir.

.NET Framework seçimi

5. Projeyi oluşturmak için Oluştur butonuna tıklayın.

Gerekli Paketleri Kur

Proje oluşturulduktan sonra Fluent Validation ve IronPDF için gerekli NuGet paketlerini ekleyin.

1. Çözüm Gezgini'nde projeye sağ tıklayın ve "NuGet Paketlerini Yönet" seçeneğini seçin.
2. "FluentValidation" kelimesini arayın ve paketi projeye eklemek için "Install" butonuna tıklayın.

NuGet Paket Yöneticisi UI'de FluentValidation paketi kurun

3. Benzer şekilde, "IronPDF - Güçlü .NET PDF Kütüphanesi" arayın ve IronPDF paketini kurun.

Alternatif olarak, aşağıdaki komutu kullanarak IronPDF'i NuGet Paket Yöneticisi Konsolu ile kurabilirsiniz:

Install-Package IronPdf

Paket Yöneticisi Konsolu'nda IronPDF paketini kurun

Proje kurulumu tamamlanıp gerekli paketler yüklendikten sonra, PDF içerik sınıfını tanımlamaya geçelim.

PDF İçeriğini Tanımlama

Bu örnekte, InvoiceContent ve InvoiceItem olmak üzere iki sınıftaki HTML kodlarından basit bir fatura PDF'si oluşturulacaktır.

using System.Collections.Generic;
using System.Linq;

public abstract class PdfContent
{
    // Abstract method to generate the HTML string
    public abstract string RenderHtml();
}

public class InvoiceContent : PdfContent
{
    public string CustomerName { get; set; }
    public string Address { get; set; }
    public List<InvoiceItem> InvoiceItems { get; set; }

    // Constructs the HTML representation of the invoice
    public override string RenderHtml()
    {
        string invoiceItemsHtml = string.Join("", InvoiceItems.Select(item => $"<li>{item.Description}: {item.Price}</li>"));
        return $"<h1>Invoice for {CustomerName}</h1><p>{Address}</p><ul>{invoiceItemsHtml}</ul>";
    }
}

public class InvoiceItem
{
    public string Description { get; set; }
    public decimal Price { get; set; }
}

using System.Collections.Generic;
using System.Linq;

public abstract class PdfContent
{
    // Abstract method to generate the HTML string
    public abstract string RenderHtml();
}

public class InvoiceContent : PdfContent
{
    public string CustomerName { get; set; }
    public string Address { get; set; }
    public List<InvoiceItem> InvoiceItems { get; set; }

    // Constructs the HTML representation of the invoice
    public override string RenderHtml()
    {
        string invoiceItemsHtml = string.Join("", InvoiceItems.Select(item => $"<li>{item.Description}: {item.Price}</li>"));
        return $"<h1>Invoice for {CustomerName}</h1><p>{Address}</p><ul>{invoiceItemsHtml}</ul>";
    }
}

public class InvoiceItem
{
    public string Description { get; set; }
    public decimal Price { get; set; }
}

Imports System.Collections.Generic
Imports System.Linq

Public MustInherit Class PdfContent
	' Abstract method to generate the HTML string
	Public MustOverride Function RenderHtml() As String
End Class

Public Class InvoiceContent
	Inherits PdfContent

	Public Property CustomerName() As String
	Public Property Address() As String
	Public Property InvoiceItems() As List(Of InvoiceItem)

	' Constructs the HTML representation of the invoice
	Public Overrides Function RenderHtml() As String
		Dim invoiceItemsHtml As String = String.Join("", InvoiceItems.Select(Function(item) $"<li>{item.Description}: {item.Price}</li>"))
		Return $"<h1>Invoice for {CustomerName}</h1><p>{Address}</p><ul>{invoiceItemsHtml}</ul>"
	End Function
End Class

Public Class InvoiceItem
	Public Property Description() As String
	Public Property Price() As Decimal
End Class

Yukarıdaki kodda, PdfContent adlı soyut bir sınıf, RenderHtml adlı soyut bir yöntem ile tanımlanır. InvoiceContent sınıfı PdfContent sınıfını genişletir ve fatura PDF'sinin içeriğini temsil eder. Müşteri adı, adresi ve fatura kalemleri listesine ait özellikleri vardır. InvoiceItem sınıfı 'Description' ve 'Price' olmak üzere iki özelliğe sahiptir. RenderHtml yöntemi, içerik baz alınarak fatura için HTML işaretlemesini oluşturur.

Artık PDF içeriği tanımlandığına göre, Fluent Validation kullanarak doğrulama kuralları oluşturma işlemine geçelim.

Doğrulama Kurallarını Oluşturma

InvoiceContent sınıfı için doğrulama kuralları oluşturmak üzere InvoiceContentValidator adlı bir doğrulayıcı sınıf oluşturun. Bu sınıf, FluentValidation tarafından sağlanan AbstractValidator<InvoiceContent> sınıfından türeyecek.

using FluentValidation;

public class InvoiceContentValidator : AbstractValidator<InvoiceContent>
{
    public InvoiceContentValidator()
    {
        RuleFor(content => content.CustomerName).NotEmpty().WithMessage("Customer name is required.");
        RuleFor(content => content.Address).NotEmpty().WithMessage("Address is required.");
        RuleFor(content => content.InvoiceItems).NotEmpty().WithMessage("At least one invoice item is required.");
        RuleForEach(content => content.InvoiceItems).SetValidator(new InvoiceItemValidator());
    }
}

public class InvoiceItemValidator : AbstractValidator<InvoiceItem>
{
    public InvoiceItemValidator()
    {
        RuleFor(item => item.Description).NotEmpty().WithMessage("Description is required.");
        RuleFor(item => item.Price).GreaterThanOrEqualTo(0).WithMessage("Price must be greater than or equal to 0.");
    }
}

using FluentValidation;

public class InvoiceContentValidator : AbstractValidator<InvoiceContent>
{
    public InvoiceContentValidator()
    {
        RuleFor(content => content.CustomerName).NotEmpty().WithMessage("Customer name is required.");
        RuleFor(content => content.Address).NotEmpty().WithMessage("Address is required.");
        RuleFor(content => content.InvoiceItems).NotEmpty().WithMessage("At least one invoice item is required.");
        RuleForEach(content => content.InvoiceItems).SetValidator(new InvoiceItemValidator());
    }
}

public class InvoiceItemValidator : AbstractValidator<InvoiceItem>
{
    public InvoiceItemValidator()
    {
        RuleFor(item => item.Description).NotEmpty().WithMessage("Description is required.");
        RuleFor(item => item.Price).GreaterThanOrEqualTo(0).WithMessage("Price must be greater than or equal to 0.");
    }
}

Imports FluentValidation

Public Class InvoiceContentValidator
	Inherits AbstractValidator(Of InvoiceContent)

	Public Sub New()
		RuleFor(Function(content) content.CustomerName).NotEmpty().WithMessage("Customer name is required.")
		RuleFor(Function(content) content.Address).NotEmpty().WithMessage("Address is required.")
		RuleFor(Function(content) content.InvoiceItems).NotEmpty().WithMessage("At least one invoice item is required.")
		RuleForEach(Function(content) content.InvoiceItems).SetValidator(New InvoiceItemValidator())
	End Sub
End Class

Public Class InvoiceItemValidator
	Inherits AbstractValidator(Of InvoiceItem)

	Public Sub New()
		RuleFor(Function(item) item.Description).NotEmpty().WithMessage("Description is required.")
		RuleFor(Function(item) item.Price).GreaterThanOrEqualTo(0).WithMessage("Price must be greater than or equal to 0.")
	End Sub
End Class

Kaynak kodda, InvoiceContentValidator sınıfı tanımlanır ve AbstractValidator<InvoiceContent> sınıfından türetilir. Doğrulayıcı sınıfın yapıcısında, RuleFor yöntemi, InvoiceContent sınıfının her özelliği için doğrulama kurallarını tanımlar.

Örneğin, RuleFor(content => content.CustomerName) müşteri adının boş olmaması gerektiğini belirtir. Benzer şekilde, adres ve fatura kalemleri özellikleri için doğrulama kuralları tanımlanmıştır.

RuleForEach yöntemi, InvoiceItems listesindeki her öğe üzerinde döner ve InvoiceItemValidator uygular. InvoiceItemValidator sınıfı, InvoiceItem sınıfı için doğrulama kuralları içerir.

Bu doğrulama kuralları varken, IronPDF kullanarak PDF oluşturma işlemine geçelim.

IronPDF Kullanarak PDF Oluşturma

IronPDF - PDF Belgeleri Oluşturun ve Düzenleyin, PDF belgeleri oluşturup manipüle etmek için popüler bir .NET kütüphanesidir. IronPDF, doğrulanmış fatura içeriğine dayalı olarak PDF oluşturmak için kullanılacaktır.

using IronPdf;
using FluentValidation;

public class PdfService
{
    // Generates a PDF document for the provided content
    public PdfDocument GeneratePdf<t>(T content) where T : PdfContent
    {
        // Validate the content using the appropriate validator
        var validator = GetValidatorForContent(content);
        var validationResult = validator.Validate(content);

        // Check if validation is successful
        if (!validationResult.IsValid)
        {
            throw new FluentValidation.ValidationException(validationResult.Errors);
        }

        // Generate the PDF using IronPDF
        var renderer = new ChromePdfRenderer();
        return renderer.RenderHtmlAsPdf(content.RenderHtml());
    }

    // Retrieves the appropriate validator for the content
    private IValidator<t> GetValidatorForContent<t>(T content) where T : PdfContent
    {
        if (content is InvoiceContent)
        {
            return (IValidator<t>)new InvoiceContentValidator();
        }
        else
        {
            throw new NotSupportedException("Unsupported content type.");
        }
    }
}

using IronPdf;
using FluentValidation;

public class PdfService
{
    // Generates a PDF document for the provided content
    public PdfDocument GeneratePdf<t>(T content) where T : PdfContent
    {
        // Validate the content using the appropriate validator
        var validator = GetValidatorForContent(content);
        var validationResult = validator.Validate(content);

        // Check if validation is successful
        if (!validationResult.IsValid)
        {
            throw new FluentValidation.ValidationException(validationResult.Errors);
        }

        // Generate the PDF using IronPDF
        var renderer = new ChromePdfRenderer();
        return renderer.RenderHtmlAsPdf(content.RenderHtml());
    }

    // Retrieves the appropriate validator for the content
    private IValidator<t> GetValidatorForContent<t>(T content) where T : PdfContent
    {
        if (content is InvoiceContent)
        {
            return (IValidator<t>)new InvoiceContentValidator();
        }
        else
        {
            throw new NotSupportedException("Unsupported content type.");
        }
    }
}

Imports IronPdf
Imports FluentValidation

Public Class PdfService
    ' Generates a PDF document for the provided content
    Public Function GeneratePdf(Of T As PdfContent)(content As T) As PdfDocument
        ' Validate the content using the appropriate validator
        Dim validator = GetValidatorForContent(content)
        Dim validationResult = validator.Validate(content)

        ' Check if validation is successful
        If Not validationResult.IsValid Then
            Throw New FluentValidation.ValidationException(validationResult.Errors)
        End If

        ' Generate the PDF using IronPDF
        Dim renderer = New ChromePdfRenderer()
        Return renderer.RenderHtmlAsPdf(content.RenderHtml())
    End Function

    ' Retrieves the appropriate validator for the content
    Private Function GetValidatorForContent(Of T As PdfContent)(content As T) As IValidator(Of T)
        If TypeOf content Is InvoiceContent Then
            Return CType(New InvoiceContentValidator(), IValidator(Of T))
        Else
            Throw New NotSupportedException("Unsupported content type.")
        End If
    End Function
End Class

PdfService sınıfı bir GeneratePdf yöntemi sağlar. Bu yöntem, bir PdfContent nesnesini girdi olarak alır ve doğrulanan içeriğe dayalı olarak PDF belgesini üretir.

Öncelikle, içerik için uygun doğrulayıcıyı, içeriğin türünü kontrol eden ve ilgili doğrulayıcıyı döndüren GetValidatorForContent yöntemini çağırarak getirir. Bizim durumumuzda, InvoiceContent destekliyoruz ve InvoiceContentValidator kullanıyoruz.

Sonraki adımda, içerik doğrulayıcı kullanılarak doğrulanır ve doğrulayıcının Validate yöntemi çağrılır. Doğrulama sonucu, bir ValidationResult nesnesinde saklanır.

Doğrulama başarısız olursa (!validationResult.IsValid), doğrulama hatalarıyla birlikte bir FluentValidation.ValidationException atılır. Aksi takdirde, PDF IronPDF ile oluşturulur.

ChromePdfRenderer örneği, HTML içeriğini PDF olarak oluşturmak için oluşturulur. RenderHtmlAsPdf yöntemi renderer nesnesinde çağrılarak, content.RenderHtml yöntemi tarafından üretilen HTML içine geçirilir ve PDF belgesi oluşturulur.

Artık PDF oluşturma mantığını tanımladığımıza göre, meydana gelebilecek doğrulama hatalarını ele alalım.

Doğrulama Hatalarını Ele Alma

Doğrulama hatası meydana geldiğinde, bir hata mesajı göstermek ve zarif bir şekilde ele almak istiyoruz. Main yöntemini, Program sınıfında, olası istisnaları ele alması ve kullanıcıya anlamlı mesajlar göstermesi için değiştirelim.

using System;
using System.Collections.Generic;

public class Program
{
    static void Main(string[] args)
    {
        var pdfService = new PdfService();

        // Test 1: Empty Customer Name
        try
        {
            var invoiceContent = new InvoiceContent
            {
                CustomerName = "",
                Address = "123 Main St, Anytown, USA",
                InvoiceItems = new List<InvoiceItem> {
                    new InvoiceItem { Description = "Item 1", Price = 19.99M },
                    new InvoiceItem { Description = "Item 2", Price = 29.99M }
                }
            };

            var pdfDocument = pdfService.GeneratePdf(invoiceContent);
            pdfDocument.SaveAs("C:\\TestInvoice.pdf");
            Console.WriteLine("PDF generated successfully!");
        }
        catch (Exception ex)
        {
            Console.WriteLine("Error generating PDF: " + ex.Message);
        }

        // Test 2: Empty InvoiceItems
        try
        {
            var invoiceContent = new InvoiceContent
            {
                CustomerName = "John Doe",
                Address = "123 Main St, Anytown, USA",
                InvoiceItems = new List<InvoiceItem>()  // Empty list
            };

            var pdfDocument = pdfService.GeneratePdf(invoiceContent);
            pdfDocument.SaveAs("C:\\TestInvoice.pdf");
            Console.WriteLine("PDF generated successfully!");
        }
        catch (Exception ex)
        {
            Console.WriteLine("Error generating PDF: " + ex.Message);
        }

        // Successful generation
        try
        {
            var invoiceContent = new InvoiceContent
            {
                CustomerName = "John Doe",
                Address = "123 Main St, Anytown, USA",
                InvoiceItems = new List<InvoiceItem> {
                    new InvoiceItem { Description = "Item 1", Price = 19.99M },
                    new InvoiceItem { Description = "Item 2", Price = 29.99M }
                }
            };
            var pdfDocument = pdfService.GeneratePdf(invoiceContent);
            pdfDocument.SaveAs("C:\\TestInvoice.pdf");
            Console.WriteLine("PDF generated successfully!");
        }
        catch (Exception ex)
        {
            Console.WriteLine("Error generating PDF: " + ex.Message);
        }
    }
}

using System;
using System.Collections.Generic;

public class Program
{
    static void Main(string[] args)
    {
        var pdfService = new PdfService();

        // Test 1: Empty Customer Name
        try
        {
            var invoiceContent = new InvoiceContent
            {
                CustomerName = "",
                Address = "123 Main St, Anytown, USA",
                InvoiceItems = new List<InvoiceItem> {
                    new InvoiceItem { Description = "Item 1", Price = 19.99M },
                    new InvoiceItem { Description = "Item 2", Price = 29.99M }
                }
            };

            var pdfDocument = pdfService.GeneratePdf(invoiceContent);
            pdfDocument.SaveAs("C:\\TestInvoice.pdf");
            Console.WriteLine("PDF generated successfully!");
        }
        catch (Exception ex)
        {
            Console.WriteLine("Error generating PDF: " + ex.Message);
        }

        // Test 2: Empty InvoiceItems
        try
        {
            var invoiceContent = new InvoiceContent
            {
                CustomerName = "John Doe",
                Address = "123 Main St, Anytown, USA",
                InvoiceItems = new List<InvoiceItem>()  // Empty list
            };

            var pdfDocument = pdfService.GeneratePdf(invoiceContent);
            pdfDocument.SaveAs("C:\\TestInvoice.pdf");
            Console.WriteLine("PDF generated successfully!");
        }
        catch (Exception ex)
        {
            Console.WriteLine("Error generating PDF: " + ex.Message);
        }

        // Successful generation
        try
        {
            var invoiceContent = new InvoiceContent
            {
                CustomerName = "John Doe",
                Address = "123 Main St, Anytown, USA",
                InvoiceItems = new List<InvoiceItem> {
                    new InvoiceItem { Description = "Item 1", Price = 19.99M },
                    new InvoiceItem { Description = "Item 2", Price = 29.99M }
                }
            };
            var pdfDocument = pdfService.GeneratePdf(invoiceContent);
            pdfDocument.SaveAs("C:\\TestInvoice.pdf");
            Console.WriteLine("PDF generated successfully!");
        }
        catch (Exception ex)
        {
            Console.WriteLine("Error generating PDF: " + ex.Message);
        }
    }
}

Imports System
Imports System.Collections.Generic

Public Class Program
	Shared Sub Main(ByVal args() As String)
		Dim pdfService As New PdfService()

		' Test 1: Empty Customer Name
		Try
			Dim invoiceContent As New InvoiceContent With {
				.CustomerName = "",
				.Address = "123 Main St, Anytown, USA",
				.InvoiceItems = New List(Of InvoiceItem) From {
					New InvoiceItem With {
						.Description = "Item 1",
						.Price = 19.99D
					},
					New InvoiceItem With {
						.Description = "Item 2",
						.Price = 29.99D
					}
				}
			}

			Dim pdfDocument = pdfService.GeneratePdf(invoiceContent)
			pdfDocument.SaveAs("C:\TestInvoice.pdf")
			Console.WriteLine("PDF generated successfully!")
		Catch ex As Exception
			Console.WriteLine("Error generating PDF: " & ex.Message)
		End Try

		' Test 2: Empty InvoiceItems
		Try
			Dim invoiceContent As New InvoiceContent With {
				.CustomerName = "John Doe",
				.Address = "123 Main St, Anytown, USA",
				.InvoiceItems = New List(Of InvoiceItem)()
			}

			Dim pdfDocument = pdfService.GeneratePdf(invoiceContent)
			pdfDocument.SaveAs("C:\TestInvoice.pdf")
			Console.WriteLine("PDF generated successfully!")
		Catch ex As Exception
			Console.WriteLine("Error generating PDF: " & ex.Message)
		End Try

		' Successful generation
		Try
			Dim invoiceContent As New InvoiceContent With {
				.CustomerName = "John Doe",
				.Address = "123 Main St, Anytown, USA",
				.InvoiceItems = New List(Of InvoiceItem) From {
					New InvoiceItem With {
						.Description = "Item 1",
						.Price = 19.99D
					},
					New InvoiceItem With {
						.Description = "Item 2",
						.Price = 29.99D
					}
				}
			}
			Dim pdfDocument = pdfService.GeneratePdf(invoiceContent)
			pdfDocument.SaveAs("C:\TestInvoice.pdf")
			Console.WriteLine("PDF generated successfully!")
		Catch ex As Exception
			Console.WriteLine("Error generating PDF: " & ex.Message)
		End Try
	End Sub
End Class

Yukarıdaki kodda, meydana gelebilecek her türlü istisnayı yakalamak için try-catch blokları kullanılır. Bir istisna yakalanırsa, kullanıcıya Console.WriteLine kullanılarak bir hata mesajı gösterilecektir.

Şimdi bu uygulamayı, PDF oluşturmayı ve doğrulama kurallarını doğrulamak için farklı senaryolarla test edin.

Uygulamayı Test Etme

Kod örneğinde test edilecek üç senaryo bulunmaktadır:

1. Boş müşteri adı: Müşteri adını boş bırakarak bir doğrulama hatası tetikleyin.
2. Boş fatura kalemleri: Boş fatura kalemleri listesi sağlayarak bir doğrulama hatası tetikleyin.
3. Başarılı oluşturma: Geçerli içerik sağlayarak PDF'yi başarıyla oluşturun.

Uygulamayı çalıştırın ve çıktıyı konsolda gözlemleyin.

Error generating PDF: Validation failed:
    -- CustomerName: Customer name is required. Severity: Error
Error generating PDF: Validation failed:
    -- InvoiceItems: At least one invoice item is required. Severity: Error
PDF generated successfully!

Konsoldaki çıktı hatası

Çıktı PDF dosyası

Beklendiği gibi, ilk iki senaryo için doğrulama hataları gösterilir ve üçüncü senaryo için bir başarı mesajı gösterilir.