UNIVPLMDataIntegration/Admin.NET/Admin.NET.Core/Utils/Collections/DictionaryExtensions.cs

// Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
//
// 本项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
//
// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！

using System.Dynamic;

namespace Admin.NET.Core;

/// <summary>
/// 字典扩展方法
/// </summary>
public static class DictionaryExtensions
{
    /// <summary>
    /// 使用给定的键从字典中获取值。如果找不到，则返回默认值
    /// </summary>
    /// <typeparam name="TKey">键的类型</typeparam>
    /// <typeparam name="TValue">值的类型</typeparam>
    /// <param name="dictionary">要检查和获取的字典</param>
    /// <param name="key">要查找值的键</param>
    /// <returns>如果找到，返回值；如果找不到，返回默认值</returns>
    public static TValue? GetOrDefault<TKey, TValue>(this Dictionary<TKey, TValue> dictionary, TKey key) where TKey : notnull
    {
        return dictionary.GetValueOrDefault(key);
    }

    /// <summary>
    /// 使用给定的键从字典中获取值。如果找不到，则返回默认值
    /// </summary>
    /// <typeparam name="TKey">键的类型</typeparam>
    /// <typeparam name="TValue">值的类型</typeparam>
    /// <param name="dictionary">要检查和获取的字典</param>
    /// <param name="key">要查找值的键</param>
    /// <returns>如果找到，返回值；如果找不到，返回默认值</returns>
    public static TValue? GetOrDefault<TKey, TValue>(this IDictionary<TKey, TValue> dictionary, TKey key)
    {
        return dictionary.TryGetValue(key, out var obj) ? obj : default;
    }

    /// <summary>
    /// 使用给定的键从只读字典中获取值。如果找不到，则返回默认值
    /// </summary>
    /// <typeparam name="TKey">键的类型</typeparam>
    /// <typeparam name="TValue">值的类型</typeparam>
    /// <param name="dictionary">要检查和获取的只读字典</param>
    /// <param name="key">要查找值的键</param>
    /// <returns>如果找到，返回值；如果找不到，返回默认值</returns>
    public static TValue? GetOrDefault<TKey, TValue>(this IReadOnlyDictionary<TKey, TValue> dictionary, TKey key)
    {
        return dictionary.GetValueOrDefault(key);
    }

    /// <summary>
    /// 使用给定的键从并发字典中获取值。如果找不到，则返回默认值
    /// </summary>
    /// <typeparam name="TKey">键的类型，不能为空</typeparam>
    /// <typeparam name="TValue">值的类型</typeparam>
    /// <param name="dictionary">要检查和获取的并发字典</param>
    /// <param name="key">要查找值的键</param>
    /// <returns>如果找到，返回值；如果找不到，返回默认值</returns>
    public static TValue? GetOrDefault<TKey, TValue>(this ConcurrentDictionary<TKey, TValue> dictionary, TKey key) where TKey : notnull
    {
        return dictionary.GetValueOrDefault(key);
    }

    /// <summary>
    /// 使用给定的键从字典中获取值。如果找不到，则使用工厂方法创建并添加值
    /// </summary>
    /// <typeparam name="TKey">键的类型</typeparam>
    /// <typeparam name="TValue">值的类型</typeparam>
    /// <param name="dictionary">要检查和获取的字典</param>
    /// <param name="key">要查找值的键</param>
    /// <param name="factory">如果字典中未找到，则用于创建值的工厂方法</param>
    /// <returns>如果找到，返回值；如果找不到，使用工厂方法创建并返回默认值</returns>
    public static TValue GetOrAdd<TKey, TValue>(this IDictionary<TKey, TValue> dictionary, TKey key, Func<TKey, TValue> factory)
    {
        return dictionary.TryGetValue(key, out var obj) ? obj : dictionary[key] = factory(key);
    }

    /// <summary>
    /// 使用给定的键从字典中获取值。如果找不到，则使用工厂方法创建并添加值
    /// </summary>
    /// <typeparam name="TKey">键的类型</typeparam>
    /// <typeparam name="TValue">值的类型</typeparam>
    /// <param name="dictionary">要检查和获取的字典</param>
    /// <param name="key">要查找值的键</param>
    /// <param name="factory">如果字典中未找到，则用于创建值的工厂方法</param>
    /// <returns>如果找到，返回值；如果找不到，使用工厂方法创建并返回默认值</returns>
    public static TValue GetOrAdd<TKey, TValue>(this IDictionary<TKey, TValue> dictionary, TKey key, Func<TValue> factory)
    {
        return dictionary.GetOrAdd(key, _ => factory());
    }

    /// <summary>
    /// 使用给定的键从并发字典中获取值。如果找不到，则使用工厂方法创建并添加值
    /// </summary>
    /// <typeparam name="TKey">键的类型，不能为空</typeparam>
    /// <typeparam name="TValue">值的类型</typeparam>
    /// <param name="dictionary">要检查和获取的并发字典</param>
    /// <param name="key">要查找值的键</param>
    /// <param name="factory">如果并发字典中未找到，则用于创建值的工厂方法</param>
    /// <returns>如果找到，返回值；如果找不到，使用工厂方法创建并返回默认值</returns>
    public static TValue GetOrAdd<TKey, TValue>(this ConcurrentDictionary<TKey, TValue> dictionary, TKey key, Func<TValue> factory) where TKey : notnull
    {
        return dictionary.GetOrAdd(key, _ => factory());
    }

    /// <summary>
    /// 将字典转换为动态对象，以便在运行时添加和移除
    /// </summary>
    /// <param name="dictionary">要转换的字典对象</param>
    /// <returns>如果值正确，返回表示对象的 ExpandoObject</returns>
    public static dynamic ConvertToDynamicObject(this Dictionary<string, object> dictionary)
    {
        ExpandoObject expandoObject = new();
        ICollection<KeyValuePair<string, object>> expendObjectCollection = expandoObject!;

        foreach (var keyValuePair in dictionary)
        {
            expendObjectCollection.Add(keyValuePair);
        }

        return expandoObject;
    }

    /// <summary>
    /// 如果字典中存在指定的键，则尝试获取其值
    /// </summary>
    /// <typeparam name="T">值的类型</typeparam>
    /// <param name="dictionary">字典对象</param>
    /// <param name="key">要查找的键</param>
    /// <param name="value">键对应的值，如果键不存在，则为默认值</param>
    /// <returns>如果字典中存在该键，则返回真(True)；否则返回假(False)</returns>
    public static bool TryGetValue<T>(this IDictionary<string, object> dictionary, string key, out T? value)
    {
        if (dictionary.TryGetValue(key, out var valueObj) && valueObj is T t)
        {
            value = t;
            return true;
        }

        value = default;
        return false;
    }

    /// <summary>
    /// 字典根据 key 删除，返回一个新的字典
    /// </summary>
    /// <param name="dictionary"></param>
    /// <param name="keys"></param>
    /// <returns>移除后新的字典</returns>
    public static IDictionary<string, object> RemoveByKeys(this IDictionary<string, object> dictionary, params string[] keys)
    {
        ArgumentNullException.ThrowIfNull(dictionary);

        if (keys.Length == 0)
        {
            return dictionary;
        }

        // 创建一个新的字典，避免修改原始字典
        var newDic = new Dictionary<string, object>(dictionary);
        foreach (var key in keys)
        {
            newDic.Remove(key);
        }
        return newDic;
    }
}