在SCOTT HANSELMAN 博客上看到一个好东西《Exploring refit, an automatic type-safe REST library for .NET Standard》,他推荐了一个.NET标准1.4 的自动类型安全的REST库refit。 refit 类似于Java的Retrofit,是一套RESTful架构的.NET客户端实现,基于特性,提供把REST API返回的数据转化为(Plain Ordinary C# Object,简单C#对象),POCO to JSON,网络请求(POST,GET,PUT,DELETE等)封装,内部封装使用HttpClient,前者专注于接口的封装,后者专注于网络请求的高效,二者分工协作。我们的应用程序通过 refit
请求网络,实际上是使用 refit
接口层封装请求参数、Header、Url 等信息,之后由 HttpClient
完成后续的请求操作,在服务端返回数据之后,HttpClient
将原始的结果交给 refit
,后者根据用户的需求对结果进行解析的过程。
例如:
public interface IGitHubApi
{
[Get("/users/{user}")]
Task<User> GetUser(string user);
}
定义上面的一个REST API接口。 该接口定义了一个函数 GetUser,该函数会通过HTTP GET请求去访问服务器的/users/{user}
路径并把返回的结果封装为User POCO 对象返回。
其中URL路径中的{user}
的值为GetUser函数中的参数 user
的取值。
然后通过 RestService
类来生成一个 IGitHubApi
接口的实现,使用HttpClient 调用;
var gitHubApi = RestService.For<IGitHubApi>(https://api.github.com);
var octocat = await gitHubApi.GetUser("octocat");
从上面的示例可以看出, refit使用特性来声明HTTP请求
支持 URL 参数替换和查询参数
返回结果转换为C#对象(返回结果可以为JSON)
支持 Multipart请求和文件上传
具体使用文档
函数和函数参数上的特性声明了请求方式
1、请求方式
每个函数都必须带有 HTTP特性来表明请求方式和请求的URL路径。类库中有5个HTTP注解:GET, POST, PUT,DELETE和HEAD。注解中的参数为请求的相对URL路径。
[Get("/users/list")]
在URL路径中也可以指定URL参数:
[Get("/users/list?sort=desc")]
2、URL处理
请求的URL可以根据函数参数动态更新。一个可替换的区块为用 {
和 }
包围的字符串,而函数参数必需用 @
AliasAs特性
标明,并且特性的参数为 同样的字符串
[Get("/group/{id}/users")]//注意 字符串id
Task<List<User>> GroupList([AliasAs("id")] int groupId); //注意 AliasAs特性的参数要和前面的字符串一样 id
还支持查询参数
[Get("/group/{id}/users")]
Task<List<User>> GroupList([AliasAs("id")] int groupId, [AliasAs("sort")] string sortOrder);
GroupList(4, "desc");
>>> "/group/4/users?sort=desc"
3、请求体(Request Body)
通过[Body]特性
可以声明一个对象作为请求体发送到服务器。
[Post("/users/new")]
Task CreateUser([Body] User user);
对象将被RestService
使用对应的转换器转换为字符串或者字节流提交到服务器。
4、FORM ENCODED AND MULTIPART 表单和Multipart
函数也可以注解为发送表单数据和multipart 数据
5、服务器结果转换为C# 对象
使用RestService
的转换器把HTTP请求结果(默认为JSON)转换为C#对象,C#对象通过函数返回值指定
6、添加请求头
我们可以通过[Headers]来添加请求头,支持动态的请求头。
refit
是非常强大的,本文通过丰富的示例和对源码的挖掘,向大家展示了 refit自身强大的功能以及扩展性
原文:http://www.cnblogs.com/shanyou/p/8047749.html
.NET社区新闻,深度好文,欢迎访问公众号文章汇总 http://www.csharpkit.com