.NET 帮助

Flurl C#（它如何为开发人员工作）

发布 2024年八月13日

介绍

在 C# 开发方面，加入强大的库可以显著提高产出和能力。 Flurl 和IronPDF这些工具分别为程序员提供了创建 PDF 和与在线 API 交互的强大工具。

Flurl 提供了一种流畅、富有表现力的语法，使在 C# 中处理 HTTP 请求、API 及其 API 端点变得更加容易。发送 HTTP 请求、响应 HTTP 请求以及管理查询参数或标头只是它简化的几项工作。开发人员可以使用 Flurl 快速有效地管理身份验证、序列化和反序列化 JSON 以及使用 Web API，同时编写清晰易懂、条理清晰的代码。

开发人员可以利用 Flurl 的易用性和多功能性，与 IronPDF 结合使用，通过与 Web API 连接、检索数据并将其轻松集成到 IronPDF 中，从而创建详细而有准备的 PDF 文档。通过这种集成，程序员可以设计复杂的应用程序，利用从在线服务获取的实时数据自动创建文档，从而提高工作效率和用户体验。

我们将在本介绍中探讨如何在 C# 程序中使用和结合 Flurl 和 IronPDF，强调它们在现代当代软件开发中的优势和协同潜力。

什么是 Flurl C#?

Flurl 是一个强大且用户友好的 C# 库，用于管理 HTTP 请求并与在线 API 通信。它提供了流畅、可链式的语法，提高了代码的可读性和可维护性，降低了与 RESTful API 交互的复杂性。开发人员可以使用 Flurl 轻松创建和提交 HTTP 请求，以易于理解的方式处理响应，并管理查询参数、标头和有效载荷。

Flurl 最显著的特点之一是能够动态管理 URL 的构建，这使得根据运行时的情况创建和更改 URL 变得非常简单，同时也允许将其用作独立的 URL 生成器。 Flurl 是一款强大的 JSON 数据序列化和反序列化管理工具，支持 GET、POST、PUT、DELETE 等常用 HTTP 功能。此外，Flurl 还具有管理表单数据和查询参数的内置功能，这使它能适应各种 API 集成场景。

流畅的界面

Flurl 提供的流畅、可链式语法提高了程序的可读性和可维护性。开发人员可以创建简单而富有表现力的 HTTP 请求，并处理 URL、查询参数、标头和有效载荷。

HTTP 方法支持

支持所有标准 HTTP 方法，包括 GET、POST、PUT、DELETE、PATCH、HEAD 和 OPTIONS。有了这种包罗万象的支持方法，开发人员在使用网络 API 时可以完成各种任务。

查询参数处理

Flurl 提供了在 URL 中修改、添加和删除查询参数的简便方法。它使根据用户输入或运行时情况创建动态 URL 变得更加容易。

支持 JSON

Flurl 本身支持 JSON 数据处理。它可以轻松地将 JSON 响应反序列化为 C# 对象，并将对象序列化为用于请求有效载荷的 JSON。因此，使用基于 JSON 的 API 既简单又容易。

表单数据和多部分支持

它使多部分请求和表单数据的管理变得更容易。 Flurl 可让开发人员轻松地在 HTTP 请求中包含多址/表单数据有效载荷或表单编码数据。

错误处理和重试策略

Flurl 为所有 HTTP 调用提供重试策略定义和错误处理功能。通过定义独特的错误处理逻辑或重试技术，开发人员可以增强 API 调用和交互的弹性和可靠性。这还能保障和帮助开发人员防止匿名对象在响应中造成错误。

身份验证

它支持多种流行的网络 API 身份验证方法，包括 OAuth、自定义身份验证方案、基本身份验证和 API 密钥。这可确保与需要验证的 API 进行安全通信。

测试支持

Flurl 将与 HTTP 相关的逻辑隔离成可重复使用的组件，并将关注点明确分开，从而提高了可测试性。这使得编写 API 交互单元测试变得更加简单，因为测试时不需要真正的网络调用。

配置灵活性

它为 HTTP 客户端和请求参数提供了配置灵活性。开发人员可以更改客户端行为、超时、错误响应量、标头和其他设置，以满足特定应用程序的需求或 API 的限制。

可扩展性

