成人在线亚洲_国产日韩视频一区二区三区_久久久国产精品_99国内精品久久久久久久

您的位置:首頁技術(shù)文章
文章詳情頁

.net core 中 WebApiClientCore的使用示例代碼

瀏覽:316日期:2022-06-09 09:02:59

WebApiClient

接口注冊與選項

1 配置文件中配置HttpApiOptions選項

配置示例

 "IUserApi": {
    "HttpHost": "http://www.webappiclient.com/",
    "UseParameterPropertyValidate": false,
    "UseReturnValuePropertyValidate": false,
    "JsonSerializeOptions": {
      "IgnoreNullValues": true,
      "WriteIndented": false
    }
  }

2 Service注冊

示例

services
    .ConfigureHttpApi<IUserApi>(Configuration.GetSection(nameof(IUserApi)))
    .ConfigureHttpApi<IUserApi>(o =>
    {
// 符合國情的不標(biāo)準(zhǔn)時間格式,有些接口就是這么要求必須不標(biāo)準(zhǔn)
o.JsonSerializeOptions.Converters.Add(new JsonDateTimeConverter("yyyy-MM-dd HH:mm:ss"));
    });

HttpApiOptions詳細(xì)展示

/// <summary>
/// 表示HttpApi選項
/// </summary>
public class HttpApiOptions
{
    /// <summary>
    /// 獲取或設(shè)置Http服務(wù)完整主機域名
    /// 例如http://www.abc.com/或http://www.abc.com/path/
    /// 設(shè)置了HttpHost值,HttpHostAttribute將失效
    /// </summary>
    public Uri? HttpHost { get; set; }

    /// <summary>
    /// 獲取或設(shè)置是否使用的日志功能
    /// </summary>
    public bool UseLogging { get; set; } = true;

    /// <summary>
    /// 獲取或設(shè)置請求頭是否包含默認(rèn)的UserAgent
    /// </summary>
    public bool UseDefaultUserAgent { get; set; } = true;

    /// <summary>
    /// 獲取或設(shè)置是否對參數(shù)的屬性值進(jìn)行輸入有效性驗證
    /// </summary>
    public bool . { get; set; } = true;

    /// <summary>
    /// 獲取或設(shè)置是否對返回值的屬性值進(jìn)行輸入有效性驗證
    /// </summary>
    public bool UseReturnValuePropertyValidate { get; set; } = true;



    /// <summary>
    /// 獲取json序列化選項
    /// </summary>
    public JsonSerializerOptions JsonSerializeOptions { get; } = CreateJsonSerializeOptions();

    /// <summary>
    /// 獲取json反序列化選項
    /// </summary>
    public JsonSerializerOptions JsonDeserializeOptions { get; } = CreateJsonDeserializeOptions();

    /// <summary>
    /// xml序列化選項
    /// </summary>
    public XmlWriterSettings XmlSerializeOptions { get; } = new XmlWriterSettings();

    /// <summary>
    /// xml反序列化選項
    /// </summary>
    public XmlReaderSettings XmlDeserializeOptions { get; } = new XmlReaderSettings();

    /// <summary>
    /// 獲取keyValue序列化選項
    /// </summary>
    public KeyValueSerializerOptions KeyValueSerializeOptions { get; } = new KeyValueSerializerOptions();

    /// <summary>
    /// 獲取自定義數(shù)據(jù)存儲的字典
    /// </summary>
    public Dictionary<object, object> Properties { get; } = new Dictionary<object, object>();

    /// <summary>
    /// 獲取接口的全局過濾器集合
    /// </summary>
    public IList<IApiFilter> GlobalFilters { get; } = new List<IApiFilter>();


    /// <summary>
    /// 創(chuàng)建序列化JsonSerializerOptions
    /// </summary> 
    private static JsonSerializerOptions CreateJsonSerializeOptions()
    {
return new JsonSerializerOptions
{
    PropertyNameCaseInsensitive = true,
    PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
    DictionaryKeyPolicy = JsonNamingPolicy.CamelCase,
    Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping
};
    }

