在 C# 构造函数中处理损坏的输入数据的最合适方法是什么？

Question

我正在从文件中读取数据并根据该数据创建对象。数据格式不受我的控制，并且偶尔会损坏。在 C# 中构造对象时，处理这些错误的最合适方法是什么？

在其他编程语言中，我返回了 null，但这似乎不是 C# 的一个选项。

我已经设法找出以下选项，但我希望得到更有经验的 C# 程序员的建议：

选项 1。读取构造函数内的文件，并在源数据损坏时引发异常：

try
{
    obj = Constructor(sourceFile);
    ... process object ...
}
catch (IOException ex)
{
    ...
}

<选项 2。 创建对象，然后使用方法从源文件读取数据：

obj = Constructor();
obj.ReadData(sourceFile);
if (obj.IsValid)
{
    ... process object ...
}

或者可能在错误时引发异常：

obj = Constructor();
try
{
    obj.Read(sourceFile);
    ... process object ...
}
catch
{
    ...
}

选项 3。 使用静态 TryParse 方法创建对象：

if (ObjClass.TryParse(sourceFile, out obj))
{
    ... process object ...
}

如果是这样，我应该在内部实施选项 3使用选项 1？

public static bool TryParse(FileStream sourceFile, out ObjClass obj)
{   
    try
    {
        obj = Constructor(sourceFile);
        return true;
    }
    catch (IOException ex)
        return false;
}

Answer 1

我会按照选项3）做一些事情：

class ObjectClass
{
    protected ObjectClass(...constructor parameters your object depends on...)
    {
    }

    public static ObjectClass CreateFromFile(FileStream sourceFile)
    {
        .. parse source file
        if (parseOk)
        {
            return new ObjectClass(my, constructor, parameters);
        }
        return null;
    }
}

然后像这样使用它：

ObjClass.CreateFromFile(sourcefile);

一般来说，构造函数应该将本质上定义类的所有属性作为参数。进行重量级计算（例如解析文件）最好留给工厂方法，因为通常不希望构造函数执行复杂且可能长时间运行的任务。

更新：正如评论中提到的，更好的模式是这样的：

    public static ObjectClass CreateFromFile(FileStream sourceFile)
    {
        .. parse source file
        if (!parseOk)
        {
            throw new ParseException(parseErrorDescription);
        }
        return new ObjectClass(my, constructor, parameters);
    }

    public static bool TryCreateFromFile(FileStream sourceFile, out ObjectClass obj)
    {
        obj = null;
        .. parse source file
        if (!parseOk)
        {
            return false;
        }
        obj = new ObjectClass(my, constructor, parameters);
        return true;
    }

Answer 2

我不会将任何可能引发异常的内容放入构造函数中 - 除非出现真正错误。
如果你的构造函数有一个可能的返回值而不是一个有效的对象，你应该封装它。

最安全的方法可能是创建一个工厂方法（在类中接受文件引用和返回类的新实例或 null）。此方法应首先验证文件及其数据，然后才创建一个新对象。

如果文件数据具有简单的结构，您可以首先将其加载到某个局部变量中，并使用该数据构造对象。
否则，您仍然可以在工厂方法内部决定是否想尝试/捕获构造或使用上面提到的任何其他点。

Answer 3

选项 #1 和 #3 都是不错的选择，并且在 .Net 框架中很常见。为同一类型提供两者也很常见。考虑 Int32.TryParse 和 Int32.Parse。提供这两者可以为开发人员提供更多的灵活性，而不会损害类型的完整性。

我强烈建议你避免#2。此模式强制类型作者和类型使用者处理处于多种状态的类型实例

• 已构造但未完全初始化
• 已初始化且有效
• 已初始化且无效

这给每个使用者带来了处理处于所有不同状态的实例的负担（即使反应就是直接抛出）。此外，它还迫使消费者采用非标准模式。开发人员必须了解您的类型是特殊的，并且需要对其进行构造然后初始化。它违背了 .Net 中创建对象的标准方式。

注意#3，尽管我会采取一些不同的方法。异常形式应该按照try形式来实现。这是向用户提供这两个选项时的标准模式。考虑以下模式

class MyType { 
  struct ParsedData { 
    // Data from the file
  }

  public MyType(string filePath) : this(Parse(filePath)) { 
    // The Parse method will throw here if the data is invalid
  }

  private MyType(ParsedData data) {
    // Operate on the valid data.  This doesn't throw since the errors
    // have been rooted out already in TryParseFile
  }

  public static bool TryParse(string filePath, out MyType obj) {
    ParsedData data;
    if (!TryParseFile(filePath, out data)) {
      obj = null;
      return false;
    }

    obj = new MyType(data);
    return true;
  }

  private static ParsedData Parse(string filePath) {
    ParsedData data;
    if (!TryParseFile(filePath, out data)) {
      throw new Exception(...);
    }
    return data;
  }

  private static bool TryParseFile(string filePath, out ParsedData data) {
    // Parse the file and implement error detection logic here
  }
}

Answer 4

来自 Microsoft 构造函数设计指南 (MSDN)，

如果合适，请从实例构造函数抛出异常。

构造函数应该像任何方法一样抛出和处理异常。具体来说，构造函数不应捕获和隐藏任何它无法处理的异常。

工厂方法不是解决此问题的正确方法。 构造函数与工厂方法

请参阅 /amzn/click/com/0321246756" rel="nofollow noreferrer">框架设计指南：可重用 .NET 的约定、习惯用法和模式图书馆

5.3 构造函数设计

如果满足以下条件，请考虑使用静态工厂方法而不是构造函数
所需操作的语义不直接映射到构造
新实例的，或者如果遵循构造函数设计指南
感觉不自然。

如果合适，请从实例构造函数抛出异常。

.NET BCL 实现确实会从构造函数中抛出异常

例如，列表构造函数 (Int32)，抛出 ArgumentOutOfRangeException 当列表的容量参数为负数时。

var myList = new List<int>(-1); // throws ArgumentOutOfRangeException

同样，构造函数在读取文件时应该抛出适当类型的异常。例如，如果文件指定位置不存在等

更多信息

• 代码合同
• 在.Net中从构造函数抛出异常
• 在构造函数中抛出 ArgumentNullException？
• C# 中的构造函数参数验证 - 最佳实践

Answer 5

所有这些解决方案都有效，但正如您所说，C# 不允许从构造函数返回 null。你要么得到一个对象，要么得到一个异常。由于这是 C# 的方法，我不会选择选项 3，因为它只是模仿您正在谈论的其他语言。

很多人[编辑]其中包括马丁，正如我在他的回答中读到的那样:)[/编辑]认为保持构造函数干净和小是件好事。我对此不太确定。如果你的对象没有这些数据就没有用，你也可以在构造函数中读入数据。如果您想构造对象，设置一些选项，然后读取数据（特别是在读取失败时可以重试），那么单独的方法也可以。所以选项2也是一个很好的可能性。也许更好，主要取决于口味。

所以只要你不选择3个，就选择你最舒服的那个。 :)