`static_assert` 声明 (C++11 起)

进行编译时断言检查。

语法


`static_assert(` 布尔常量表达式 `,` 不求值字符串 `)`	(1)

`static_assert(` 布尔常量表达式 `)`	(2)	(C++17 起)

`static_assert(` 布尔常量表达式 `,` 常量表达式 `)`	(3)	(C++26 起)

声明静态断言。如果断言失败，那么程序非良构，并且可能会生成诊断错误信息。

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

2) 不带错误信息的静态断言。

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

只有在语法 (1) 不匹配的情况下才会匹配该语法。

解释

布尔常量表达式

-

按语境转换到 bool 类型的常量表达式。不允许进行除了到 bool 的非窄化整数转换之外的内建转换。	(C++23 前)
按语境转换到 bool 的表达式，其中转换是常量表达式。	(C++23 起)

不求值字符串

-

作为编译器错误信息的不求值字符串字面量

常量表达式

-

满足以下所有条件的常量表达式 msg：

msg.size() 可以隐式转换到 std::size_t。
msg.data() 可以隐式转换到 const char*。

(C++26 起)

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

如果布尔常量表达式良构并求值为 true，或在模板定义的语境中求值而该模板未被实例化，那么该声明没有效果。否则将发出编译时错误，并且诊断消息中会包含用户提供的错误信息（如果存在）。

按以下方式确定用户提供的错误信息文本：

如果消息匹配不求值字符串的语法要求，那么错误信息文本就是不求值字符串的文本。

否则，给定以下值：

msg 表示常量表达式的值。
len 表示 msg.size() 的值，该表达式必须是 std::size_t 类型的经转换的常量表达式。
ptr 表示隐式转换到 const char* 的表达式 msg.data()。ptr 必须是核心常量表达式。

错误信息文本使用普通字面量编码，它由从 ptr 开始的包含 len 个代码单元的序列组成。对于 [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); // C++17 起可省略消息
 
template <class T>
void swap(T& a, T& b) noexcept
{
    static_assert(std::is_copy_constructible<T>::value,
                  "交换需要可复制");
    static_assert(std::is_nothrow_copy_constructible<T>::value
               && std::is_nothrow_copy_assignable<T>::value,
                  "交换需要可复制及可赋值，且无异常抛出");
    auto c = b;
    b = a;
    a = c;
}
 
template<class T>
struct data_structure
{
    static_assert(std::is_default_constructible<T>::value,
                  "数据结构要求元素可默认构造");
};
 
template<class>
constexpr bool dependent_false = false; // CWG2518/P2593R1 前的变通方法
 
template<class T>
struct bad_type
{
    static_assert(dependent_false<T>, "实例化时错误，变通方法");
    static_assert(false, "实例化时错误"); // 由于 CWG2518/P2593R1 OK
};
 
struct no_copy
{
    no_copy(const no_copy&) = delete;
    no_copy() = default;
};
 
struct no_default
{
    no_default() = delete;
};
 
#if __cpp_static_assert >= 202306L
// C++ 目前还不能真正使下面这句工作（需要 std::format 为 constexpr）：
static_assert(sizeof(long) == 4, std::format("期待 4，得到 {}", sizeof(long)));
#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：错误：静态断言失败：交换需要可复制
2：错误：静态断言失败：数据结构要求元素可默认构造
3：错误：静态断言失败：期待 4，得到 8

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告	应用于	出版时的行为	正确行为
CWG 2039	C++11	只要求转换前的表达式是常量	转换本身必须也在常量表达式中合法
CWG 2518 (P2593R1)	C++11	未实例化的 static_assert(false, ""); 会导致错误	使之良构

引用

C++23 标准（ISO/IEC 14882:2024）：

9.1 Preamble [dcl.pre]（第 10 页）

C++20 标准（ISO/IEC 14882:2020）：

9.1 Preamble [dcl.pre]（第 6 页）

C++17 标准（ISO/IEC 14882:2017）：

10 Declarations [dcl.dcl]（第 6 页）

C++14 标准（ISO/IEC 14882:2014）：

7 Declarations [dcl.dcl]（第 4 页）

C++11 标准（ISO/IEC 14882:2011）：

7 Declarations [dcl.dcl]（第 4 页）

参阅

#error	显示给定的错误信息并使程序非良构 (预处理指令)
assert	若用户指定的条件非 true 则中断程序。可以在发行构建中禁用。 (宏函数)
enable_if (C++11)	条件性地从重载决议移除函数重载或模板特化 (类模板)
类型特性 (C++11)	定义编译时基于模板的接口，以查询类型的属性。

编译器支持
自立实现与有宿主实现
语言
标准库
标准库标头
具名要求
功能特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用工具库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
技术规范
符号索引
外部库

static_assert 声明 (C++11 起)

语法

解释

注解

关键词

示例

缺陷报告

引用

参阅

导航

`static_assert` 声明 (C++11 起)