由于 Flurl 采用了插件框架，因此具有很强的可扩展性。开发人员可以通过构建独特的扩展功能或集成第三方插件来增加平台的功能。

创建和配置 Flurl C&num；

以下是在 C# 项目中构建和配置 Flurl 的步骤：

创建一个新的Visual Studio项目

使用Visual Studio创建控制台项目非常简单。要在 Visual Studio 环境中启动控制台应用程序，请按照以下简单步骤操作：

在尝试使用之前，请确保您的计算机上安装了 Visual Studio。

开始一个新项目

选择文件、项目，然后选择新建选项。

Flurl C#（开发人员如何使用）：图1 - 点击新的选项

控制台应用程序 "或 "控制台应用程序(.NET Core)可以从下面的项目模板参考列表中选择".NET "模板。

请填写 "名称 "表单，为您的项目命名。

Flurl C#（如何为开发人员工作）：图2 - 提供名称和位置

选择项目的保存位置。

点击 "创建 "将打开控制台应用程序项目。

Flurl C#（它如何为开发人员工作）：图 3 - 点击“创建”

安装 Flurl.Http 软件包

第一步是使用 NuGet 软件包管理器控制台或 Visual Studio 中的 NuGet 软件包管理器安装 Flurl.Http 软件包。

Install-Package Flurl.Http

Install-Package Flurl.Http

IRON VB CONVERTER ERROR developers@ironsoftware.com

VB C#

创建 FlurlClient 配置

Flurl 提供 FlurlClient 类，通过该类，您只需使用 URL 生成器即可为每个 HTTP 请求建立默认参数。可以通过设置基础 URL 或默认标题来完成这一可选但有用的步骤。

using Flurl;
using Flurl.Http;
// Configure a FlurlClient instance with base URL and headers
FlurlClient flurlClient = new FlurlClient("https://api.example.com/");
flurlClient.WithHeader("Authorization", "Bearer YourAccessTokenHere");

using Flurl;
using Flurl.Http;
// Configure a FlurlClient instance with base URL and headers
FlurlClient flurlClient = new FlurlClient("https://api.example.com/");
flurlClient.WithHeader("Authorization", "Bearer YourAccessTokenHere");

IRON VB CONVERTER ERROR developers@ironsoftware.com

VB C#

提出 HTTP 请求

现在，您可以使用 Flurl 的流畅 URL 进行 HTTP 请求。

var response = await "http://localhost:5013/users".GetAsync();
Console.WriteLine(response.ToString());
if (response.ResponseMessage.IsSuccessStatusCode)
{
    var result = await response.ResponseMessage.Content.ReadAsStringAsync();
    Console.WriteLine(result);
}
else
{
    Console.WriteLine($"Error: {response.StatusCode}");
}

var response = await "http://localhost:5013/users".GetAsync();
Console.WriteLine(response.ToString());
if (response.ResponseMessage.IsSuccessStatusCode)
{
    var result = await response.ResponseMessage.Content.ReadAsStringAsync();
    Console.WriteLine(result);
}
else
{
    Console.WriteLine($"Error: {response.StatusCode}");
}

Dim response = await "http://localhost:5013/users".GetAsync()
Console.WriteLine(response.ToString())
If response.ResponseMessage.IsSuccessStatusCode Then
	Dim result = Await response.ResponseMessage.Content.ReadAsStringAsync()
	Console.WriteLine(result)
Else
	Console.WriteLine($"Error: {response.StatusCode}")
End If

VB C#

Flurl C# （它如何为开发者工作）：图 4 - 示例控制台输出

处理回复

根据预期格式管理回复内容(JSON, 字符串, 等等。)Flurl 的 HttpResponseMessageExtensions 提供扩展方法，如 ReceiveJson 和 ReceiveString。

// Handling JSON response
var responseObject = await "https://api.example.com/resource"
    .WithClient(flurlClient)
    .GetJsonAsync<ResponseType>();
// Assuming ResponseType is a class representing the expected JSON structure
Console.WriteLine($"Response: {responseObject.Property}");

// Handling JSON response
var responseObject = await "https://api.example.com/resource"
    .WithClient(flurlClient)
    .GetJsonAsync<ResponseType>();
// Assuming ResponseType is a class representing the expected JSON structure
Console.WriteLine($"Response: {responseObject.Property}");

