是否有与 Java 的 C# 的 ToStringBuilder 等价物？什么是好的 C# 版本功能？

Question

在 Java 世界中，我们有 Apache Commons 的 ToStringBuilder 来帮助创建 toString() 实现。

有人知道 C# 的一个不错的免费实现吗？还有我不知道的更好的选择吗？

如果不存在免费实现，我猜这个问题更像是一个“在 C# 3 中怎样才能成为一个好的 ToStringBuilder？”

在我的头顶：

• 它可以提供反射和手动创建 ToString 字符串。

• 如果它可以利用表达式树，那就太棒了。

像这样..

 public override string ToString()
   {
      return new ToStringBuilder<Foo>(this)
         .Append(t => t.Id)
         .Append(t => t.Name)
         .ToString();
   }

哪个会返回：

 "Foo{Id: 1, Name: AName}"

• 它可以使用 System.Reflection.Emit 来预编译 ToString 委托。

还有其他想法吗？

更新

只是为了澄清 ToStringBuilder 与 StringBuilder 不同。我正在寻找类似于 Apache Common 的 ToStringBuilder 功能的东西，它具有多行格式、不同样式和反射基础 ToString 创建等功能。谢谢。

更新 2

我已经建立了自己的。见here。

Answer 1

ObjectPrinter 将为您提供许多可自定义的功能。文档仍然有些粗糙，但我们多年来一直在生产中使用它并取得了很好的效果。

Answer 2

最初的问题涉及 C# 3.5，但从那以后我升级到了 C# 4。

我想我会在这里分享我的新版本，以防它对其他人有所帮助。它具有该线程中提到的所有功能，并在运行时编译为快速的 Stringify 方法。

在这里获取：ToStringBuilder

Answer 3

它可能不是你想要的，因为它不是免费的，但Resharper 会这样做。它是 Visual Studio 的一个很棒的插件，它的功能远不止生成 ToString。但它会这样做。将光标放在班级内，按 alt+insert 并选择格式化成员。

Answer 4

编辑：好的，您想使用反射，因此您不必键入属性名称。我认为这会让你得到你所追求的：

// forgive the mangled code; I hate horizontal scrolling
public sealed class ToStringBuilder<T> {
    private T _obj;
    private Type _objType;
    private StringBuilder _innerSb;

    public ToStringBuilder(T obj) {
        _obj = obj;
        _objType = obj.GetType();
        _innerSb = new StringBuilder();
    }

    public ToStringBuilder<T> Append<TProperty>
    (Expression<Func<T, TProperty>> expression) {

        string propertyName;
        if (!TryGetPropertyName(expression, out propertyName))
            throw new ArgumentException(
                "Expression must be a simple property expression."
            );

        Func<T, TProperty> func = expression.Compile();

        if (_innerSb.Length < 1)
            _innerSb.Append(
                propertyName + ": " + func(_obj).ToString()
            );
        else
            _innerSb.Append(
                ", " + propertyName + ": " + func(_obj).ToString()
            );

        return this;
    }

    private static bool TryGetPropertyName<TProperty>
    (Expression<Func<T, TProperty>> expression, out string propertyName) {

        propertyName = default(string);

        var propertyExpression = expression.Body as MemberExpression;
        if (propertyExpression == null)
            return false;

        propertyName = propertyExpression.Member.Name;
        return true;
    }

    public override string ToString() {
        return _objType.Name + "{" + _innerSb.ToString() + "}";
    }
}

例子：

// from within some class with an Id and Name property
public override string ToString() {
    return new ToStringBuilder<SomeClass>(this)
        .Append(x => x.Id)
        .Append(x => x.Name)
        .ToString();
}

看，你所追求的行为：

class Thing {
    public int Id { get; set; }
    public string Name { get; set; }

    public override string ToString() {
        return new ToStringBuilder<Thing>(this)
            .Append(t => t.Id)
            .Append(t => t.Name)
            .ToString()
    }
}

void Main() {
    var t = new Thing { Id = 10, Name = "Bob" };
    Console.WriteLine(t.ToString());
}

输出：

事物{Id：10，名称：“Bob”}

Answer 5

我不知道有任何现有项目可以满足您的需求，但是使用 lambda 实现您给出的示例并不难。

这是另一个使用匿名委托的 [未经测试/未编译/可能有错误] 的想法：

public override string ToString() {
    return this.ToString(x => {
        x.Append(t => t.Id);
        x.Append(t => t.Name);
    });
}

此ToString() 重载将被编写为扩展方法，因此您将获得对源对象的引用，并接受Action<T>，其中[T] 是源对象的类型。然后 ToString() 方法将新建一个字符串构建器或某种内部对象，执行从调用者传入的匿名方法，然后将结果包装在任何必要的打开/关闭文本中。

需要说明的是，我实际上并没有尝试过这个。我只是认为它比原始问题中基于 lambda 的示例更灵活。

Answer 6

我认为您对使用表达式有所了解。前几天晚上我读了这篇文章：Getting Information About Objects, Types, and Members with Expression Trees

我敢打赌，您可以将这些技术与 Dan 在此线程上发布的代码结合起来，以获得您所追求的目标。

Answer 7

查看这个项目...

http://commonsdotnet.codeplex.com/

Answer 8

使用 .NET 的 StringBuilder。

请注意，您必须自己提供一个小模板。

例如：

public StringBuilder ToStringBuilder<T>(T type) where T : IYourInterface
{
StringBuilder sb = new StringBuilder();
sb.append(type.key);
// more appends

return sb;
}

在这里提供了一种generic 方式。 您将能够使用 .NET 中的 System.Reflection 命名空间创建自己的简洁解决方案

干杯