不要从许多方法中分配一个字段

Question

我的班级里有这样一个字段：

public class Shape
{
    private Point2D m_location;

    public void Move()
    {
       m_location = ...
    }

    public void Rotate()
    {
       m_location = ...
    }

    public void Flip()
    {
       m_location = ...
    }
}

我在 NDepend 中收到一条警告：

不要从许多方法中分配一个字段

https://www.ndepend.com/default-rules/Q_Don't_assign_a_field_from_many_methods.html

看来我可以通过在我的类中创建另一个方法来轻松解决这个问题，例如：

private void SetLocation(Point2D point)
{
    m_location = location;
}

并在所有设置m_location 的方法中调用它。现在m_location 仅以一种方法分配！

这是解决此问题的有效方法吗？我是否只是通过在这些方法中调用 SetLocation() 方法来隐藏之前检测到的代码异味 NDepend？

Answer 1

这是解决此问题的有效方法吗？

没有。正如您所怀疑的，这是代码异味。 NDepend 抱怨的是可变引用；你有代码在哪里：

var s = new SomeObject(someInitialization);
var r = s.SomeResult();
// you now have no idea what s contains or if it is even usable any more.

解决方案是使SomeObject 不可变并返回新引用而不是更改内部结构：

public SomeObject Something()
{
    return new SomeObject(SomethingDifferentDependingOn(this.something));
}

现在你有的不是你的第一个例子：

var s = new SomeObject(someInitialization);
var r = s.Something().Result;
// s is guaranteed to be unchanged.

是的，有时您需要可变引用。在这些情况下；记录它们并解释为什么它们必须是可变的。然后您可以根据具体情况override NDepend rules 以防止它显示警告。如果您有代码气味，请警告人们。不要试图隐藏它。

编辑后的示例完全不同，但一般原则仍然成立。如果您只有几个内部字段在方法调用中全部更改，您仍然可以返回不可变引用，例如：

public Shape Move()
{
    return new Shape(m_location ...);
}

如果您有许多内部字段并没有全部更改，或者您需要执行诸如共享私有字段之类的操作，则您无法轻松获得不可变引用，但您仍然可以通过使用访问器来避免警告：

public Location
{
    get { return m_location; }
    private set { m_location = value; }
}

然后在你的内部方法中只使用Shape.Location。