【C#生态园】构建高效HTTP请求和异常处理：深度剖析6款.NET库和框架

🕗 发布于 2024-09-23 05:21 http .net 网络协议

简化JSON操作、优化API调用：探索.NET开发利器的核心功能

前言

在现代的软件开发中，使用合适的库和框架可以极大地提高开发效率和代码质量。特别是在构建和调用 RESTful Web 服务时，选择合适的工具至关重要。本文将介绍几个在 .NET 开发中常用的库和框架，它们分别用于生成、描述、调用和可视化 RESTful Web 服务，以及简化 HTTP 请求、处理异常等功能。

欢迎订阅专栏：C#生态园

文章目录

简化JSON操作、优化API调用：探索.NET开发利器的核心功能

1. Swagger：一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful Web 服务

1.1 简介

Swagger是一个用于生成、描述、调用和可视化RESTful Web服务的规范和完整框架。它包括一组工具，可以轻松地为API设计、编写文档、测试和部署。

1.1.1 核心功能

Swagger的核心功能包括：

自动生成API文档
提供API调用接口
支持可视化展示

1.1.2 使用场景

Swagger通常用于以下场景：

在开发过程中生成API文档
提供一个交互式API控制台，方便开发人员调试和测试API
将API以可视化形式展示给团队成员或客户

1.2 安装与配置

Swagger提供了多种安装和配置方式，下面是一种基本的安装与配置方法。

1.2.1 安装指南

通过NuGet包管理器安装 Swashbuckle.AspNetCore 库。在Visual Studio中，可以直接在NuGet包管理器控制台中运行以下命令：

Install-Package Swashbuckle.AspNetCore

关于Swashbuckle.AspNetCore更多信息，请查看官方文档

1.2.2 基本设置

在Startup.cs文件中进行Swagger的基本配置。以下是一个简单的配置示例：

public void ConfigureServices(IServiceCollection services)
{
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
    });
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ...

    app.UseSwagger();
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
    });

    // ...
}

更多高级设置请参考官方文档

1.3 API 概览

1.3.1 文档生成

Swagger可以根据代码中的特性和注释自动生成API文档。以下是一个简单的控制器示例：

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    [HttpGet]
    public IEnumerable<WeatherForecast> Get()
    {
        // ...
    }
}

以上代码中的特性会被Swagger解析并生成对应的API文档。

1.3.2 API 调用

Swagger生成的API文档同时提供了API调用接口，开发人员可以直接在Swagger UI界面上调用API。以下是一个C#实例代码，演示如何使用生成的API文档中的接口：

var client = new HttpClient();
var response = await client.GetAsync("https://localhost:<port>/weatherforecast");
if (response.IsSuccessStatusCode)
{
    var content = await response.Content.ReadAsStringAsync();
    Console.WriteLine(content);
}

以上是Swagger的简要介绍和基本配置示例，具体内容和更多功能请查阅Swagger官方文档。

2. NSwag：一个用于生成 .NET API 文档和客户端代码的库

2.1 简介

NSwag 是一个功能强大的工具，用于生成 .NET API 文档和客户端代码。它支持从 WebAPI 控制器、ASP.NET Core 控制器、WCF 或其他 .NET 后端生成 OpenAPI/Swagger 规范文档，并可以进一步生成 C# 和 TypeScript 客户端代码。

2.1.1 核心功能

从 .NET 后端生成 OpenAPI/Swagger 规范文档
自动生成 C# 和 TypeScript 客户端代码

2.1.2 使用场景

NSwag 可以广泛应用于 .NET 后端项目中，特别适用于需要自动生成 API 文档和客户端代码的场景，如前后端分离开发、微服务架构等。

2.2 安装与配置

2.2.1 安装方法

首先，在 Visual Studio 中打开 NuGet 包管理器控制台，执行以下命令安装NSwag：

Install-Package NSwag.AspNetCore

2.2.2 基本设置

在 ASP.NET Core 项目的 Startup.cs 文件中进行配置，示例代码如下：

public void ConfigureServices(IServiceCollection services)
{
    // 配置NSwag生成Swagger 文档
    services.AddOpenApiDocument(config =>
    {
        config.Title = "My API";
        config.AddSecurity("JWT", Enumerable.Empty<string>(), new OpenApiSecurityScheme
        {
            Type = OpenApiSecuritySchemeType.ApiKey,
            Name = "Authorization",
            In = OpenApiSecurityApiKeyLocation.Header,
            Description = "Copy this into the value field: Bearer {token}"
        });
    });
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // 启用NSwag SwaggerUI
    app.UseOpenApi();
    app.UseSwaggerUi3();
}

