关于c＃：带上限的线程安全集合


thread safe Collection with upper bound

我正在寻找具有以下属性的集合：

  • 线程安全：它将在ASP.NET中使用，多个客户端可以尝试同时添加、删除和访问成员。
  • 最大元素：我希望能够在构建时设置一个上限，最大元素数。
  • tryadd：与BlockingCollection.TryAdd(T)相同的方法是完美的，即如果达到元素的最大数目，它将返回false。
  • 字典式：在大多数其他方面，ConcurrentDictionary是完美的，即能够通过键识别元素，删除任何项(不只是第一项或最后一项，我认为这是BlockingCollection的限制)。

在我尝试自己动手之前，我的问题是：

  • 我是否错过了一个内置类型，它可以为集合中的元素数量设置一个安全的上限？
  • 有没有办法用BlockingCollection来实现这个功能？

    • 最后，如果我确实需要尝试自己的方法，我应该考虑什么方法？它是否像用locks包裹的Dictionary一样简单？

    实例使用：一个对参与者数量有明确限制的聊天室可以存储参与者的连接信息，并拒绝新进入者，直到有足够的空间进入。

    下面是一个简单的实现：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    public class ConcurrentDictionaryEx<TKey, TValue>
    {
        private readonly object _lock = new object();
        private ConcurrentDictionary<TKey, TValue> _dic;
        public int Capacity { get; set; }
        public int Count { get; set; }
        public ConcurrentDictionaryEx(int capacity, int concurrencyLevel = 2)
        {
            this.Capacity = capacity;
            _dic = new ConcurrentDictionary<TKey, TValue>(concurrencyLevel, capacity);
        }

        public bool TryAdd(TKey key, TValue value)
        {
            lock (_lock)
            {
                if (this.Count < this.Capacity && _dic.TryAdd(key, value))
                {
                    this.Count++;
                    return true;
                }
                return false;

            }
        }

        public bool TryRemove(TKey key, out TValue value)
        {
            lock (_lock)
            {
                if (_dic.TryRemove(key, out value))
                {
                    this.Count--;
                    return true;
                }
                return false;
            }
        }

        public bool TryGetValue(TKey key, out TValue value)
        {
            lock (_lock)
            {
                return _dic.TryGetValue(key, out value);
            }
        }

        public bool TryUpdate(TKey key, TValue newValue, TValue comparisonValue)
        {
            lock (_lock)
            {
                return _dic.TryUpdate(key, newValue, comparisonValue);
            }
        }
    }
    相关讨论

    最简单的解决方案就是创建一个包装类，它使用普通字典并使用ReaderWriterLockSlim来控制线程安全访问。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    public class SizeLimitedDictionary<TKey, TValue> : IDictionary<TKey, TValue>
    {
        private readonly int _maxSize;
        private readonly IDictionary<TKey, TValue> _dictionary;
        private readonly ReaderWriterLockSlim _readerWriterLock;

        public SizeLimitedDictionary(int maxSize)
        {
            _maxSize = maxSize;
            _dictionary = new Dictionary<TKey, TValue>(_maxSize);
            _readerWriterLock = new ReaderWriterLockSlim();
        }

        public bool TryAdd(TKey key, TValue value)
        {
            _readerWriterLock.EnterWriteLock();
            try
            {
                if (_dictionary.Count >= _maxSize)
                    return false;

                _dictionary.Add(key, value);
            }
            finally
            {
                _readerWriterLock.ExitWriteLock();
            }

            return true;
        }

        public void Add(TKey key, TValue value)
        {
            bool added = TryAdd(key, value);
            if(!added)
                throw new InvalidOperationException("Dictionary is at max size, can not add additional members.");
        }

        public bool TryAdd(KeyValuePair<TKey, TValue> item)
        {
            _readerWriterLock.EnterWriteLock();
            try
            {
                if (_dictionary.Count >= _maxSize)
                    return false;

                _dictionary.Add(item);
            }
            finally
            {
                _readerWriterLock.ExitWriteLock();
            }

            return true;
        }

        public void Add(KeyValuePair<TKey, TValue> item)
        {
            bool added = TryAdd(item);
            if (!added)
                throw new InvalidOperationException("Dictionary is at max size, can not add additional members.");
        }

        public void Clear()
        {
            _readerWriterLock.EnterWriteLock();
            try
            {
                _dictionary.Clear();
            }
            finally
            {
                _readerWriterLock.ExitWriteLock();
            }

        }

        public bool Contains(KeyValuePair<TKey, TValue> item)
        {
            _readerWriterLock.EnterReadLock();
            try
            {
                return _dictionary.Contains(item);
            }
            finally
            {
                _readerWriterLock.ExitReadLock();
            }

        }

        public void CopyTo(KeyValuePair<TKey, TValue>[] array, int arrayIndex)
        {
            _readerWriterLock.EnterReadLock();
            try
            {
                _dictionary.CopyTo(array, arrayIndex);
            }
            finally
            {
                _readerWriterLock.ExitReadLock();
            }
        }

        public bool Remove(KeyValuePair<TKey, TValue> item)
        {
            _readerWriterLock.EnterWriteLock();
            try
            {
                return _dictionary.Remove(item);
            }
            finally
            {
                _readerWriterLock.ExitWriteLock();
            }
        }

        public int Count
        {
            get
            {
                _readerWriterLock.EnterReadLock();
                try
                {
                    return _dictionary.Count;
                }
                finally
                {
                    _readerWriterLock.ExitReadLock();
                }
            }
        }

        public bool IsReadOnly
        {
            get
            {
                _readerWriterLock.EnterReadLock();
                try
                {
                    return _dictionary.IsReadOnly;
                }
                finally
                {
                    _readerWriterLock.ExitReadLock();
                }
            }
        }

        public bool ContainsKey(TKey key)
        {
            _readerWriterLock.EnterReadLock();
            try
            {
                return _dictionary.ContainsKey(key);
            }
            finally
            {
                _readerWriterLock.ExitReadLock();
            }
        }

        public bool Remove(TKey key)
        {
            _readerWriterLock.EnterWriteLock();
            try
            {
                return _dictionary.Remove(key);
            }
            finally
            {
                _readerWriterLock.ExitWriteLock();
            }
        }

        public bool TryGetValue(TKey key, out TValue value)
        {
            _readerWriterLock.EnterReadLock();
            try
            {
                return _dictionary.TryGetValue(key, out value);
            }
            finally
            {
                _readerWriterLock.ExitReadLock();
            }
        }

        public TValue this[TKey key]
        {
            get
            {
                _readerWriterLock.EnterReadLock();
                try
                {
                    return _dictionary[key];
                }
                finally
                {
                    _readerWriterLock.ExitReadLock();
                }
            }
            set
            {
                _readerWriterLock.EnterUpgradeableReadLock();
                try
                {
                    var containsKey = _dictionary.ContainsKey(key);
                    _readerWriterLock.EnterWriteLock();
                    try
                    {
                        if (containsKey)
                        {
                            _dictionary[key] = value;
                        }
                        else
                        {
                            var added = TryAdd(key, value);
                            if(!added)
                                throw new InvalidOperationException("Dictionary is at max size, can not add additional members.");
                        }
                    }
                    finally
                    {
                        _readerWriterLock.ExitWriteLock();
                    }
                }
                finally
                {
                    _readerWriterLock.ExitUpgradeableReadLock();
                }
            }
        }

        public ICollection<TKey> Keys
        {
            get
            {
                _readerWriterLock.EnterReadLock();
                try
                {
                    return _dictionary.Keys;
                }
                finally
                {
                    _readerWriterLock.ExitReadLock();
                }
            }
        }

        public ICollection<TValue> Values
        {
            get
            {
                _readerWriterLock.EnterReadLock();
                try
                {
                    return _dictionary.Values;
                }
                finally
                {
                    _readerWriterLock.ExitReadLock();
                }
            }
        }

        public IEnumerator<KeyValuePair<TKey, TValue>> GetEnumerator()
        {
            return _dictionary.GetEnumerator();
        }

        IEnumerator IEnumerable.GetEnumerator()
        {
            return ((IEnumerable)_dictionary).GetEnumerator();
        }
    }

    这个类实现了完整的IDictionary接口。这样做的方法是，所有插入都通过TryAdd，如果您的大小等于或大于最大值，并尝试插入新成员，则从TryAdd获得false，从不返回bool的方法获得InvalidOperationException。

    我没有使用ConcurrentDictionary的原因是，在以原子方式添加新成员之前，没有好的方法尝试检查计数，因此您无论如何都需要锁定。您可能会使用并发字典，删除我的所有EnterReadLock，并用正常的lock调用替换EnterWriteLock，但您需要进行性能测试，以确定哪一个更好。

    如果您想要像GetOrAdd这样的方法，那么实现自己并不困难。

    相关讨论

    如果您需要创建具有一些额外功能(例如max元素)的ConcurrentDictionary，我会选择一个Adaptor，它将保存一个私有ConcurrentDictionary，并在需要扩展的地方扩展它。

    许多方法调用将保持不变(您只需调用私有ConcurrentDictionary，什么也不做)。

    如果您有所有这些额外的需求，那么创建一个组成List的类，而不是一个类，不是更好吗？把名单放在你要上的班级里。

    例如，我会说聊天室包含一个列表，而不是一个特殊类型的列表。我会把所有的max数，名字等逻辑与实际的List分开。然后，我将围绕与列表的交互使用lock，或者像ConcurrentBag这样的threadsafe集合。至于你是否想要一本字典，它实际上取决于数据的细节以及你将如何访问它。

    相关讨论

    无论如何，您最终都会得到定制实现，也就是说，没有内置类型可以像字典一样工作，并且具有容量限制…

    为了使它完全自定义，您可以使用ConcurrentHashSet，限制条目数量对您有效。

    .NET框架中的并发哈希集

    相关讨论