.net core 中 WebApiClientCore的使用

来源:https://www.cnblogs.com/lonely-wen/archive/2022/12/09/16969377.html
-Advertisement-
Play Games

WebApiClient 介面註冊與選項 1 配置文件中配置HttpApiOptions選項 配置示例 "IUserApi": { "HttpHost": "http://www.webappiclient.com/", "UseParameterPropertyValidate": false, ...


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 =>
    {
        // 符合國情的不標準時間格式，有些介面就是這麼要求必須不標準
        o.JsonSerializeOptions.Converters.Add(new JsonDateTimeConverter("yyyy-MM-dd HH:mm:ss"));
    });

HttpApiOptions詳細展示

/// <summary>
/// 表示HttpApi選項
/// </summary>
public class HttpApiOptions
{
    /// <summary>
    /// 獲取或設置Http服務完整主機功能變數名稱
    /// 例如http://www.abc.com/或http://www.abc.com/path/
    /// 設置了HttpHost值，HttpHostAttribute將失效
    /// </summary>
    public Uri? HttpHost { get; set; }

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

    /// <summary>
    /// 獲取或設置請求頭是否包含預設的UserAgent
    /// </summary>
    public bool UseDefaultUserAgent { get; set; } = true;

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

    /// <summary>
    /// 獲取或設置是否對返回值的屬性值進行輸入有效性驗證
    /// </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>
    /// 獲取自定義數據存儲的字典
    /// </summary>
    public Dictionary<object, object> Properties { get; } = new Dictionary<object, object>();

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


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

    /// <summary>
    /// 創建反序列化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)拼接規則

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

帶/結尾的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

不帶/結尾的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.com與http://a.com/是完全一樣的，他們的path都是/，所以才會表現一樣。為了避免低級錯誤的出現，請使用的標準baseUri書寫方式，即使用/作為baseUri的結尾的第一種方式。

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一樣，除此之外，如果因為意外的原因導致伺服器仍然返回未授權(401狀態碼)，其還會丟棄舊token，申請新token來重試一次請求。

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

當token在url中時我們需要自定義OAuthTokenHandler

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

    /// <summary>
    /// 應用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是為客戶端能夠局部更新服務端已存在的資源而設計的一種標準交互，在RFC6902里有詳細的介紹json patch，通俗來講有以下幾個要點：

  1. 使用HTTP PATCH請求方法；
  2. 請求body為描述多個opration的數據json內容；
  3. 請求的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, "[email protected]");

請求內容

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":"[email protected]"}]

異常處理

try
{
    var model = await api.GetAsync();
}
catch (HttpRequestException ex) when (ex.InnerException is ApiInvalidConfigException configException)
{
    // 請求配置異常
}
catch (HttpRequestException ex) when (ex.InnerException is ApiResponseStatusException statusException)
{
    // 響應狀態碼異常
}
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或響應模型符合某種條件。

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

API介面處理

使用ITask<>非同步聲明

[HttpHost("http://wmsapi.dev.gct-china.com/")]//請求地址功能變數名稱
    public interface ITestApi : IHttpApi
    {
        [OAuthToken]//許可權
        [JsonReturn]//設置返回格式
        [HttpGet("/api/services/app/NumberingTemplate/GetForEdit")]//請求路徑
        ITask<AjaxResponse<GetNumberTemplateForEditOutput>> GetForEdit([Required] string id);//請求參數聲明

        [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>();

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 利用Python實現批量ping的小工具
    一、原理： 主要涉及的系統命令：ping -n 1 -w 1 IP地址 -n 為ping的次數，在linux下為-c；-w為等待超時時間； 利用Python多線程縮短時間，提升運行效率。 二、其它說明 DEV_NULL = open(os.devnull, 'w') 是在Python中實現的黑洞，類 ...
  • 每日演算法之字元串的排列
    JZ38 字元串的排列 描述 輸入一個長度為 n 字元串，列印出該字元串中字元的所有排列，你可以以任意順序返回這個字元串數組。 例如輸入字元串ABC,則輸出由字元A,B,C所能排列出來的所有字元串ABC,ACB,BAC,BCA,CBA和CAB。 題目主要信息 給定一個長度為n的字元串，求其中所有字元 ...
  • 進位制數的靈活運用
    簡單記錄一下springboot引用kettle對接數據 第一步（這一步講述了下載kettle、創建資料庫連接、轉換等，如果這一步會的可以略過，直接看第二步） 先從kettle官網下載kettle，官網地址：https://sourceforge.net/projects/pentaho/ 進入官網 ...
  • python基礎-模塊和包
    1.什麼是python的包 包就是一個文件夾，裡面放著一個個py文件或子包； 在包中可以被調用的一個個py文件，我們叫做模塊； 如上，test就是一個包、two.py就是test下的一個模塊，child是子包，結構和test包一樣； 包的身份證 可以看到test下還有一個__init__.py命名的 ...
  • 彙編指令
    add add 目的,源 ; 加法指令，結果放入目操作數，操作數的長度必須相同 adc adc 目的,源 ; 帶進位加法，目的=目的+源+CF and and 目的,源 ; 邏輯按位與 指令，結果放到目的操作數。 ; 影響標誌位OF、SF、ZF、PF和CF。 call call s ; 使call ...
  • PHP Firebase HTTP v1 API 新版推送
    //最近一個公司項目需要對接firebase推送，官方文檔就是謝特,再網上找了很多大神的資料，還是有很多坑，把自己踩的坑記錄一下,平時都是伸手黨，這次回饋一下 use Google\Client; /** * 註意需要準備vpn * 1.安裝sdk composer require google/a ...
  • SSM總結
    SSM Spring IOC（控制反轉）& DI（依賴註入） IOC是容器，用來裝Spring創建的Bean對象。 Bean註入方式 Set方法註入 構造器註入 @Autowared自動註入 <!-- SpringBean的註入方式 --> <!-- 手動裝配 --> <!-- == set方法註入 ...
  • 想早點下班？試試Aorm庫吧，更方便的進行Go資料庫操作
    使用go進行項目開發，大多數人會使用gorm，但是gorm有一些缺點，我無法接受。於是開發出了aorm，目前能有滿足日常開發需求，並且完善了使用文檔，希望能夠幫助到大家。 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類