IRON VB CONVERTER ERROR developers@ironsoftware.com

VB C#

附加配置

查询参数： 要添加查询参数，请使用 .SetQueryParams()方法。确保每个请求使用相同的 HttpClient 实例运行，以提高效率。

超时： 例如，您可以使用 .WithTimeout 设置超时。(TimeSpan.FromSeconds(30)).

错误处理： 要处理特定的错误情形，请使用 .OnError().

入门

当您需要从远程 API 获取数据并使用这些数据创建 PDF 文档时，在 C# 项目中将 Flurl 与 IronPDF 集成会很有帮助。要开始使用 Flurl 和 IronPDF，请按照以下步骤操作：

什么是 IronPDF？

在 C# 程序中，有一个名为 IronPDF 的功能丰富的 .NET 库，可用于创建、阅读和修改 PDF 文档。在该工具的帮助下，开发人员可以从 HTML、CSS 和 JavaScript 内容中快速生成可打印的高质量 PDF。一些基本功能包括水印、制作页眉和页脚、分割和合并 PDF 以及将 HTML 转换为 PDF。 IronPDF 支持 .NET Framework 和 .NET Core，因此适用于各种应用。

由于 PDF 易于集成且拥有丰富详细的文档，因此开发人员可以轻松地在其应用程序中使用它们。 IronPDF 通过有效处理复杂的布局和样式，确保生成的 PDF 与源 HTML 内容非常相似。

Flurl C#（对开发人员的工作原理）：图 5 - IronPDF：C# PDF 库

IronPDF 的功能

从 HTML 生成 PDF

将JavaScript、HTML和CSS转换为PDF。它支持媒体查询和响应式设计这两种当代网络标准。它适用于使用 HTML 和 CSS 对 PDF 报告、发票和文档进行动态装饰。

PDF 编辑

文本、照片和其他内容可以添加到已有的 PDF 文件中。可从 PDF 文件中删除文本和图片。可将多个 PDF 文件合并为一个文件。PDF 文件可分为多个独立文件。可以包含水印、注释、页眉和页脚。

PDF 转换

将多种文件类型（包括 Word、Excel 和图片文件）转换为 PDF 格式。将 PDF 转换为图像(PNG、JPEG 等。).

性能和可靠性

在工业环境中，高性能和可靠性是所需的设计品质，因为它们可以有效地管理大量文件集。

安装 IronPDF

要获得在 .NET 项目中处理 PDF 所需的工具，请安装 IronPDF for .NET 软件包。

Install-Package IronPDF

Install-Package IronPDF

'INSTANT VB TODO TASK: The following line uses invalid syntax:
'Install-Package IronPDF

VB C#

使用 Flurl 获取数据以生成 PDF

要进行 HTTP 查询并从 API 获取数据，请使用 Flurl 的流畅 API。这是一个检索 JSON 数据的实例：

