static_assert

在编译时测试软件断言。 如果指定的常量表达式为 false,则编译器显示指定的消息(如果提供了消息),并且编译失败,错误为 C2338;否则,声明无效。

语法

static_assert( constant-expression, string-literal );

static_assert( constant-expression ); // C++17 (Visual Studio 2017 and later)

参数

constant-expression
可以转换为布尔值的整型常量表达式。 如果计算出的表达式为零 (false),则显示 string-literal 参数,并且编译失败,并出现错误。 如果表达式不为零 (true),则 static_assert 声明无效。

string-literal
constant-expression 参数为零时显示的消息。 该消息是编译器的基本字符集中的一个字符串;即,不是多字节或宽字符

注解

static_assert 声明的 constant-expression 参数表示软件断言。 软件断言指定在程序的某个特定点应满足的条件。 如果条件为 true,则 static_assert 声明无效。 如果条件为 false,则断言失败,编译器在 string-literal 参数中显示消息,并且编译失败,出现错误。 在 Visual Studio 2017 及更高版本中,string-literal 参数是可选的。

static_assert 声明在编译时测试软件断言。 相反,assert 宏、_assert 和 _wassert 函数在运行时测试软件断言,并产生运行时空间或时间成本。 static_assert 声明对调试模板尤其有用,因为模板自变量可包含在 constant-expression 中。

当遇到声明时,编译器将检查 static_assert 声明是否存在语法错误。 如果编译器不依赖于模板参数,则编译器会立即计算 constant-expression 参数。 否则,在对模板进行实例化时,编译器将计算 constant-expression 参数。 因此,当遇到声明时,编译器可能一次发布一个诊断消息,而在对模板进行实例化时也是如此。

可以在命名空间、类或块范围中使用 static_assert 关键字。 (由于 static_assert 关键字可以在命名空间范围内使用,因此,即使它不将新名称引到程序中,但从技术上讲,它也是一个声明。)

包含命名空间范围的 static_assert 说明

在下面的示例中,static_assert 声明具有命名空间范围。 由于编译器知道类型 void * 的大小,因此可以立即计算表达式。

示例:具有命名空间范围 static_assert

static_assert(sizeof(void *) == 4, "64-bit code generation is not supported.");

具有类范围的 static_assert 说明

在下面的示例中,static_assert 声明具有类范围。 static_assert 验证模板参数是否为纯旧数据 (POD) 类型。 编译器将在声明 static_assert 声明时检查该声明,但不计算 constant-expression 参数,直到在 main() 中实例化 basic_string 类模板。

示例:具有类范围 static_assert

#include <type_traits>
#include <iosfwd>
namespace std {
template <class CharT, class Traits = std::char_traits<CharT> >
class basic_string {
    static_assert(std::is_pod<CharT>::value,
                  "Template argument CharT must be a POD type in class template basic_string");
    // ...
    };
}

struct NonPOD {
    NonPOD(const NonPOD &) {}
    virtual ~NonPOD() {}
};

int main()
{
    std::basic_string<char> bs;
}

具有块范围的 static_assert 说明

在下面的示例中,static_assert 声明具有块范围。 static_assert 验证 VMPage 结构的大小是否与该系统的虚拟内存页大小相等。

示例:static_assert 在块范围内

#include <sys/param.h> // defines PAGESIZE
class VMMClient {
public:
    struct VMPage { // ...
           };
    int check_pagesize() {
    static_assert(sizeof(VMPage) == PAGESIZE,
        "Struct VMPage must be the same size as a system virtual memory page.");
    // ...
    }
// ...
};

另请参阅

断言和用户提供的消息 (C++)
#error 指令 (C/C++)
assert 宏、_assert、_wassert
模板
ASCII 字符集
声明和定义