引言
在阅读开源项目源代码是,发现了一个有趣且特殊的C++特性:属性。
属性(attribute specifier sequences)是在C++11标准引入的。在C++11之前,编译器特有的扩展被广泛用来提供额外的代码信息。例如,GNU编译器(GCC)使用__attribute__
来控制函数的行为。但是缺点也很明显,那就是这种方式缺乏标准化,不同编译器的特性并不兼容,严重影响了代码的可移植性。
为了解决这一问题,C++11标准引入了属性,提供一种标准化的方法来给编译器额外的信息。属性既可以应用于类型声明,也可以应用于声明语句、定义、代码块等,为编译器提供了关于编码意图的附加信息。
属性的作用
属性引入C++后,提供了以下几个方面的价值:
-
可移植性:提供了一种标准的方式来传达编译器特定的信息,减少了依赖特定编译器扩展的需要。
-
可读性:通过标准的属性,代码的特定行为和意图被清晰地表达,易于他人理解。
-
健壮性:属性可以帮助检测潜在的错误,如忽略了重要的函数返回值。
-
性能:许多属性可以帮助编译器进行优化,提高程序性能。
常见属性
以下是C++中一些常用的属性:
-
[[noreturn]]
- 表明函数不会返回到调用者。这通常用于那些通过抛出异常或终止程序来退出的函数。 -
[[nodiscard]]
- 用于函数或类型,标明调用者不应忽略返回值。对于类型,它表示该类型的对象或其构造函数返回的对象不应被忽略。 -
[[deprecated]]
- 标记某个实体(如函数、类、类型别名、变量等)为过时的,建议不要使用。可选地,可以提供一条消息说明替代的使用方式。 -
[[fallthrough]]
- 在C++17中引入,用于switch语句的case节中,明确表示允许控制流从当前case分支无条件跳转到下一个case分支的行为,避免编译器生成可能的警告。 -
[[maybe_unused]]
- 表示某个实体(如函数、类、变量等)可能不会被使用,从而防止编译器发出未使用警告。 -
[[likely]]
和[[unlikely]]
- 这两个属性是在C++20中引入的,用来显式地指示给定的布尔表达式结果的可能性。[[likely]]
表示表达式结果为true的可能性更高,而[[unlikely]]
表示结果为false的可能性更高。 -
[[no_unique_address]]
- 在C++20中引入,它指示类成员不必拥有唯一的地址,允许空基优化或类似的优化技术。
这些属性可以用来改善代码的文档化、提高性能、帮助编译器检查错误和警告,以及启用或禁用特定的编译器行为。
它们是现代C++编程中代码质量和维护方面的重要工具。不同的编译器可能对属性的支持程度有所不同。
常用属性示例
[[noreturn]]
[[noreturn]]
属性指示某个函数不会返回到调用者。这通常用于那些通过抛出异常或终止程序来退出的函数。
[[noreturn]] void terminate_program() {// ... 清理操作 ...std::exit(1); // std::exit不返回
}
[[nodiscard]]
[[nodiscard]]
属性用于函数或类型,标明调用者不应忽略返回值。这有助于防止编码中的错误,例如忘记处理函数返回的错误代码。
[[nodiscard]] int compute() {// ... 计算操作 ...return result;
}void example() {compute(); // 如果忽略了结果,编译器可能会警告
}
C++20对nodiscard进行了扩展,支持注明原因。格式为:[[nodiscard(“reason”)]]
[[deprecated]]
[[deprecated]]
属性用于标记过时的实体。
[[deprecated("Use new_function instead")]]
void old_function() {// ...
}void example() {old_function(); // 使用这个函数时,编译器会给出警告
}
[[fallthrough]]
[[fallthrough]]
属性用在switch
语句中,表示有意识的case穿透。
void example(int val) {switch (val) {case 1:// 计算某些事情[[fallthrough]]; // 明确表明穿透是有意为之case 2:// 1和2执行相同的代码break;default:// 其他值处理break;}
}
[[maybe_unused]]
[[maybe_unused]]
属性用于可能不使用的变量或函数,防止编译器发出未使用警告。
[[maybe_unused]] static bool is_debug = true;void example() {[[maybe_unused]] int local_variable = compute();
}
[[likely]] 和 [[unlikely]]
[[likely]]
和[[unlikely]]
在C++20中引入,帮助编译器优化分支预测。
bool condition = /* ... */;
if ([[likely]] condition) {// 大多数情况下,条件为真时的代码
} else {// 条件为假时的代码
}
其他不常用的属性介绍
[[carries_dependency]] (C++11)
[[carries_dependency]]
属性用来指示在函数参数或返回值中的依赖关系链可以传递,这在使用std::memory_order
时或在多线程编程中非常重要。
#include <atomic>
#include <iostream>std::atomic<int> global_data;// 该函数表明参数和返回值带有依赖关系链
[[carries_dependency]] int load_data(std::atomic<int>& data) {return data.load(std::memory_order_consume);
}void process_data() {// 从全局数据载入的依赖关系被保留int local_data = load_data(global_data);// 接下来的操作可以依赖于这个顺序
}
[[no_unique_address]] (C++20)
[[no_unique_address]]
属性表示非静态数据成员不必具有唯一的地址,这允许编译器在可能的情况下进行内存优化。在C++中,即使是完全空的类(不含任何成员变量或成员函数)也至少会占用1字节的大小,这是为了确保每个对象都有一个唯一的地址。但是,有时候这个额外的1字节并不是必须的,例如当空类作为其他类的成员时,这在包含多个空类成员的大型结构体中可以节省大量内存。
struct Empty {}; // empty classstruct X
{int i;Empty e;
};struct Y
{int i;[[no_unique_address]] Empty e;
};int main()
{// the size of any object of empty class type is at least 1static_assert(sizeof(Empty) >= 1); // at least one more byte is needed to give e a unique addressstatic_assert(sizeof(X) >= sizeof(int) + 1); static_assert(sizeof(Y) == sizeof(int));
}
[[assume(expression)]] (C++23)
[[assume(expression)]]
属性告诉编译器,在给定的点上,表达式总是评估为真。这有助于编译器进行优化。
void process_data(int* ptr) {// 告诉编译器ptr不为nullptr,这有助于优化[[assume(ptr != nullptr)]]*ptr = 42;
}
[[indeterminate]] (C++26)
[[indeterminate]]
属性是一个假设的属性,用来指明一个对象如果没有被初始化,则具有不确定的值。由于C++26还目前还未发布,暂时用不了。
void f(int);
void g()
{int x [[indeterminate]]; // indeterminate valueint y; // erroneous valuef(x); // 允许编译通过,但是具有不确定的行为f(y); // 编译报错,不允许使用未初始化的值
}
[[optimize_for_synchronized]] (TM TS)
[[optimize_for_synchronized]]
属性来自事务性内存技术规范(TM TS),它建议函数应该为同步块中的调用进行优化。TM TS不是ISO C++标准的一部分,支持度因编译器而异。
// 这个属性建议函数在同步块中调用时应该进行优化
[[optimize_for_synchronized]] void synchronized_function() {// 在同步语句中频繁调用的函数
}
结语
笔者最喜欢的C++属性就是[[nodiscard]]了,计划今天就在团队中推广开。因为许多开发者在调用一些可能失败的函数不检查返回值,导致代码鲁棒性较低。给一些重要函数加上[[nodiscard]]属性之后,编译器就能避免这种情况的发生,真是太有用了。试了一下,MSVC下nodiscard会出现警告,还好我们开了警告视为错误,那么就可以确保开发者不会忘记处理返回值了。
如果向了解更多关于C++属性的知识,那么可以来cppreference看看。cppreference的C++的属性参考:Attribute specifier sequence(since C++11)