using Flurl;
using Flurl.Http;
using IronPdf;
using System;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        try
        {
            var response = await "http://localhost:5013/users/1".GetJsonAsync<User>();
            var id = response?.Id;
            var name = response?.Name;
            Console.WriteLine($"Data fetched successfully: {name}");
            // Generate PDF using IronPDF
            var renderer = new HtmlToPdf();
            string htmlTemplate = $@"
                <html>
                <body>
                    <h1>{id}</h1>
                    <p>{name}</p>
                </body>
                </html>";
            // Generate PDF document from HTML template
            var pdfDocument = renderer.RenderHtmlAsPdf(htmlTemplate);
            // Save or stream the PDF document
            pdfDocument.SaveAs(@"document.pdf");
            Console.WriteLine("PDF document generated successfully.");
        }
        catch (FlurlHttpException ex)
        {
            Console.WriteLine($"HTTP Error: {ex.Message}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
// Example model class for JSON deserialization
public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
}

using Flurl;
using Flurl.Http;
using IronPdf;
using System;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        try
        {
            var response = await "http://localhost:5013/users/1".GetJsonAsync<User>();
            var id = response?.Id;
            var name = response?.Name;
            Console.WriteLine($"Data fetched successfully: {name}");
            // Generate PDF using IronPDF
            var renderer = new HtmlToPdf();
            string htmlTemplate = $@"
                <html>
                <body>
                    <h1>{id}</h1>
                    <p>{name}</p>
                </body>
                </html>";
            // Generate PDF document from HTML template
            var pdfDocument = renderer.RenderHtmlAsPdf(htmlTemplate);
            // Save or stream the PDF document
            pdfDocument.SaveAs(@"document.pdf");
            Console.WriteLine("PDF document generated successfully.");
        }
        catch (FlurlHttpException ex)
        {
            Console.WriteLine($"HTTP Error: {ex.Message}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
// Example model class for JSON deserialization
public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
}

Imports Flurl
Imports Flurl.Http
Imports IronPdf
Imports System
Imports System.Threading.Tasks
Friend Class Program
	Shared Async Function Main(ByVal args() As String) As Task
		Try
			Dim response = await "http://localhost:5013/users/1".GetJsonAsync(Of User)()
			Dim id = response?.Id
			Dim name = response?.Name
			Console.WriteLine($"Data fetched successfully: {name}")
			' Generate PDF using IronPDF
			Dim renderer = New HtmlToPdf()
			Dim htmlTemplate As String = $"
                <html>
                <body>
                    <h1>{id}</h1>
                    <p>{name}</p>
                </body>
                </html>"
			' Generate PDF document from HTML template
			Dim pdfDocument = renderer.RenderHtmlAsPdf(htmlTemplate)
			' Save or stream the PDF document
			pdfDocument.SaveAs("document.pdf")
			Console.WriteLine("PDF document generated successfully.")
		Catch ex As FlurlHttpException
			Console.WriteLine($"HTTP Error: {ex.Message}")
		Catch ex As Exception
			Console.WriteLine($"Error: {ex.Message}")
		End Try
	End Function
End Class
' Example model class for JSON deserialization
Public Class User
	Public Property Id() As Integer
	Public Property Name() As String
End Class

VB C#

使用 Flurl 的 .GetJsonAsync()功能，示例发送了一个 GET 请求。将 "User "替换为代表 API 响应结构的模型类，将 "URL "替换为实际的 API 端点。 HTML 模板(htmlTemplate)可以渲染为PDF 文档

(pdfDocument)使用 IronPDF 的 HtmlToPdf 类。在本例中，从 API 中获取的标题和正文数据用于动态构建 HTML 模板。在文件系统中，创建的 PDF 文档(pdfDocument)保存到指定位置(“document.pdf”). 要到达您想去的地方，请改变路径。

Flurl C#（开发者如何使用）：图6 - 示例控制台输出

为网络故障等问题提供强大的错误处理功能(FlurlHttpException)或一般异常(异常)在数据提取或 PDF 制作过程中。您可以使用 IronPdf 更改页面大小、页边距、页眉、页脚和其他 PDF 设置。有关更多高级定制可能性，请参阅 IronPDF 的方式手册。向 API 发送 HTTP 查询时，确保敏感数据和访问令牌得到安全处理。使用您的 API 所需的正确验证方法。

结论

总之，将用于生成 PDF 的 IronPDF 与用于 C# 应用程序中 API 交互的 Flurl 相结合，可为动态检索数据和生成高质量 PDF 文档提供强有力的组合。 Flurl 库通过其流畅的 API 简化了 HTTP 请求，并在从远端点检索数据时提供了灵活性和用户友好性。此外，IronPDF 还能方便地将 HTML 资料翻译成 PDF 格式，并提供可调整的功能，如页眉、页边距和页面大小。

在实施集成时，还必须考虑速度优化、数据安全和错误处理。通过遵循最佳实践并利用 Flurl 和 IronPDF 的优势，开发人员可以创建可靠、可扩展的解决方案，成功满足当代应用程序的要求。

IronPDF 和IronSoftware 套件通过将 IronSoftware 高度灵活的系统和套件与其核心支持相结合，IronSoftware 可提供额外的在线应用程序和功能以及更高效的开发。

如果许可证替代方案明确且针对项目需求，开发人员就能更好地确定哪种模式是理想和最佳做法。这些优势使开发人员能够以清晰、引人注目和轻松整合的方式管理一系列问题。

< 前一页
IdentityServer .NET（开发人员如何工作）

下一步 >
NServiceBus C#（开发人员如何使用）