feat: 新增 取消令牌相关方法

Author: jianxuanbing

framework/src/Bing.AspNetCore/Bing/AspNetCore/Threading/HttpContextCancellationTokenProvider.cs

@@ -1,5 +1,4 @@
-using System.Threading;
-using Bing.DependencyInjection;
+using Bing.DependencyInjection;
 using Bing.Threading;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.DependencyInjection;
@@ -27,4 +26,4 @@ public class HttpContextCancellationTokenProvider : ICancellationTokenProvider
     /// 异步任务取消令牌
     /// </summary>
     public CancellationToken Token => _httpContextAccessor.HttpContext?.RequestAborted ?? CancellationToken.None;
-}
+}

framework/src/Bing/Bing/Threading/AmbientDataContextAmbientScopeProvider.cs

@@ -0,0 +1,119 @@
+using System.Collections.Concurrent;
+using Bing.Collections;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
+
+namespace Bing.Threading;
+
+/// <summary>
+/// 环境数据上下文环境范围提供程序
+/// </summary>
+/// <typeparam name="T">泛型类型</typeparam>
+public class AmbientDataContextAmbientScopeProvider<T> : IAmbientScopeProvider<T>
+{
+    /// <summary>
+    /// 日志
+    /// </summary>
+    public ILogger<AmbientDataContextAmbientScopeProvider<T>> Logger { get; set; }
+
+    /// <summary>
+    /// 范围字典
+    /// </summary>
+    // ReSharper disable once InconsistentNaming
+    private static readonly ConcurrentDictionary<string, ScopeItem> ScopeDictionary = new();
+
+    /// <summary>
+    /// 环境数据上下文
+    /// </summary>
+    private readonly IAmbientDataContext _dataContext;
+
+    /// <summary>
+    /// 初始化一个<see cref="AmbientDataContextAmbientScopeProvider{T}"/>类型的实例
+    /// </summary>
+    /// <param name="dataContext">环境数据上下文</param>
+    public AmbientDataContextAmbientScopeProvider(IAmbientDataContext dataContext)
+    {
+        _dataContext = dataContext ?? throw new ArgumentNullException(nameof(dataContext));
+        Logger = NullLogger<AmbientDataContextAmbientScopeProvider<T>>.Instance;
+    }
+
+    /// <summary>
+    /// 获取值
+    /// </summary>
+    /// <param name="contextKey">上下文键名</param>
+    /// <returns>对象值</returns>
+    public T GetValue(string contextKey)
+    {
+        var item = GetCurrentItem(contextKey);
+        if (item is null)
+            return default;
+        return item.Value;
+    }
+
+    /// <summary>
+    /// 开始范围
+    /// </summary>
+    /// <param name="contextKey">上下文键名</param>
+    /// <param name="value">对象值</param>
+    public IDisposable BeginScope(string contextKey, T value)
+    {
+        var item = new ScopeItem(value, GetCurrentItem(contextKey));
+        if (!ScopeDictionary.TryAdd(item.Id, item))
+            throw new BingFrameworkException($"Can not add item! ScopeDictionary.TryAdd returns false!");
+        _dataContext.SetData(contextKey, item.Id);
+
+        return new DisposeAction(() =>
+        {
+            ScopeDictionary.TryRemove(item.Id, out item);
+            if (item.Outer == null)
+            {
+                _dataContext.SetData(contextKey, null);
+                return;
+            }
+
+            _dataContext.SetData(contextKey, item.Outer.Id);
+        });
+    }
+
+    /// <summary>
+    /// 获取当前项
+    /// </summary>
+    /// <param name="contextKey">上下文键名</param>
+    private ScopeItem GetCurrentItem(string contextKey)
+    {
+        return _dataContext.GetData(contextKey) is string objKey ? ScopeDictionary.GetOrDefault(objKey) : null;
+    }
+
+    /// <summary>
+    /// 范围项
+    /// </summary>
+    private class ScopeItem
+    {
+        /// <summary>
+        /// 标识
+        /// </summary>
+        public string Id { get; }
+
+        /// <summary>
+        /// 外部范围项
+        /// </summary>
+        public ScopeItem Outer { get; }
+
+        /// <summary>
+        /// 值
+        /// </summary>
+        public T Value { get; }
+
+        /// <summary>
+        /// 初始化一个<see cref="ScopeItem"/>类型的实例
+        /// </summary>
+        /// <param name="value">值</param>
+        /// <param name="outer">外部范围项</param>
+        public ScopeItem(T value, ScopeItem outer = null)
+        {
+            Id = Guid.NewGuid().ToString();
+            Value = value;
+            Outer = outer;
+        }
+    }
+}

framework/src/Bing/Bing/Threading/AsyncLocalAmbientDataContext.cs

@@ -0,0 +1,38 @@
+using System.Collections.Concurrent;
+using Bing.DependencyInjection;
+
+namespace Bing.Threading;
+
+/// <summary>
+/// 基于 <see cref="AsyncLocal{T}"/> 的环境数据上下文
+/// </summary>
+public class AsyncLocalAmbientDataContext : IAmbientDataContext, ISingletonDependency
+{
+    /// <summary>
+    /// 异步线程本地存储字典
+    /// </summary>
+    // ReSharper disable once InconsistentNaming
+    private static readonly ConcurrentDictionary<string, AsyncLocal<object>> AsyncLocalDictionary = new();
+
+    /// <summary>
+    /// 设置数据
+    /// </summary>
+    /// <param name="key">键名</param>
+    /// <param name="value">对象值</param>
+    public void SetData(string key, object value)
+    {
+        var asyncLocal = AsyncLocalDictionary.GetOrAdd(key, (k) => new AsyncLocal<object>());
+        asyncLocal.Value = value;
+    }
+
+    /// <summary>
+    /// 获取数据
+    /// </summary>
+    /// <param name="key">键名</param>
+    /// <returns>对象值</returns>
+    public object GetData(string key)
+    {
+        var asyncLocal = AsyncLocalDictionary.GetOrAdd(key, (k) => new AsyncLocal<object>());
+        return asyncLocal.Value;
+    }
+}

