（27）ASP.NET Core .NET標準REST庫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<User> GetUser(string user);
}
public class GitHubApi
{
    public async Task<User> GetUser()
    {
        var gitHubApi = RestService.For<IGitHubApi>("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<ActionResult<IEnumerable<string>>> 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<List<User>> GroupList([AliasAs("id")] int groupId);

請求URL還能夠將替換塊綁定到自定義對象，例：

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

未指定爲URL替換的參數將自動用做查詢參數。這與Retrofit不一樣，在Retrofit中，必須明確指定全部參數，例：

[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.動態查詢字符串參數(Dynamic Querystring Parameters)

方法還能夠傳遞自定義對象，把對象屬性追加到查詢字符串參數當中，例如：

public class MyQueryParams
{
    [AliasAs("order")]
    public string SortOrder { get; set; }
    public int Limit { get; set; }
}
[Get("/group/{id}/users")]
Task<List<User>> GroupList([AliasAs("id")] int groupId, MyQueryParams params);
[Get("/group/{id}/users")]
Task<List<User>> 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<Tweet> PostTweet([Query]TweetParams params);

5.集合做爲查詢字符串參數(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"

6.轉義符查詢字符串參數(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"

7.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);

7.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<IGitHubApi>("https://api.github.com",
    new RefitSettings {
        ContentSerializer = new JsonContentSerializer(
            new JsonSerializerSettings {
                ContractResolver = new SnakeCasePropertyNamesContractResolver()
        }
    )});
var otherApi = RestService.For<IOtherApi>("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; }
} 

7.2XML內容

XML請求和響應使用System.XML.Serialization.XmlSerializer進行序列化/反序列化。默認狀況下，Refit只會使用JSON將內容序列化，若要使用XML內容，請將ContentSerializer配置爲使用XmlContentSerializer：

var gitHubApi = RestService.For<IXmlApi>("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<IXmlApi>("https://www.w3.org/XML",
    new RefitSettings {
        ContentSerializer = new XmlContentSerializer(
            new XmlContentSerializerSettings
            {
                XmlReaderWriterSettings = new XmlReaderWriterSettings()
                {
                    ReaderSettings = new XmlReaderSettings
                    {
                        IgnoreWhitespace = true
                    }
                }
            }
        )
});

7.3.表單發佈(Form posts)

對於以表單形式發佈（即序列化爲application/x-www-form-urlencoded）的API，請使用初始化Body屬性BodySerializationMethod.UrlEncoded屬性，參數能夠是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"},
};
// 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 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"
};
// Serialized as: v=1&tid=UA-1234-5&cid=d1e9ea6b-2e8b-4699-93e0-0bcbd26c206c&t=event
await api.Collect(measurement);

8.設置請求頭

8.1靜態頭(Static headers)

您能夠爲將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);
}

8.2動態頭(Dynamic headers)

若是須要在運行時設置頭的內容，則能夠經過將頭屬性應用於參數來向請求添加具備動態值的頭：

[Get("/users/{user}")]
Task<User> GetUser(string user, [Header("Authorization")] string authorization);
// Will add the header "Authorization: token OAUTH-TOKEN" to the request
var user = await GetUser("octocat", "token OAUTH-TOKEN"); 

8.3受權(動態頭redux)

使用頭的最多見緣由是爲了受權。而如今大多數API使用一些oAuth風格的訪問令牌，這些訪問令牌會過時，刷新壽命更長的令牌。封裝這些類型的令牌使用的一種方法是，能夠插入自定義的HttpClientHandler。這樣作有兩個類：一個是AuthenticatedHttpClientHandler，它接受一個Func<Task<string>>參數，在這個參數中能夠生成簽名，而沒必要知道請求。另外一個是authenticatedparameteredhttpclienthandler，它接受一個Func<HttpRequestMessage，Task<string>>參數，其中籤名須要有關請求的信息（參見前面關於Twitter的API的註釋），
例如：

class AuthenticatedHttpClientHandler : HttpClientHandler
{
    private readonly Func<Task<string>> getToken;
    public AuthenticatedHttpClientHandler(Func<Task<string>> getToken)
    {
        if (getToken == null) throw new ArgumentNullException(nameof(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);
    }
}

或者：

class AuthenticatedParameterizedHttpClientHandler : DelegatingHandler
    {
        readonly Func<HttpRequestMessage, Task<string>> getToken;
        public AuthenticatedParameterizedHttpClientHandler(Func<HttpRequestMessage, Task<string>> getToken, HttpMessageHandler innerHandler = null)
            : base(innerHandler ?? new HttpClientHandler())
        {
            this.getToken = getToken ?? throw new ArgumentNullException(nameof(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(request).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()
    {
        // The AcquireTokenAsync call will prompt with a UI if necessary
        // Or otherwise silently use a refresh token to return
        // a valid access token    
        var token = await context.AcquireTokenAsync("http://my.service.uri/app", "clientId", new Uri("callback://complete"));
        return token;
    }
    public async Task 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將嘗試獲取新的訪問令牌。由應用程序提供，檢查現有訪問令牌的過時時間，並在須要時獲取新的訪問令牌。

參考文獻：
Refit