用于.NET Core,Xamarin和.NET的自动类型安全的REST库,Refit是一个受Square Square Retrofit库影响的库,但它比REST API更容易:

public interface IGitHubApi
{
[Get("/users/{user}")]
Task<User> GetUser(string user);
}

RestService类生成一个使用HttpClient进行调用的IGitHubApi实现:

var gitHubApi = RestService.For<IGitHubApi>("https://api.github.com");

var octocat = await gitHubApi.GetUser("octocat");

兼容的平台

Refit目前支持以下平台和任何.NET Standard 1.3Taget

  • Xamarin.Android
  • Xamarin.Mac
  • Xamarin.iOS 64-bit (Unified API)
  • Desktop .NET 4.5
  • Windows Store 8.1+
  • Windows Phone 8.1 Universal Apps
  • .NET Core

以下平台不支持

  • Xamarin.iOS 32-bit

关于.NET Core

对于.NET Core支持,您必须使用csproj类型的项目托管您的Refit接口。 这是因为xproj无法执行不包含在项目文件中的编译时代码生成。 如果您使用xproj作为网站,类库或应用程序,您仍然可以通过创建一个netstandard csproj然后使用从xproj到csproj的项目到项目的引用来使用Refit。 一旦出现“VS 15”和最终的.NET Core工具,此解决方法就不需要了。

API属性

  • 每个方法都必须有一个HTTP属性,提供请求方法和相对URL。 有五个内置注释:Get,Post,Put,Delete和Head。 资源的相对URL在注释中指定。
    [Get("/users/list")]

  • 你可以在URL中指定查询参数:
    [Get("/users/list?sort=desc")]

  • 可以使用方法上的替换块和参数动态更新请求URL。 替换块是由{}包围的字母数字字符串。如果您的参数名称与URL路径中的名称不匹配,请使用AliasAs属性。

[Get("/group/{id}/users")]
Task<List<User>> GroupList([AliasAs("id")] int groupId)
  • 未指定为URL替换的参数将自动用作查询参数。 这与Retrofit不同,其中必须明确指定所有参数。参数名称和URL参数之间的比较不区分大小写,因此如果您在路径/ group/{groupid} /show中命名参数"groupId",它将正常工作。
[Get("/group/{id}/users")]
Task<List<User>> GroupList([AliasAs("id")] int groupId, [AliasAs("sort")] string sortOrder);
GroupList(4, "desc");
>>> "/group/4/users?sort=desc"
  • PS:这里就是说如果你在GroupList的签名里面使用[AliasAs("sort")] 变量类型 变量名的方式,即使原本的路径里面没有“sort"的属性,也会自动加上去。

Body内容

通过使用Body属性,方法中的一个参数可以作为Body

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

根据参数的类型,提供Body数据有四种可能:

  • 如果类型为Stream,则内容将通过StreamContent流式传输。
  • 如果类型是字符串,则该字符串将直接用作内容
  • 如果参数具有[Body(BodySerializationMethod.UrlEncoded)]属性,内容将被URL编码(见下面的Form Posts部分)
  • 对于所有其他类型,对象将被序列化为JSON。

JSON内容

  • JSON请求和响应使用Json.NET进行序列化/反序列化。 默认情况下,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 });
  • 因为这些是全局设置,它们会影响整个应用程序。 将请求的设置隔离到特定的AP也许是有益的。 当创建一个Refit生成的实时界面时,您可以选择传递一个RefitSettings,这将允许您指定你想要的serializer设置。 这允许您为不同的API具有不同的序列化器设置。
var gitHubApi = RestService.For<IGitHubApi>("https://api.github.com",new RefitSettings
{
JsonSerializerSettings = new JsonSerializerSettings {
ContractResolver = new SnakeCasePropertyNamesContractResolver()
} } );
var otherApi = RestService.For<IOtherApi>("https://api.example.com",new RefitSettings
{
JsonSerializerSettings = new JsonSerializerSettings {
ContractResolver = new CamelCasePropertyNamesContractResolver()
} } );
  • 属性序列化/反序列化可以使用Json.NET的JsonProperty属性进行定制:
public class Foo
{
// 像[AliasAs(“b”)]的使用将以form posts发布(见下文)
[JsonProperty(PropertyName="b")]
public string Bar { get; set; }
}

Form posts

  • 对于采用表单帖子(即序列化为应用程序/ x-www-form-urlencoded)的API,使用BodySerializationMethod.UrlEncoded初始化Body属性。参数可以是一个IDictionary
