2.1升级指南

### 上个版本？

v2.0

### 受影响组件

- [x] All
- [ ] Core
- [ ] Tcp
- [ ] Udp
- [ ] NamedPipe
- [ ] WebSocket
- [ ] Http
- [ ] Redis
- [ ] Dmtp-Tcp
- [ ] Dmtp-Udp
- [ ] Dmtp-WebSocket
- [ ] Dmtp-Http
- [ ] Dmtp-NamedPipe
- [ ] 其他

### 本次改动较大，可能会导致现有代码不兼容，所以在升级前请做好代码备份。

### 改动内容

#### TouchSocket.Core

【1】适配器大多数投递的数据，由byte[]改为ReadOnlySpan<byte>。这部分重新实现接口，或者重写函数即可完成。例如：
![输入图片说明](https://foruda.gitee.com/images/1716215148920389733/6c9564f1_8553710.png "屏幕截图")

【2】适配器所有同步方法改为异步。例如：
- PreviewSend=>PreviewSendAsync
- SendCallBack=>SendAsyncCallBack
- GoSend=>GoSendAsync
- GoReceived=>GoReceivedAsync

【3】用户自定义适配器的`Filter`函数需要重写实现。这部分重写函数即可完成。例如：
![输入图片说明](https://foruda.gitee.com/images/1716297684004242345/a275cb82_8553710.png "屏幕截图")

【2】ByteBlock相关属性名称还原全称。例如：
- ByteBlock.Len=>ByteBlock.Length
- ByteBlock.Pos=>ByteBlock.Position

【3】ByteBlock数据转string。如果你是net6.0以上的，你可以使用ByteBlock.Span来做转换。例如：

```
string str=  Encoding.UTF8.GetString(byteBlock.Span);
```

如何是netf平台，或者unity，则可以使用我们内置的扩展方法（net6.0以上也可以用）：

```
var str= byteBlock.Span.ToString(Encoding.UTF8);
```

【4】IPackage相关的方法重写，这部分需要重新实现接口，或者重写函数实现，内部逻辑不变。例如：

```
internal class MyPackage : PackageBase
{
    public int Property { get; set; }

/*新写法*/
    public override void Package<TByteBlock>(ref TByteBlock byteBlock)
    {
        byteBlock.Write(Property);
    }

public override void Unpackage<TByteBlock>(ref TByteBlock byteBlock)
    {
        this.Property = byteBlock.ReadInt32();
    }

/*旧写法*/
    //public override void Package(in ByteBlock byteBlock)
    //{
    //    byteBlock.Write(this.Property);
    //}
    //public override void Unpackage(in ByteBlock byteBlock)
    //{
    //    this.Property = byteBlock.ReadInt32();
    //}
 
}
```

【5】PluginManager（插件管理器）取消泛型插件接口。修改时只实现非泛型即可。例如：

![输入图片说明](https://foruda.gitee.com/images/1716470889970214153/50d049dd_8553710.png "屏幕截图")

修改为

![输入图片说明](https://foruda.gitee.com/images/1716470915006312827/cedba22d_8553710.png "屏幕截图")

【6】订阅或者触发时，使用插件直接触发。例如：
![输入图片说明](https://foruda.gitee.com/images/1716474377405098399/e9189aa8_8553710.png "屏幕截图")

修改为

![输入图片说明](https://foruda.gitee.com/images/1716474399640098466/d44309ca_8553710.png "屏幕截图")

#### TouchSocket.Sockets

【1】ITcpClientBase、IHttpClientBase、ITcpDmtpClientBase等接口改名，具体请看vs提示。例如：
![输入图片说明](https://foruda.gitee.com/images/1716212377012762488/3b661239_8553710.png "屏幕截图")

【2】ISocketClient、IHttpSocketClient、ITcpDmtpSocketClient等接口改名，具体请看vs提示，例如：
![输入图片说明](https://foruda.gitee.com/images/1716212541617438726/d066c436_8553710.png "屏幕截图")

【3】所有方法仅实现异步方法，部分提供扩展同步方法，使用方面没有限制和缺点，但是建议全部向异步靠近。
【4】Send发送数据时，全部只支持ReadonlyMemory<byte>，此更改不会影响byte[]的发送。但是当需要指定offset和length时，需要先转为ReadonlyMemory。例如：
![输入图片说明](https://foruda.gitee.com/images/1716214745631171898/4fc6cddc_8553710.png "屏幕截图")

如果发送的数据是ByteBlock，则直接可以使用ByteBlock.Memory。

【5】DisconnectEventArgs类修改，细分为ClosingEventArgs或者ClosedEventArgs，主要是看具体的事件，vs也会给出相应提示。例如：
![输入图片说明](https://foruda.gitee.com/images/1716216493480944187/95f66187_8553710.png "屏幕截图")

【6】Disconnecting，Disconnected分别改名为Closing和Closed。此处可借助vs提示完成修改。

【7】TcpService系，获取所有已连接客户端集合方式。由`service.GetClients()`改为`service.Clients`。例如：

#### TouchSocket.Dmtp

【1】IDmtpChannel组件，仅保留异步公共Api方法。例如：
![输入图片说明](https://foruda.gitee.com/images/1716474695901684984/bb41dbfc_8553710.png "屏幕截图")

#### TouchSocket.Http

【1】只保留所有异步方法，移除同步方法。例如：
- HttpRequest.Read=>HttpRequest.ReadAsync
- HttpResponse.Answer=>HttpResponse.AnswerAsync

#### TouchSocketPro.Dmtp

【1】Redis所有操作Api仅提供Async异步方法。

```
//获取Redis
var redis = client.GetDmtpRedisActor();

//执行Set
var result = await redis.SetAsync("1", "1");
client.Logger.Info($"Set result={result}");
client.Logger.Info($"ContainsCache result={await redis.ContainsCacheAsync("1")}");

//执行Get
var result1 = await redis.GetAsync<string>("1");
client.Logger.Info($"Get result={result}");

//执行Remove
result = await redis.RemoveCacheAsync("1");
client.Logger.Info($"Get result={result}");
await redis.ClearCacheAsync();
```

### 这个问题是否已经存在？

- [x] 我已经搜索过现有的问题 (https://gitee.com/RRQM_Home/TouchSocket/issues)

### 友好承诺

- [x] 我承诺将本着相互尊重、理解和友善的态度进行交流，共同维护好 TouchSocket 来之不易的良好的社区氛围。

GVP 若汝棋茗/TouchSocket

内容风险标识

评论 (0)

GVP若汝棋茗/TouchSocket

内容风险标识

2.1升级指南

评论 (0)

搜索帮助

GVP 若汝棋茗/TouchSocket