如何调试 SignalR 以找到阻止类实例从服务器传输到 C# 客户端（此处为 WPF）的原因

Question

我使用 Signal 在 ASP.NET 服务器和 WPF 客户端之间进行通信。

根据我对文档的阅读，我们应该使用 SignalR 来使用简单的 POCO 类。但文档示例也使用枚举。我的类确实引用了另一个 POCO 类。在文档示例中我没有找到任何其他类参考。而且我的课程也不完全是 POCO。

实际上，我尝试传输的类几乎是 POCO（但不是 100%），并且它没有正确传输到 SignalR 中。在客户端下面的代码中，如果服务器向客户端发送“LogItem”，则永远不会调用 lambda：

HubConnection.On<LogItem>("NewLogItem", (logItem)=> OnNewLogItemFromServer(logItem));

。服务器和客户端共享包含“LogItem”类的完全相同的库。

但我找不到阻止 SignalR 接受我的类实例传输的原因。我尝试了很多方法但没有成功，以便在我的类“LogItem”（正在传输的类实例）中找到有问题的属性，这会阻止使用 SignalR 进行传输。

我尝试这样做：在 ASP.NET Core SignalR 中进行日志记录和诊断，但它并没有帮助我找到 LogItem 类的违规（一个或多个字段），从而阻止其传输。

有谁可以告诉我一种调试 SignalR 的方法，以便找到阻止 SignalR 传输该类实例的类的一个或多个有问题的属性？

我的代码：我将我的代码放在参考中但是我正在寻找一种调试 SignalR 的方法。不仅仅是找到确切的实际原因，因为我将不得不使用 SignalR 来做其他事情。

注意：如果 SignalR 框架应该为我解码 JSON，那么我不想自己解码 JSON。我想像它设计的那样使用它。

当服务器向我发送“LogItem”但其中是“JsonElement”时，以下代码将被调用到我的客户端：