2.3 API 概览

2.3.1 文档生成

通过 NSwag 自动生成 API 文档非常简单。在 .NET 后端项目中集成 NSwag 后，它会自动扫描你的 API 控制器并生成相应的 Swagger 文档。你可以访问 https://your-api-base-url/swagger 来查看生成的 API 文档。

2.3.2 客户端代码生成

NSwag 也提供了生成客户端代码的功能。以下是一个使用 NSwag 命令行工具生成 C# 客户端代码的示例：

nswag openapi2csclient /input:swagger.json /classname:ApiClient /output:Client.cs

通过上述命令，NSwag 会根据提供的 Swagger 文档（swagger.json）生成一个名为 ApiClient 的 C# 客户端代码文件。

官网链接：NSwag

3. Flurl：用于简化HTTP请求的库

Flurl 是一个用于简化 HTTP 请求的 C# 库，它使得发送和处理 HTTP 请求变得更加简单和直观。在本文中，我们将介绍 Flurl 的核心功能、安装与配置方法以及 API 概览。

3.1 简介

3.1.1 核心功能

Flurl 提供了一种简洁而强大的方式来构建和发送 HTTP 请求，并处理响应。它能够轻松地处理 URL 构建、参数传递、请求发送等操作。

3.1.2 使用场景

Flurl 通常用于需要频繁进行 HTTP 请求的应用程序中，比如 Web API 调用、远程数据获取等场景。

3.2 安装与配置

3.2.1 安装指南

你可以通过 NuGet 来安装 Flurl。在 Visual Studio 中，可以使用 NuGet 包管理器来搜索并安装 Flurl 包。或者在 Package Manager 控制台中运行以下命令：

Install-Package Flurl.Http

更多详情请参考 NuGet Flurl.Http

3.2.2 基本配置

安装完成后，在代码中引入 Flurl 的命名空间：

using Flurl;
using Flurl.Http;

3.3 API 概览

3.3.1 URL构建

Flurl 提供了便捷的 API 来构建 URL，可以使用 AppendPathSegment、SetQueryParams 等方法来构建所需的 URL。下面是一个示例：

var url = "https://api.example.com"
    .AppendPathSegment("users")
    .SetQueryParams(new {
        page = 1,
        pageSize = 10
    });

更多关于 URL 构建的信息，请查阅 Flurl URL Building

3.3.2 请求发送

Flurl 使得发送请求变得非常简单，可以使用 GetAsync、PostJsonAsync 等方法来发送不同类型的请求。下面是一个示例：

var response = await "https://api.example.com/users"
    .WithOAuthBearerToken("your_token")
    .GetAsync();

更多关于请求发送的信息，请查阅 Flurl Request Sending

4. Polly：用于处理HTTP请求中的重试和异常处理的库

4.1 简介

Polly 是一个能够帮助开发人员处理重试和异常的库，可以轻松地增加容错机制到.NET应用程序中。

4.1.1 核心功能

Polly 提供了强大的策略定义，可用于配置重试、回退、断路器等行为，以及异常处理和故障处理。

4.1.2 使用场景

在执行 HTTP 请求时，需要进行重试以增加稳定性和可靠性。
需要对不同类型的异常进行特定的处理或重试策略。
需要实现断路器模式来防止雪崩效应。

4.2 安装与配置

4.2.1 安装方法

使用 NuGet 包管理器来安装 Polly 库：

Install-Package Polly

更多安装方式请参考 NuGet Polly

4.2.2 基本设置

在使用之前，需要在代码中引入 Polly 命名空间：

using Polly;

4.3 API 概览

4.3.1 策略定义

Polly 允许用户定义各种策略来处理重试、回退和瞬态故障等。以下是一个简单的重试策略示例：

// 定义一个重试策略，最多重试3次
var policy = Policy
    .Handle<HttpRequestException>()
    .Retry(3);

更多关于策略定义的信息，请参考 Polly - Policy Syntax

4.3.2 异常处理

Polly 也提供了丰富的异常处理功能，可以根据具体的异常类型进行处理。以下是一个处理特定异常的示例：

