理解Fluent Validation

Fluent Validation是一个.NET的开源库，使为模型类构建验证规则变得简单。

1. 验证器：验证器是封装验证逻辑的类。 它们通常通过继承AbstractValidator<T>基类创建。
2. 规则：规则是属性必须满足的验证条件。 规则是使用验证器类中的RuleFor方法定义的。
3. 验证失败：如果规则失败，Fluent Validation会创建一个ValidationFailure对象，包含关于错误的详细信息，包括属性名称和错误消息。

什么是 IronPDF？ [IronPDF - 在C#中将HTML转换为PDF](/)是一个强大的.NET库，允许您从HTML内容生成PDF文档。 无论您需要创建发票、报告或其他类型的文档，IronPDF都提供了一种易于使用的解决方案。 它无缝集成到ASP.NET Core应用程序中，使您可以仅用几行代码生成高质量的PDF文件。 ## 在IronPDF中使用Fluent Validation 现在我们了解了Fluent Validation和IronPDF是什么，我们来看一下它们如何一起使用。 本教程将帮助构建一个发票生成器，其中的发票内容将在使用IronPDF生成PDF之前在ASP.NET Core中使用FluentValidation进行验证。 ### 项目设置 首先，让我们在Visual Studio或您喜欢的开发环境中创建一个新的控制台应用程序。 1. 打开Visual Studio并转到**文件 > 新建 > 项目**。 2. 选择“控制台应用程序（ASP.NET Core）”作为项目模板，并为您的项目提供一个名称。  **创建新的控制台应用程序** 3. 点击**下一步**按钮，并通过命名并选择存储库位置来配置您的项目。  **配置新应用程序** 4. 点击**下一步**按钮并选择.NET Framework。 推荐使用最新的.NET Framework（7）。  **.NET Framework选择** 5. 点击**创建**按钮以创建项目。 ### 安装所需的包 项目创建完成后，添加Fluent Validation和IronPDF所需的NuGet包。 1. 右键点击解决方案资源管理器中的项目并选择“管理NuGet包”。 2. 搜索“FluentValidation”并点击“安装”以将包添加到您的项目中。  **在NuGet包管理器UI中安装FluentValidation包** 3. 同样，搜索“[IronPDF - 强大的.NET PDF库](/)”并安装IronPDF包。 或者，您可以使用**NuGet包管理器控制台**通过以下命令安装IronPDF： ```shell :ProductInstall ```  **在包管理器控制台中安装IronPdf包** 在设置好项目并安装所需包后，让我们继续定义PDF内容类。 ### 定义PDF内容 在这个例子中，将从两个类中的HTML代码中创建一个简单的发票PDF：`InvoiceContent`和`InvoiceItem`。 ```csharp 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 InvoiceItems { get; set; } // Constructs the HTML representation of the invoice public override string RenderHtml() { string invoiceItemsHtml = string.Join("", InvoiceItems.Select(item => $"

{item.Description}: {item.Price}

")); return $"

Invoice for {CustomerName}

{Address}

{invoiceItemsHtml}

"; } } public class InvoiceItem { public string Description { get; set; } public decimal Price { get; set; } } ``` 在上面的代码中，定义了一个抽象的`PdfContent`类，其内部定义了一个抽象方法`RenderHtml`。 `InvoiceContent`类扩展了`PdfContent`，表示发票PDF的内容。 它具有客户姓名、地址和发票项目列表的属性。 `InvoiceItem`类包含两个属性：'Description'和'Price'。 `RenderHtml`方法根据内容生成发票的HTML标记。 既然PDF内容已定义，让我们继续使用Fluent Validation创建验证规则。 ### 创建验证规则 为`InvoiceContent`类构建验证规则，请创建一个名为`InvoiceContentValidator`的验证器类。 该类将继承自FluentValidation提供的`AbstractValidator`。 ```csharp using FluentValidation; public class InvoiceContentValidator : AbstractValidator { 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 { 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."); } } ``` 在源代码中，定义了一个`InvoiceContentValidator`类，该类继承自`AbstractValidator`。 在验证器类的构造函数中，`RuleFor`方法为`InvoiceContent`类的每个属性定义了验证规则。 例如，`RuleFor(content => content.CustomerName)`指定客户姓名不应为空。 类似地，为地址和发票项目属性定义了验证规则。 `RuleForEach`方法遍历`InvoiceItems`列表中的每个项目并应用`InvoiceItemValidator`。 `InvoiceItemValidator`类包含`InvoiceItem`类的验证规则。 随着这些验证规则的到位，让我们继续使用IronPDF生成PDF。 ### 使用IronPDF生成PDF [IronPDF - 生成和编辑PDF文档](/tutorials/html-to-pdf/)是一个流行的.NET库，用于创建和操作PDF文档。 IronPDF将用于基于经过验证的发票内容生成PDF。 ```csharp using IronPdf; using FluentValidation; public class PdfService { // Generates a PDF document for the provided content public PdfDocument GeneratePdf(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 GetValidatorForContent(T content) where T : PdfContent { if (content is InvoiceContent) { return (IValidator)new InvoiceContentValidator(); } else { throw new NotSupportedException("Unsupported content type."); } } } ``` `PdfService`类提供了一个`GeneratePdf`方法。 此方法接受一个`PdfContent`对象作为输入，并根据经过验证的内容生成PDF文档。 首先，通过调用`GetValidatorForContent`方法获取适用于内容的验证器，该方法检查内容类型并返回相应的验证器。 在我们的例子中，我们支持`InvoiceContent`并使用`InvoiceContentValidator`。 接下来，通过调用验证器的`Validate`方法对内容进行验证。 验证结果储存在一个`ValidationResult`对象中。 如果验证失败（`!validationResult.IsValid`），则会抛出带有验证错误的`FluentValidation.ValidationException`。 否则，使用IronPDF生成PDF。 创建< a href="/object-reference/api/IronPdf.ChromePdfRenderer.html">ChromePdfRenderer实例来将HTML内容渲染为PDF。 在`renderer`对象上调用< a href="/object-reference/api/IronPdf.ChromePdfRenderer.html# IronPdf_ChromePdfRenderer_RenderHtmlAsPdf_System_String_System_String_System_String_">RenderHtmlAsPdf方法，传入`content.RenderHtml`方法生成的HTML，从而生成PDF文档。 既然我们已经定义了PDF生成逻辑，让我们处理可能出现的任何验证错误。 ### 处理验证错误 当验证错误发生时，我们希望显示一个错误消息并优雅地处理它。 让我们修改`Program`类的`Main`方法来处理任何异常并向用户显示有意义的消息。 ```csharp 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 { 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() // 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 { 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); } } } ``` 在上面的代码中，使用`try-catch`块捕获可能发生的任何异常。 如果捕获到了异常，则通过`Console.WriteLine`向用户显示一条错误消息。 现在让我们用不同的场景来测试这个应用程序，以验证PDF生成和验证规则。 ### 测试应用程序 在代码示例中，有三个场景需要测试： 1. 空客户姓名：让客户姓名为空以触发验证错误。 2. 空发票项目：提供一个空的发票项目列表以触发验证错误。 3. 成功生成：提供有效内容以成功生成PDF。 运行应用程序并观察控制台中的输出。 ```plaintext 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! ```  **控制台中的输出错误**  **输出PDF文件** 正如预期的那样，前两个场景显示验证错误，第三个场景显示成功消息。 ## 结论 本教程探讨了Fluent Validation，以及如何使用它与IronPDF生成PDF文档。 首先通过设置控制台应用和定义PDF内容类开始。 然后，使用Fluent Validation创建验证规则，并通过不同场景测试PDF生成。 Fluent Validation为.NET应用程序中的对象验证提供了一种灵活且易于使用的方法。 它允许您以强类型的方式定义验证规则，自定义错误消息，并优雅地处理验证错误。 [IronPDF Free Trial & Licensing Information](trial-license)提供免费试用，许可证起价为每位开发者$499。