内存池
定义
一、说明
内存池是TouchSocket系列的最重要的组成部分,在TouchSocket产品中,ArrayPool贯穿始终。所以熟练使用ArrayPool,也是非常重要的。
二、功能
内存池(ArrayPool<T>)是微软的ArrayPool<T>。但是在用法上做了一些的优化。
内存池的最小实现单体是内存块(ByteBlock)和值内存块(ValueByteBlock)。它们均实现了IBufferWriter<byte>接口,可以更好的使用GetMemory、GetSpan与Advance等功能。
三、创建与回收
3.1 内存池
ArrayPool<T>在默认情况提供了一个ArrayPool<T>.Shared的默认静态实例。这是整个进程可以共享使用的。
当然您可以创建只属于自己的ArrayPool<T>。
其中:
- maxArrayLength,是内存池的最大字节数组尺寸。
- maxArraysPerBucket是每个内存块桶的最大数组数量。
3.2 创建、释放内存块
内存块就是可以使用的字节数组。框架提供了ByteBlock和ValueByteBlock两种内存块。ValueByteBlock是值类型的,其余特点完全一致。
【创建ByteBlock】
【创建ValueByteBlock】
以上的创建方式,都是从默认内存池创建。如果想要自定义内存池,可以在new的时候指定内存池。
释放过程也完全可以使用using。
byteSize用于申请的最小字节尺寸。例如:当申请100长度时,可能会得到100,1000,甚至更大尺寸的内存,但绝不会小于100
创建的ByteBlock(ValueByteBlock)必须显示释放(Dispose),可用using,如果不释放,虽然不会内存泄露,但是会影响性能。
四、内存块使用
内存块就是可以使用的字节数组。只不过他具备借用与归还的功能。
我们可以使用TotalMemory,获取到整个内存块原始数据。
Memory<byte> memory = byteBlock.TotalMemory;
但一般情况下,我们不会直接使用内存块的TotalMemory,而是使用Span、Memory、甚至是ToArray()等有效数据。
有效数据 是指在内存块中已经被有效写入,或者可以被有效读取的数据。因为当一个内存块被申请的时候,无论它的容量多大,它的有效数据长度总是为0(Length)。我们必须通过Write、Advance、SetLength等方法,来完成数据的有效化。
ByteBlock的工作模式,就像是你向商店(ArrayPool)租借了一个杯子(ByteBlock),TotalMemory就是这个杯子本身。
于我们而言,只在乎杯中实际有多少水(Span、Memory),所以byteBlock.Length就是水位线。所以无论何时,我们都不可以喝超过水位线的水。因为超过水位线的水,可能是上个租客留下的口水。
同时,喝水的时候,还可以接力喝。比如先让张三(方法A)喝1口,那么我们可以把已喝的水做个标记(Position赋值为1),然后把杯子(ByteBlock)传递给李四(方法B),那么这时候,李四就只能按张三喝过的水继续喝,当然如果李四不嫌弃的话,也是可以从头再喝的。
最后就是杯子的归还(Dispose),以及杯中水的处理。在杯子未归还至前,杯子的所有属性(例如:Length、Position、Span、Memory)都代表的是当前的状态。而当杯子被归还时,这些属性将变得没有意义,尤其是Memory。因为Memory可以被其他对象引用,但是杯子归还后,Memory指向的内存块可能已经是新的申请人,这杯中的水,终究是变成了“前人的口水”。
但是如果我们确实需要保存杯中水的话,可以使用ToArray()方法。其返回值是一个数组,它可以以新引用的方式保存,且与内存池没有任何关系了,所有的生命周期归GC管理。
4.1 读写数组
使用比较简单,支持Byte[],Span、Memory等数据的直接写入。
4.2 基础类型的写入和读取
4.3 按照BufferWriter方式写入
五、多线程同步协作(Hold)
在多线程异步时,设计架构应当遵守谁(Thread)创建的ByteBlock,由谁释放,这样就能很好的避免未释放的情况发生。实际上TouchSocket中,就是秉承这样的设计,任何非用户创建的ByteBlock,都会由创建的线程最后释放。但是在使用中,经常出现异步多线程的操作。
以TouchSocket的TcpClient为例。如果直接在收到数据时,使用Task异步,则必定会发生关于ByteBlock的各种各样的异常。
原因非常简单,byteBlock对象在到达HandleReceivedData时,触发Task异步,此时触发线程会立即返回,并释放byteBlock,而Task异步线程会滞后,然后试图从已释放的byteBlock中获取数据,所以,必定发生异常。
解决方法也非常简单,只需要在异步前锁定,然后使用完成后取消锁定,且不用再调用Dispose。
ByteBlock在设置SetHolding(false)后,不需要再调用Dispose。