您现在的位置是：网站首页> 编程资料编程资料

自动类型安全的REST.NET标准库refit_实用技巧_

2023-05-24 319人已围观

简介自动类型安全的REST.NET标准库refit_实用技巧_

1.简介

Refit是一个受到Square的Retrofit库（Java）启发的自动类型安全REST库。通过HttpClient网络请求(POST，GET,PUT，DELETE等封装)把REST API返回的数据转化为POCO(Plain Ordinary C# Object,简单C#对象) to JSON。我们的应用程序通过Refit请求网络，实际上是使用Refit接口层封装请求参数、Header、Url等信息，之后由HttpClient完成后续的请求操作，在服务端返回数据之后，HttpClient将原始的结果交给Refit，后者根据用户的需求对结果进行解析的过程。安装组件命令行：

Install-Package refit

代码例子：

[Headers("User-Agent: Refit Integration Tests")]//这里因为目标源是GitHubApi，所以一定要加入这个静态请求标头信息，让其这是一个测试请求，不然会返回数据异常。 public interface IGitHubApi { [Get("/users/{user}")] Task GetUser(string user); } public class GitHubApi { public async Task GetUser() { var gitHubApi = RestService.For("https://api.github.com"); var octocat = await gitHubApi.GetUser("octocat"); return octocat; } } public class User { public string login { get; set; } public int? id { get; set; } public string url { get; set; } } [HttpGet] public async Task>> Get() { var result = await new GitHubApi().GetUser(); return new string[] { result.id.Value.ToString(), result.login }; }

注：接口中Headers、Get这些属性叫做Refit的特性。
定义上面的一个IGitHubApi的REST API接口，该接口定义了一个函数GetUser，该函数会通过HTTP GET请求去访问服务器的/users/{user}路径把返回的结果封装为User POCO对象并返回。其中URL路径中的{user}的值为GetUser函数中的参数user的取值，这里赋值为octocat。然后通过RestService类来生成一个IGitHubApi接口的实现并供HttpClient调用。

2.API属性

每个方法必须具有提供请求URL和HTTP属性。HTTP属性有六个内置注释：Get, Post, Put, Delete, Patch and Head，例：

[Get("/users/list")]

您还可以在请求URL中指定查询参数：

[Get("/users/list?sort=desc")]

还可以使用相对URL上的替换块和参数来动态请求资源。替换块是由{and，即&}包围的字母数字字符串。如果参数名称与URL路径中的名称不匹配，请使用AliasAs属性，例：

[Get("/group/{id}/users")] Task> GroupList([AliasAs("id")] int groupId);

请求URL还可以将替换块绑定到自定义对象，例：

[Get("/group/{request.groupId}/users/{request.userId}")] Task> GroupList(UserGroupRequest request); class UserGroupRequest{ int groupId { get;set; } int userId { get;set; } }

未指定为URL替换的参数将自动用作查询参数。这与Retrofit不同，在Retrofit中，必须明确指定所有参数，例：

[Get("/group/{id}/users")] Task> GroupList([AliasAs("id")] int groupId, [AliasAs("sort")] string sortOrder); GroupList(4, "desc");

输出结果："/group/4/users?sort=desc"

3.动态查询字符串参数(Dynamic Querystring Parameters)

方法还可以传递自定义对象，把对象属性追加到查询字符串参数当中，例如：

public class MyQueryParams { [AliasAs("order")] public string SortOrder { get; set; } public int Limit { get; set; } } [Get("/group/{id}/users")] Task> GroupList([AliasAs("id")] int groupId, MyQueryParams params); [Get("/group/{id}/users")] Task> GroupListWithAttribute([AliasAs("id")] int groupId, [Query(".","search")]MyQueryParams params); params.SortOrder = "desc"; params.Limit = 10; GroupList(4, params)

输出结果："/group/4/users?order=desc&Limit=10"

GroupListWithAttribute(4, params)

输出结果："/group/4/users?search.order=desc&search.Limit=10"
您还可以使用[Query]指定querystring参数，并将其在非GET请求中扁平化，类似于：

[Post("/statuses/update.json")] Task PostTweet([Query]TweetParams params);

4.集合作为查询字符串参数(Collections as Querystring Parameters)

方法除了支持传递自定义对象查询，还支持集合查询的，例：

[Get("/users/list")] Task Search([Query(CollectionFormat.Multi)]int[] ages); Search(new [] {10, 20, 30})

输出结果："/users/list?ages=10&ages=20&ages=30"

[Get("/users/list")] Task Search([Query(CollectionFormat.Csv)]int[] ages); Search(new [] {10, 20, 30})

输出结果："/users/list?ages=10%2C20%2C30"

5.转义符查询字符串参数(Unescape Querystring Parameters)

使用QueryUriFormat属性指定查询参数是否应转义网址，例：

[Get("/query")] [QueryUriFormat(UriFormat.Unescaped)] Task Query(string q); Query("Select+Id,Name+From+Account")

输出结果："/query?q=Select+Id,Name+From+Account"

6.Body内容

通过使用Body属性，可以把自定义对象参数追加到HTTP请求Body当中。

[Post("/users/new")] Task CreateUser([Body] User user)

根据参数的类型，提供Body数据有四种可能性：

如果类型为Stream，则内容将通过StreamContent流形式传输。
如果类型为string，则字符串将直接用作内容，除非[Body(BodySerializationMethod.Json)]设置了字符串，否则将其作为StringContent。
如果参数具有属性[Body(BodySerializationMethod.UrlEncoded)]，则内容将被URL编码。
对于所有其他类型，将使用RefitSettings中指定的内容序列化程序将对象序列化（默认为JSON）。
缓冲和Content-Length头

默认情况下，Refit重新调整流式传输正文内容而不缓冲它。例如，这意味着您可以从磁盘流式传输文件，而不会产生将整个文件加载到内存中的开销。这样做的缺点是没有在请求上设置内容长度头（Content-Length）。如果您的API需要您随请求发送一个内容长度头，您可以通过将[Body]属性的缓冲参数设置为true来禁用此流行为：

Task CreateUser([Body(buffered: true)] User user);

6.1.JSON内容

使用Json.NET对JSON请求和响应进行序列化/反序列化。默认情况下，Refit将使用可以通过设置Newtonsoft.Json.JsonConvert.DefaultSettings进行配置的序列化器设置：

JsonConvert.DefaultSettings = () => new JsonSerializerSettings() { ContractResolver = new CamelCasePropertyNamesContractResolver(), Converters = {new StringEnumConverter()} }; //Serialized as: {"day":"Saturday"} await PostSomeStuff(new { Day = DayOfWeek.Saturday });

由于默认静态配置是全局设置，它们将影响您的整个应用程序。有时候我们只想要对某些特定API进行设置，您可以选择使用RefitSettings属性，以允许您指定所需的序列化程序进行设置，这使您可以为单独的API设置不同的序列化程序设置：

var gitHubApi = RestService.For("https://api.github.com", new RefitSettings { ContentSerializer = new JsonContentSerializer( new JsonSerializerSettings { ContractResolver = new SnakeCasePropertyNamesContractResolver() } )}); var otherApi = RestService.For("https://api.example.com", new RefitSettings { ContentSerializer = new JsonContentSerializer( new JsonSerializerSettings { ContractResolver = new CamelCasePropertyNamesContractResolver() } )});

还可以使用Json.NET的JsonProperty属性来自定义属性序列化/反序列化：

public class Foo { //像[AliasAs(“ b”)]一样会在表单中发布 [JsonProperty(PropertyName="b")] public string Bar { get; set; } }

6.2XML内容

XML请求和响应使用System.XML.Serialization.XmlSerializer进行序列化/反序列化。默认情况下，Refit只会使用JSON将内容序列化，若要使用XML内容，请将ContentSerializer配置为使用XmlContentSerializer：

var gitHubApi = RestService.For("https://www.w3.org/XML", new RefitSettings { ContentSerializer = new XmlContentSerializer() });

属性序列化/反序列化可以使用System.Xml.serialization命名空间中的属性进行自定义：

public class Foo { [XmlElement(Namespace = "https://www.w3.org/XML")] public string Bar { get; set; } }

System.Xml.Serialization.XmlSerializer提供了许多序列化选项，可以通过向XmlContentSerializer构造函数提供XmlContentSerializer设置来设置这些选项：

var gitHubApi = RestService.For("https://www.w3.org/XML", new RefitSettings { ContentSerializer = new XmlContentSerializer( new XmlContentSerializerSettings { XmlReaderWriterSettings = new XmlReaderWriterSettings() { ReaderSettings = new XmlReaderSettings { IgnoreWhitespace = true } } } ) });

6.3.表单发布(Form posts)

对于以表单形式发布（即序列化为application/x-www-form-urlencoded）的API，请使用初始化Body属性BodySerializationMethod.UrlEncoded属性，参数可以是IDictionary字典，例：

public interface IMeasurementProtocolApi { [Post("/collect")] Task Collect([Body(BodySerializationMethod.UrlEncoded)] Dictionary data); } var data = new Dictionary { {"v", 1}, {"tid", "UA-1234-5"}, {"cid", new Guid("d1e9ea6b-2e8b-4699-93e0-0bcbd26c206c")}, {"t", "event"}, }; // Serialized as: v=1&tid=UA-1234-5&cid=d1e9ea6b-2e8b-4699-93e0-0bcbd26c206c&t=event await api.Collect(data);

如果我们传递对象跟请求表单中字段名称不一致时，可在对象属性名称上加入[AliasAs("你定义字段名称")] 属性，那么加入属性的对象字段都将会被序列化为请求中的表单字段：

public interface IMeasurementProtocolApi { [Post("/collect")] Task Collect([Body(BodySerializationMethod.UrlEncoded)] Measurement measurement); } public class Measurement { // Properties can be read-only and [AliasAs] isn't required public int v { get { return 1; } } [AliasAs("tid")] public string We
                提示：
                    本文由神整理自网络，如有侵权请联系本站删除！
                    

                    本站声明： 

                    1、本站所有资源均来源于互联网，不保证100%完整、不提供任何技术支持； 

                    2、本站所发布的文章以及附件仅限用于学习和研究目的;不得将用于商业或者非法用途；否则由此产生的法律后果，本站概不负责！
                
                
                
                                            上一篇：ASP.NET Core使用EF保存数据、级联删除和事务使用_实用技巧_
                                                                下一篇：ASP.NET Core使用AutoMapper组件_实用技巧_