如何在 C# 中使用 ArrayPool 和 MemoryPool

对资源的可复用是提升应用程序性能的一个非常重要的手段，比如本篇要分享的 ArrayPool 和 MemoryPool，它们就有效的减少了内存使用和对GC的压力，从而提升应用程序性能。

什么是 ArrayPool

System.Buffers 命名空间下提供了一个可对 array 进行复用的高性能池化类 ArrayPool<T>，在经常使用 array 的场景下可使用 ArrayPool<T> 来减少内存占用,它是一个抽象类，如下代码所示：


public abstract class ArrayPool<T>
{
}

可以想象一下你的业务场景中需要多次实例化 array，这么做有什么后果呢？很显然每一次 new array 都会在托管堆上分配，同时当 array 不再使用时还需要 GC 去释放，而 ArrayPool<T> 就是为了解决此事而生的，它在池中动态维护若干个 array 对象，当你需要 new array 的时候只需从池中获取即可。

使用 `ArrayPool<T>`

可以通过下面三种方式来使用 ArrayPool<T> 。

通过 ArrayPool<T>.Shared 属性来获取 ArrayPool<T> 实例。
通过 ArrayPool<T>.Create() 来生成 ArrayPool<T> 实例。
通过继承 ArrayPool<T> 来生成一个自定义子类。

下面的代码展示了如何从 ArrayPool 中获取一个 size >= 10 的 array 数组。


var shared = ArrayPool<int>.Shared;
var rentedArray = shared.Rent(10);

如何在 C# 中使用 ArrayPool 和 MemoryPool-LMLPHP

上面的代码一定要注意，虽然只租用了 10 个 size，但底层会返回 2的倍数 的size , 也就是图中的 2* 8 = 16。

当什么时候不需要 rentedArray 了，记得再将它归还到 ArrayPool 中，如下代码所示。


shared.Return(rentedArray);

下面是仅供参考的完整代码。


        static void Main(string[] args)
        {
            var shared = ArrayPool<int>.Shared;

            var rentedArray = shared.Rent(10);

            for (int i = 0; i < 10; i++)
            {
                rentedArray[i] = i + 1;
            }

            for (int j = 0; j < 10; j++)
            {
                Console.WriteLine(rentedArray[j]);
            }

            shared.Return(rentedArray);

            Console.ReadKey();
        }

创建自定义的 ArrayPool

你也可以通过重写 ArrayPool 来实现自定义的池化对象，如下代码所示：


    public class CustomArrayPool<T> : ArrayPool<T>
    {
        public override T[] Rent(int minimumLength)
        {
            throw new NotImplementedException();
        }
        public override void Return(T[] array, bool clearArray = false)
        {
            throw new NotImplementedException();
        }
    }

使用 `MemoryPool<T>`

System.Memory 命名空间下提供了一个内存池对象 MemoryPool<T>，在这之前你需要每次都 new 一个内存块出来，同时也增加了 GC 的负担，有了 MemoryPool<T> 之后，你需要的内存块直接从池中拿就可以了。


        static void Main(string[] args)
        {

            var  memoryPool = MemoryPool<int>.Shared;

            var rentedArray = memoryPool.Rent(10);

            for (int i = 0; i < 10; i++)
            {
                rentedArray.Memory.Span[i] = i + 1;
            }

            for (int j = 0; j < 10; j++)
            {
                Console.WriteLine(rentedArray.Memory.Span[j]);
            }

            Console.ReadKey();
        }

如何在 C# 中使用 ArrayPool 和 MemoryPool-LMLPHP

`ArrayPool<T>` vs `MemoryPool<T>`

从上面的演示可以看出， ArrayPool<T> 是以 array 的形式向外租借，而 MemoryPool<T> 则是以 内存块 的方式向外租借，所以在重复使用 array 的场景下可以优选 ArrayPool<T> 来提高性能，如果你的代码是以 Memory<T> 这种内存块的形式多次使用则优先使用 MemoryPool<T>。

码农读书