增加HttpMessageHandlers

Author: xljiulang

WebApiClientCore.Extensions.OAuths/HttpMessageHandlers/OAuthTokenHandler.cs

@@ -1,70 +1,46 @@
-using System.Net;
-using System.Net.Http;
+using System.Net.Http;
 using System.Net.Http.Headers;
 using System.Threading;
 using System.Threading.Tasks;
+using WebApiClientCore.HttpMessageHandlers;
 
 namespace WebApiClientCore.Extensions.OAuths.HttpMessageHandlers
 {
  /// <summary>
  /// 表示token应用的http消息处理程序
  /// </summary>
- public class OAuthTokenHandler : DelegatingHandler
+ public class OAuthTokenHandler : AuthorizationHandler
  {
  /// <summary>
  /// token提供者
  /// </summary>
- private readonly ITokenProvider tokenProvider; 
+ private readonly ITokenProvider tokenProvider;
 
  /// <summary>
  /// token应用的http消息处理程序
  /// </summary>
  /// <param name="tokenProvider">token提供者</param> 
  public OAuthTokenHandler(ITokenProvider tokenProvider)
- { 
+ {
  this.tokenProvider = tokenProvider;
  }
 
  /// <summary>
- /// 检测响应是否未授权
- /// 未授权则重试请求一次
+ /// 设置请求的授权信息
  /// </summary>
- /// <param name="request"></param>
- /// <param name="cancellationToken"></param>
+ /// <param name="reason">授权原因</param> 
+ /// <param name="request">请求</param>
+ /// <param name="cancellationToken">取消令牌</param>
  /// <returns></returns>
- protected sealed override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+ protected sealed override async Task SetAuthorizationAsync(AuthorizationReason reason, HttpRequestMessage request, CancellationToken cancellationToken)
  {
- var response = await this.SendCoreAsync(request, cancellationToken).ConfigureAwait(false);
- if (await this.IsUnauthorizedAsync(response).ConfigureAwait(false) == true)
+ if (reason == AuthorizationReason.SetForResend)
  {
  this.tokenProvider.ClearToken();
- response = await this.SendCoreAsync(request, cancellationToken).ConfigureAwait(false);
  }
- return response;
- }
 
- /// <summary>
- /// 发送http请求
- /// </summary>
- /// <param name="request"></param>
- /// <param name="cancellationToken"></param>
- /// <returns></returns>
- private async Task<HttpResponseMessage> SendCoreAsync(HttpRequestMessage request, CancellationToken cancellationToken)
- {
  var tokenResult = await this.tokenProvider.GetTokenAsync().ConfigureAwait(false);
  this.UseTokenResult(request, tokenResult);
- return await base.SendAsync(request, cancellationToken).ConfigureAwait(false);
- }
-
- /// <summary>
- /// 返回响应是否为未授权状态
- /// 反回true则强制清除token以支持下次获取到新的token
- /// </summary>
- /// <param name="response"></param> 
- protected virtual Task<bool> IsUnauthorizedAsync(HttpResponseMessage? response)
- {
- var state = response != null && response.StatusCode == HttpStatusCode.Unauthorized;
- return Task.FromResult(state);
  }
 
  /// <summary>

WebApiClientCore/HttpMessageHandlers/AuthorizationHandler.cs

@@ -0,0 +1,55 @@
+using System.ComponentModel;
+using System.Net;
+using System.Net.Http;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace WebApiClientCore.HttpMessageHandlers
+{
+ /// <summary>
+ /// 表示授权应用的抽象http消息处理程序
+ /// </summary>
+ public abstract class AuthorizationHandler : DelegatingHandler
+ {
+ /// <summary>
+ /// 检测响应是否未授权
+ /// 未授权则重试请求一次
+ /// </summary>
+ /// <param name="request"></param>
+ /// <param name="cancellationToken"></param>
+ /// <returns></returns>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ protected sealed override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+ {
+ await this.SetAuthorizationAsync(AuthorizationReason.SetForSend, request, cancellationToken).ConfigureAwait(false);
+ var response = await base.SendAsync(request, cancellationToken).ConfigureAwait(false);
+
+ if (await this.IsUnauthorizedAsync(response).ConfigureAwait(false) == true)
+ {
+ await this.SetAuthorizationAsync(AuthorizationReason.SetForResend, request, cancellationToken).ConfigureAwait(false);
+ response = await base.SendAsync(request, cancellationToken).ConfigureAwait(false);
+ }
+ return response;
+ }
+
+ /// <summary>
+ /// 设置请求的授权信息
+ /// </summary>
+ /// <param name="reason">授权原因</param> 
+ /// <param name="request">请求</param>
+ /// <param name="cancellationToken">取消令牌</param>
+ /// <returns></returns>
+ protected abstract Task SetAuthorizationAsync(AuthorizationReason reason, HttpRequestMessage request, CancellationToken cancellationToken);
+
+ /// <summary>
+ /// 返回响应是否为未授权状态
+ /// 反回true则强制清除token以支持下次获取到新的token
+ /// </summary>
+ /// <param name="response"></param> 
+ protected virtual Task<bool> IsUnauthorizedAsync(HttpResponseMessage? response)
+ {
+ var state = response != null && response.StatusCode == HttpStatusCode.Unauthorized;
+ return Task.FromResult(state);
+ }
+ }
+}

WebApiClientCore/HttpMessageHandlers/AuthorizationReason.cs

@@ -0,0 +1,18 @@
+namespace WebApiClientCore.HttpMessageHandlers
+{
+ /// <summary>
+ /// 设置授权原因
+ /// </summary>
+ public enum AuthorizationReason
+ {
+ /// <summary>
+ /// 用于发送
+ /// </summary>
+ SetForSend,
+
+ /// <summary>
+ /// 用于重试发送
+ /// </summary>
+ SetForResend
+ }
+}

WebApiClientCore/HttpMessageHandlers/CookieAuthorizationHandler.cs

@@ -0,0 +1,34 @@
+using System.Net.Http;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace WebApiClientCore.HttpMessageHandlers
+{
+ /// <summary>
+ /// 表示cookie授权验证的抽象http消息处理程序
+ /// </summary>
+ public abstract class CookieAuthorizationHandler : AuthorizationHandler
+ {
+ /// <summary>
+ /// 设置请求的授权信息
+ /// </summary>
+ /// <param name="reason">授权原因</param> 
+ /// <param name="request">请求</param>
+ /// <param name="cancellationToken">取消令牌</param>
+ /// <returns></returns>
+ protected sealed override async Task SetAuthorizationAsync(AuthorizationReason reason, HttpRequestMessage request, CancellationToken cancellationToken)
+ {
+ if (reason == AuthorizationReason.SetForResend)
+ {
+ await this.RefreshCookieAsync().ConfigureAwait(false);
+ }
+ }
+
+ /// <summary>
+ /// 刷新CookieContainer的cookie
+ /// 一般情况下，登录操作就得到最新的cookie，且自动覆盖到CookieContainer
+ /// </summary>
+ /// <returns></returns>
+ protected abstract Task RefreshCookieAsync();
+ }
+}