nanoFramework.System.Net.Http.Server 1.5.145

欢迎使用.NET nanoFramework System.Net.Http库仓库

构建状态

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

使用示例

此库中的API、类和命名空间尽可能遵循.NET的，但有一些例外：不包含异步调用、泛型和Task，以及缺少具有CancelationToken参数的重载方法。名称的变化反映这一点，通过移除Async后缀，不返回Task，以及缺少带CancelationToken参数的重载方法。

还值得一提的是，需要向HttpClient传递CA根证书，以便能够验证服务器证书。

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处理二进制内容也非常容易。以下是从网络服务器下载文件的一个示例。

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的开发机器。这可以通过使用诸如此代理之类的代理来实现。请注意，这会导致在使用当前版本的nanoFramework System.Net.Http时向开发机器发送连续请求时出现SocketExceptions。在调试模式下，一个简单的重试机制可以解决这个问题。

反馈和文档

有关文档、提供反馈、问题以及了解如何贡献，请参阅主存储库。

加入我们的Discord社区这里。

鸣谢

此项目的贡献者名单可在CONTRIBUTORS中找到。

许可协议

nanoFramework类库受MIT许可证的许可。

行为准则

本项目已采用贡献者契约中定义的行为准则，以明确我们社区中预期的行为。有关更多信息，请参阅.NET Foundation行为准则。

.NET Foundation

本项目由.NET Foundation支持。