返回访问器的引用是否惯用？

Question

在 C++ 中，可以创建一个返回对私有字段的引用的访问器。

class Cls {
    private:
        int _attr;
    public:
        int& attr() { return _attr; }
};

这样就可以这样访问该属性：

// set
c.attr() = 4;

// get
cout << c.attr() << endl;

这种访问器风格是否惯用/良好实践？一般的 C++ 程序员看到这种风格的访问器会感到惊讶吗？ （提示：我第一次看到这个时很惊讶，但有点喜欢这种风格）

Answer 1

假设您需要保证：

template <int Base>
class Digit {
  private:
    int attr_; // leading underscore names are reserved!
  public:
    int attr() const { return attr_; }
    void attr(int i) { attr_ = i % Base; } // !
};

在这种情况下，您无法返回引用，因为无法保证用户不会以您不想要的方式修改它。这是使用 setter 的主要原因 - 您可以（现在或以后）过滤输入以确保它是可以接受的。通过参考，您必须盲目接受用户分配给您的会员的内容。既然如此，为什么不直接公开呢？

Answer 2

不，只要您还提供 const 重载，该代码就不足为奇了：

class Cls {
    int _attr;
public:
    int& attr() { return _attr; }
    int const& attr() const { return _attr; }
};

但是，出于 Chris Lutz 和 Mark B 提到的原因，我会考虑以下惯用语：

class Cls {
    int _attr;
public:
    int const& attr() const { return _attr; }
    void attr(int i) { _attr = i; }
};

Answer 3

一般来说，对于不平凡的类（例如可以简单地定义为struct的类），为特定属性提供访问器/修改器可能是一种代码味道。一般来说，类应该倾向于保持其内部状态：Internal。如果您提供对内部状态的非常量引用，那么突然间您根本无法控制类不变量。这不仅会使调试变得更加困难，因为可能的状态更改的范围是整个项目，它还会阻止您更改类的内部结构，因为它们实际上既是状态又是用户 API。

相反，您可能应该设计一些方法，在您的类上执行有意义的工作，同时维护类不变量。在某些情况下，提供对特定状态变量的只读访问完全没问题，而在其他情况下，您只想以另一种方式提供对最终状态的访问。

Answer 4

这样做完全违背了将其设为私有的目的。

访问器的目的是公开内部状态，以便当外部代码尝试修改状态时，类可以保持不变量（通过仅允许读访问，或者在修改状态之前验证写访问）；它们通常看起来像这样

int  attr() const {return _attr;}
void attr(int a)  {_attr = a;}

：如果将来您需要限制属性可以采用的值，或者更改其内部存储的方式，那么您可以修改它们的实现，而无需更改类接口。

如果没有必要（并且您已经决定永远没有必要），请将其公开；将其公开为引用只会带来几行不必要的代码和使用它时的奇怪语法。

Answer 5

这取决于。如果类的作用是包含这样的对象（例如
容器类），那么它非常惯用，并且是正常的做法
事物。然而，在大多数其他情况下，人们认为最好
使用 getter 和 setter 方法。不一定命名为 getXxx 和
setXxx——我见过的最常见的命名约定使用 m_attr
属性的名称，以及简单的 attr 两个属性的名称
getter 和 setter。 （运算符重载会在它们之间进行选择
根据参数的数量。）

--
詹姆斯·坎泽

Answer 6

返回对 POD 成员的引用通常不太常见。我想读者一定会期待有一个二传手来达到这个目的。但是，如果您这样做，请不要忘记为 const 情况也重载它。

Answer 7

这种情况比较常见，但风格很糟糕。

例如，如果您查看过 STL，您会注意到生成 const& 或 & 到内部状态的类通常是普通容器，并且只提供这种对您实际存储在其中的内容的访问。显然，您无法直接修改诸如 size 之类的属性或二叉树的内部节点。

提供对元素的直接访问会破坏封装。您不仅会丢失与这些元素有关的所有类不变量，而且还使它们成为 API 的一部分，因此在不更新所有客户端的情况下无法更改类的实现。

就我而言，它们是 C++ 中的两种类型：

struct BigBag {
  Foo _foo;
  Bar _bar;
  FooBar _foobar;
};

class MyClass {
public:
  explicit MyClass(int a, int b);

  int getSomeInfo();

  void updateDetails(int a, int b);
private:
  // no peeking
};

也就是说：要么它只是相关元素的集合，在这种情况下，一切都是公共的，你就完成了，要么有类不变量和/或你'关心它的 API，因为有很多客户端代码，在这种情况下，您根本不会公开实现细节。

Answer 8

以防万一你想去掉括号……

class Cls {
    private:
        int _attr;
    public:
        Cls() : attr(_attr) { }
        int& attr;
};

编辑：克里斯的观点很好。用公共引用包装私有变量基本上没有任何好处。不过，以下版本确实添加了一些内容。将引用设置为 const 可防止设置，但允许获取私有变量。

class Cls {
    private:
        int _attr;
    public:
        Cls() : attr(_attr) { }
        int const & attr;
};