重写 ToString() 以进行调试和日志 - 字符串应该本地化吗？

Question

我正在设计一个 .NET 库，其他开发人员将使用该库来制作 Web 和桌面应用程序。我正在重写各种类中的 ToString() ，以提供用于调试目的和包含在应用程序日志文件中的信息。

我的一些课程包含数字和日期。

考虑一个对象，其中包含一个名为 date 的 DateTime 和一个名为 value 的 double（也可能还有其他字段） ...如果我覆盖该对象的 ToString()，我可能想做类似的事情：

public override string ToString() {
    return "ObjectName[date=" + date + ", value=" + value + "]";
}

但这将包括 date.ToString() 和 的结果value.ToString()，这将为我提供本地化的字符串根据Thread.CurrentThread.CurrentCulture。

对我来说，这似乎是错误的。我的 ToString() 实现返回的字符串用于调试和日志消息，而不是用于用户界面。所以我认为返回本地化字符串只会让事情变得混乱。如果“2,341”出现在日志文件中，开发人员需要知道线程的 CurrentCulture 值才能知道它是否意味着 2000 341 还是 2 点 341。日期更令人困惑 - 一个字符串例如 xx/xx/xxxx 可以是 dd/mm/yyyy 或 mm/dd/yyyy。我不希望我的 ToString() 方法造成这种歧义。

因此，我倾向于使我的 ToString() 方法对区域性不敏感，以确保所有返回的字符串在不同区域性中保持一致。例如，在内部，我的 ToString() 方法会像 value.ToString(CultureInfo.InvariantCulture) 一样格式化数字。

然而，.NET 库中的规范似乎是在默认的无参数 ToString() 实现中使用 CurrentCulture 。许多具有 ToString() 方法的对象也具有 ToString(IFormatProvider) 方法。就好像 .NET 的设计者决定默认使用 ToString() 应该用于用户界面显示（本地化），以及调试和日志（为此您需要调用 < code>ToString(CultureInfo.InvariantCulture)) 是次要的。

因此，如果我以一种文化不敏感的方式实现我的 ToString() 方法，我觉得我会有点违背常规。但是，当区域性敏感性对于日志文件或调试没有意义时，默认创建区域性敏感的字符串似乎很愚蠢。

我可以使用 CurrentCulture 在我的默认 ToString() 实现中表示数字和日期，并且还提供 ToString(FormatProvider) 方法，以便人们可以获取一个不区分文化的字符串用于日志文件等。但这似乎很愚蠢，因为它只是迫使开发人员编写更多代码来获取我猜他们想要的不区分文化的字符串（无论他们是否考虑过）或不）。

最重要的是，像 ObjectName[value=12.234, date=2011-10-01] 这样的字符串不应该出现在用户界面中，那么为什么程序员希望对其进行本地化呢？ ？

我一直在阅读《框架设计指南》中关于实现 ToString() 的建议。有些建议似乎有些矛盾。例如：

我认为 ToString 是一种为 UI 通用类型提供的特别危险的方法，因为它很可能是在考虑到某些特定 UI 的情况下实现的，这使得它对于其他 UI 需求毫无用处。为了避免以这种方式诱惑自己，我更喜欢让我的 ToString 输出尽可能地令人讨厌，以强调唯一应该看到输出的“人类”是“开发人员”（他们所有的亚种）自己的）。

和

ToString 最重要的值是调试器使用它作为显示对象的默认方式。

似乎不太适合：

DO 在返回区域性相关信息时根据当前线程区域性进行字符串格式化。

和

使用线程的 CurrentCulture 属性返回的 CultureInfo 实例来格式化任何数字或日期

我完全支持遵循准则，并编写符合程序员期望的 API。但如果 ToString() 是为程序员准备的，那么本地化它似乎很愚蠢。 C# 编译器不允许程序员使用系统相关的小数分隔符编写双精度文字，因此为程序员编写的 ToString() 方法肯定应该表现类似吗？

你怎么认为？ 当 ToString() 的输出不用于用户界面时，其中的数字和日期是否应该本地化？

---

更新

我使用 DebuggerDisplay 属性做了一些测试，默认情况下，它以不区分区域性的方式格式化数字。

[DebuggerDisplay("[value={value}]")]
class DoubleHolder {
    private double value;
    DoubleHolder(double value) {
        this.value = value;
    }
}

[TestMethod]
public void TestDebuggerValue() {
    DoubleHolder s = new DoubleHolder(12345678.12345);
    string doubleString = TestDouble.ToString();
    CultureInfo current = Thread.CurrentThread.CurrentCulture;
    Thread.CurrentThread.CurrentUICulture = current;
    CultureInfo ui = Thread.CurrentThread.CurrentUICulture;
    Debugger.Break();
}

在调试器中运行该测试，当它中断时，您可以看到 DoubleHolder 中包含的 double 被格式化为 . 作为小数分隔符。

然后关闭 Visual Studio，将 Windows 标准和格式区域选项更改为法语，然后再次运行测试。您会看到 doubleString 有一个 , 作为小数分隔符，但调试器仍然在 DoubleHolderdouble code> 和 .

我想在正确的法语版本的 Windows 上使用法语的 Visual Studio 进行测试。在 Visual Studio 中，如果您转到“工具”->“选项->环境->国际设置，您可以将语言设置为“与 Microsoft Windows 相同”。默认情况下，我的安装设置为“英语”。但是要获得法语版的 Visual Studio，您需要安装法语版的 Windows，而我的 Windows 版本似乎只有英语版。如果有人使用法语 Windows 或任何其他使用 , 作为小数点分隔符的语言环境，那么如果您可以检查调试器是否使用 . 或 < code>, 作为格式化双精度数中的小数分隔符。

我想知道 Thread.CurrentThread.CurrentUICulture 是否可能会对 Visual Studio 调试器显示内容的方式产生影响，并且我不确定像上面那样设置它是否与运行 Visual 相同工作室完全用法语。

但从上面看来，调试器确实始终使用 . 作为小数点分隔符。对我来说，这意味着与区域性无关的 ToString() 方法很好，如果用于调试目的，可能更可取。

Answer 1

对于调试，您需要查看调试器显示属性，而不是使用ToString()。

[DebuggerDisplay("{Name} [date={Date}, value={Value}]")]
public class MyClass {
    // ...
}

至于ToString()的本地化，我会通过机会发表评论。

Answer 2

在我看来，这里唯一重要的两件事是：

• 您已经考虑预期用途，并适当地应用文化，
• 该行为已被清楚地记录下来

如果其预期用途是记录，然后不变似乎很好。如果预期用途是 IDE 显示，那么我会将其本地化到当前线程。

如果不确定，请考虑添加 ToString(CultureInfo) 方法，然后调用者就可以按照自己的意愿进行操作。在这种情况下，我假设 tw 默认值是当前文化，并且日志记录代码应该明确请求不变（也许也通过 IFormattable）。