参考滥用:值得清理?

时间:2009-04-14 18:51:45

标签: c# ref

我继承了一些广泛且不必要地使用 ref 关键字的代码。如果没有使用 ref ,原始开发人员显然担心对象会被克隆为原始类型,并且在编写50k +代码行之前没有费心去研究这个问题。

这与其他不良编码实践相结合,创造了一些表面上非常危险的情况。例如:


Customer person = NextInLine(); 
//person is Alice
person.DataBackend.ChangeAddress(ref person, newAddress);
//person could now be Bob, Eve, or null

你能想象走进商店改变你的地址,走出一个完全不同的人吗?


可怕,但在实践中在此应用程序中使用 ref 似乎无害多余。我无法证明清理它需要花费大量时间。为了帮助推销这个想法,我提出了以下问题:

如何不必要地使用ref是破坏性的?

我特别关心维护。有例子的合理答案是首选。

我们也欢迎您争辩说没有必要进行清理。

7 个答案:

答案 0 :(得分:8)

我想说最大的危险是如果参数在函数内被设置为null由于某种原因:

public void MakeNull(ref Customer person)
{
    // random code
    person = null;
    return;
}

现在,你不只是一个不同的人,你已经完全被删除了!

只要开发此应用程序的任何人都理解:

  

默认情况下,对象引用按值传递。

  

使用ref关键字,对象引用通过引用传递。

如果代码现在按预期工作,并且您的开发人员了解其中的差异,则可能不值得将它们全部删除。

答案 1 :(得分:4)

我只是添加了我见过的最关键的ref关键字,方法看起来像这样:

public bool DoAction(ref Exception exception) {...}

是的,你必须声明并传递一个Exception引用才能调用该方法,然后检查方法的返回值,看看是否已经通过引用异常捕获并返回了异常。

答案 2 :(得分:2)

你能弄清楚为什么代码的发起者认为他们需要将参数作为参考吗?是因为他们确实更新了它然后删除了功能,还是因为他们当时不理解c#?

如果你觉得清理是值得的,那就继续吧 - 特别是如果你现在有时间的话。当出现真正的问题时,您可能无法正确地修复它,因为它很可能是一个紧急的错误修复,您将没有时间做正确的工作。

答案 3 :(得分:1)

在C#中修改方法中参数的值是很常见的,因为它们通常是按值而不是参考。这适用于参考和价值类型;例如,将引用设置为null将更改原始引用。当其他开发人员像往常一样工作时,这可能会导致非常奇怪和痛苦的错误。使用ref参数创建递归方法是不行的。

除此之外,你对ref传递的内容有限制。例如,您不能传递常量值,只读字段,属性等,因此在使用ref参数调用方法时需要许多辅助变量。

最后但并非最不重要的是性能如果可能不太好,因为它需要更多间接(ref只是一个需要在每次访问时解决的引用)并且还可以使对象保持更长时间,因为引用不是快速走出范围。

答案 4 :(得分:1)

对我来说,闻起来像是一个C ++开发人员做出了无根据的假设。

我要小心改变那些有效的东西。 (我假设它有效,因为你没有评论它被破坏,只是它很危险)。

你要做的最后一件事是打破一些微妙的东西,并且必须花一周的时间来追查问题。

我建议你随时清理 - 一次一种方法。

  1. 找到一个使用ref的方法,确定它不是必需的。
  2. 更改方法签名并修复呼叫。
  3. 测试。
  4. 重复。
  5. 虽然您遇到的具体问题可能比大多数情况更严重,但您的情况非常普遍 - 拥有大量代码库,不符合我们目前对“正确方式”的理解做事。

    批发“升级”经常遇到困难。随你进行重构 - 在处理它们时将事情提升到规范 - 更加安全。

    建筑行业有先例。例如,除非出现问题,否则不需要触摸较旧(例如19世纪)建筑物中的电线。但是当 出现问题时,必须按照现代标准完成新工作。

答案 5 :(得分:0)

我会尝试解决它。只需用正则表达式执行解决方案宽字符串替换,然后检查单元测试。我知道这可能会破坏代码。但是你多久使用一次参考?几乎没有,对吗?鉴于开发人员不知道它是如何工作的,我认为它在某个地方(它应该的方式)使用的可能性更小。如果代码中断 - 好吧,回滚......

答案 6 :(得分:0)

  

如何不必要地使用ref是破坏性的?

其他答案涉及语义问题,这绝对是最重要的事情。好的代码是自我记录的,当我给出一个ref参数时,我认为改变。如果没有,则API无法自我记录。

但为了好玩,我们如何看待另一个方面 - 表现?

void ChangeAddress(ref Customer person, Address address)
{
    person.Address = address;
}

这里person是对引用的引用,因此每当您访问它时都会引入一些间接。让我们看看这可能转化为的一些装配:

mov eax, [person]           ; load the reference to person.
mov [eax+Address], address  ; assign address to person.Address.

现在是非参考版本:

void ChangeAddress(Customer person, Address address)
{
    person.Address = address;
}

这里没有间接,所以我们可以摆脱一个阅读:

mov [person+Address], address  ; assign address to person.Address.

实际上,人们希望.NET在[person]版本中缓存ref,在多次访问中分摊间接成本。实际上,除了这里的琐碎方法之外,指令数量实际上不会下降50%。