static_assert 声明 (自 C++11 起)

 

C++

编译器支持

独立和宿主式

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

C++ 语言

通用主题
预处理器 注释	关键字 转义序列
流程控制
条件执行语句
if	switch
迭代语句（循环）
for 范围 for (C++11)	while do-while
跳转语句
continue - break	goto - return
函数
函数声明
Lambda 函数表达式
inline 说明符
动态异常规范 (直至 C++17*)
noexcept 说明符 (C++11)
异常
throw 表达式 try 块	catch 处理程序
命名空间
命名空间声明	命名空间别名
类型
基本类型 枚举类型 函数类型	类/结构体类型 联合体类型
说明符
const/volatile decltype (C++11) auto (C++11)	constexpr (C++11) consteval (C++20) constinit (C++20)
存储期说明符
初始化
默认初始化 值初始化 零初始化 复制初始化 直接初始化	聚合初始化 列表初始化 (C++11)   常量初始化 引用初始化

表达式
值类别 求值顺序	运算符 运算符优先级
替用表示
字面量
布尔 - 整型 - 浮点
字符 - 字符串 - nullptr (C++11)
用户定义 (C++11)
实用工具
属性 (C++11)
类型
typedef 声明
类型别名声明 (C++11)
转型
隐式转换 static_cast const_cast	显式转换 dynamic_cast reinterpret_cast
内存分配
new 表达式	delete 表达式
类
类声明 构造函数 this 指针	访问说明符 friend 说明符
类特定的函数属性
虚函数 override 说明符 (C++11)   final 说明符 (C++11)	explicit (C++11) static
特殊成员函数
默认构造函数 复制构造函数 移动构造函数 (C++11)	复制赋值 移动赋值 (C++11) 析构函数
模板
类模板 函数模板	模板特化 形参包 (C++11)
杂项
内联汇编	C++ 的历史

 

声明

概述 声明语法 decl-specifier-seq 声明符 冲突声明 说明符 typedef inline virtual 函数说明符 explicit 函数说明符 friend constexpr (C++11) consteval (C++20) constinit (C++20) 存储类说明符 翻译单元局部 (C++20) class/struct union enum decltype (C++11) auto (C++11) alignas (C++11) constvolatile 形参包索引说明符 (C++26)     详述类型说明符 属性 (C++11)

声明符 引用 指针 数组 块声明 简单声明   →结构化绑定声明 (C++17) 别名声明 (C++11) 命名空间别名定义 using 声明 using 指令 static_assert 声明 (C++11) asm 声明 不透明枚举声明 (C++11) 其他声明 命名空间定义 函数声明 类模板声明 函数模板声明 显式模板实例化 (C++11) 显式模板特化 链接规范 属性声明 (C++11) 空声明

 

执行编译时断言检查。

语法

static_assert( bool-constexpr , unevaluated-string )	(1)
static_assert( bool-constexpr )	(2)	(自 C++17 起)
static_assert( bool-constexpr , constant-expression )	(3)	(自 C++26 起)

声明一个静态断言。如果断言失败，则程序是非良构的，并且可能会生成诊断错误消息。

1) 带有固定错误消息的静态断言。

2) 没有错误消息的静态断言。

3) 带有用户生成的错误消息的静态断言。

只有当语法 (1) 不匹配时，才能匹配此语法。

解释

bool-constexpr	-	一个语境转换到 bool 类型的常量表达式。除了到 bool 的非窄化整型转换外，不允许内置转换。 (直至 C++23) 一个语境转换到 bool 的表达式，其中转换是一个常量表达式 (自 C++23 起)
unevaluated-string	-	一个未求值的字符串字面量，将作为错误消息出现
constant-expression	-	一个常量表达式 msg，满足所有以下条件 msg.size() 隐式可转换为 std::size_t。 msg.data() 隐式可转换为 const char*。

static_assert 声明可以出现在命名空间和块作用域（作为块声明）以及类体内部（作为成员声明）。

如果 bool-constexpr 是良构的并且求值为 true，或者在模板定义的上下文中求值并且模板未被实例化，则此声明不起作用。否则，将发出编译时错误，并且用户提供的消息（如果有）将包含在诊断消息中。

用户提供的消息文本按如下方式确定

• 如果消息符合 unevaluated-string 的语法要求，则消息文本是 unevaluated-string 的文本。

