C ++ getters / setters编码风格

时间:2009-04-17 15:04:47

标签: c++ coding-style getter-setter

我已经在C#编程了一段时间,现在我想要提高我的C ++技能。

上课:

class Foo
{
    const std::string& name_;
    ...
};

什么是最好的方法(我只想允许对name_字段的读访问权):

  • 使用getter方法:inline const std::string& name() const { return name_; }
  • 将该字段设为公开,因为它是常量

感谢。

8 个答案:

答案 0 :(得分:77)

对于长期存在的类,使用getter方法是一种更好的设计选择,因为它允许您将getter方法替换为将来更复杂的东西。虽然这似乎不太可能需要const值,但成本很低,可能带来的好处很大。

顺便说一句,在C ++中,为成员同名提供getter和setter是一个特别好的主意,因为将来你可以实际更改这对方法:

class Foo {
public:
    std::string const& name() const;          // Getter
    void name(std::string const& newName);    // Setter
    ...
};

单个公共成员变量,为每个变量定义operator()()

// This class encapsulates a fancier type of name
class fancy_name {
public:
    // Getter
    std::string const& operator()() const {
        return _compute_fancy_name();    // Does some internal work
    }

    // Setter
    void operator()(std::string const& newName) {
        _set_fancy_name(newName);        // Does some internal work
    }
    ...
};

class Foo {
public:
    fancy_name name;
    ...
};

当然需要重新编译客户端代码,但不需要更改语法!显然,这种转换对于const值也同样适用,其中只需要一个getter。

答案 1 :(得分:46)

将非常量字段公开是一个坏主意,因为这样就很难强制错误检查约束和/或在将来为值变化添加副作用。

在您的情况下,您有一个const字段,因此上述问题不是问题。使其成为公共领域的主要缺点是您要锁定底层实现。例如,如果将来您想要将内部表示更改为C字符串或Unicode字符串或其他内容,那么您将中断所有客户端代码。使用getter,您可以转换为现有客户端的旧表示,同时通过新的getter为新用户提供更新的功能。

我仍然建议你使用上面提到的getter方法。这将最大化您未来的灵活性。

答案 2 :(得分:21)

顺便说一下,在C ++中,拥有一个const引用成员有点奇怪。您必须在构造函数列表中分配它。谁拥有该对象的实际记忆以及它的生命周期是什么?

至于风格,我同意其他人你不想暴露你的私人。 :-)我喜欢setter / getters的这种模式

class Foo
{
public:
  const string& FirstName() const;
  Foo& FirstName(const string& newFirstName);

  const string& LastName() const;
  Foo& LastName(const string& newLastName);

  const string& Title() const;
  Foo& Title(const string& newTitle);
};

通过这种方式,您可以执行以下操作:

Foo f;
f.FirstName("Jim").LastName("Bob").Title("Programmer");

答案 3 :(得分:8)

我认为C ++ 11的方法现在会更像这样。

#include <string>
#include <iostream>
#include <functional>

template<typename T>
class LambdaSetter {
public:
    LambdaSetter() :
        getter([&]() -> T { return m_value; }),
        setter([&](T value) { m_value = value; }),
        m_value()
    {}

    T operator()() { return getter(); }
    void operator()(T value) { setter(value); }

    LambdaSetter operator=(T rhs)
    {
        setter(rhs);
        return *this;
    }

    T operator=(LambdaSetter rhs)
    {
        return rhs.getter();
    }

    operator T()
    { 
        return getter();
    }


    void SetGetter(std::function<T()> func) { getter = func; }
    void SetSetter(std::function<void(T)> func) { setter = func; }

    T& GetRawData() { return m_value; }

private:
    T m_value;
    std::function<const T()> getter;
    std::function<void(T)> setter;

    template <typename TT>
    friend std::ostream & operator<<(std::ostream &os, const LambdaSetter<TT>& p);

    template <typename TT>
    friend std::istream & operator>>(std::istream &is, const LambdaSetter<TT>& p);
};

template <typename T>
std::ostream & operator<<(std::ostream &os, const LambdaSetter<T>& p)
{
    os << p.getter();
    return os;
}

template <typename TT>
std::istream & operator>>(std::istream &is, const LambdaSetter<TT>& p)
{
    TT value;
    is >> value;
    p.setter(value);
    return is;
}


