静态成员变量的C ++核心准则

如何解决静态成员变量的C ++核心准则

我在类中有一个私有的静态向量，该向量保持指向从中创建的所有对象的指针。每个对象都需要访问所有其他对象的信息以执行一些计算，这是必要的：

// Header file:
class Example {
public:
    Example();
private:
    static std::vector<const Example*> examples_;
};
// Cpp file:
std::vector<const Example *> Example::examples_ = {};
Example::Example() {
    // intialization
    examples_.emplace_back(this);
}
void Example::DoCalc() {
    for (auto example : examples_) {
        // do stuff
    }
}

clang-tidy指出我违反了C ++核心准则，即：“变量'examples_'是非const且可全局访问，请考虑使其成为const（cppcoreguidelines-avoid-non-const-global-variables）”。

就个人而言，我看不到核心准则中的代码与示例代码之间的相似之处，特别是因为变量位于类内部并且是私有的。实现此功能的“正确”方法是什么？如果可以避免，我不想从clang-tidy禁用此检查。

解决方法

您所做的一切都很好。从字面上看，这是class-static的目的。出于不相关的原因，有些人会推荐替代方法，这可能值得考虑……但并不是因为clang-tidy在这里告诉您任何事情。

您遇到了clang-tidy bug #48040。您可以看到此消息，因为它在消息传递中是错误的：矢量被标记为private（尽管它在全球范围内存在），但在全球范围内都不是不可跨翻译单元，这很好）。

您的代码与所引用的核心准则无关。

,

一种可能的解决方案是强制每个访问Example::examples_的客户端通过一个函数。然后将examples作为静态变量放入该函数。这样，将在首次调用函数时创建对象-与任何全局对象构造顺序无关。

// Header file:
class Example {
public:
    Example();
private:
    std::vector<const Example*>& examples();
};
// Cpp file:
std::vector<Example *>& Example::examples()
{
    static std::vector<Example *> examples_;
    return examples_;
};
Example::Example() {
    // intialization
    examples().emplace_back(this);
}
void Example::DoCalc() {
    for (auto example : examples()) {
        // do stuff
    }
}

当然，如果您确定全局对象没有问题，并且确定在构造过程中没有其他全局对象正在访问Examples::examples_，则可以忽略该警告。这只是一个准则，您不需要严格遵循。

有翼的小行星指出，准则I.2不适用于您的代码。但是请注意，CoreGuidelines也打算禁止静态成员，请参见To-do: Unclassified proto-rules：

避免使用静态类成员变量（竞争条件，几乎全局变量）

,

我个人看不到核心准则中的代码与示例代码之间的相似之处

您有一个对每个线程都可访问的变量，对Example的用户而言是隐藏的。与普通全局变量的唯一区别是它是private，即，您不能使用 name Example::examples_在Example之外引用它。

注意

规则是“避免”，而不是“不要使用”。

实现此功能的“正确”方法可能是您的实现方式，但我强烈建议您重做“每个对象需要访问所有其他对象的信息以执行一些计算”，以便您传递{{1 }}到需要的地方，并跟踪所有std::vector<const Example*>相关的（特别是活着的）使用地点。

替代： [...]另一个解决方案是将数据定义为某些对象的状态，并将操作定义为成员函数。

警告：：当心数据竞争：如果一个线程可以访问非本地数据（或通过引用传递的数据），而另一个线程执行被调用方，则我们可以进行数据竞争。每个对可变数据的指针或引用都是潜在的数据竞争。