.net源码分析 – List

通过分析源码可以更好理解List的工作方式，帮助我们写出更稳定的代码。

List源码地址: https://github.com/dotnet/corefx/blob/master/src/System.Collections/src/System/Collections/Generic/List.cs。

接口

List实现的接口：IList, IList, IReadOnlyList

其实.net framework经过多代发展，List的接口确实是有点多了，添加新功能时为了兼容老功能，一些旧的接口又不能丢掉，所以看上去有点复杂。先把这些接口捋一下：

IEnumerator是枚举器接口，拥有枚举元素的功能，成员有Current, MoveNext, Reset，这三个函数可以使集合支持遍历。

IEnumerable是支持枚举接口，实现这接口表示支持遍历，成员就是上面的IEnumerator。

ICollection是集合接口，支持着集合的Count属性和CopyTo操作，另外还有同步的属性IsSynchronized（判断是否线程安全）和SyncRoot（lock的对象）。

IList是集合的操作接口，支持索引器，Add, Remove, Insert, Contains等操作。

泛型部分基本是上面这些接口的泛型实现，不过IList的一些操作放到ICollection里了，可能微软也觉得对于集合的一些操作放到ICollection更合理吧。

IReadOnlyCollection是.net 4.5加进来的，可以认为是IList的只读版。

变量

private const int _defaultCapacity = 4;

private T[] _items;

private int _size;

private int _version;

private Object _syncRoot;

static readonly T[] _emptyArray = new T[0];

_defaultCapacity意思是new List时默认大小是4。

_items就是存List元素的数组了，List也是基于数组实现的。

_size指元素个数。

_version看字面意思是版本，具体用处下面看，与遍历集合时经常碰到的集合被修改异常有关。

_syncRoot上面有说到，内置的用于lock的对象，如果在多线程时只是操作这个集合就可以lock这个来保证线程安全，当然一般来说这个是内部用的，虽然对List本身来说没什么用，这个不取的话是不会把对象new出来的，对于锁我们更常用的是在外面new一个readonly的object。

emptyArray这是个静态只读的空数组，所有没有元素的List都是用这个，所以两个List的_items其实是一样的，都是这个_emptyArray。

构造函数

有三个构造函数

public List()
{
   _items = _emptyArray;
}

最常用的，_items直接指向静态空数组。

public List(int capacity)
{
    if (capacity < 0) throw new ArgumentOutOfRangeException(nameof(capacity), capacity, SR.ArgumentOutOfRange_NeedNonNegNum);
    Contract.EndContractBlock();

    if (capacity == 0)
        _items = _emptyArray;
    else
        _items = new T[capacity];
}

可以通过capacity指定大小

public List(IEnumerable<T> collection)
{
    if (collection == null)
        throw new ArgumentNullException(nameof(collection));
    Contract.EndContractBlock();

    ICollection<T> c = collection as ICollection<T>;
    if (c != null)
    {
        int count = c.Count;
        if (count == 0)
        {
            _items = _emptyArray;
        }
        else
        {
            _items = new T[count];
            c.CopyTo(_items, 0);
            _size = count;
        }
    }
    else
    {
        _size = 0;
        _items = _emptyArray;
        // This enumerable could be empty.  Let Add allocate a new array, if needed.
        // Note it will also go to _defaultCapacity first, not 1, then 2, etc.

        using (IEnumerator<T> en = collection.GetEnumerator())
        {
            while (en.MoveNext())
            {
                Add(en.Current);
            }
        }
    }
}

初始添加一个集合， 先看是否是ICollection，看上面知道这个接口有Copy的功能，copy到_items里。如果不是ICollection，不过由于是IEnumerable，所以可以遍历，一个一个加到_items里。

属性

Count 返回的是_size，这个是元素的实际个数，不是数组大小。

IsSynchronized是false，表示并非用SyncRoot 来实现同步。List不是线程安全，需要我们自己用锁搞定，

IsReadOnly也是false, 那为什么要继承IReadOnlyList呢，是为了提供一个转换成只读List的机会，比如有的方法不希望传进来的List可以修改，就可以把参数设成IReadOnlyList。