    /// <summary>
    /// 創(chuàng)建反序列化JsonSerializerOptions
    /// </summary>
    /// <returns></returns>
    private static JsonSerializerOptions CreateJsonDeserializeOptions()
    {
var options = CreateJsonSerializeOptions();
options.Converters.Add(JsonCompatibleConverter.EnumReader);
options.Converters.Add(JsonCompatibleConverter.DateTimeReader);
return options;
    }
}

Uri(url)拼接規(guī)則

所有的Uri拼接都是通過Uri(Uri baseUri, Uri relativeUri)這個構(gòu)造器生成。

/結(jié)尾的baseUri

  • http://a.com/ + b/c/d = http://a.com/b/c/d
  • http://a.com/path1/ + b/c/d = http://a.com/path1/b/c/d
  • http://a.com/path1/path2/ + b/c/d = http://a.com/path1/path2/b/c/d

不帶/結(jié)尾的baseUri

  • http://a.com + b/c/d = http://a.com/b/c/d
  • http://a.com/path1 + b/c/d = http://a.com/b/c/d
  • http://a.com/path1/path2 + b/c/d = http://a.com/path1/b/c/d

事實上http://a.comhttp://a.com/是完全一樣的,他們的path都是/,所以才會表現(xiàn)一樣。為了避免低級錯誤的出現(xiàn),請使用的標(biāo)準(zhǔn)baseUri書寫方式,即使用/作為baseUri的結(jié)尾的第一種方式。

OAuths&Token

推薦使用自定義TokenProvider

 public class TestTokenProvider : TokenProvider
    {
private readonly IConfiguration _configuration;
public TestTokenProvider(IServiceProvider services,IConfiguration configuration) : base(services)
{
    _configuration = configuration;
}

protected override Task<TokenResult> RefreshTokenAsync(IServiceProvider serviceProvider, string refresh_token)
{
   return this.RefreshTokenAsync(serviceProvider, refresh_token);
}

protected override async Task<TokenResult> RequestTokenAsync(IServiceProvider serviceProvider)
{
    LoginInput login = new LoginInput();
    login.UserNameOrEmailAddress = "admin";
    login.Password = "bb123456";
    var result = await serviceProvider.GetRequiredService<ITestApi>().RequestToken(login).Retry(maxCount: 3);
    return result;
}
    }

TokenProvider的注冊

services.AddTokenProvider<ITestApi,TestTokenProvider>();

OAuthTokenHandler

可以自定義OAuthTokenHandler官方定義是屬于http消息處理器,功能與OAuthTokenAttribute一樣,除此之外,如果因為意外的原因?qū)е路?wù)器仍然返回未授權(quán)(401狀態(tài)碼),其還會丟棄舊token,申請新token來重試一次請求。

OAuthToken在webapiclient中一般是保存在http請求的Header的Authrization

當(dāng)token在url中時我們需要自定義OAuthTokenHandler

class UriQueryOAuthTokenHandler : OAuthTokenHandler
{
    /// <summary>
    /// token應(yīng)用的http消息處理程序
    /// </summary>
    /// <param name="tokenProvider">token提供者</param> 
    public UriQueryOAuthTokenHandler(ITokenProvider tokenProvider)
: base(tokenProvider)
    {
    }

    /// <summary>
    /// 應(yīng)用token
    /// </summary>
    /// <param name="request"></param>
    /// <param name="tokenResult"></param>
    protected override void UseTokenResult(HttpRequestMessage request, TokenResult tokenResult)
    {
// var builder = new UriBuilder(request.RequestUri);
// builder.Query += "mytoken=" + Uri.EscapeDataString(tokenResult.Access_token);
// request.RequestUri = builder.Uri;

var uriValue = new UriValue(request.RequestUri).AddQuery("myToken", tokenResult.Access_token);
request.RequestUri = uriValue.ToUri();
    }
}

AddQuery是請求的的url中攜帶token的key

自定義OAuthTokenHandler的使用

services
    .AddHttpApi<IUserApi>()
    .AddOAuthTokenHandler((s, tp) => new UriQueryOAuthTokenHandler(tp));