HubConnection.On<Object>("NewLogItem", (obj) =>
            { ...

这是我的 LogItem 类代码作为参考（但我正在寻找一种通用方法来查找阻止类在 SignalR 中成为 tfr 的问题）：

using CommunityToolkit.Mvvm.ComponentModel;
using General.Diagnostics;
using Microsoft.Extensions.Logging;
using System;
using System.ComponentModel;
using System.Globalization;
using System.IO;
using System.Runtime.Serialization;
using System.Text.Json.Serialization;
using System.Xml.Serialization;

namespace General.LogEx
{
    [DataContract(Namespace = "")]
    public class LogItem : ObservableObject
    {
        private const string DateFormat = "yyyy-MM-dd HH:mm:ss.fff";

        // ******************************************************************
        [DataMember]
        public UInt64 Id { get; set; }

        //private bool _isAcknowledged = false;
        //public bool IsAcknowledged
        //{
        //    get => _isAcknowledged;
        //    set => SetProperty(ref _isAcknowledged, value);
        //}

        // ******************************************************************
        public DateTime DateTime { get; set; }

        // ******************************************************************
        [XmlIgnore]
        [JsonIgnore]
        public string TimeStamp
        {
            get
            {
                return DateTime.ToString(DateFormat);
            }
            set
            {
                DateTime = DateTime.ParseExact(value, DateFormat, CultureInfo.InvariantCulture);
            }
        }

        // ******************************************************************
        [DataMember]
        public LogCategory LogCategory { get; set; }

        // ******************************************************************
        [DataMember]
        public LogLevel LogLevel { get; set; }

        // ******************************************************************
        private string _message = null;

        [DataMember]
        public string Message
        {
            get
            {
                return _message;
            }
            set
            {
                _message = value;
            }
        }

        // ******************************************************************
        private Exception _exception = null;

        [DataMember]
        public Exception Exception
        {
            get
            {
                return _exception;
            }
            set
            {
                _exception = value;
            }
        }

        // ******************************************************************
        [XmlIgnore]
        [JsonIgnore]
        public string ExceptionMessage
        {
            get
            {
                return _exception?.Message;
            }
        }

        [DataMember]
        public string MoreInfo { get; set; }
        // ******************************************************************

        [DataMember]
        public int Occurence { get; set; } = 1;

        /// <summary>
        /// Public only for serialization (XML or JSON)
        /// </summary>
        public LogItem()
        {
        }

        // ******************************************************************
        public LogItem(UInt64 id, LogCategory logCategory, LogLevel logLevel, string message)
        {
            Id = Id;
            DateTime = DateTime.Now;
            LogCategory = logCategory;
            LogLevel = logLevel;
            Message = FixMessage(message);
        }

        // ******************************************************************
        /// <summary>
        /// </summary>
        /// <param name="message"></param>
        /// <returns></returns>
        private string FixMessage(string message)
        {
            //if (message != null && message.Length > 0)
            //{
            //    if (message[0] == ' ' || message[message.Length - 1] == ' ')
            //    {
            //        message = message.Trim();
            //    }

            //    if (message.EndsWith("."))
            //    {
            //        return message.Substring(0, message.Length - 1);
            //    }
            //}

            return message;
        }

        // ******************************************************************
        public LogItem(UInt64 id, LogCategory logCategory, LogLevel logType, string message, Exception exception)
        {
            Id = id;
            DateTime = DateTime.Now;
            LogCategory = logCategory;
            LogLevel = logType;
            Message = FixMessage(message);
            if (exception != null)
            {
                Exception = exception;

                MoreInfo = "Exception:\nMessage:\n" + exception.Message +
                    "\nSource:\n" + exception.Source +
                    "\nStack:\n" + exception.StackTrace +
                    "\nToString():\n" + exception.ToString();
            }
            else
            {
                if (LogLevel == LogLevel.Error || LogLevel == LogLevel.Critical)
                {
                    MoreInfo = StackUtil.GetStackTraceWithoutIntialTypes(new Type[] { typeof(Log), typeof(LogItem) }).ToString();

                    if (MoreInfo.EndsWith("\r\n"))
                    {
                        MoreInfo = MoreInfo.Remove(MoreInfo.Length - 2);
                    }
                }
            }
        }

        // ******************************************************************
        [XmlIgnore]
        [JsonIgnore]
        public string MessageAndException
        {
            get { return Message + ExceptionMessage; }
        }

        // ******************************************************************
        [XmlIgnore]
        [JsonIgnore]
        public string DateTimeFormated
        {
            get { return DateTime.ToString("yyyy-MM-dd hh:mm:ss.ffffff"); }
        }

        // ******************************************************************
        public void WriteTo(StreamWriter streamWriter)
        {
            streamWriter.Write(ToString());
        }

        // ******************************************************************
        [XmlIgnore]
        [JsonIgnore]
        public string QuickDescription
        {
            get
            {
                return string.Format($"{Id}, {DateTimeFormated}, {LogLevel}, {LogCategory} , {Message.Replace("\r\n", "[CRLF]")}");
            }
        }

        // ******************************************************************
        public override string ToString()
        {
            if (string.IsNullOrEmpty(MoreInfo))
            {
                if (Occurence == 1)
                {
                    // return String.Format($"{DateTimeFormated,-26}, {LogLevel,-12}, {Message}.");
                    return string.Format("{0,5}, {1,-26}, {2,-12}, {3}.", Id, DateTimeFormated, LogLevel, Message);
                }

                // return String.Format($"{DateTimeFormated,-26}, {LogLevel,-12}, {Message}. Occurence: {Occurence}.");
                return string.Format("{0,5}, {1,-26}, {2,-12}, {3}. Occurence: {4}.", Id, DateTimeFormated, LogLevel, Message, Occurence);
            }
            else
            {
                if (Occurence == 1)
                {
                    // return String.Format($"{DateTimeFormated,-26}, {LogLevel,-12}, {Message}. MoreInfo: {MoreInfo}.");
                    return string.Format("{0,5}, {1,-26}, {2,-12}, {3}. MoreInfo: {4}.", Id, DateTimeFormated, LogLevel, Message, MoreInfo);
                }

                // return String.Format($"{DateTimeFormated,-26}, {LogLevel,-12}, {Message}. Occurence: {Occurence}, MoreInfo: {MoreInfo}.");
                return string.Format("{0,5}, {1,-26}, {2,-12}, {3}. Occurence: {4}. MoreInfo: {5}.", Id, DateTimeFormated, LogLevel, Message, Occurence, MoreInfo);
            }
        }

        // ******************************************************************
    }
}

Answer 1

我终于找到了解决我的具体问题的方法，主要是找到了识别问题根源的方法。

所以我无法接收 SignalR 特定对象类型。所以我替换了以下函数

HubConnection.On<LogItem>("NewLogItem", (logItem)=> OnNewLogItemFromServer(logItem));

与：

HubConnection.On<Object>("NewLogItem", (obj) => {...

但 obj 实际上是一个“JsonElement”，需要反序列化为我的特定类型，因此我对其进行编程，并导致出现异常，显示初始行在 HubConnection 上不起作用的确切原因。

这是代码：

    HubConnection.On<Object>("NewLogItem", (obj) =>
    {
        if (obj is JsonElement jsonElement)
        {
            JsonSerializerOptions opts = new JsonSerializerOptions();
            opts.PropertyNameCaseInsensitive = true;
            var logItem2 = JsonSerializer.Deserialize<LogItem>(jsonElement, opts);
        }
    });

我得到的异常可以轻松解决我的问题。我的解决方案是将 LogCategory 从类更改为字符串）。构造器很复杂并且有问题。我应用该方案后，Json反序列化没有任何异常。