---
id: bytepool
title: 内存池
---

## 一、说明

内存池是TouchSocketCore的最重要的组成部分，在TouchSocket产品中，BytePool贯穿始终。所以熟悉使用BytePool，也是非常重要的。

## 二、功能

内存池（BytePool）是解决创建大量字节数组消耗的最有力手段，其实质相当于微软的ArrayPool。但是比ArrayPool更加易用，且功能更加强大。

内存池的最小实现单体是`内存块（ByteBlock）`和`值内存块（ValueByteBlock）`。`ByteBlock`是继承自Stream的类，拥有和MemoryStream一样的功能和内存回收管理的增强功能。所以如果有MemoryStream的使用需求的话，就可以完全让ByteBlock替代。而`ValueByteBlock`是`ByteBlock`的值类型（ref struct），其功能除了不继承Stream以外，和`ByteBlock`一模一样。且为值类型，创建开销更小。

## 三、创建、回收

`BytePool`在默认情况提供了一个`Default`的默认实例，当然您可以新建只属于自己的`BytePool`。

```csharp
BytePool bytePool = new BytePool();
BytePool defaultBytePool = BytePool.Default;
```

`ByteBlock`可通过BytePool实例创建，也可以直接new对象，后者使用的是默认内存池实例提供支持。

- byteSize：用于申请的最小字节尺寸。例如：当申请100长度时，可能会得到100，1000，甚至更大尺寸的内存，但绝不会小于100.
- equalSize：强制请求的尺寸和得到的尺寸是一致的。一般不建议设置该值。

```csharp
ByteBlock byteBlock1 = new ByteBlock(byteSize: 1024 * 1024, equalSize: false);//从默认内存池获得
byteBlock1.Dispose();

BytePool bytePool = new BytePool();
ByteBlock byteBlock2 = bytePool.GetByteBlock(byteSize: 1024 * 1024, equalSize: false);//从指定内存池获得
byteBlock2.Dispose(bytePool);//释放到指定内存池

using (ByteBlock byteBlock3 = new ByteBlock())//通过using创建及释放时，均在默认内存池
{
}
```

:::caution 注意

创建的**ByteBlock（ValueByteBlock）**必须显示释放（Dispose），可用using，如果不释放，虽然不会内存泄露，但是会影响性能。

:::  

:::danger 危险

无论何时何地，都不要直接引用ByteBlock.Buffer，可以直接使用。如果需要引用实际数据，请使用Read、ToArray等方法可复制导出新的数据内存。

:::  

## 四、使用

基础使用和MemoryStream一致，下面仅介绍特定使用。

### 4.1 写入、读取数据对象

```csharp
using (ByteBlock byteBlock = new ByteBlock())
{
    byteBlock.Write(byte.MaxValue);//写入byte类型
    byteBlock.Write(int.MaxValue);//写入int类型
    byteBlock.Write(long.MaxValue);//写入long类型
    byteBlock.Write("RRQM");//写入字符串类型
    byteBlock.WriteObject(new Person(), SerializationType.Json);//写入实体类型，且使用json
    byteBlock.WriteBytesPackage(new byte[1024]);//写入一个独立byte数组类型

    byteBlock.Pos = 0;//读取时，先将游标移动到初始写入的位置，然后按写入顺序，依次读取

    byte ByteValue = byteBlock.ReadByte();
    int IntValue = byteBlock.ReadInt32();
    long LongValue = byteBlock.ReadInt64();
    string StringValue = byteBlock.ReadString();
    Person ObjectValue = byteBlock.ReadObject<Person>(SerializationType.Json);
    byte[] BytesValue = byteBlock.ReadBytesPackage();
}
```

:::tip 提示

**ByteBlock（ValueByteBlock）**的实际数据有效长度应该是`ByteBlock.Length`属性，而不是`ByteBlock.Buffer.Length`。

:::  

:::tip 提示

由于**ByteBlock（ValueByteBlock）**的部分属性是long类型，但是在使用时有时候需要int类型，所以也提供了int的封装转换，例如：`ByteBlock.Length`和`ByteBlock.Len`。

:::  

### 4.2 多线程同步协作（Hold）

在多线程异步时，设计架构应当遵守谁（Thread）创建的ByteBlock，由谁释放，这样就能很好的避免未释放的情况发生。实际上TouchSocket中，就是秉承这样的设计，任何非用户创建的ByteBlock，都会由创建的线程最后释放。但是在使用中，经常出现异步多线程的操作。

以TouchSocket的TcpClient为例。如果直接在收到数据时，使用Task异步，则必定会发生关于ByteBlock的各种各样的异常。

**原因非常简单，byteBlock对象在到达HandleReceivedData时，触发Task异步，此时触发线程会立即返回，并释放byteBlock，而Task异步线程会滞后，然后试图从已释放的byteBlock中获取数据，所以，必定发生异常。**

```csharp
public class MyTClient : TcpClient
{
    protected override void HandleReceivedData(ByteBlock byteBlock, IRequestInfo requestInfo)
    {
        Task.Run(()=> 
        {
            string mes = Encoding.UTF8.GetString(byteBlock.Buffer, 0, byteBlock.Len);
            Console.WriteLine($"已接收到信息：{mes}");
        });
    }
}
```

解决方法也非常简单，只需要在异步前锁定，然后使用完成后取消锁定，且不用再调用Dispose。

```csharp
public class MyTClient : TcpClient
{
    protected override void HandleReceivedData(ByteBlock byteBlock, IRequestInfo requestInfo)
    {
        byteBlock.SetHolding(true);//异步前锁定
        Task.Run(()=> 
        {
            string mes = Encoding.UTF8.GetString(byteBlock.Buffer, 0, byteBlock.Len);
            byteBlock.SetHolding(false);//使用完成后取消锁定，且不用再调用Dispose
            Console.WriteLine($"已接收到信息：{mes}");
        });
    }
}
```

:::caution 注意

ByteBlock在设置SetHolding(false)后，不需要再调用Dispose。

:::  