framework/src/Bing/Bing/Threading/AsyncLocalExtensions.cs

@@ -0,0 +1,23 @@
+namespace Bing.Threading;
+
+/// <summary>
+/// <see cref="AsyncLocal{T}"/> 扩展
+/// </summary>
+public static class AsyncLocalExtensions
+{
+    /// <summary>
+    /// 设置范围
+    /// </summary>
+    /// <typeparam name="T">类型</typeparam>
+    /// <param name="asyncLocal">异步本地存储</param>
+    /// <param name="value">值</param>
+    public static IDisposable SetScoped<T>(this AsyncLocal<T> asyncLocal, T value)
+    {
+        var previousValue = asyncLocal.Value;
+        asyncLocal.Value = value;
+        return new DisposeAction(() =>
+        {
+            asyncLocal.Value = previousValue;
+        });
+    }
+}

framework/src/Bing/Bing/Threading/CancellationTokenOverride.cs

@@ -0,0 +1,21 @@
+namespace Bing.Threading;
+
+/// <summary>
+/// 取消令牌覆盖
+/// </summary>
+public class CancellationTokenOverride
+{
+    /// <summary>
+    /// 取消令牌
+    /// </summary>
+    public CancellationToken CancellationToken { get; }
+
+    /// <summary>
+    /// 初始化一个<see cref="CancellationTokenOverride"/>类型的实例
+    /// </summary>
+    /// <param name="cancellationToken">取消令牌</param>
+    public CancellationTokenOverride(CancellationToken cancellationToken)
+    {
+        CancellationToken = cancellationToken;
+    }
+}

framework/src/Bing/Bing/Threading/CancellationTokenProviderBase.cs

@@ -0,0 +1,45 @@
+namespace Bing.Threading;
+
+/// <summary>
+/// 异步任务取消令牌提供程序基类
+/// </summary>
+public abstract class CancellationTokenProviderBase : ICancellationTokenProvider
+{
+    /// <summary>
+    /// 取消令牌覆盖上下文键名
+    /// </summary>
+    public const string CancellationTokenOverrideContextKey = "Bing.Threading.CancellationToken.Override";
+
+    /// <summary>
+    /// 异步任务取消令牌
+    /// </summary>
+    public abstract CancellationToken Token { get; }
+
+    /// <summary>
+    /// 取消令牌覆盖-环境范围提供程序
+    /// </summary>
+    protected IAmbientScopeProvider<CancellationTokenOverride> CancellationTokenOverrideScopeProvider { get; }
+
+    /// <summary>
+    /// 取消令牌覆盖值
+    /// </summary>
+    protected CancellationTokenOverride OverrideValue => CancellationTokenOverrideScopeProvider.GetValue(CancellationTokenOverrideContextKey);
+
+    /// <summary>
+    /// 初始化一个<see cref="CancellationTokenProviderBase"/>类型的实例
+    /// </summary>
+    /// <param name="cancellationTokenOverrideScopeProvider">取消令牌覆盖-环境范围提供程序</param>
+    protected CancellationTokenProviderBase(IAmbientScopeProvider<CancellationTokenOverride> cancellationTokenOverrideScopeProvider)
+    {
+        CancellationTokenOverrideScopeProvider = cancellationTokenOverrideScopeProvider;
+    }
+
+    /// <summary>
+    /// 自动释放
+    /// </summary>
+    /// <param name="cancellationToken">取消令牌</param>
+    public IDisposable Use(CancellationToken cancellationToken)
+    {
+        return CancellationTokenOverrideScopeProvider.BeginScope(CancellationTokenOverrideContextKey, new CancellationTokenOverride(cancellationToken));
+    }
+}

framework/src/Bing/Bing/Threading/IAmbientDataContext.cs

@@ -0,0 +1,24 @@
+namespace Bing.Threading;
+
+/// <summary>
+/// 环境数据上下文
+/// </summary>
+/// <remarks>
+/// 应用程序中共享上下文信息的模式，允许从一个地方设置和存储上下文，在整个应用程序中使用该上下文，而无需显示地将其传递给每个方法和类。
+/// </remarks>
+public interface IAmbientDataContext
+{
+    /// <summary>
+    /// 设置数据
+    /// </summary>
+    /// <param name="key">键名</param>
+    /// <param name="value">对象值</param>
+    void SetData(string key, object value);
+
+    /// <summary>
+    /// 获取数据
+    /// </summary>
+    /// <param name="key">键名</param>
+    /// <returns>对象值</returns>
+    object GetData(string key);
+}

framework/src/Bing/Bing/Threading/IAmbientScopeProvider.cs

@@ -0,0 +1,22 @@
+namespace Bing.Threading;
+
+/// <summary>
+/// 环境范围提供程序
+/// </summary>
+/// <typeparam name="T">泛型类型</typeparam>
+public interface IAmbientScopeProvider<T>
+{
+    /// <summary>
+    /// 获取值
+    /// </summary>
+    /// <param name="contextKey">上下文键名</param>
+    /// <returns>对象值</returns>
+    T GetValue(string contextKey);
+
+    /// <summary>
+    /// 开始范围
+    /// </summary>
+    /// <param name="contextKey">上下文键名</param>
+    /// <param name="value">对象值</param>
+    IDisposable BeginScope(string contextKey, T value);
+}