//自定義TokoenProvider使用自定義OAuthTokenHandler
 apiBulider.AddOAuthTokenHandler<UrlTokenHandler>((sp,token)=>
    {
token=sp.GetRequiredService<TestTokenProvider>();
return new UrlTokenHandler(token);
    },WebApiClientCore.Extensions.OAuths.TypeMatchMode.TypeOrBaseTypes);

OAuthToken 特性

OAuthToken可以定義在繼承IHttpApi的接口上也可以定義在接口的方法上

在使用自定義TokenProvier時要注意OAuthToken特性不要定義在具有請求token的Http請求定義上

Patch請求

json patch是為客戶端能夠局部更新服務(wù)端已存在的資源而設(shè)計的一種標(biāo)準(zhǔn)交互,在RFC6902里有詳細(xì)的介紹json patch,通俗來講有以下幾個要點:

  • 使用HTTP PATCH請求方法;
  • 請求body為描述多個opration的數(shù)據(jù)json內(nèi)容;
  • 請求的Content-Type為application/json-patch+json;

聲明Patch方法

public interface IUserApi
{
    [HttpPatch("api/users/{id}")]
    Task<UserInfo> PatchAsync(string id, JsonPatchDocument<User> doc);
}

實例化JsonPatchDocument

var doc = new JsonPatchDocument<User>();
doc.Replace(item => item.Account, "laojiu");
doc.Replace(item => item.Email, "laojiu@qq.com");

請求內(nèi)容

PATCH /api/users/id001 HTTP/1.1
Host: localhost:6000
User-Agent: WebApiClientCore/1.0.0.0
Accept: application/json; q=0.01, application/xml; q=0.01
Content-Type: application/json-patch+json

[{"op":"replace","path":"/account","value":"laojiu"},{"op":"replace","path":"/email","value":"laojiu@qq.com"}]

異常處理

try
{
    var model = await api.GetAsync();
}
catch (HttpRequestException ex) when (ex.InnerException is ApiInvalidConfigException configException)
{
    // 請求配置異常
}
catch (HttpRequestException ex) when (ex.InnerException is ApiResponseStatusException statusException)
{
    // 響應(yīng)狀態(tài)碼異常
}
catch (HttpRequestException ex) when (ex.InnerException is ApiException apiException)
{
    // 抽象的api異常
}
catch (HttpRequestException ex) when (ex.InnerException is SocketException socketException)
{
    // socket連接層異常
}
catch (HttpRequestException ex)
{
    // 請求異常
}
catch (Exception ex)
{
    // 異常
}

請求重試

使用ITask<>異步聲明,就有Retry的擴展,Retry的條件可以為捕獲到某種Exception或響應(yīng)模型符合某種條件。

 GetNumberTemplateForEditOutput put = new GetNumberTemplateForEditOutput();
    var res = await _testApi.GetForEdit(id).Retry(maxCount: 1).WhenCatchAsync<ApiResponseStatusException>(async p =>
    {
if (p.StatusCode == HttpStatusCode.Unauthorized)
{
    await Token();//當(dāng)http請求異常時報錯,重新請求一次,保證token一直有效
}
    });
    put = res.Result;
    return put;

API接口處理

使用ITask<>異步聲明

[HttpHost("請求地址")]//請求地址域名
    public interface ITestApi : IHttpApi
    {
[OAuthToken]//權(quán)限
[JsonReturn]//設(shè)置返回格式
[HttpGet("/api/services/app/NumberingTemplate/GetForEdit")]//請求路徑
ITask<AjaxResponse<GetNumberTemplateForEditOutput>> GetForEdit([Required] string id);//請求參數(shù)聲明

[HttpPost("api/TokenAuth/Authenticate")]
ITask<string> RequestToken([JsonContent] AuthenticateModel login);
    }

基于WebApiClient的擴展類

擴展類聲明

