静态成员变量的 C++ 核心指南

问题描述 投票:0回答:3

我的类中有一个私有静态向量,它保存指向从它创建的所有对象的指针。这是必要的,因为每个对象都需要访问所有其他对象的信息来执行一些计算:

// 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_' 是非常量且全局可访问的,请考虑将其设为常量 (cppcoreguidelines-avoid-non-const-global-variables)” .

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

c++ static-members clang-tidy cpp-core-guidelines
3个回答
17
投票

你所做的一切都很好。这实际上就是类

static
的目的。有些人会出于不相关的原因推荐替代方案,这可能值得考虑......但不是因为
clang-tidy
在这里告诉你的任何事情。

您遇到了

clang-tidy
bug #48040。你可以看到这一点,因为它的消息传递是错误的:该向量不是“全局可访问”,至少不是在访问规则的意义上,因为它被标记为
private
(尽管它在翻译单元中全局存在,这很好) ).

您的代码与引用的核心指南无关。


6
投票

一个可能的解决方案是强制每个访问

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_
,则可以忽略该警告。这只是一个指南,您无需严格遵循。

正如 Asteroids With Wings 所指出的,准则 I.2 不适用于您的代码。但请注意,CoreGuidelines 也打算禁止静态成员,请参阅待办事项:未分类的原型规则

避免静态类成员变量(竞争条件、几乎全局变量)


3
投票

就我个人而言,我没有看到我的代码与核心指南中的示例代码有任何相似之处

您有一个可供每个线程访问的变量,对

Example
的用户隐藏。与普通全局变量的唯一区别是它是
private
,即您不能使用 name
Example::examples_
Example
之外引用它。

注意

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

实现此功能的“正确”方法可能是您拥有它的方式,但我强烈建议您重新设计“每个对象需要访问所有其他对象的信息来执行一些计算”,以便将

std::vector<const Example*>
传递到这是需要的,跟踪所有相关的(尤其是活跃的)
Example
它们的使用位置。

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

警告:谨防数据竞争:如果一个线程可以访问非本地数据(或通过引用传递的数据),而另一个线程执行被调用者,则可能会发生数据竞争。对可变数据的每个指针或引用都是潜在的数据竞争。

© www.soinside.com 2019 - 2024. All rights reserved.