public interface IMeasurementProtocolApi
{
[Post("/collect")]
Task Collect([Body(BodySerializationMethod.UrlEncoded)] Dictionary<string, object> data);
}
var data = new Dictionary<string, object> {
{"v", 1},
{"tid", "UA-1234-5"},
{"cid", new Guid("d1e9ea6b-2e8b-4699-93e0-0bcbd26c206c")},
{"t", "event"},
};
// 序列化为: v=1&tid=UA-1234-5&cid=d1e9ea6b-2e8b-4699-93e0-0bcbd26c206c&t=event
await api.Collect(data);
  • 或者您可以传递任何对象,所有公共可读属性将作为请求中的表单字段序列化。 该方法允许您使用[AliasAs(“whatever”)]来别名属性名称,如果API具有隐藏字段名称,则可以帮助您:
public interface IMeasurementProtocolApi
{
[Post("/collect")]
Task Collect([Body(BodySerializationMethod.UrlEncoded)] Measurement measurement);
}
public class Measurement
{
// 属性可以是只读的,不需要[AliasAs]
public int v { get { return 1; } [AliasAs("tid")]
public string WebPropertyId { get; set; } [AliasAs("cid")]
public Guid ClientId { get;set; } [AliasAs("t")]
public string Type { get; set; } public object IgnoreMe { private get; set; }
}
var measurement = new Measurement {
WebPropertyId = "UA-1234-5",
ClientId = new Guid("d1e9ea6b-2e8b-4699-93e0-0bcbd26c206c"),
Type = "event"
};
//序列化为: v=1&tid=UA-1234-5&cid=d1e9ea6b-2e8b-4699-93e0-0bcbd26c206c&t=event
await api.Collect(measurement);

设置请求标头

  • 静态标题

您可以为应用Headers属性的方法设置一个或多个静态请求标头:

[Headers("User-Agent: Awesome Octocat App")]
[Get("/users/{user}")]
Task<User> GetUser(string user);

也可以通过将Headers属性应用于接口,将静态标头添加到API中的每个请求中:

[Headers("User-Agent: Awesome Octocat App")]
public interface IGitHubApi
{
[Get("/users/{user}")]
Task<User> GetUser(string user); [Post("/users/new")]
Task CreateUser([Body] User user);
}
  • 动态标题

如果头文件的内容需要在运行时设置,则可以通过将Header属性应用到参数来为请求添加具有动态值的头文件:

[Get("/users/{user}")]
Task<User> GetUser(string user, [Header("Authorization")] string authorization);
// 将标题“Authorization:token OAUTH-TOKEN”添加到请求中
var user = await GetUser("octocat", "token OAUTH-TOKEN");
  • 授权(动态标题缩减)

使用标头的最常见原因是授权。 今天,大多数API使用一些口味的oAuth,访问令牌到期并刷新取得更长寿命的令牌。封装这些令牌用法的一种方法是,可以插入一个自定义的HttpClientHandler。举个例子:

class AuthenticatedHttpClientHandler : HttpClientHandler
{
private readonly Func<Task<string>> getToken;
public AuthenticatedHttpClientHandler(Func<Task<string>> getToken)
{
if (getToken == null) throw new ArgumentNullException("getToken");
this.getToken = getToken;
}
protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
// See if the request has an authorize header
var auth = request.Headers.Authorization;
if (auth != null)
{
var token = await getToken().ConfigureAwait(false);
request.Headers.Authorization = new AuthenticationHeaderValue(auth.Scheme, token);
}
return await base.SendAsync(request, cancellationToken).ConfigureAwait(false);
}
}

