nanoFramework.System.Net.Http 1.5.145

欢迎使用.NET nanoFramework System.Net.Http库存储库

构建状态

组件	构建状态	NuGet包
System.Net.Http
System.Net.Http.Client
System.Net.Http.Server

使用示例

此库中的API、类和命名空间尽可能接近.NET中的结构。例外是缺少异步调用、泛型和Task以及异步/await模型。通过删除Async后缀以及不返回Task和缺少带有CancelationToken参数的 Overloaded方法来实现这一点。

还需要注意的是，为了能够验证服务器证书，需要将CA根证书传递给HttpClient。

HttpClient调用REST服务

HttpClient使得连接和消费REST服务变得非常简单。要使用它，必须创建对象，然后执行调用。请注意，HttpClient旨在在整个应用程序生命周期中重复使用。每次调用时无需创建新实例。如下所示

static readonly HttpClient _httpClient = new HttpClient();

传递CA根证书以允许验证安全服务器证书。CA根证书也可以来自资源中的二进制文件或文本文件。

_httpClient.HttpsAuthentCert = new X509Certificate(
@"-----BEGIN CERTIFICATE-----
MIIEDzCCAvegAwIBAgIBADANBgkqhkiG9w0BAQUFADBoMQswCQYDVQQGEwJVUzEl
MCMGA1UEChMcU3RhcmZpZWxkIFRlY2hub2xvZ2llcywgSW5jLjEyMDAGA1UECxMp
U3RhcmZpZWxkIENsYXNzIDIgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwHhcNMDQw
NjI5MTczOTE2WhcNMzQwNjI5MTczOTE2WjBoMQswCQYDVQQGEwJVUzElMCMGA1UE
ChMcU3RhcmZpZWxkIFRlY2hub2xvZ2llcywgSW5jLjEyMDAGA1UECxMpU3RhcmZp
ZWxkIENsYXNzIDIgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwggEgMA0GCSqGSIb3
DQEBAQUAA4IBDQAwggEIAoIBAQC3Msj+6XGmBIWtDBFk385N78gDGIc/oav7PKaf
8MOh2tTYbitTkPskpD6E8J7oX+zlJ0T1KKY/e97gKvDIr1MvnsoFAZMej2YcOadN
+lq2cwQlZut3f+dZxkqZJRRU6ybH838Z1TBwj6+wRir/resp7defqgSHo9T5iaU0
X9tDkYI22WY8sbi5gv2cOj4QyDvvBmVmepsZGD3/cVE8MC5fvj13c7JdBmzDI1aa
K4UmkhynArPkPw2vCHmCuDY96pzTNbO8acr1zJ3o/WSNF4Azbl5KXZnJHoe0nRrA
1W4TNSNe35tfPe/W93bC6j67eA0cQmdrBNj41tpvi/JEoAGrAgEDo4HFMIHCMB0G
A1UdDgQWBBS/X7fRzt0fhvRbVazc1xDCDqmI5zCBkgYDVR0jBIGKMIGHgBS/X7fR
zt0fhvRbVazc1xDCDqmI56FspGowaDELMAkGA1UEBhMCVVMxJTAjBgNVBAoTHFN0
YXJmaWVsZCBUZWNobm9sb2dpZXMsIEluYy4xMjAwBgNVBAsTKVN0YXJmaWVsZCBD
bGFzcyAyIENlcnRpZmljYXRpb24gQXV0aG9yaXR5ggEAMAwGA1UdEwQFMAMBAf8w
DQYJKoZIhvcNAQEFBQADggEBAAWdP4id0ckaVaGsafPzWdqbAYcaT1epoXkJKtv3
L7IezMdeatiDh6GX70k1PncGQVhiv45YuApnP+yz3SFmH8lU+nLMPUxA2IGvd56D
eruix/U0F47ZEUD0/CwqTRV/p2JdLiXTAAsgGh1o+Re49L2L7ShZ3U0WixeDyLJl
xy16paq8U4Zt3VekyvggQQto8PT7dL5WXXp59fkdheMtlb71cZBDzI0fmgAKhynp
VSJYACPq4xJDKVtHCN2MQWplBqjlIapBtJUhlbl90TSrE9atvNziPTnNvT51cKEY
WQPJIrSPnNVeKtelttQKbfi3QBFGmh95DmK/D5fs4C8fF5Q=
-----END CERTIFICATE-----");

![注意]

要从服务器获取根证书，如果您已安装OpenSSL，可以运行以下命令：openssl s_client -connect the.server-to-get-the-cert.com:443 -showcerts 这将显示所有使用的根证书并以PEM形式展示。然后您可以复制/粘贴所需的证书。

可以为每个请求添加要发送的HTTP头部。

_httpClient.DefaultRequestHeaders.Add("x-ms-blob-type", "BlockBlob");

执行HTTP GET请求

以下是一个以字符串读取内容的HTTP请求示例

HttpResponseMessage response = _httpClient.Get("https://httpbin.org/get");
response.EnsureSuccessStatusCode();
var responseBody = response.Content.ReadAsString();

上述调用将返回类似以下的内容，可以在Visual Studio中通过调用Debug.WriteLine(responseBody)输出

{
  "args": {}, 
  "headers": {
    "Host": "httpbin.org", 
    "X-Amzn-Trace-Id": "Root=1-6214aad3-38e5f8357bdf90530300eb5f", 
    "X-Ms-Blob-Type": "BlockBlob"
  }, 
  "origin": "5.249.47.208", 
  "url": "https://httpbin.org/get"
}

注意调用response.EnsureSuccessStatusCode();。如果HTTP请求的状态码不是成功的状态码，则会抛出HttpRequestException。

执行HTTP POST请求

以下是一个执行POST请求向端点发送JSON内容的HTTP请求示例。

var content = new StringContent("{\"someProperty\":\"someValue\"}", Encoding.UTF8, "application/json");
var result = _httpClient.Post("https://httpbin.org/anything", content);
result.EnsureSuccessStatusCode();

值得注意的是，上述JSON内容以简单的字符串形式呈现，以简化代码。您还可以使用json库来帮助将C#类序列化和反序列化，即使是复杂类。

再次，注意调用response.EnsureSuccessStatusCode();以确保HTTP请求执行成功。

将二进制内容下载到文件

使用HttpClient也可以轻松处理二进制内容。以下是如何从web服务器下载文件的一个示例。

HttpResponseMessage response = _httpClient.Get("https://storage-on-the-cloud.net/file-with-binary-content");
response.EnsureSuccessStatusCode();

using FileStream fs = new FileStream($"I:\\i-am-a-binary-file.bin", FileMode.Create, FileAccess.Write);
response.Content.ReadAsStream().CopyTo(fs);

释放响应

![重要]您必须为所有请求释放响应。设备内存有限，如果不请求释放，响应内容将不会释放。根据设备，在内存不足之前可能只有16个可请求的。

以下是一些确保正确释放响应内容的良好模式

using HttpResponseMessage response = client.Get(apiUrl);
// do whatever you want
// When the response object won't be used, it will be disposed

您还可以为块使用显式using

using HttpResponseMessage response = client.Get(apiUrl)
{
  // do whatever you want
  // when exiting the block, the response will be disposed
}

或显式释放响应

HttpResponseMessage response = client.Get(apiUrl);
// do whatever you want
// Dispose explicitly the content
response.Dispose();

在任何情况下，您都必须确保释放响应内容。

通过反向代理进行调试

当代码部署到MCU时，可能希望让设备连接到运行IIS Express的开发机器。这可以通过例如此代理实现。请注意，这会导致当前版本的System.Net.Http在向开发机器发送连续请求时出现SocketExceptions。在调试模式下实现一个简单的重试机制可以解决这个问题。

反馈和文档

有关文档、提供反馈、报告问题以及了解如何贡献的信息，请参阅主页仓库。

加入我们的Discord社区这里。

致谢

此项目的贡献者列表可以在贡献者中找到。

许可协议

nanoFramework Class Libraries采用MIT许可协议。

行为准则

本项目采用了由贡献者公约定义的守则，以明确我们社区的期望行为。更多信息请参阅.NET Foundation 守则。

.NET Foundation

本项目由.NET Foundation 支持。