// 处理特定异常并执行自定义操作
var policy = Policy
    .Handle<TimeoutException>()
    .Fallback(() => Console.WriteLine("执行超时！"));

更多关于异常处理的信息，请参考 Polly - Exception Handling

以上是对 Polly 库的简单介绍和基本使用说明，更多详细信息请参考 Polly GitHub

5. Newtonsoft.Json：用于JSON序列化和反序列化的库

5.1 简介

Newtonsoft.Json是一个用于在.NET平台上进行JSON序列化和反序列化的流行库，由James Newton-King开发。它提供了一系列强大的功能，使得处理JSON数据变得简单而高效。

5.1.1 核心功能

支持将.NET对象序列化为JSON格式的字符串
能够将JSON格式的字符串反序列化为.NET对象
提供了灵活的配置选项，以满足不同的序列化和反序列化需求

5.1.2 使用场景

Newtonsoft.Json可广泛应用于各种.NET开发场景中，包括但不限于：

Web开发中处理前后端数据交互
与第三方API进行通信时的数据格式转换
数据存储和读取过程中的对象序列化和反序列化

5.2 安装与配置

5.2.1 安装指导

在Visual Studio中，可以通过NuGet Package Manager来安装Newtonsoft.Json库。在Package Manager Console中执行以下命令即可完成安装：

Install-Package Newtonsoft.Json

5.2.2 基本配置

使用Newtonsoft.Json无需复杂的配置过程，只需在C#代码中引入相关命名空间即可开始使用。

using Newtonsoft.Json;

5.3 API 概览

5.3.1 JSON序列化

// 创建一个示例对象
public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}

class Program
{
    static void Main()
    {
        // 初始化Person对象
        var person = new Person { Name = "Alice", Age = 30 };

        // 将对象序列化为JSON格式的字符串
        string json = JsonConvert.SerializeObject(person);

        Console.WriteLine(json);
        // 输出结果: {"Name":"Alice","Age":30}
    }
}

更多关于JSON序列化的信息，请参考官方文档

5.3.2 JSON反序列化

class Program
{
    static void Main()
    {
        // 定义一个JSON格式的字符串
        string json = @"{'Name':'Bob','Age':25}";

        // 将JSON格式的字符串反序列化为Person对象
        Person person = JsonConvert.DeserializeObject<Person>(json);

        Console.WriteLine(person.Name); // 输出结果: Bob
        Console.WriteLine(person.Age);  // 输出结果: 25
    }
}

更多关于JSON反序列化的信息，请参考官方文档

6. ServiceStack：一个全功能的C# REST API框架

ServiceStack 是一个开源的、高性能的C# Web服务框架，支持创建 RESTful API 和 Web 服务。它具有简洁的设计和强大的功能，可以帮助开发人员快速构建可扩展的服务端应用程序。

6.1 简介

6.1.1 核心功能

ServiceStack 提供了以下核心功能：

快速的.NET Web服务框架
支持RESTful API和SOAP服务
强大的数据访问和ORM支持
内置的认证和授权机制
自定义插件和中间件支持

6.1.2 使用场景

ServiceStack 可以广泛应用于企业级应用程序、移动应用后端、IoT 设备通讯和微服务架构中，适用于需要高性能、可扩展性和安全性的场景。

6.2 安装与配置

6.2.1 安装指南

你可以通过NuGet包管理器来安装ServiceStack框架。在Visual Studio中打开NuGet包管理器控制台，并执行以下命令来安装ServiceStack：

Install-Package ServiceStack

6.2.2 基本设置

安装完成后，在Global.asax.cs文件中进行初始化配置：

public class AppHost : AppHostBase
{
    public AppHost() : base("Your App Name", typeof(MyServices).Assembly) { }

    public override void Configure(Container container)
    {
        // 注册服务
        Routes
            .Add<MyRequest>("/myrequest")
            .Add<MyOtherRequest>("/myotherrequest");
    }
}

6.3 API 概览

6.3.1 服务创建

ServiceStack 提供了一种简单的方式来创建服务，只需继承Service类并实现所需的服务方法即可。下面是一个示例：

[Route("/hello/{Name}")]
public class Hello : IReturn<HelloResponse>
{
    public string Name { get; set; }
}

public class HelloResponse
{
    public string Result { get; set; }
}

