零基础网站建设教学培训,360免费wifi连不上,wordpress编辑器升级,开发一个网站的流程在C#xff03;中使用RESTful API的几种好方法原文来自互联网#xff0c;由长沙DotNET技术社区编译。 通过Web开发的路径#xff0c;您发现自己迟早需要处理外部API#xff08;应用程序编程接口#xff09;。在本文中#xff0c;我的目标是列出在C#xff03;项目中使用… 在C中使用RESTful API的几种好方法原文来自互联网由长沙DotNET技术社区编译。 通过Web开发的路径您发现自己迟早需要处理外部API应用程序编程接口。在本文中我的目标是列出在C项目中使用RESTful API的方法的最全面列表并通过一些简单示例向您展示如何做到这一点。阅读该文章后您将更深入地了解可以使用哪些选项以及下次需要使用RESTful API[2]时如何选择正确的选项。什么是RESTful API因此在开始之前您可能想知道API[3]代表什么以及RESTful的全部含义是什么简而言之API是软件应用程序之间的层。您可以将请求发送到API[4]并从中获得响应。API隐藏了软件应用程序具体实现的所有细节并公开了您用于与该应用程序通信的接口。整个互联网是由API组成的大型蜘蛛网。我们使用API在应用程序之间通信和关联信息。我们有一个API[5]可以处理几乎所有内容。您每天使用的大多数服务都有自己的APIGoogleMapsFacebookTwitterInstagram天气门户…RESTful部分意味着API是根据REST表示状态传输的原理和规则来实现的REST是网络的基础架构原理。RESTful API在大多数情况下会返回纯文本JSON或XML响应。更详细地解释REST不在本文的讨论范围之内但是您可以在我们的文章REST API最佳实践中[6]阅读有关REST的更多信息。如何使用RESTful API好吧让我们进入整个故事中最重要的部分。有几种方法可以在C中使用RESTful API•HttpWebRequest/Response Class[7]•WebClient Class[8]•HttpClient Class[9]•RestSharp NuGet Package[10]•ServiceStack Http Utils[11]•Flurl[12]•DalSoft.RestClient[13]这些中的每一个都有优点和缺点因此让我们仔细研究它们看看它们提供了什么。例如我们将通过GitHub API收集有关RestSharp回购版本及其发布日期的信息。此信息是公开可用的您可以在此处查看原始JSON响应的外观 RestSharp版本[14]我们将利用Json.NET库的帮助来反序列化获得的响应。同样对于某些示例我们将使用库的内置反序列化机制。选择哪种方式取决于您因为没有正确的方法。您可以在源代码中[15]看到这两种机制的实现。我期望通过接下来的几个示例得到一个反序列化JArray为简单起见其中包含RestSharp发布信息。之后我们可以遍历它以获得以下结果。HttpWebRequest / Response类这是WebRequest 类的特定于HTTP的实现该实现最初用于处理HTTP请求但已过时并由WebClient该类代替 。该HttpWebRequest 提供细粒度控制的要求制定过程的每一个环节。您可以想象这可能是一把双刃剑您很容易浪费大量时间来微调您的请求。另一方面这可能正是您针对特定案例所需要的。HttpWebRequest 类不会阻止用户界面也就是说我相信您会同意这一点这一点非常重要。HttpWebResponse 类为传入的响应提供了一个容器。这是有关如何使用这些类使用API的简单示例。public class HttpWebRequestHandler : IRequestHandler
{public string GetReleases(string url){var request (HttpWebRequest)WebRequest.Create(url);request.Method GET;request.UserAgent RequestConstants.UserAgentValue;request.AutomaticDecompression DecompressionMethods.Deflate | DecompressionMethods.GZip;var content string.Empty;using (var response (HttpWebResponse)request.GetResponse()){using (var stream response.GetResponseStream()){using (var sr new StreamReader(stream)){content sr.ReadToEnd();}}}return content;}
}
尽管是一个简单的示例但是当您需要处理更复杂的方案例如发布表单信息授权等时它会变得更加复杂。WebClient类别这个类对HttpWebRequest的包装。它通过HttpWebRequest从开发人员中提取的细节来简化流程。该代码更容易编写并且您通过这种方式犯错误的可能性较小。如果您想编写更少的代码而不用担心所有细节并且执行速度是不重要的请考虑使用WebClientclass。这个示例应该使您大致了解WebClient与HttpWebRequest/ HttpWebResponse方法相比使用起来要容易得多。public string GetReleases(string url)
{var client new WebClient();client.Headers.Add(RequestConstants.UserAgent, RequestConstants.UserAgentValue);var response client.DownloadString(url);return response;
}
容易得多对吗除了其他DownloadString方法WebClient类还提供了许多其他有用的方法使我们的生活更轻松。我们可以轻松地使用它来操作字符串文件或字节数组并且价格比HttpWebRequest/ HttpWebResponse方法要慢几毫秒。无论是HttpWebRequest/ HttpWebResponse和WebClient类在旧版本的.NET可供选择。如果您对其他产品感兴趣请务必查看MSDN[16]WebClient。HttpClient类HttpClient 是“新人”它提供了旧库所缺乏的一些现代.NET功能。例如您可以使用的单个实例发送多个请求HttpClient它不绑定到特定的HTTP服务器或主机而是使用async / await机制。您可以在此视频中[17]找到使用HttpClient[18]的五个很好的理由[19]•强类型标题。•共享缓存cookie和凭据•访问cookie和共享cookie•控制缓存和共享缓存。•将您的代码模块注入ASP.NET管道。清洁和模块化的代码。HttpClient在我们的示例中这是实际的public string GetReleases(string url)
{using (var httpClient new HttpClient()){httpClient.DefaultRequestHeaders.Add(RequestConstants.UserAgent, RequestConstants.UserAgentValue);var response httpClient.GetStringAsync(new Uri(url)).Result;return response;}
}
为了简单起见我同步实现了它。每个HttpClient方法都应异步使用应该以这种方式使用。另外我还要提到一件事。是否HttpClient应该包装在using块中还是在应用程序级别上进行静态讨论。尽管它实现了IDisposable但似乎通过将它包装在using块中会使应用程序出现故障并获得SocketException[20]。而在ANKIT博客中提供了基于很多有利于静态初始化的[21]的HttpClient性能测试结果是。请务必阅读这些博客文章因为它们可以帮助您更了解该HttpClient 库的正确用法。并且不要忘记由于是新的HttpClient是.NET 4.5以上版本才有因此在某些旧项目中使用它可能会遇到麻烦。RestSharpRestSharp是标准.NET库的OpenSource替代品也是目前最酷的.NET库之一。它以NuGet软件包的形式提供出于某些原因您应该考虑尝试一下。就像HttpClientRestSharp 一样它是一个现代而全面的库易于使用且令人愉悦同时仍支持旧版本的.NET Framework。它具有内置的身份验证[22]和序列化/反序列化机制[23]但允许您使用自定义机制[24]覆盖它们。它可跨平台使用[25]并支持OAuth1OAuth2基本NTLM和基于参数的身份验证。您可以选择同步或异步工作。该库还有很多其他功能而这些只是它提供的众多好处中的一部分。有关RestSharp的用法和功能的详细信息您可以访问GitHub上[26]的RestSharp 页面[27]。现在让我们尝试使用RestSharp get获取RestSharp版本的列表。public string GetReleases(string url)
{var client new RestClient(url);var response client.Execute(new RestRequest());return response.Content;
}
很简单。RestSharp非常灵活拥有使用RESTful API时几乎可以实现所有功能所需的所有工具。在此示例中要注意的一件事是由于示例的一致性我没有使用RestSharp的反序列化机制这有点浪费但是我鼓励您使用它因为它确实非常容易和方便。因此您可以轻松地制作一个这样的容器public class GitHubRelease
{[JsonProperty(PropertyName name)]public string Name { get; set; }[JsonProperty(PropertyName published_at)]public string PublishedAt { get; set; }
}
然后使用该Execute方法直接反序列化对该容器的响应。您可以仅添加所需的属性并使用属性JsonProperty将它们映射到C属性很好的触摸。由于我们在响应中获得了发布列表因此我们将List 用作包含类型。public ListGitHubRelease GetDeserializedReleases(string url)
{var client new RestClient(url);var response client.ExecuteListGitHubRelease(new RestRequest());return response.Data;
}
一种非常直接而优雅的方式来获取我们的数据。RestSharp不仅具有发送GET请求的功能还可以自己探索并观察它的酷炫之处。在RestSharp案例中要补充的最后一点是其存储库需要维护者。如果您想了解更多有关这个很棒的库的信息我敦促您前往RestSharp存储库[28]帮助该项目继续发展并变得更好。ServiceStack Http实用程序另一个库但与RestSharp不同ServiceStack似乎得到了适当维护并与现代API[29]趋势保持同步。ServiceStack功能列表令人印象深刻并且肯定具有各种应用程序。在这里对我们最有用的是演示如何使用外部RESTful API。ServiceStack具有一种专门的方式来处理称为Http Utils的[30]第三方HTTP API 。让我们看看如何首先使用Json.NET解析器来获取RestSharp版本是如何使用ServiceStack Http Utils。public string GetReleases(string url)
{var response url.GetJsonFromUrl(webReq {webReq.UserAgent RequestConstants.UserAgentValue;});return response;
}
您还可以选择将其留给ServiceStack解析器。我们可以重用本文前面定义的Release类 。public ListGitHubRelease GetDeserializedReleases(string url)
{var releases url.GetJsonFromUrl(webReq {webReq.UserAgent RequestConstants.UserAgentValue;}).FromJsonListGitHubRelease();return releases;
}
如您所见无论哪种方式都可以正常工作并且您可以选择是获取字符串响应还是立即反序列化它。尽管ServiceStack是我们偶然发现的最后一个库但令我感到惊讶的是它使用起来如此容易而且我认为它将来可能成为我处理API和服务的首选工具。Flurl评论库中许多人要求的图书馆之一并在Internet上受到许多人的喜爱但仍吸引着人们。Flurl代表Fluent Url Builder这是库构建其查询的方式。对于不熟悉flurl的做事方式的人来说flurl只是意味着库的构建方式是将方法链接在一起以实现更高的可读性类似于人类语言。为了使事情更容易理解让我们举一些例子这个例子来自官方文档// Flurl will use 1 HttpClient instance per host
var person await https://api.com.AppendPathSegment(person).SetQueryParams(new { a 1, b 2 }).WithOAuthBearerToken(my_oauth_token).PostJsonAsync(new{first_name Claire,last_name Underwood}).ReceiveJsonPerson();
您可以看到方法如何链接在一起以完成“句子”。在后台Flurl使用HttpClient或通过自己的语法糖增强HttpClient库。因此这意味着Flurl是一个异步库因此请牢记这一点。与其他高级库一样我们可以通过两种不同的方式来做到这一点public string GetReleases(string url)
{var result url.WithHeader(RequestConstants.UserAgent, RequestConstants.UserAgentValue).GetJsonAsyncListGitHubRelease().Result;return JsonConvert.SerializeObject(result);
}
这种方式相当糟糕因为我们只是序列化结果以便稍后对其进行反序列化。如果您使用的是Flurl之类的库则不应以这种方式进行操作。更好的做事方式是public ListGitHubRelease GetDeserializedReleases(string url)
{var result url.WithHeader(RequestConstants.UserAgent, RequestConstants.UserAgentValue).GetJsonAsyncListGitHubRelease().Result;return result;
}
随着.Result我们强迫代码的同步行为。使用Flurl的实际和预期方式如下所示public async TaskListGitHubRelease GetDeserializedReleases(string url)
{var result await url.WithHeader(RequestConstants.UserAgent, RequestConstants.UserAgentValue).GetJsonAsyncListGitHubRelease();return result;
}
这展示了Flurl库的全部潜力。如果您想了解更多有关如何在不同的现实生活场景使用Flurl看看我们的 消费GitHub的APIREST随着[31]Flurl[32] 文章总而言之它就像广告一样易于使用现代可读性和可测试性。您对这个库还有什么期望要开源签[33]出 Flurl存储库[34]如果您愿意可以贡献自己的力量DalSoft.RestClient现在此列表与该列表中的任何内容都有些不同。但这一点有所不同。让我们看看如何使用DalSoft.RestClient来使用GitHub API然后谈论我们已完成的工作。首先您可以通过输入以下内容通过NuGet软件包管理器下载DalSoft.RestClient Install-Package DalSoft.RestClient或通过.NET Core CLI dotnet add package DalSoft.RestClient两种方法都可以。拥有图书馆后我们可以执行以下操作public string GetReleases(string url)
{dynamic client new RestClient(RequestConstants.BaseUrl,new Headers { { RequestConstants.UserAgent, RequestConstants.UserAgentValue } });var response client.repos.restsharp.restsharp.releases.Get().Result.ToString();return response;
}
或最好使用DalSoft.RestClient在充分利用其功能的同时立即反序列化响应public async TaskListGitHubRelease GetDeserializedReleases(string url)
{dynamic client new RestClient(RequestConstants.BaseUrl,new Headers { { RequestConstants.UserAgent, RequestConstants.UserAgentValue } });var response await client.repos.restsharp.restsharp.releases.Get();return response;
}
因此让我们稍微讨论一下这些例子。乍一看它似乎并不比我们使用的其他一些现代库简单得多。但这归结为形成请求的方式那就是利用RestClient的动态特性。例如我们的BaseUrl是https://api.github.com 我们需要进入https://api.github.com/repos/restsharp/restsharp/releases。我们可以通过动态创建客户端然后通过链接Url的“部分”来形成Url来做到这一点await client.repos.restsharp.restsharp.releases.Get();
形成请求的一种非常独特的方法。还有一个非常灵活的因此一旦我们设置了基本的网址就可以轻松地使用不同的端点。还值得一提的是我们得到的JSON响应会自动进行类型转换。如您在第二个示例中看到的那样我们方法的返回值是Task. So该库足够聪明可以将响应转换为我们的类型依赖于Json.NET。这使我们的生活更加轻松。除了易于理解和使用之外DalSoft.RestClient还具有现代库应具备的所有功能。它是可配置的异步的可扩展的可测试的并且支持多个平台。我们仅演示了DalSoft.RestClient功能的一小部分。如果您对使用DalSoft.RestClient感兴趣请转至我们的文章[35]以学习如何在不同情况下使用它或参阅 GitHub官方仓库[36]和文档[37]。其他选择对于您的特定问题还有许多其他选项可用。您可以使用任何这些库来使用特定的RESTful API。例如octokit.net专门 [38]用于GitHub APIFacebook SDK[39] 用于使用Facebook API并且还有许多其他功能可用于任何用途。虽然这些库是专门为这些API而设计的并且可能擅长于它们的用途但它们的用途是有限的因为您经常需要在应用程序中连接多个API[40]。这可能会导致每个实现都有不同的实现方式以及更多的依赖关系这可能导致重复并且容易出错。库越具体其灵活性就越差。GitHub上的源代码GitHub上的源代码[41]结论因此总而言之我们已经讨论了可用于使用RESTful API的不同工具。我们已经提到了一些.NET库可以这样做HttpWebRequestWebClient和HttpClient以及一些惊人的第三方工具如RestSharp和ServiceStack。您还对这些工具进行了简短的介绍并给出了一些非常简单的示例来向您展示如何开始使用它们。我认为您现在至少有95准备使用一些REST。继续展开翅膀探索并找到更多有趣且有趣的方式来使用和连接不同的API。
