编码艺术：如何用Flurl构建出色的网络请求
在软件开发的世界里，网络请求是构建现代应用程序不可或缺的一部分。随着API和微服务的流行，我们需要更好的工具来管理这些交互。在这篇文章中，我们将探讨Flurl，它是一款强大的.NET库，可以帮助我们高效地构建和测试HTTP请求。
什么是Flurl？
Flurl是一个基于C#的URI模块化系统，允许你以一种声明式、链式调用方式来创建复杂的HTTP请求。这意味着你可以通过一系列简单、易于阅读的方法轻松地组合你的URL路径、查询参数以及其他元素，而无需担心细节。
如何使用Flurl？
创建基本请求
var url = "https://api.example.com/users";
var response = await url.GetJsonAsync<List<User>>();
上面的代码片段展示了如何使用Flurl创建一个GET请求，并且直接获取JSON响应并解析成List<User>类型。
参数化URL
如果你想动态添加参数到你的URL中，你可以这样做：
var userId = 123;
var userUrl = $"https://api.example.com/users/{userId}";
或者，如果你想要一次性处理多个参数：
var id = 1;
var name = "John Doe";
// Flurl提供了多种方法来设置参数。
// 这里我只列举其中的一些：
userUrl.AppendPathSegment($"users/{id}");
userUrl.SetQueryParam("name", name);
userUrl.SetQueryParam("age", 30);
// 或者使用链式调用风格：
User user = await (from baseUri in "https://api.example.com"
from path in "users"
from segment in $"{id}"
from queryName in new[] { "name", "age" }
let queryValue =
queryName switch {
"name" => name,
_ => queryName == "age" ? 30.ToString() : null
}
where queryValue != null
select baseUri.CombinePath(path).CombinePath(segment)
.SetQueryParams(new Dictionary<string, string>
{
[queryName] = queryValue!
})
.GetJsonAsync<User>()).DefaultIfEmpty(null).FirstOrDefault();
处理POST请求
对于POST请求，你可以像这样操作：
string jsonPayload =
"{\"username\":\"john\",\"email\":\"john@example.com\"}";
dynamic dataToPostAsDynamicObject;
try {
dataToPostAsDynamicObject =
JsonConvert.DeserializeObject<dynamic>(jsonPayload);
} catch (JsonReaderException ex) {
Console.WriteLine($"Error parsing JSON: {ex.Message}");
}
using var contentStreamWriter =
new StreamWriter(new MemoryStream(), leaveOpen: true);
await JsonSerializer.SerializeAsync(dataToPostAsDynamicObject, contentStreamWriter);
contentStreamWriter.BaseStream.Position = 0;
using var httpContent =
new StringContent(contentStreamWriter.ReadToEnd(), Encoding.UTF8, ContentType.Json);
httpContent.Headers.ContentType?.Parameters["charset"] ??= Encoding.UTF8.WebName;
using var responseMessageWithBodyAndHeadersFromApiCall =
from baseAddressString in uriBase.ParseAbsoluteUri()
from requestMethodString in HttpMethod.Post.MethodString.ToHttpMethod().ToString()
let headersForRequestInDictionaryForm =
new Dictionary<string, string>
{
[HttpHeaderNames.Accept] ="application/json",
[HttpHeaderNames.ContentType]= @"application/json; charset=utf-8"
}
let bodyOfRequestInMemoryForm =
new MemoryStream(Encoding.UTF8.GetBytes(jsonPayload))
into streamInputIntoRequestBodyUsingStreamWriterOrStreamReader_
select Post($"{baseAddressString}{resource}", headersForRequestInDictionaryForm,
bodyOfRequestInMemoryForm)
return await responseMessageWithBodyAndHeadersFromApiCall.ReadAsStreamAsync();
responseMessageWithBodyAndHeadersFromApiCall.EnsureSuccessStatusCode();
string responseBodyTextAsUTF16LittleEndianEncodedBytes =
await HttpContentExtensions.ReadAsStringAsync(responseMessageWithBodyFromApiResponse_);
Console.WriteLine(
$"Server responded with a status code of '{(int)responseMessage.StatusCode}'");
Console.WriteLine(responseBodyTextAsUTF16LittleEndianEncodedBytes); // Output the result.
这个例子展示了如何发送一个带有JSON payload的POST请求，并打印服务器响应。
总结
总之，使用Flurl进行网络通信能够让我们的代码更加清晰和简洁。它为我们提供了一种优雅而强大的方式去构建复杂HTTP 请求，无论是在开发Web应用还是移动应用时都非常有用。通过学习和实践这项技术，你将能够提高自己的工作效率，并且能更好地理解API设计原则，从而写出更好的代码。如果你还没有开始尝试，今天就开始吧！