test(ITcpSocketClient): improve code coverage (#6356)

* test: 重构代码提高覆盖率

* refactor: 更改接口方法名称

* refactor: 增加 SetDataPackageAdapter 扩展方法

* refactor: 精简代码

* feat: 增加 SetDataPackageAdapter 方法

* test: 更新单元测试

* test: 增加单元测试

* doc: 增加移除的路由

Author: ArgoZhang

src/BootstrapBlazor.Server/Components/Pages/Introduction.razor

@@ -1,5 +1,6 @@
 @page "/docs"
 @page "/introduction"
+@page "/components"
 
 <h3>@Localizer["Title"]</h3>
 

src/BootstrapBlazor.Server/Components/Samples/Sockets/Adapters.razor.cs

@@ -93,7 +93,7 @@ private async ValueTask OnReceivedAsync(ReadOnlyMemory<byte> data)
         if (_useDataAdapter)
         {
             // 使用数据适配器处理接收的数据
-            await _dataAdapter.ReceiveAsync(data, _receiveTokenSource.Token);
+            await _dataAdapter.HandlerAsync(data, _receiveTokenSource.Token);
         }
         else
         {

src/BootstrapBlazor/Extensions/ITcpSocketClientExtensions.cs

@@ -48,4 +48,68 @@ public static ValueTask<bool> ConnectAsync(this ITcpSocketClient client, string
         var endPoint = Utility.ConvertToIpEndPoint(ipString, port);
         return client.ConnectAsync(endPoint, token);
     }
+
+    /// <summary>
+    /// Configures the specified <see cref="ITcpSocketClient"/> to use the provided <see cref="IDataPackageAdapter"/> 
+    /// for processing received data and sets a callback to handle processed data.
+    /// </summary>
+    /// <remarks>This method sets up a two-way data processing pipeline: <list type="bullet"> <item>
+    /// <description>The <paramref name="client"/> is configured to pass received data to the <paramref name="adapter"/>
+    /// for processing.</description> </item> <item> <description>The <paramref name="adapter"/> is configured to invoke
+    /// the provided <paramref name="callback"/> with the processed data.</description> </item> </list> Use this method
+    /// to integrate a custom data processing adapter with a TCP socket client.</remarks>
+    /// <param name="client">The <see cref="ITcpSocketClient"/> instance to configure.</param>
+    /// <param name="adapter">The <see cref="IDataPackageAdapter"/> used to process incoming data.</param>
+    /// <param name="callback">A callback function invoked with the processed data. The function receives a <see cref="ReadOnlyMemory{T}"/> 
+    /// containing the processed data and returns a <see cref="ValueTask"/>.</param>
+    public static void SetDataPackageAdapter(this ITcpSocketClient client, IDataPackageAdapter adapter, Func<ReadOnlyMemory<byte>, ValueTask> callback)
+    {
+        // 设置 ITcpSocketClient 的回调函数
+        client.ReceivedCallBack = async buffer =>
+        {
+            // 将接收到的数据传递给 DataPackageAdapter 进行数据处理合规数据触发 ReceivedCallBack 回调
+            await adapter.HandlerAsync(buffer);
+        };
+
+        // 设置 DataPackageAdapter 的回调函数
+        adapter.ReceivedCallBack = buffer => callback(buffer);
+    }
+
+    /// <summary>
+    /// Configures the specified <see cref="ITcpSocketClient"/> to use a custom data package adapter and a callback
+    /// function for processing received data.
+    /// </summary>
+    /// <remarks>This method sets up the <paramref name="client"/> to use the provided <paramref
+    /// name="adapter"/> for handling incoming data. The adapter processes the raw data received by the client and
+    /// attempts to convert it into an instance of <typeparamref name="TEntity"/>. If the conversion is successful, the
+    /// <paramref name="callback"/> is invoked with the converted entity; otherwise, it is invoked with <see
+    /// langword="null"/>.</remarks>
+    /// <typeparam name="TEntity">The type of the entity that the data package adapter will attempt to convert the received data into.</typeparam>
+    /// <param name="client">The <see cref="ITcpSocketClient"/> instance to configure.</param>
+    /// <param name="adapter">The <see cref="IDataPackageAdapter"/> instance responsible for handling and processing incoming data.</param>
+    /// <param name="callback">A callback function to be invoked with the processed data of type <typeparamref name="TEntity"/>.  The callback
+    /// receives <see langword="null"/> if the data cannot be converted to <typeparamref name="TEntity"/>.</param>
+    public static void SetDataPackageAdapter<TEntity>(this ITcpSocketClient client, IDataPackageAdapter adapter, Func<TEntity?, Task> callback)
+    {
+        // 设置 ITcpSocketClient 的回调函数
+        client.ReceivedCallBack = async buffer =>
+        {
+            // 将接收到的数据传递给 DataPackageAdapter 进行数据处理合规数据触发 ReceivedCallBack 回调
+            await adapter.HandlerAsync(buffer);
+        };
+
+        // 设置 DataPackageAdapter 的回调函数
+        adapter.ReceivedCallBack = async buffer =>
+        {
+            TEntity? ret = default;
+            if (adapter.TryConvertTo(buffer, out var t))
+            {
+                if (t is TEntity entity)
+                {
+                    ret = entity;
+                }
+            }
+            await callback(ret);
+        };
+    }
 }

src/BootstrapBlazor/Services/TcpSocket/DataPackage/DataPackageAdapter.cs

@@ -30,7 +30,7 @@ public class DataPackageAdapter : IDataPackageAdapter
     /// <param name="data"></param>
     /// <param name="token"></param>
     /// <returns></returns>
-    public virtual async ValueTask ReceiveAsync(ReadOnlyMemory<byte> data, CancellationToken token = default)
+    public virtual async ValueTask HandlerAsync(ReadOnlyMemory<byte> data, CancellationToken token = default)
     {
         if (DataPackageHandler != null)
         {
@@ -40,10 +40,22 @@ public virtual async ValueTask ReceiveAsync(ReadOnlyMemory<byte> data, Cancellat
             }
 
             // 如果存在数据处理器则调用其处理方法
-            await DataPackageHandler.ReceiveAsync(data, token);
+            await DataPackageHandler.HandlerAsync(data, token);
         }
     }
 
+    /// <summary>
+    /// <inheritdoc/>
+    /// </summary>
+    /// <param name="data"></param>
+    /// <param name="entity"></param>
+    /// <returns></returns>
+    public virtual bool TryConvertTo(ReadOnlyMemory<byte> data, [NotNullWhen(true)] out object? entity)
+    {
+        entity = null;
+        return false;
+    }
+
     /// <summary>
     /// Handles incoming data by invoking a callback method, if one is defined.
     /// </summary>

src/BootstrapBlazor/Services/TcpSocket/DataPackage/DataPackageHandlerBase.cs

@@ -26,7 +26,7 @@ public abstract class DataPackageHandlerBase : IDataPackageHandler
     /// <param name="data"></param>
     /// <param name="token"></param>
     /// <returns></returns>
-    public abstract ValueTask ReceiveAsync(ReadOnlyMemory<byte> data, CancellationToken token = default);
+    public abstract ValueTask HandlerAsync(ReadOnlyMemory<byte> data, CancellationToken token = default);
 
     /// <summary>
     /// Handles the processing of a sticky package by adjusting the provided buffer and length.

src/BootstrapBlazor/Services/TcpSocket/DataPackage/DelimiterDataPackageHandler.cs

@@ -52,7 +52,7 @@ public DelimiterDataPackageHandler(byte[] delimiter)
     /// <param name="data"></param>
     /// <param name="token"></param>
     /// <returns></returns>
-    public override async ValueTask ReceiveAsync(ReadOnlyMemory<byte> data, CancellationToken token = default)
+    public override async ValueTask HandlerAsync(ReadOnlyMemory<byte> data, CancellationToken token = default)
     {
         data = ConcatBuffer(data);
 

src/BootstrapBlazor/Services/TcpSocket/DataPackage/FixLengthDataPackageHandler.cs

@@ -24,7 +24,7 @@ public class FixLengthDataPackageHandler(int length) : DataPackageHandlerBase
     /// <param name="data"></param>
     /// <param name="token"></param>
     /// <returns></returns>
-    public override async ValueTask ReceiveAsync(ReadOnlyMemory<byte> data, CancellationToken token = default)
+    public override async ValueTask HandlerAsync(ReadOnlyMemory<byte> data, CancellationToken token = default)
     {
         while (data.Length > 0)
         {

src/BootstrapBlazor/Services/TcpSocket/DataPackage/IDataPackageAdapter.cs

@@ -38,5 +38,16 @@ public interface IDataPackageAdapter
     /// not provided.</param>
     /// <returns>A <see cref="ValueTask"/> representing the asynchronous operation. The task completes when the data has been
     /// successfully received and processed.</returns>
-    ValueTask ReceiveAsync(ReadOnlyMemory<byte> data, CancellationToken token = default);
+    ValueTask HandlerAsync(ReadOnlyMemory<byte> data, CancellationToken token = default);
+
+    /// <summary>
+    /// Attempts to convert the specified binary data into an object representation.
+    /// </summary>
+    /// <remarks>This method does not throw an exception if the conversion fails. Instead, it returns  <see
+    /// langword="false"/> and sets <paramref name="entity"/> to <see langword="null"/>.</remarks>
+    /// <param name="data">The binary data to be converted. Must not be empty.</param>
+    /// <param name="entity">When this method returns <see langword="true"/>, contains the converted object.  When this method returns <see
+    /// langword="false"/>, contains <see langword="null"/>.</param>
+    /// <returns><see langword="true"/> if the conversion was successful; otherwise, <see langword="false"/>.</returns>
+    bool TryConvertTo(ReadOnlyMemory<byte> data, [NotNullWhen(true)] out object? entity);
 }

src/BootstrapBlazor/Services/TcpSocket/DataPackage/IDataPackageHandler.cs

@@ -29,5 +29,5 @@ public interface IDataPackageHandler
     /// provided.</param>
     /// <returns>A <see cref="ValueTask{TResult}"/> containing <see langword="true"/> if the data was successfully received and
     /// processed; otherwise, <see langword="false"/>.</returns>
-    ValueTask ReceiveAsync(ReadOnlyMemory<byte> data, CancellationToken token = default);
+    ValueTask HandlerAsync(ReadOnlyMemory<byte> data, CancellationToken token = default);
 }

src/BootstrapBlazor/Services/TcpSocket/TcpSocketClientBase.cs

@@ -148,9 +148,14 @@ public virtual async ValueTask<bool> SendAsync(ReadOnlyMemory<byte> data, Cancel
         }
         catch (OperationCanceledException ex)
         {
-            Log(LogLevel.Warning, ex, token.IsCancellationRequested
-                ? $"TCP Socket send operation was canceled from {_localEndPoint} to {_remoteEndPoint}"
-                : $"TCP Socket send operation timed out from {_localEndPoint} to {_remoteEndPoint}");
+            if (token.IsCancellationRequested)
+            {
+                Log(LogLevel.Warning, ex, $"TCP Socket send operation was canceled from {_localEndPoint} to {_remoteEndPoint}");
+            }
+            else
+            {
+                Log(LogLevel.Warning, ex, $"TCP Socket send operation timed out from {_localEndPoint} to {_remoteEndPoint}");
+            }
         }
         catch (Exception ex)
         {