获取对象的完整字符串表示形式（如在 Visual Studio 中的即时窗口中）

Question

给定以下示例类：

public class MyClass
{
    public string S { get; set; }
    public int I { get; set; }
    public DateTime D { get; set; }
    private float F { get; set; }
    private long l;

    public MyClass()
    {
        S = "foo";
        I = 42;
        D = new DateTime(2011, 11, 11);
        F = 3.14f;
        l = 12435;
    }
}

如果我在我的应用程序中有一个此类的实例 myClass，则在调试模式 (Visual Studio 2010) 中逐步执行代码，并在某些时候将 myClass 类型输入到即时窗口中，显示如下：

{MyClass}
    D: {11.11.2011 00:00:00}
    F: 3.14
    I: 42
    l: 12435
    S: "foo"

获取对象及其所有值的这种字符串表示形式对于日志记录非常有用。有没有一种简单易行的方法来实现这一目标？

我猜即时窗口使用反射来循环所有字段和属性，但我想我会问一下，以防万一已经存在一些实用功能或任何可以做的事情。

Answer 1

这会将所有字段存储在字典中（确保可以首先读取它们）：

public static Dictionary<string, object> GeneratePropertiesDictionary(object myClass)
{
    return myClass.GetType()
                  .GetProperties()
                  .Where(p => p.CanRead)
                  .ToDictionary(p => p.Name, p => p.GetValue(myClass, null));
}

您可以轻松地修改它以将每个名称/值附加到 StringBuilder 对象而不是字典，然后将其转储到文件中。

Answer 2

如果您想要一个对象的序列化版本，我可能会在您的日志记录中使用JavaScriptSerializer：

public void LogObject(object obj)
{
    var serializer = new JavaScriptSerializer();
    var objString = serializer.Serialize(obj);

    WriteLog(objString);
}

Answer 3

您可以使用反射并遍历所有字段和属性，对每个结果调用 ToString()。如果当前字段/属性是类/结构，则可以递归地执行此操作。

其次，一些类使用DebuggerDisplayAttribute，尽管您需要解析该 AFAICT。

Answer 4

如果您只想记录（即打印）对象的表示，请覆盖 ToString 方法。

ToString 是 .NET Framework 中的主要格式化方法。它将一个对象转换为它的字符串表示，以便它适合显示。

此外，如果您想提供多种输出字符串的方式（例如，支持详细或最小选项），您还可以考虑实现 IFormattable。