否则，给定以下值 设 msg 表示 constant-expression 的值。 设 len 表示 msg.size() 的值，它必须是 转换的常量表达式，类型为 std::size_t。 设 ptr 表示表达式 msg.data()，隐式转换为 const char*。ptr 必须是 核心常量表达式。 消息的文本由 len 个代码单元的序列组成，从 ptr 开始，使用普通字面量编码。对于 [​0​, len) 中的每个整数 i，ptr[i] 必须是 整型常量表达式。

(自 C++26 起)

注解

标准不要求编译器打印错误消息的原文，尽管编译器通常会尽可能地这样做。

由于错误消息必须是字符串字面量，因此它不能包含动态信息，甚至不能包含不是字符串字面量本身的常量表达式。特别是，它不能包含模板类型实参的名称。

(直至 C++26)

特性测试宏	值	标准	特性
__cpp_static_assert	200410L	(C++11)	static_assert (语法 (1))
	201411L	(C++17)	单参数 static_assert (语法 (2))
	202306L	(C++26)	用户生成的错误消息 (语法 (3))

关键词

static_assert

示例

运行此代码

#include <format>
#include <type_traits>
 
static_assert(03301 == 1729); // since C++17 the message string is optional
 
template<class T>
void swap(T& a, T& b) noexcept
{
    static_assert(std::is_copy_constructible_v<T>,
                  "Swap requires copying");
    static_assert(std::is_nothrow_copy_constructible_v<T> &&
                  std::is_nothrow_copy_assignable_v<T>,
                  "Swap requires nothrow copy/assign");
    auto c = b;
    b = a;
    a = c;
}
 
template<class T>
struct data_structure
{
    static_assert(std::is_default_constructible_v<T>,
                  "Data structure requires default-constructible elements");
};
 
template<class>
constexpr bool dependent_false = false; // workaround before CWG2518/P2593R1
 
template<class T>
struct bad_type
{
    static_assert(dependent_false<T>, "error on instantiation, workaround");
    static_assert(false, "error on instantiation"); // OK because of CWG2518/P2593R1
};
 
struct no_copy
{
    no_copy(const no_copy&) = delete;
    no_copy() = default;
};
 
struct no_default
{
    no_default() = delete;
};
 
#if __cpp_static_assert >= 202306L
// Not real C++ yet (std::format should be constexpr to work):
static_assert(sizeof(int) == 4, std::format("Expected 4, got {}", sizeof(int)));
#endif
 
int main()
{
    int a, b;
    swap(a, b);
 
    no_copy nc_a, nc_b;
    swap(nc_a, nc_b); // 1
 
    [[maybe_unused]] data_structure<int> ds_ok;
    [[maybe_unused]] data_structure<no_default> ds_error; // 2
}

可能的输出

1: error: static assertion failed: Swap requires copying
2: error: static assertion failed: Data structure requires default-constructible elements
3: error: static assertion failed: Expected 4, got 2

缺陷报告

以下行为变更缺陷报告被追溯应用于先前发布的 C++ 标准。

DR	应用于	已发布行为	正确行为
CWG 2039	C++11	仅要求转换前的表达式是常量	转换也必须是 在常量表达式中有效
CWG 2518 (P2593R1)	C++11	未实例化的 static_assert(false, ""); 是非良构的	使其为良构

参考

• C++23 标准 (ISO/IEC 14882:2024)

• 9.1 序言 [dcl.pre] (p: 10)

• C++20 标准 (ISO/IEC 14882:2020)

• 9.1 序言 [dcl.pre] (p: 6)

• C++17 标准 (ISO/IEC 14882:2017)

• 10 声明 [dcl.dcl] (p: 6)

• C++14 标准 (ISO/IEC 14882:2014)

• 7 声明 [dcl.dcl] (p: 4)

• C++11 标准 (ISO/IEC 14882:2011)

• 7 声明 [dcl.dcl] (p: 4)

参见

#error	显示给定的错误消息并使程序成为非良构 (预处理指令)
assert	如果用户指定的条件不为 true，则中止程序。可能会在发布版本中禁用。 (函数宏)
contract_assert 语句 (C++26)	在执行期间验证内部条件
enable_if (C++11)	有条件地从重载解析中移除函数重载或模板特化 (类模板)
类型特性 (C++11)	定义基于编译时模板的接口以查询类型的属性
C 文档 关于 静态断言