Revert "去掉 Json 库，重新构建进行测试"

This reverts commit 178366b.

Author: lindexi

src/dotnetCampus.Ipc/Context/IpcConfiguration.cs

@@ -113,10 +113,18 @@ internal IEnumerable<IIpcRequestHandler> GetIpcRequestHandlers()
         /// </summary>
         public IIpcObjectSerializer IpcObjectSerializer
         {
-            get => _ipcObjectSerializer ?? throw new Exception("xxxx");
+            get => _ipcObjectSerializer ??= DefaultNewtonsoftJsonSerializer;
             set => _ipcObjectSerializer = value;
         }
 
         private IIpcObjectSerializer? _ipcObjectSerializer;
+
+        /// <summary>
+        /// 默认的 Newtonsoft Json 序列化器
+        /// </summary>
+        public static IpcObjectJsonSerializer DefaultNewtonsoftJsonSerializer
+        // 不加上锁了，这里不管线程安全，最多就是多创建几个对象而已，不会影响业务逻辑
+            => _defaultNewtonsoftJsonSerializer ??= new IpcObjectJsonSerializer();
+        private static IpcObjectJsonSerializer? _defaultNewtonsoftJsonSerializer;
     }
 }

src/dotnetCampus.Ipc/Context/IpcConfigurationExtensions.cs

@@ -1,4 +1,5 @@
 using dotnetCampus.Ipc.Serialization;
+using Newtonsoft.Json;
 
 namespace dotnetCampus.Ipc.Context;
 