/// <summary>
    /// WebApiClient擴展類
    /// </summary>
    public static class WebApiClientExentions
    {
public static IServiceCollection AddWebApiClietHttp<THttp>(this IServiceCollection services, Action<HttpApiOptions>? options = null) where THttp : class, IHttpApi
{
    HttpApiOptions option = new HttpApiOptions();
    option.JsonSerializeOptions.Converters.Add(new JsonDateTimeConverter("yyyy-MM-dd HH:mm:ss"));
    option.UseParameterPropertyValidate = true;
    if(options != null)
    {
options.Invoke(option);
    }
    services.AddHttpApi<THttp>().ConfigureHttpApi(p => p = option);
    return services;
}

public static IServiceCollection AddWebApiClietHttp<THttp>(this IServiceCollection services,IConfiguration configuration) where THttp : class, IHttpApi
{
    services.AddHttpApi<THttp>().ConfigureHttpApi((Microsoft.Extensions.Configuration.IConfiguration)configuration);
    return services;
}

public static IServiceCollection AddWebApiClientHttpWithTokeProvider<THttp, TTokenProvider>(this IServiceCollection services, Action<HttpApiOptions>? options = null) where THttp : class, IHttpApi
    where TTokenProvider : class, ITokenProvider
{
    services.AddWebApiClietHttp<THttp>(options);
    services.AddTokenProvider<THttp,TTokenProvider>();
    return services;
}

public static IServiceCollection AddWebApiClientHttpWithTokeProvider<THttp, TTokenProvider>(this IServiceCollection services, IConfiguration configuration) where THttp : class, IHttpApi
    where TTokenProvider : class, ITokenProvider
{
    services.AddWebApiClietHttp<THttp>(configuration);
    services.AddTokenProvider<THttp, TTokenProvider>();
    return services;
}
    }

擴展類使用

services.AddWebApiClientHttpWithTokeProvider<ITestApi, TestTokenProvider>();

到此這篇關(guān)于.net core 中 WebApiClientCore的使用示例代碼的文章就介紹到這了,更多相關(guān).net core 中 WebApiClientCore使用內(nèi)容請搜索以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持!

