使用 ref 改变部分不可变类的方法设计

Question

在我的项目中，我有一个标头类，它表示系统内一条信息的全局唯一键，例如它属于谁，它存在的时间等。在同一个标​​头类中，我还有用于信息的字段特定于给定的数据实例，例如谁创建了该版本的信息、何时创建、是否需要将其新数据保存到数据库等。

下面是一个将某些信息存入数据的示例传输类并查询它。

var header = new IntvlDataHeader(
       datapoint: Guid.NewGuid(),
       element: Guid.NewGuid(),
       intervalUtc: DateTime.Now.Date);

package.StockData_Decimal(header, 5m);

decimal cloneData;
package.TryGetData_Decimal(ref header, out cloneData);

// header now refers to a different object, that could have different flags/information

请注意我如何使 TryGetData_Decimal 通过引用传递标头变量。 IntvlDataHeader 是一个类，如果在 TryGetData 中找到数据，则引用将更改为指向 IntvlDataHeader 的新实例，该实例除了具有相同的唯一密钥信息之外，还具有特定的实例信息。

将密钥与实例特定信息相结合并使用 ref 参数作为输入和输出是否是一个糟糕的设计？拆分另一个类以便有两个 out 参数并且没有 ref 参数的工作是否会更好或避免任何潜在的问题？

该方法的签名是 public bool TryGetData_Decimal(ref IntvlDataHeader header, out Decimal data)

Answer 1

我认为您的 TryGetData_Decimal 的命名具有误导性，如果您传入的 ref 参数在方法退出时指向一个新实例。对我来说，TryGetData_Decimal 听起来像是许多值类型上的 TryParse 方法的变体（它有一个包含解析值的输出参数 - 类似于 cloneData 参数）。

我想我不确定为什么标头对象必须指向一个新实例，所以我不确定我可以推荐一种设计。 那么它可能更具可读性

IntvlDataHeader ExtractValueAndGetNewInstance_Decimal(IntvlDataHeader header, out decimal cloneData)

如果这就是您需要做的，我认为如果您的 TryGetData_XXX 方法具有类似这样的签名： header 被传入，但在方法退出时不会更改， 。该方法返回新实例，如果需要，您可以使用它。我不会更改 cloneData - 我认为 out 参数只要不被过度使用就可以。

我也会尝试将该方法的名称更改为更有意义的名称。

我希望这有帮助。