@@ -7,6 +8,26 @@ namespace dotnetCampus.Ipc.Context;
 /// </summary>
 public static class IpcConfigurationExtensions
 {
+    /// <summary>
+    /// 使用 Newtonsoft.Json 作为 IPC 对象序列化器
+    /// </summary>
+    /// <param name="configuration"></param>
+    /// <param name="jsonSerializer"></param>
+    /// <returns></returns>
+    public static IpcConfiguration UseNewtonsoftJsonIpcObjectSerializer(this IpcConfiguration configuration, JsonSerializer? jsonSerializer)
+    {
+        if (jsonSerializer is null)
+        {
+            configuration.IpcObjectSerializer = IpcConfiguration.DefaultNewtonsoftJsonSerializer;
+        }
+        else
+        {
+            configuration.IpcObjectSerializer = new IpcObjectJsonSerializer(jsonSerializer);
+        }
+
+        return configuration;
+    }
+
 #if NET6_0_OR_GREATER
     /// <summary>
     /// 使用 System.Text.Json 作为 IPC 对象序列化器

src/dotnetCampus.Ipc/IpcRouteds/DirectRouteds/Json_/JsonIpcDirectRoutedHandleRequestExceptionInfo.cs

@@ -1,10 +1,13 @@
-namespace dotnetCampus.Ipc.IpcRouteds.DirectRouteds;
+using Newtonsoft.Json;
+
+namespace dotnetCampus.Ipc.IpcRouteds.DirectRouteds;
 
 /// <summary>
 /// 直接路由的 IPC 通讯的异常信息，即 IPC 服务端的业务层通讯异常。如参数不匹配、执行的业务端逻辑抛出异常等
 /// </summary>
 internal class JsonIpcDirectRoutedHandleRequestExceptionResponse
 {
+    [JsonProperty("__$Exception")]
 #if NET6_0_OR_GREATER
     [System.Text.Json.Serialization.JsonPropertyName("__$Exception")]
 #endif

src/dotnetCampus.Ipc/Pipes/PeerProxy.cs

@@ -8,6 +8,7 @@
 using dotnetCampus.Ipc.Internals;
 using dotnetCampus.Ipc.Messages;
 using dotnetCampus.Ipc.Utils.Extensions;
+using Newtonsoft.Json.Schema;
 
 namespace dotnetCampus.Ipc.Pipes
 {

src/dotnetCampus.Ipc/Serialization/IpcObjectJsonSerializer.cs

@@ -0,0 +1,55 @@
+using System.IO;
+using System.Text;
+using Newtonsoft.Json;
+
+namespace dotnetCampus.Ipc.Serialization
+{
+    public class IpcObjectJsonSerializer : IIpcObjectSerializer
+    {
+        public IpcObjectJsonSerializer()
+        {
+            JsonSerializer = JsonSerializer.CreateDefault();
+        }
+
+        public IpcObjectJsonSerializer(JsonSerializer jsonSerializer)
+        {
+            JsonSerializer = jsonSerializer;
+        }
+
+        private JsonSerializer JsonSerializer { get; }
+
+        public byte[] Serialize(object value)
+        {
+            var json = JsonConvert.SerializeObject(value);
+            return Encoding.UTF8.GetBytes(json);
+        }
+
+        public void Serialize(Stream stream, object? value)
+        {
+            using var textWriter = new StreamWriter(stream, Encoding.UTF8, leaveOpen: true, bufferSize: 2048);
+            JsonSerializer.Serialize(textWriter, value);
+        }
+
+        public T? Deserialize<T>(byte[] byteList)
+        {
+            var json = Encoding.UTF8.GetString(byteList);
+            return JsonConvert.DeserializeObject<T>(json);
+        }
+
+        public T? Deserialize<T>(Stream stream)
+        {
+            using StreamReader reader = new StreamReader
+            (
+                stream,
+#if !NETCOREAPP
+                Encoding.UTF8,
+                detectEncodingFromByteOrderMarks: false,
+                bufferSize: 2048,
+#endif
+                leaveOpen: true
+            );
+            JsonReader jsonReader = new JsonTextReader(reader);
+            return JsonSerializer.Deserialize<T>(jsonReader);
+        }
+    }
+}

src/dotnetCampus.Ipc/Serialization/JsonIpcMessageSerializer.cs

@@ -0,0 +1,83 @@
+using System;
+using System.Diagnostics.CodeAnalysis;
+using System.Text;
+
+using dotnetCampus.Ipc.Messages;
+
+using Newtonsoft.Json;
+
+namespace dotnetCampus.Ipc.Serialization
+{
+    /// <summary>
+    /// 如果某 IPC 消息计划以 JSON 格式传输，那么可使用此类型来序列化和反序列化。
+    /// </summary>
+    public static class JsonIpcMessageSerializer
+    {
+        /// <summary>
+        /// 将 IPC 模块自动生成的内部模型序列化成可供跨进程传输的 IPC 消息。
+        /// </summary>
+        /// <param name="tag"></param>
+        /// <param name="model"></param>
+        /// <returns></returns>
+        public static IpcMessage Serialize(string tag, object model)
+        {
+            if (model is null)
+            {
+                throw new ArgumentNullException(nameof(model));
+            }
+
+            var json = JsonConvert.SerializeObject(model);
+            var data = Encoding.UTF8.GetBytes(json);
+            var message = new IpcMessage(tag, new IpcMessageBody(data));
+            return message;
+        }
+
+        /// <summary>
+        /// 尝试将跨进程传输过来的 IPC 消息反序列化成 IPC 模块自动生成的内部模型。
+        /// </summary>
+        /// <param name="message">IPC 消息。</param>
+        /// <param name="model"></param>
+        /// <returns></returns>
+        public static bool TryDeserialize<T>(IpcMessage message, [NotNullWhen(true)] out T? model) where T : class, new()
+        {
+            var body = message.Body;
+            var stringBody = Encoding.UTF8.GetString(body.Buffer, body.Start, body.Length);
+            if (string.IsNullOrWhiteSpace(stringBody))
+            {
+                model = new T();
+                return true;
+            }
+            try
+            {
+                model = JsonConvert.DeserializeObject<T>(stringBody);
+                return true;
+            }
+            catch (JsonSerializationException)
+            {
+                model = null;
+                return false;
+            }
+            catch (JsonReaderException)
+            {
+                // Newtonsoft.Json.JsonReaderException
+                //     Unexpected character encountered while parsing value: {0}.
+                // JSON 字符串中包含不符合格式的字符。典型情况如下：
+                //  * IPC 消息头被意外合入了消息体
+                //  * 待发现……
+                model = null;
+                return false;
+            }
+            catch
+            {
+                // 此反序列化过程抛出异常是合理行为（毕竟 IPC 谁都能发，但应该主要是 JsonSerializationException）。
+                // 目前来看，还不知道有没有一些合理的正常的情况下会抛出其他异常，因此暂时在 !DEBUG 下不处理消息。
+#if DEBUG
+                throw;
+#else
+                model = null;
+                return false;
+#endif
+            }
+        }
+    }
+}

src/dotnetCampus.Ipc/dotnetCampus.Ipc.csproj

@@ -43,6 +43,7 @@
   <ItemGroup>
     <PackageReference Include="dotnetCampus.LatestCSharpFeatures" PrivateAssets="all" />
     <PackageReference Include="dotnetCampus.AsyncWorkerCollection.Source" PrivateAssets="all" />
+    <PackageReference Include="Newtonsoft.Json" />
     <PackageReference Include="System.ValueTuple" />
   </ItemGroup>