虽然HttpClient包含几乎相同的方法签名,但使用方式不同。 HttpClient.SendAsync不被调用。 必须修改HttpClientHandler。这个类是这样使用的(例如使用ADAL库来管理Xamarin.Auth或任何其他库的自动令牌刷新:

class LoginViewModel
{
AuthenticationContext context = new AuthenticationContext(...);
private async Task<string> GetToken()
{
// 如果需要,AquireTokenAsync调用将提示用户界面
// 否则默认使用刷新令牌返回一个有效的访问令牌
var token = await context.AcquireTokenAsync("http://my.service.uri/app", "clientId", new Uri("callback://complete"));
return token;
} public async void LoginAndCallApi()
{
var api = RestService.For<IMyRestService>(new HttpClient(new AuthenticatedHttpClientHandler(GetToken)) { BaseAddress = new Uri("https://the.end.point/") });
var location = await api.GetLocationOfRebelBase();
}
}
interface IMyRestService
{
[Get("/getPublicInfo")]
Task<Foobar> SomePublicMethod();
[Get("/secretStuff")]
[Headers("Authorization: Bearer")]
Task<Location> GetLocationOfRebelBase();
}

在上面的例子中,任何时候调用需要身份验证的方法,AuthenticatedHttpClientHandler将尝试获取一个新的访问令牌。 由应用程序提供一个,检查现有访问令牌的到期时间,并在需要时获取新的访问令牌。

  • 重新定义标题

不同于Retrofit,其中标题不会相互覆盖,并且都添加到请求中,而不管定义同一个标题的次数如何,Refit对ASP.NET MVC采用与动作过滤器相似的方法采用类似的方法 - 重新定义标题将替换 它按以下顺序排列:

  • 接口上的标题属性(最低优先级)
  • 标题属性在方法
  • 方法参数的标题属性(最高优先级)
[Headers("X-Emoji: :rocket:")]
public interface IGitHubApi
{
[Get("/users/list")]
Task<List> GetUsers();
[Get("/users/{user}")]
[Headers("X-Emoji: :smile_cat:")]
Task<User> GetUser(string user);
[Post("/users/new")]
[Headers("X-Emoji: :metal:")]
Task CreateUser([Body] User user, [Header("X-Emoji")] string emoji);
} // X-Emoji: :rocket:
var users = await GetUsers();
// X-Emoji: :smile_cat:
var user = await GetUser("octocat");
// X-Emoji: :trollface:
await CreateUser(user, ":trollface:");
  • 删除标题

在界面或方法上定义的标题可以通过重新定义没有值的静态标题(即不使用:<value>)或为动态标题传递null来删除。 空字符串将被包括为空标题。

[Headers("X-Emoji: :rocket:")]
public interface IGitHubApi
{
[Get("/users/list")]
[Headers("X-Emoji")] // 删除X-Emoji标题
Task<List> GetUsers(); [Get("/users/{user}")]
[Headers("X-Emoji:")] // 将X-Emoji标题重新定义为空
Task<User> GetUser(string user); [Post("/users/new")]
Task CreateUser([Body] User user, [Header("X-Emoji")] string emoji);
} // 没有X-Emoji标题
var users = await GetUsers();
// X-Emoji:
var user = await GetUser("octocat");
// 没有X-Emoji标题
await CreateUser(user, null);
// X-Emoji:
await CreateUser(user, "");
  • 断点上传

使用Multipart属性装饰的方法将使用多部分内容类型提交。 此时,multipart方法支持以下参数类型:

  • 字符串(参数名称将用作名称和字符串值作为值)
  • 字节数组
  • FileInfo
    参数名称将用作多部分数据中字段的名称。 这可以被AliasAs属性覆盖。要指定字节数组(byte []),Stream和FileInfo参数的文件名和内容类型,需要使用包装类。 ByteArrayPart,StreamPart和FileInfoPart。
public interface ISomeApi
{
[Multipart]
[Post("/users/{id}/photo")]
Task UploadPhoto(int id, [AliasAs("myPhoto")] StreamPart stream);
}

要将Stream传递给此方法,请构建如下所示的StreamPart对象:
someApiInstance.UploadPhoto(id, new StreamPart(myPhotoStream, "photo.jpg", "image/jpeg"));
注意:此部分以前描述的AttachmentName属性已被弃用,不推荐使用它。

检索回应

请注意,在Refit中,与Retrofit不同,没有同步网络请求的选项 - 所有请求都必须通过任务或通过IObservable进行异步。 不像Retrofit,只能通过回调参数创建异步,因为我们生活在async/await未来。

[Post("/users/new")]
Task CreateUser([Body] User user); // 如果网络呼叫失败,则会发生这种情况
await CreateUser(someUser);

如果type参数是'HttpResponseMessage'或'string',则原始响应消息或作为字符串的内容将分别返回。

// Returns the content as a string (i.e. the JSON data)
[Get("/users/{user}")]
Task<string> GetUser(string user); //返回原始响应,作为可用于Reactive Extensions的IObservable
[Get("/users/{user}")]
IObservable<HttpResponseMessage> GetUser(string user);

使用通用接口

当使用像ASP.NET Web API这样的东西,它是一个相当普遍的模式,拥有一整套CRUD REST服务。 Refit现在允许您使用通用类型定义单个API接口:

public interface IReallyExcitingCrudApi<T, in TKey> where T : class
{
[Post("")]
Task<T> Create([Body] T paylod); [Get("")]
Task<List<T>> ReadAll(); [Get("/{key}")]
Task<T> ReadOne(TKey key); [Put("/{key}")]
Task Update(TKey key, [Body]T payload); [Delete("/{key}")]
Task Delete(TKey key);
}
  • 可以这样使用:

// 这里的“/ users”部分是很重要的,如果您希望它可以使用多种类型(除非每种类型都有不同的域)
var api = RestService.For<IReallyExcitingCrudApi<User, string>>("http://api.example.com/users");

Xamarin Forms Api请求开源框架Refit的更多相关文章

  1. 【安卓网络请求开源框架Volley源码解析系列】定制自己的Request请求及Volley框架源码剖析

    通过前面的学习我们已经掌握了Volley的基本用法,没看过的建议大家先去阅读我的博文[安卓网络请求开源框架Volley源码解析系列]初识Volley及其基本用法.如StringRequest用来请求一 ...

  2. 【安卓网络请求开源框架Volley源码解析系列】初识Volley及其基本用法

    在安卓中当涉及到网络请求时,我们通常使用的是HttpUrlConnection与HttpClient这两个类,网络请求一般是比较耗时,因此我们通常会在一个线程中来使用,但是在线程中使用这两个类时就要考 ...

  3. Xamarin.Forms 开发资源集合(复制)

    复制:https://www.cnblogs.com/mschen/p/10199997.html 收集整理了下 Xamarin.Forms 的学习参考资料,分享给大家,稍后会不断补充: UI样式 S ...

  4. Xamarin.Forms 开发资源集合

    收集整理了下 Xamarin.Forms 的学习参考资料,分享给大家,稍后会不断补充: UI样式 Snppts: Xamarin Forms UI Snippets. Prebuilt Templat ...

  5. Xamarin.Forms 入门

    介绍 Xamarin.Forms是一个开源UI框架,Xamarin.Forms允许开发人员从单个共享代码库构建Android,iOS和Windows应用程序. Xamarin.Forms允许开发人员使 ...

  6. Xamarin.Forms介绍

    On May 28, 2014, Xamarin introduced Xamarin.Forms, which allows you to write user-interface code tha ...

  7. 使用MvvmCross框架实现Xamarin.Forms的汉堡菜单布局

    注:本文是英文写的,偷懒自动翻译过来了,原文地址:Implementing MasterDetail layout in Xamarin.Forms by MvvmCross 欢迎大家关注我的公众号: ...

  8. Xamarin.Forms学习之Platform-specific API和文件操作

    这篇文章的分享原由是由于上篇关于Properties的保存不了,调用SavePropertiesAsync()方法也不行,所以我希望通过操作文件的方式保存我的需要的数据,然后我看了一下电子书中的第二十 ...

  9. 开源框架---tensorflow c++ API 一个卡了很久的问题

    <开源框架---tensorflow c++ API 运行第一个“手写字的例子”> 中可以说明tensorflow c++ API是好用的,.......

随机推荐

  1. C#生成唯一值的方法汇总

    生成唯一值的方法很多,下面就不同环境下生成的唯一标识方法一一介绍,作为工作中的一次总结,有兴趣的可以自行测试: https://www.cnblogs.com/xinweichen/p/4287640 ...

  2. CSS---通向臃肿的道路(关于 “separation of concerns” (SoC)的原则)

    When it comes to CSS, I believe that the sacred principle of “separation of concerns” (SoC) has lead ...

  3. 洛谷P1379 八数码难题

    传送门 1.先用dfs枚举9!的全排列,存到hash数组里(类似离散化),因为顺序枚举,就不需要排序了 2.朴素bfs,判重就用二分找hash:如果发现当前状态=要求状态,输出步数结束程序 上代码 # ...

  4. yii2 部分很实用的代码

    检查执行的sql $query->createCommand()->getRawSql()     写日志 // 记录日志 \Yii::error('生成失败.' . $index, $t ...

  5. BZOJ 5118

    矩阵乘也是可以欧拉定理的HHH 所以幂次就是$(2^n-1) ~ mod ~ \varphi(p)$就好了 const ll p=1125899839733759ll; inline ll mu(ll ...

  6. css 背景(background)属性、背景图定位

    background属性: Background属性是css中应用比较多,且比较重要的一个属性,它是负责给盒子设置背景图上和背景颜色的,background是一个复合属性,它可以分解成如下几个设置项: ...

  7. 原生javascript制作时钟

    用JavaScript来制作实时的时钟 效果图如下: 接下来,我会一步一步向大家介绍如何制作,并将里面的一些值得注意的事项提出来. 首先是把框架搭构起来, <div> <canvas ...

  8. CSS_细节总结

    1. 负外边距 上下200*200盒子的重叠,切记用 absolute 绝对定位 为最佳解决方案. 定位 position : fixed    absolute    relative( top 为 ...

  9. android发送短信验证码并自动获取验证码填充文本框

    android注册发送短信验证码并自动获取短信,截取数字验证码填充文本框. 一.接入短信平台 首先需要选择短信平台接入,这里使用的是榛子云短信平台(http://smsow.zhenzikj.com) ...

  10. 腾讯云“智能+互联网TechDay”:揭秘智慧出行核心技术与创新实践

    现如今,地面交通出行与大家的生活息息相关.在当前城市道路日益复杂和拥挤的情况下,如何保证交通出行的安全和便捷相信是每个人以及众多专家.科研工作者重点关注的问题. “智慧交通”系统是解决交通发展瓶颈的有 ...