增加ClientCredentialsTokenFilter

Author: xljiulang

WebApiClient/AuthTokens/AuthTokenFilter.cs

@@ -47,6 +47,7 @@ async Task IApiActionFilter.OnBeginRequestAsync(ApiActionContext context)
  /// <summary>
  /// 初始化或刷新token
  /// </summary>
+ /// <exception cref="HttpApiTokenException"></exception>
  /// <returns></returns>
  private async Task InitOrRefreshTokenAsync()
  {

Demo/TokenFilter.cs renamed to WebApiClient/AuthTokens/ClientCredentialsTokenFilter.cs

@@ -1,41 +1,40 @@
-using System;
-using System.Threading.Tasks;
-using WebApiClient.AuthTokens;
+using System.Threading.Tasks;
 
-namespace Demo
+namespace WebApiClient.AuthTokens
 {
  /// <summary>
  /// 表示提供client_credentials方式的token过滤器
  /// </summary>
- public class TokenFilter : AuthTokenFilter
+ public class ClientCredentialsTokenFilter : AuthTokenFilter
  {
  /// <summary>
- /// 获取提供Token获取的Url节点
+ /// 获取或设置提供Token获取的Url节点
+ /// 必填
  /// </summary>
- public string TokenEndpoint { get; private set; }
+ public string TokenEndpoint { get; set; }
 
  /// <summary>
- /// 获取client_id
+ /// 获取或设置client_id
+ /// 必填
  /// </summary>
- public string ClientId { get; private set; }
+ public string ClientId { get; set; }
 
  /// <summary>
- /// 获取client_secret
+ /// 获取或设置client_secret
+ /// 必填
  /// </summary>
- public string ClientSecret { get; private set; }
+ public string ClientSecret { get; set; }
 
  /// <summary>
- /// OAuth授权的token过滤器
+ /// 获取或设置资源范围
  /// </summary>
- /// <param name="tokenEndPoint">提供Token获取的Url节点</param>
- /// <param name="client_id">客户端id</param>
- /// <param name="client_secret">客户端密码</param>
- public TokenFilter(string tokenEndPoint, string client_id, string client_secret)
- {
- this.TokenEndpoint = tokenEndPoint ?? throw new ArgumentNullException(nameof(tokenEndPoint));
- this.ClientId = client_id ?? throw new ArgumentNullException(nameof(client_id));
- this.ClientSecret = client_secret ?? throw new ArgumentNullException(nameof(client_secret));
- }
+ public string Scope { get; set; }
+
+ /// <summary>
+ /// 获取或设置额外字段，支持字典或模型
+ /// </summary>
+ public object Extra { get; set; }
+
 
  /// <summary>
  /// 请求获取token
@@ -45,7 +44,7 @@ public TokenFilter(string tokenEndPoint, string client_id, string client_secret)
  protected override async Task<TokenResult> RequestTokenResultAsync()
  {
  var tokenClient = new TokenClient(this.TokenEndpoint);
- return await tokenClient.RequestClientCredentialsAsync(this.ClientId, this.ClientSecret);
+ return await tokenClient.RequestClientCredentialsAsync(this.ClientId, this.ClientSecret, this.Scope, this.Extra);
  }
 
  /// <summary>

WebApiClient/AuthTokens/TokenClient.cs

@@ -67,7 +67,7 @@ public TimeSpan TimeOut
  /// <exception cref="ArgumentException"></exception>
  /// <exception cref="UriFormatException"></exception>
  public TokenClient(string tokenEndpoint)
- : this(new Uri(tokenEndpoint))
+ : this(new Uri(tokenEndpoint ?? throw new ArgumentNullException(nameof(tokenEndpoint))))
  {
  }
 

WebApiClient/AuthTokens/TokenResult.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Net.Http;
 using WebApiClient.DataAnnotations;
 
 namespace WebApiClient.AuthTokens
@@ -54,14 +53,14 @@ public class TokenResult
  /// <summary>
  /// 确保token成功
  /// </summary>
- /// <exception cref="HttpRequestException"></exception>
+ /// <exception cref="HttpApiTokenException"></exception>
  public TokenResult EnsureSuccess()
  {
  if (this.IsSuccess() == true)
  {
  return this;
  }
- throw new HttpRequestException(this.Error);
+ throw new HttpApiTokenException(this.Error);
  }
 
  /// <summary>

WebApiClient/Exceptions/HttpApiTokenException.cs

@@ -0,0 +1,17 @@
+namespace WebApiClient
+{
+ /// <summary>
+ /// 表示请求Token异常
+ /// </summary>
+ public class HttpApiTokenException : HttpApiException
+ {
+ /// <summary>
+ /// 请求Token异常
+ /// </summary>
+ /// <param name="message">消息</param>
+ public HttpApiTokenException(string message)
+ : base(message)
+ {
+ }
+ }
+}