public class HelloService : Service
{
    public object Any(Hello request)
    {
        return new HelloResponse { Result = "Hello, " + request.Name };
    }
}

在上面的示例中，我们定义了一个简单的“Hello”服务，当请求 /hello/xxx 时返回 Hello, xxx。

6.3.2 数据访问

ServiceStack提供了强大的数据访问支持，它集成了多种ORM工具，并提供了自己的OrmLite库来简化数据访问操作。下面是一个使用OrmLite进行查询操作的示例：

var allEmployees = db.Select<Employee>(); // 查询所有的Employee记录
var employee = db.SingleById<Employee>(id); // 根据ID查询Employee记录

更多关于ServiceStack的API和详细文档，请参考官方文档。

总结

本文对Swagger、NSwag、Flurl、Polly、Newtonsoft.Json和ServiceStack这六个库和框架进行了全面而深入的介绍。通过阅读本文，读者可以快速了解这些工具的核心功能、使用场景和安装配置方法，为日后的.NET开发工作提供参考和指导。

原文地址：https://blog.csdn.net/qq_42531954/article/details/142443265

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

上一篇：[Excel VBA]如何使用VBA按行拆分Excel工作表
下一篇：GNU链接器（LD）：什么是符号？符号定义及实例解析

【nrm】 Node.js 包管理器
nrm（Node Registry Manager）是一个用于管理 Node.js 包管理器（如 npm和 Yarn）的注册表工具。它可以帮助用户快速切换不同的 npm 源，以便于提高包安装的速度和效
阅读更多2024-09-25
luceda ipkiss教程 74：布尔运算去掉部分图层
通过布尔运算去掉版图上部分元素
阅读更多2024-09-25
Java中的位图和布隆过滤器（如果想知道Java中有关位图和布隆过滤器的知识点，那么只看这一篇就足够了！）
Java中的位图和布隆过滤器（如果想知道Java中有关位图和布隆过滤器的知识点，那么只看这一篇就足够了！）
阅读更多2024-09-25
ReadWriteLock读写锁
ReadWriteLock是Java并发包中的一个接口，它定义了两种锁：读锁（Read Lock）和写锁（Write Lock），真正的实现类是ReentrantReadWriteLock。读锁允许多
阅读更多2024-09-25
VisionPro - 基础 - 模板匹配技术-应用2 - Search\PMAline\PatMax\Image Training 的使用和模型训练概论
Image Training 是VP最常用的一种模板匹配方法了。必须掌握：这节详细说明。本节内容：【通过图像来进行匹配，其实，在业界叫做非模板匹配。当然匹配的前提是，你需要有显著的特征。【案，上表
阅读更多2024-09-25
0基础学前端 day2
层叠样式表（CSS，Cascading Style Sheets）是用来进行网页样式和布局设计的语言。通过CSS，开发者可以控制网页中元素的颜色、字体、大小、间距以及布局等视觉效果。CSS让页面不仅仅
阅读更多2024-09-25
Ubuntu20安装g++ 13.2.0
使用 PPA 是最简单的方式来安装g++ 13或者较新的版本。如果需要特定的版本，可以选择手动编译，但这个过程较为复杂且耗时。通过这两种方法，你可以在 Ubuntu 20.04 上成功安装并使用g++
阅读更多2024-09-25
HTTPS加密流程
如果发生了中间人攻击这种情况是非常严重的，由于传输数据是需要借助非对称加密，所以在客户端发送数据前会先通过验证公钥的方式确认对方是否是服务器，再决定是否要传输数据，在这个过程中服务器会返回一个响应告诉
阅读更多2024-09-25
YOLOv9改进策略【Conv和Transformer】| Bottleneck Transformers 简单且高效的自注意力模块
本文记录的是利用优化的目标检测网络模型。标准的卷积操作虽然能有效捕获局部信息，但在处理需要全局信息整合的任务时存在局限性，而自注意力机制能够有效地建模长距离依赖，因此考虑将其引入到视觉架构中。同本文利
阅读更多2024-09-25
Linux基本指令（2）
而我们学过的文件操作中,每次都需要先打开文件,所以键盘显示器这些文件就在启动程序时打开了这些文件。我们也可以通过输出从定向来实现从一个终端向另一个终端中打印内容。带上后就可以递归将文件和子目录一起处理
阅读更多2024-09-25