class foo {
public:
    foo()
    {
        myString.SetGetter([&]() -> std::string { 
            myString.GetRawData() = "Hello";
            return myString.GetRawData();
        });
        myString2.SetSetter([&](std::string value) -> void { 
            myString2.GetRawData() = (value + "!"); 
        });
    }


    LambdaSetter<std::string> myString;
    LambdaSetter<std::string> myString2;
};

int _tmain(int argc, _TCHAR* argv[])
{
    foo f;
    std::string hi = f.myString;

    f.myString2 = "world";

    std::cout << hi << " " << f.myString2 << std::endl;

    std::cin >> f.myString2;

    std::cout << hi << " " << f.myString2 << std::endl;

    return 0;
}

我在Visual Studio 2013中对此进行了测试。不幸的是,为了使用LambdaSetter中的底层存储,我需要提供一个“GetRawData”公共访问器,这可能会导致破坏封装,但你可以将其保留并提供自己的T的存储容器或只是确保您在编写自定义getter / setter方法时使用“GetRawData”的唯一时间。

答案 4 :(得分:5)

即使名称是不可变的,您仍可能希望选择计算它而不是将其存储在字段中。 (我意识到这不太可能是“名字”,但我们的目标是一般情况。)因此,即使是常数字段也最好包含在getter中:

class Foo {
    public:
        const std::string& getName() const {return name_;}
    private:
        const std::string& name_;
};

请注意,如果您要更改getName()以返回计算值,则无法返回const ref。没关系,因为它不需要对调用者进行任何更改(模数重新编译。)

答案 5 :(得分:3)

避免公共变量,除了基本上是C风格的结构的类。进入是不是一个好习惯。

一旦你定义了类接口,你可能永远无法改变它(除了添加它之外),因为人们将在它上构建并依赖它。将变量设为public意味着您需要拥有该变量,并且需要确保它具有用户需要的变量。

现在,如果您使用getter,您承诺提供一些信息,这些信息目前保存在该变量中。如果情况发生变化,并且您不想一直维护该变量,则可以更改访问权限。如果需求发生变化(我看到一些非常奇怪的需求变化),并且您大多需要此变量中的名称,但有时需要该变量中的名称,您只需更改getter即可。如果你把变量公之于众,你就会被它困住。

这并不总是会发生,但我发现写一个快速的getter要比分析情况要容易得多,看看我是否后悔让变量公开(以后可能会出错)。

将成员变量设为私有是一个很好的习惯。任何有代码标准的商店都可能会禁止将偶尔的会员变量公之于众,任何有代码评论的商店都可能会批评你。

无论何时,为了便于写作都无关紧要,请进入更安全的习惯。

答案 6 :(得分:1)

从多个C ++来源收集了一些想法,并将其放入C ++中的getter / setter一个漂亮但仍然非常简单的示例中:

class Canvas { public:
    void resize() {
        cout << "resize to " << width << " " << height << endl;
    }

    Canvas(int w, int h) : width(*this), height(*this) {
        cout << "new canvas " << w << " " << h << endl;
        width.value = w;
        height.value = h;
    }

    class Width { public:
        Canvas& canvas;
        int value;
        Width(Canvas& canvas): canvas(canvas) {}
        int & operator = (const int &i) {
            value = i;
            canvas.resize();
            return value;
        }
        operator int () const {
            return value;
        }
    } width;

    class Height { public:
        Canvas& canvas;
        int value;
        Height(Canvas& canvas): canvas(canvas) {}
        int & operator = (const int &i) {
            value = i;
            canvas.resize();
            return value;
        }
        operator int () const {
            return value;
        }
    } height;
};

int main() {
    Canvas canvas(256, 256);
    canvas.width = 128;
    canvas.height = 64;
}

输出:

new canvas 256 256
resize to 128 256
resize to 128 64

您可以在此处在线测试:http://codepad.org/zosxqjTX

PS:FO Yvette <3

答案 7 :(得分:0)

从设计模式理论; “封装变化的东西”。通过定义“吸气剂”,可以很好地遵守上述原则。因此,如果成员的实现表示在将来发生变化,则可以在从“getter”返回之前对成员进行“按摩”;暗示在进行“getter”调用的客户端没有代码重构。

此致