標(biāo)簽: ASP.NET
成人在线亚洲_国产日韩视频一区二区三区_久久久国产精品_99国内精品久久久久久久
久久国产免费| 亚洲美女视频在线免费观看| 一区二区三区蜜桃网| 亚洲精品视频在线观看免费| 久久精品国产成人一区二区三区| 免费成人在线网站| av亚洲精华国产精华| 91久久精品一区二区别| 色94色欧美sute亚洲13| 欧美一激情一区二区三区| 亚洲欧美一区二区三区孕妇| 美女任你摸久久| 99久久综合国产精品| 日韩精品专区在线影院重磅| 亚洲成av人片一区二区三区| 懂色av一区二区三区免费观看| 在线精品福利| 欧美日韩五月天| 欧美激情一区二区三区在线| 蜜臀av一区二区在线免费观看 | 蜜桃av噜噜一区| 色综合久久久久久久久久久| 久久久一区二区三区| 青青草伊人久久| 久久精品国语| 日韩电影一二三区| av在线免费不卡| 日韩视频免费直播| 成人一区二区三区视频在线观看 | 亚洲综合在线免费观看| 一本一道久久综合狠狠老精东影业 | 色婷婷综合久久久久中文| 肉色丝袜一区二区| 色综合久久综合网| 麻豆久久久9性大片| 舔着乳尖日韩一区| 精品不卡一区| 日韩三级高清在线| 成人a区在线观看| 欧美日本高清视频在线观看| 一区二区三区四区视频精品免费| 亚洲一区日韩| 国产人妖乱国产精品人妖| 麻豆精品蜜桃视频网站| 欧美日韩一区三区四区| 国产一区二区在线电影| 久久国产成人| 久久电影国产免费久久电影| 日韩欧美三级在线| 91浏览器在线视频| 日韩美一区二区三区| 91亚洲精华国产精华精华液| 国产精品乱人伦| 91亚洲国产成人精品一区二三| 国产精品久久久久久福利一牛影视| 懂色一区二区三区免费观看| 国产亲近乱来精品视频| 国产欧美日韩一区| 免费成人结看片| 欧美成人一区二区三区片免费| 加勒比av一区二区| 久久综合九九| 亚洲国产成人av网| 亚洲人成高清| 日韩精品欧美精品| 91精品国产免费| 精东粉嫩av免费一区二区三区| 久久综合色8888| 91片黄在线观看| 一区二区三区.www| 欧美精品高清视频| 国产在线麻豆精品观看| 欧美三级日韩三级| 91丝袜呻吟高潮美腿白嫩在线观看| 亚洲色图.com| 狠狠噜噜久久| 国产人成亚洲第一网站在线播放 | 国产中文一区二区| 日韩精品电影在线观看| 欧美一三区三区四区免费在线看 | 亚洲国产成人在线| 色猫猫国产区一区二在线视频| www.亚洲国产| 午夜精品成人在线视频| 欧美tickling挠脚心丨vk| 影音欧美亚洲| 精品无码三级在线观看视频| 国产精品理论片在线观看| 在线看一区二区| 卡一卡二国产精品| 中文字幕精品综合| 欧美视频自拍偷拍| 国产精品羞羞答答xxdd| 欧美一区二区三区在线视频| 亚洲激情亚洲| 国产成人综合在线观看| 日韩欧美一区在线| 一区二区三区四区五区精品| 国产一区二区三区在线看麻豆| 日韩美女视频19| 91麻豆精品国产自产在线观看一区| 国产a区久久久| 亚洲自拍偷拍综合| 欧美在线观看你懂的| 欧美日韩在线大尺度| 亚洲欧美视频在线观看| 制服丝袜成人动漫| 国产免费成人| av激情成人网| 日本vs亚洲vs韩国一区三区二区| 欧美国产日产图区| 欧美在线视频日韩| 在线观看日韩av电影| 国产精品小仙女| 亚洲成人动漫精品| 欧美国产精品中文字幕| 欧美日韩国产另类不卡| 国产精品一卡| 91麻豆免费在线观看| 免费看欧美女人艹b| 亚洲欧美日韩在线播放| 久久婷婷综合激情| 欧美日韩精品一区二区三区| 亚洲在线黄色| 国产一区日韩欧美| 成人小视频在线| 久久se这里有精品| 亚洲va欧美va国产va天堂影院| 国产精品久久三区| 欧美精品一区男女天堂| 精品动漫3d一区二区三区免费| 国产曰批免费观看久久久| 亚洲第一激情av| 中文字幕在线不卡| 91福利国产精品| 一本久道久久综合婷婷鲸鱼| 99久久精品免费看国产| 一区二区在线电影| 久久久精品tv| 欧美一区二区高清| 欧美亚洲综合一区| 国产精品日韩欧美一区二区| 国产一区二区免费视频| 视频在线在亚洲| 亚洲综合色丁香婷婷六月图片| 欧美国产日韩在线观看| 精品国产成人系列| 欧美一区二区私人影院日本| 在线看日韩精品电影| 久久av一区二区三区| 岛国一区二区在线观看| 麻豆国产欧美日韩综合精品二区| 玉米视频成人免费看| 成人欧美一区二区三区白人| 亚洲国产成人午夜在线一区| 久久久美女艺术照精彩视频福利播放| 91麻豆精品国产无毒不卡在线观看 | 最新亚洲一区| 国产精品hd| 欧美日韩精品久久| 农村妇女精品| 蜜桃视频在线观看一区二区| 亚洲在线视频网站| 亚洲精品日韩一| 亚洲免费av网站| 亚洲毛片av在线| 一区二区三区影院| 亚洲精品国久久99热| 一区二区三区中文免费| 一区二区三区中文在线| 亚洲精品成人在线| 亚洲精品视频在线看| 亚洲伦理在线免费看| 亚洲精品国产a| 亚洲影院在线观看| 一区二区三区在线免费观看| 一区二区激情小说| 亚洲综合丁香婷婷六月香| 亚洲福利电影网| 日韩成人av影视| 久久成人麻豆午夜电影| 国产综合色产在线精品| 国产精品资源网| 成人国产一区二区三区精品| 国产成人精品亚洲日本在线桃色| 国产成人高清在线| 成人黄色片在线观看| 成人黄色软件下载| 91污在线观看| 精品91免费| 中文国产一区| 久久先锋影音| 欧美日韩国产首页在线观看| 日韩午夜av电影| 久久久久综合网| 成人免费一区二区三区视频 | 暴力调教一区二区三区| 欧美chengren| 欧美日韩少妇| 国产日韩精品久久|