Object System.Collections.ICollection.SyncRoot
{
    get
    {
        if (_syncRoot == null)
        {
            System.Threading.Interlocked.CompareExchange<Object>(ref _syncRoot, new Object(), null);
        }
        return _syncRoot;
    }
}

SyncRoot通过原子操作得到一个对象，对于List来说并没有用，对于某些集合比较有用，比如SyncHashtable，就是通过syncRoot来实现线程安全。

比较重要的Capacity:

public int Capacity
{
    get
    {
        Contract.Ensures(Contract.Result<int>() >= 0);
        return _items.Length;
    }
    set
    {
        if (value < _size)
        {
            throw new ArgumentOutOfRangeException(nameof(value), value, SR.ArgumentOutOfRange_SmallCapacity);
        }
        Contract.EndContractBlock();

        if (value != _items.Length)
        {
            if (value > 0)
            {
                var items = new T[value];
                Array.Copy(_items, 0, items, 0, _size);
                _items = items;
            }
            else
            {
                _items = _emptyArray;
            }
        }
    }
}

Capacity取的就是数组的长度，另外我们可以通过Capacity给List设置大小，即使这个List里面已经有元素，会先new一个目标大小的数组，然后通过Array.Copy把现有元素复制到新数组里。但一般情况下这些不用我们设置Capacity，添加新元素时发现长度不够会自动扩大数组。Capacity是int型，说明最大是int.MaxValue，大约2G个，如果我们直接给List设置int.MaxValue就要看你的内存够不够2G*4也就是8G了，不够的话会报OutofMemory Exception。其实个人觉得这里Capacity用uint是不是更好。

用100M个，内存占用400M多

同样100M个，由于是long，内存占了800M多

方法

看几个重要的方法：

public void Add(T item)
{
    if (_size == _items.Length) EnsureCapacity(_size + 1);
    _items[_size++] = item;
    _version++;
}

当前数组大小和元素个数相等时表明再Add的话大小不够了，需要先通过EnsureCapacity扩容, _size+1指明了一个最小的扩容目标。

private void EnsureCapacity(int min)
{
    if (_items.Length < min)
    {
        int newCapacity = _items.Length == 0 ? _defaultCapacity : _items.Length * 2;
        // Allow the list to grow to maximum possible capacity (~2G elements) before encountering overflow.
        // Note that this check works even when _items.Length overflowed thanks to the (uint) cast
        //if ((uint)newCapacity > Array.MaxArrayLength) newCapacity = Array.MaxArrayLength;
        if (newCapacity < min) newCapacity = min;
        Capacity = newCapacity;
    }
}

扩容方法，如果数组长度是0的话则用_defaultCapacity也就是4来做为数组长度，否则则以当前元素个数的2倍去扩大。如果新得到的长度比传进来的min小的话则就用min，也就是选大的，这种情况在InsertRange时有可能发生，因为insert的list很可能比当前list的元素个数多。

Add函数里还有个_version++，这个_version可以在很多方法里看到，如remove, insert, sort等，但凡要修改集合都需要_version++。那这个_version有什么用呢？

public void ForEach(Action<T> action)
{
    if (action == null)
    {
        throw new ArgumentNullException(nameof(action));
    }

    int version = _version;

    for (int i = 0; i < _size; i++)
    {
        if (version != _version)
        {
            break;
        }
        action(_items[i]);
    }

    if (version != _version)
        throw new InvalidOperationException(SR.InvalidOperation_EnumFailedVersion);
}

在遍历时如果发现_version变了立即退出并抛出遍历过程集合被修改异常，比如在foreach里remove或add元素就会导致这个异常。更常见的是出现在多线程时一个线程遍历集合，另一个线程修改集合的时候，相信很多人吃过苦头。

如果一个线程时想在遍历时修改集合，比如删除，可以用原始的for(int i=list.Count-1;i>=0;i--)方式。

另外用到version还有枚举器Enumerator，MoveNext过程中同样会检测这个。

其他大部分方法都是通过Array的静态函数实现，不多说，需要注意的是List继承自IList，所以可以转成IList，转之后泛型就没了，如果是List，转成IList的话和IList