防止用户创建类的未命名实例

Preventing users from creating unnamed instances of a class

本文关键字：未命名 实例 创建 用户      更新时间：2023-10-16

对于许多RAII"guard">类，被实例化为匿名变量根本没有意义：

{
std::lock_guard<std::mutex>{some_mutex};
// Does not protect the scope!
// The unnamed instance is immediately destroyed.
}


{
scope_guard{[]{ cleanup(); }};
// `cleanup()` is executed immediately!
// The unnamed instance is immediately destroyed.
}

从这篇文章：

C++中的匿名变量具有"表达式作用域"，这意味着它们在创建它们的表达式末尾被销毁。

有没有办法防止用户在没有名称的情况下实例化它们？("预防"可能太强了 - "使其非常困难"也是可以接受的)。

我可以想到两种可能的解决方法，但它们会在使用类时引入语法开销：

  1. 将类隐藏在detail命名空间中并提供宏。

    namespace detail
{
class my_guard { /* ... */ };
};
#define SOME_LIB_MY_GUARD(...) 
detail::my_guard MY_GUARD_UNIQUE_NAME(__LINE__) {__VA_ARGS__}

    这有效，但很黑客。

  2. 仅允许用户通过高阶函数使用防护。

    template <typename TArgTuple, typename TF>
decltype(auto) with_guard(TArgTuple&& guardCtorArgs, TF&& f)
{
make_from_tuple<detail::my_guard>(std::forward<TArgTuple>(guardCtorArgs));
f();
}

    用法：

    with_guard(std::forward_as_tuple(some_mutex), [&]
{
// ...
});

    当保护类的初始化具有"流畅"语法时，此解决方法不起作用：

    {
auto _ = guard_creator()
.some_setting(1)
.some_setting(2)
.create();
}

有没有更好的选择？我可以使用 C++17 功能。

我想到的唯一明智的方法是让用户将guard_creator::create的结果传递给某些将左值引用作为参数的guard_activator。

这样，类的用户就没有办法，只能使用名称创建对象(大多数开发人员会做的理智选项)，或者new它然后取消引用(疯狂的选项)

例如，您在评论中说您在非分配异步链创建器上工作。我可以考虑一个看起来像这样的 API：

auto token = monad_creator().then([]{...}).then([]{...}).then([]{...}).create();
launch_async_monad(token); //gets token as Token&, the user has no way BUT create this object with a name

如果能够充分利用 C++17 的潜力，则可以将使用静态工厂函数的想法扩展为有用的东西：保证复制 elision 使静态工厂函数即使对于不可移动的类也可以使用，并且 [[nodiscard]] 属性提示编译器在忽略返回值时发出警告。

class [[nodiscard]] Guard {
public:
Guard(Guard& other) = delete;
~Guard() { /* do sth. with _ptr */ }
static Guard create(void* ptr) { return Guard(ptr); }
private:
Guard(void* ptr) : _ptr(ptr) {}
void* _ptr;
};
int main(int, char**) {
Guard::create(nullptr);
//auto g = Guard::create(nullptr);
}

在编译器资源管理器中编译

你可以使用可扩展的lint工具，如Vera++ https://bitbucket.org/verateam/vera/wiki/Home 它允许你lint你的代码，你可以使用Python或tcl创建新规则(我更喜欢Python)

一个可能的流程是 - 在每次提交后，您的 CI 系统(例如 Jenkins)将运行执行 Vera++ 的作业并验证此类监督，如果失败，将向提交者发送邮件。

防止类被实例化的规范方法是使其构造函数private。若要实际获取所需的实例之一，请调用static方法，该方法返回对构造对象的引用。

class Me {
public:
static Me &MakeMe() { return Me(); }
private:
Me();
}; // Me

这当然没有帮助 - 但它可能会让程序员停下来！

int main() {
Me(); // Invalid
Me m; // Invalid
Me::MakeMe(); // Valid - but who'd write that?
Me m = Me::MakeMe();
} // main()

我知道这不是您描述的Guard实例的直接类比 - 但也许您可以调整这个概念？

相关文章：