分享一个热门的HTTP开源库

概述

Flurl是一个功能强大且易于使用的开源HTTP客户端库，主要用于简化和增强对REST API的调用。Flurl不仅提供了一套流畅的API接口，还支持强大的URL构建、异步操作、全局配置和测试模拟等功能，使得开发人员能够更加高效地进行HTTP操作。

特性

1. 流畅的API接口

Flurl的API设计非常简洁且易于使用，通过链式调用可以轻松构建和发送HTTP请求。例如，发送一个GET请求只需要如下几行代码：

var response = await "https://api.example.com"
    .AppendPathSegment("users")
    .SetQueryParam("name", "john")
    .GetAsync();

2. 强大的URL构建功能

Flurl允许你通过链式调用来构建复杂的URL。你可以添加路径段、查询参数、甚至是处理URL编码问题。

var url = new Url("https://api.example.com")
    .AppendPathSegment("users")
    .SetQueryParam("name", "john")
    .ToString(); // 输出: https://api.example.com/users?name=john

3. 支持异步操作

Flurl全面支持异步操作，使用async/await关键字可以避免阻塞主线程，提高应用的响应速度。

var response = await "https://api.example.com/users".GetJsonAsync<User>();

4. 全局配置和拦截器

Flurl提供了全局配置选项，可以设置默认的超时时间、全局的请求头、重试策略等。同时，Flurl还支持请求和响应的拦截，方便进行日志记录和异常处理。

FlurlHttp.Configure(settings => {
    settings.HttpClientFactory = new MyCustomHttpClientFactory();
    settings.BeforeCall = call => Logger.LogRequest(call);
    settings.AfterCall = call => Logger.LogResponse(call);
});

5. 易于测试

Flurl的HttpTest类使得测试HTTP请求变得非常简单。通过设置期望的请求和响应，可以轻松地进行单元测试而不需要实际发送请求。

using (var httpTest = new HttpTest())
{
    httpTest.RespondWithJson(new { name = "john" });

    var result = await "https://api.example.com/users".GetJsonAsync<User>();

    httpTest.ShouldHaveCalled("https://api.example.com/users")
        .WithVerb(HttpMethod.Get)
        .Times(1);
}
 

安装

在你的项目中使用Flurl非常简单，你只需要在NuGet包管理器中安装Flurl.Http包：

Install-Package Flurl.Http

或者使用.NET CLI：

dotnet add package Flurl.Http

示例代码

以下是一个使用Flurl的完整示例，包括GET和POST请求、错误处理以及异步操作：

using System;
using System.Threading.Tasks;
using Flurl.Http;

namespace FlurlExample
{
    class Program
    {
        static async Task Main(string[] args)
        {
            try
            {
                // 发送GET请求
                var user = await "https://api.example.com/users/1".GetJsonAsync<User>();

                Console.WriteLine($"Name: {user.Name}, Email: {user.Email}");

                // 发送POST请求
                var newUser = new { Name = "Jane Doe", Email = "jane.doe@example.com" };
                var createdUser = await "https://api.example.com/users".PostJsonAsync(newUser).ReceiveJson<User>();

                Console.WriteLine($"Created User: {createdUser.Name}, Email: {createdUser.Email}");
            }
            catch (FlurlHttpException ex)
            {
                // 错误处理
                Console.WriteLine($"Error: {ex.Message}");
                var error = await ex.GetResponseJsonAsync<Error>();
                Console.WriteLine($"API Error: {error.Message}");
            }
        }
    }

    public class User
    {
        public string Name { get; set; }
        public string Email { get; set; }
    }

    public class Error
    {
        public string Message { get; set; }
    }
}
 

总结

Flurl是一个非常强大且易于使用的HTTP客户端库，适用于需要频繁与REST API进行交互的.NET应用程序。通过其流畅的API、强大的URL构建功能、全面的异步支持、全局配置选项以及测试友好的特性，Flurl能够极大地提升开发效率和代码可读性。希望这篇分享文档能帮助你更好地理解和使用Flurl进行HTTP操作。

开源地址：GitHub - tmenier/Flurl: Fluent URL builder and testable HTTP client for .NET