华为C++编程规范
Categories:
- 华为C++编程规范
C++语言编程规范
目的
规则并不是完美的,通过禁止在特定情况下有用的特性,可能会对代码实现造成影响。但是我们制定规则的目的“为了大多数程序员可以得到更多的好处”, 如果在团队运作中认为某个规则无法遵循,希望可以共同改进该规则。 参考该规范之前,希望您具有相应的C++语言基础能力,而不是通过该文档来学习C++语言。
- 了解C++语言的ISO标准;
- 熟知C++语言的基本语言特性,包括C++ 03/11/14/17相关特性;
- 了解C++语言的标准库;
总体原则
代码需要在保证功能正确的前提下,满足可读、可维护、安全、可靠、可测试、高效、可移植的特征要求。
重点关注
- 约定C++语言的编程风格,比如命名,排版等。
- C++语言的模块化设计,如何设计头文件,类,接口和函数。
- C++语言相关特性的优秀实践,比如常量,类型转换,资源管理,模板等。
- 现代C++语言的优秀实践,包括C++11/14/17中可以提高代码可维护性,提高代码可靠性的相关约定。
- 本规范优先适于用C++17版本。
约定
规则:编程时必须遵守的约定(must)
建议:编程时应该遵守的约定(should)
本规范适用通用C++标准, 如果没有特定的标准版本,适用所有的版本(C++03/11/14/17)。
例外
无论是’规则’还是’建议’,都必须理解该条目这么规定的原因,并努力遵守。 但是,有些规则和建议可能会有例外。
在不违背总体原则,经过充分考虑,有充足的理由的前提下,可以适当违背规范中约定。 例外破坏了代码的一致性,请尽量避免。‘规则’的例外应该是极少的。
下列情况,应风格一致性原则优先: 修改外部开源代码、第三方代码时,应该遵守开源代码、第三方代码已有规范,保持风格统一。
2 命名
通用命名
驼峰风格(CamelCase) 大小写字母混用,单词连在一起,不同单词间通过单词首字母大写来分开。 按连接后的首字母是否大写,又分: 大驼峰(UpperCamelCase)和小驼峰(lowerCamelCase)
| 类型 | 命名风格 |
|---|---|
| 类类型,结构体类型,枚举类型,联合体类型等类型定义, 作用域名称 | 大驼峰 |
| 函数(包括全局函数,作用域函数,成员函数) | 大驼峰 |
| 全局变量(包括全局和命名空间域下的变量,类静态变量),局部变量,函数参数,类、结构体和联合体中的成员变量 | 小驼峰 |
| 宏,常量(const),枚举值,goto 标签 | 全大写,下划线分割 |
注意: 上表中__常量__是指全局作用域、namespace域、类的静态成员域下,以 const或constexpr 修饰的基本数据类型、枚举、字符串类型的变量,不包括数组和其他类型变量。 上表中__变量__是指除常量定义以外的其他变量,均使用小驼峰风格。
文件命名
规则2.2.1 C++文件以.cpp结尾,头文件以.h结尾
我们推荐使用.h作为头文件的后缀,这样头文件可以直接兼容C和C++。 我们推荐使用.cpp作为实现文件的后缀,这样可以直接区分C++代码,而不是C代码。
目前业界还有一些其他的后缀的表示方法:
- 头文件: .hh, .hpp, .hxx
- cpp文件:.cc, .cxx, .c
如果当前项目组使用了某种特定的后缀,那么可以继续使用,但是请保持风格统一。 但是对于本文档,我们默认使用.h和.cpp作为后缀。
规则2.2.2 C++文件名和类名保持一致
C++的头文件和cpp文件名和类名保持一致,使用下划线小写风格。
如果有一个类叫DatabaseConnection,那么对应的文件名:
- database_connection.h
- database_connection.cpp
结构体,命名空间,枚举等定义的文件名类似。
函数命名
函数命名统一使用大驼峰风格,一般采用动词或者动宾结构。
class List {
public:
void AddElement(const Element& element);
Element GetElement(const unsigned int index) const;
bool IsEmpty() const;
};
namespace Utils {
void DeleteUser();
}
类型命名
类型命名采用大驼峰命名风格。 所有类型命名——类、结构体、联合体、类型定义(typedef)、枚举——使用相同约定,例如:
// classes, structs and unions
class UrlTable { ...
class UrlTableTester { ...
struct UrlTableProperties { ...
union Packet { ...
// typedefs
typedef std::map<std::string, UrlTableProperties*> PropertiesMap;
// enums
enum UrlTableErrors { ...
对于命名空间的命名,建议使用大驼峰:
// namespace
namespace OsUtils {
namespace FileUtils {
}
}
建议2.4.1 避免滥用 typedef或者#define 对基本类型起别名
除有明确的必要性,否则不要用 typedef/#define 对基本数据类型进行重定义。
优先使用<cstdint>头文件中的基本类型:
| 有符号类型 | 无符号类型 | 描述 |
|---|---|---|
| int8_t | uint8_t | 宽度恰为8的有/无符号整数类型 |
| int16_t | uint16_t | 宽度恰为16的有/无符号整数类型 |
| int32_t | uint32_t | 宽度恰为32的有/无符号整数类型 |
| int64_t | uint64_t | 宽度恰为64的有/无符号整数类型 |
| intptr_t | uintptr_t | 足以保存指针的有/无符号整数类型 |
变量命名
通用变量命名采用小驼峰,包括全局变量,函数形参,局部变量,成员变量。
std::string tableName; // Good: 推荐此风格
std::string tablename; // Bad: 禁止此风格
std::string path; // Good: 只有一个单词时,小驼峰为全小写
规则2.5.1 全局变量应增加 ‘g_’ 前缀,静态变量命名不需要加特殊前缀
全局变量是应当尽量少使用的,使用时应特别注意,所以加上前缀用于视觉上的突出,促使开发人员对这些变量的使用更加小心。
- 全局静态变量命名与全局变量相同。
- 函数内的静态变量命名与普通局部变量相同。
- 类的静态成员变量和普通成员变量相同。
int g_activeConnectCount;
void Func()
{
static int packetCount = 0;
...
}
规则2.5.2 类的成员变量命名以小驼峰加后下划线组成
class Foo {
private:
std::string fileName_; // 添加_后缀,类似于K&R命名风格
};
对于struct/union的成员变量,仍采用小驼峰不加后缀的命名方式,与局部变量命名风格一致。
宏、常量、枚举命名
宏、枚举值采用全大写,下划线连接的格式。 全局作用域内,有名和匿名namespace内的 const 常量,类的静态成员常量,全大写,下划线连接;函数局部 const 常量和类的普通const成员变量,使用小驼峰命名风格。
#define MAX(a, b) (((a) < (b)) ? (b) : (a)) // 仅对宏命名举例,并不推荐用宏实现此类功能
enum TintColor { // 注意,枚举类型名用大驼峰,其下面的取值是全大写,下划线相连
RED,
DARK_RED,
GREEN,
LIGHT_GREEN
};
int Func(...)
{
const unsigned int bufferSize = 100; // 函数局部常量
char *p = new char[bufferSize];
...
}
namespace Utils {
const unsigned int DEFAULT_FILE_SIZE_KB = 200; // 全局常量
}
3 格式
行宽
规则3.1.1 行宽不超过 120 个字符
建议每行字符数不要超过 120 个。如果超过120个字符,请选择合理的方式进行换行。
例外:
- 如果一行注释包含了超过120 个字符的命令或URL,则可以保持一行,以方便复制、粘贴和通过grep查找;
- 包含长路径的 #include 语句可以超出120 个字符,但是也需要尽量避免;
- 编译预处理中的error信息可以超出一行。 预处理的 error 信息在一行便于阅读和理解,即使超过 120 个字符。
#ifndef XXX_YYY_ZZZ
#error Header aaaa/bbbb/cccc/abc.h must only be included after xxxx/yyyy/zzzz/xyz.h, because xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
#endif
缩进
规则3.2.1 使用空格进行缩进,每次缩进4个空格
只允许使用空格(space)进行缩进,每次缩进为 4 个空格。不允许使用Tab符进行缩进。 当前几乎所有的集成开发环境(IDE)都支持配置将Tab符自动扩展为4空格输入;请配置你的IDE支持使用空格进行缩进。
大括号
规则3.3.1 使用 K&R 缩进风格
K&R风格 换行时,函数(不包括lambda表达式)左大括号另起一行放行首,并独占一行;其他左大括号跟随语句放行末。 右大括号独占一行,除非后面跟着同一语句的剩余部分,如 do 语句中的 while,或者 if 语句的 else/else if,或者逗号、分号。
如:
struct MyType { // 跟随语句放行末,前置1空格
...
};
int Foo(int a)
{ // 函数左大括号独占一行,放行首
if (...) {
...
} else {
...
}
}
推荐这种风格的理由:
- 代码更紧凑;
- 相比另起一行,放行末使代码阅读节奏感上更连续;
- 符合后来语言的习惯,符合业界主流习惯;
- 现代集成开发环境(IDE)都具有代码缩进对齐显示的辅助功能,大括号放在行尾并不会对缩进和范围产生理解上的影响。
对于空函数体,可以将大括号放在同一行:
class MyClass {
public:
MyClass() : value_(0) {}
private:
int value_;
};
函数声明和定义
规则3.4.1 函数声明和定义的返回类型和函数名在同一行;函数参数列表超出行宽时要换行并合理对齐
在声明和定义函数的时候,函数的返回值类型应该和函数名在同一行;如果行宽度允许,函数参数也应该放在一行;否则,函数参数应该换行,并进行合理对齐。 参数列表的左圆括号总是和函数名在同一行,不要单独一行;右圆括号总是跟随最后一个参数。
换行举例:
ReturnType FunctionName(ArgType paramName1, ArgType paramName2) // Good:全在同一行
{
...
}
ReturnType VeryVeryVeryLongFunctionName(ArgType paramName1, // 行宽不满足所有参数,进行换行
ArgType paramName2, // Good:和上一行参数对齐
ArgType paramName3)
{
...
}
ReturnType LongFunctionName(ArgType paramName1, ArgType paramName2, // 行宽限制,进行换行
ArgType paramName3, ArgType paramName4, ArgType paramName5) // Good: 换行后 4 空格缩进
{
...
}
ReturnType ReallyReallyReallyReallyLongFunctionName( // 行宽不满足第1个参数,直接换行
ArgType paramName1, ArgType paramName2, ArgType paramName3) // Good: 换行后 4 空格缩进
{
...
}
函数调用
规则3.5.1 函数调用入参列表应放在一行,超出行宽换行时,保持参数进行合理对齐
函数调用时,函数参数列表放在一行。参数列表如果超过行宽,需要换行并进行合理的参数对齐。 左圆括号总是跟函数名,右圆括号总是跟最后一个参数。
换行举例:
ReturnType result = FunctionName(paramName1, paramName2); // Good:函数参数放在一行
ReturnType result = FunctionName(paramName1,
paramName2, // Good:保持与上方参数对齐
paramName3);
ReturnType result = FunctionName(paramName1, paramName2,
paramName3, paramName4, paramName5); // Good:参数换行,4 空格缩进
ReturnType result = VeryVeryVeryLongFunctionName( // 行宽不满足第1个参数,直接换行
paramName1, paramName2, paramName3); // 换行后,4 空格缩进
如果函数调用的参数存在内在关联性,按照可理解性优先于格式排版要求,对参数进行合理分组换行。
// Good:每行的参数代表一组相关性较强的数据结构,放在一行便于理解
int result = DealWithStructureLikeParams(left.x, left.y, // 表示一组相关参数
right.x, right.y); // 表示另外一组相关参数
if语句
规则3.6.1 if语句必须要使用大括号
我们要求if语句都需要使用大括号,即便只有一条语句。
理由:
- 代码逻辑直观,易读;
- 在已有条件语句代码上增加新代码时不容易出错;
- 对于在if语句中使用函数式宏时,有大括号保护不易出错(如果宏定义时遗漏了大括号)。
if (objectIsNotExist) { // Good:单行条件语句也加大括号
return CreateNewObject();
}
规则3.6.2 禁止 if/else/else if 写在同一行
条件语句中,若有多个分支,应该写在不同行。
如下是正确的写法:
if (someConditions) {
DoSomething();
...
} else { // Good: else 与 if 在不同行
...
}
下面是不符合规范的案例:
if (someConditions) { ... } else { ... } // Bad: else 与 if 在同一行
循环语句
规则3.7.1 循环语句必须使用大括号
和条件表达式类似,我们要求for/while循环语句必须加上大括号,即便循环体是空的,或循环语句只有一条。
for (int i = 0; i < someRange; i++) { // Good: 使用了大括号
DoSomething();
}
while (condition) { } // Good:循环体是空,使用大括号
while (condition) {
continue; // Good:continue 表示空逻辑,使用大括号
}
坏的例子:
for (int i = 0; i < someRange; i++)
DoSomething(); // Bad: 应该加上括号
while (condition); // Bad:使用分号容易让人误解是while语句中的一部分
switch语句
规则3.8.1 switch 语句的 case/default 要缩进一层
switch 语句的缩进风格如下:
switch (var) {
case 0: // Good: 缩进
DoSomething1(); // Good: 缩进
break;
case 1: { // Good: 带大括号格式
DoSomething2();
break;
}
default:
break;
}
switch (var) {
case 0: // Bad: case 未缩进
DoSomething();
break;
default: // Bad: default 未缩进
break;
}
表达式
建议3.9.1 表达式换行要保持换行的一致性,运算符放行末
较长的表达式,不满足行宽要求的时候,需要在适当的地方换行。一般在较低优先级运算符或连接符后面截断,运算符或连接符放在行末。 运算符、连接符放在行末,表示“未结束,后续还有”。 例:
// 假设下面第一行已经不满足行宽要求
if ((currentValue > threshold) && // Good:换行后,逻辑操作符放在行尾
someCondition) {
DoSomething();
...
}
int result = reallyReallyLongVariableName1 + // Good
reallyReallyLongVariableName2;
表达式换行后,注意保持合理对齐,或者4空格缩进。参考下面例子
int sum = longVariableName1 + longVariableName2 + longVariableName3 +
longVariableName4 + longVariableName5 + longVariableName6; // Good: 4空格缩进
int sum = longVariableName1 + longVariableName2 + longVariableName3 +
longVariableName4 + longVariableName5 + longVariableName6; // Good: 保持对齐
变量赋值
规则3.10.1 多个变量定义和赋值语句不允许写在一行
每行只有一个变量初始化的语句,更容易阅读和理解。
int maxCount = 10;
bool isCompleted = false;
下面是不符合规范的示例:
int maxCount = 10; bool isCompleted = false; // Bad:多个变量初始化需要分开放在多行,每行一个变量初始化
int x, y = 0; // Bad:多个变量定义需要分行,每行一个
int pointX;
int pointY;
...
pointX = 1; pointY = 2; // Bad:多个变量赋值语句放同一行
例外:for 循环头、if 初始化语句(C++17)、结构化绑定语句(C++17)中可以声明和初始化多个变量。这些语句中的多个变量声明有较强关联,如果强行分成多行会带来作用域不一致,声明和初始化割裂等问题。
初始化
初始化包括结构体、联合体、及数组的初始化
规则3.11.1 初始化换行时要有缩进,并进行合理对齐
结构体或数组初始化时,如果换行应保持4空格缩进。 从可读性角度出发,选择换行点和对齐位置。
const int rank[] = {
16, 16, 16, 16, 32, 32, 32, 32,
64, 64, 64, 64, 32, 32, 32, 32
};
指针与引用
建议3.12.1 指针类型"*“跟随变量名或者类型,不要两边都留有或者都没有空格
指针命名: *靠左靠右都可以,但是不要两边都有或者都没有空格。
int* p = nullptr; // Good
int *p = nullptr; // Good
int*p = nullptr; // Bad
int * p = nullptr; // Bad
例外:当变量被 const 修饰时,"*” 无法跟随变量,此时也不要跟随类型。
const char * const VERSION = "V100";
建议3.12.2 引用类型"&“跟随变量名或者类型,不要两边都留有或者都没有空格
引用命名:&靠左靠右都可以,但是不要两边都有或者都没有空格。
int i = 8;
int& p = i; // Good
int &p = i; // Good
int*& rp = pi; // Good,指针的引用,*& 一起跟随类型
int *&rp = pi; // Good,指针的引用,*& 一起跟随变量名
int* &rp = pi; // Good,指针的引用,* 跟随类型,& 跟随变量名
int & p = i; // Bad
int&p = i; // Bad
编译预处理
规则3.13.1 编译预处理的”#“统一放在行首,嵌套编译预处理语句时,”#“可以进行缩进
编译预处理的”#“统一放在行首,即使编译预处理的代码是嵌入在函数体中的,”#“也应该放在行首。
规则3.13.2 避免使用宏
宏会忽略作用域,类型系统以及各种规则,容易引发问题。应尽量避免使用宏定义,如果必须使用宏,要保证证宏名的唯一性。 在C++中,有许多方式来避免使用宏:
- 用const或enum定义易于理解的常量
- 用namespace避免名字冲突
- 用inline函数避免函数调用的开销
- 用template函数来处理多种类型
在文件头保护宏、条件编译、日志记录等必要场景中可以使用宏。
规则3.13.3 禁止使用宏来表示常量
宏是简单的文本替换,在预处理阶段完成,运行报错时直接报相应的值;跟踪调试时也是显示值,而不是宏名; 宏没有类型检查,不安全; 宏没有作用域。
规则3.13.4 禁止使用函数式宏
宏义函数式宏前,应考虑能否用函数替代。对于可替代场景,建议用函数替代宏。 函数式宏的缺点如下:
- 函数式宏缺乏类型检查,不如函数调用检查严格
- 宏展开时宏参数不求值,可能会产生非预期结果
- 宏没有独立的作用域
- 宏的技巧性太强,例如#的用法和无处不在的括号,影响可读性
- 在特定场景中必须用编译器对宏的扩展语法,如GCC的statement expression,影响可移植性
- 宏在预编译阶段展开后,在期后编译、链接和调试时都不可见;而且包含多行的宏会展开为一行。函数式宏难以调试、难以打断点,不利于定位问题
- 对于包含大量语句的宏,在每个调用点都要展开。如果调用点很多,会造成代码空间的膨胀
函数没有宏的上述缺点。但是,函数相比宏,最大的劣势是执行效率不高(增加函数调用的开销和编译器优化的难度)。 为此,可以在必要时使用内联函数。内联函数跟宏类似,也是在调用点展开。不同之处在于内联函数是在编译时展开。
内联函数兼具函数和宏的优点:
- 内联函数执行严格的类型检查
- 内联函数的参数求值只会进行一次
- 内联函数就地展开,没有函数调用的开销
- 内联函数比函数优化得更好
对于性能要求高的产品代码,可以考虑用内联函数代替函数。
例外: 在日志记录场景中,需要通过函数式宏保持调用点的文件名(FILE)、行号(LINE)等信息。
空格和空行
规则3.14.1 水平空格应该突出关键字和重要信息,避免不必要的留白
水平空格应该突出关键字和重要信息,每行代码尾部不要加空格。总体规则如下:
- if, switch, case, do, while, for等关键字之后加空格;
- 小括号内部的两侧,不要加空格;
- 大括号内部两侧有无空格,左右必须保持一致;
- 一元操作符(& * + ‐ ~ !)之后不要加空格;
- 二元操作符(= + ‐ < > * / % | & ^ <= >= == != )左右两侧加空格
- 三目运算符(? :)符号两侧均需要空格
- 前置和后置的自增、自减(++ –)和变量之间不加空格
- 结构体成员操作符(. ->)前后不加空格
- 逗号(,)前面不加空格,后面增加空格
- 对于模板和类型转换(<>)和类型之间不要添加空格
- 域操作符(::)前后不要添加空格
- 冒号(:)前后根据情况来判断是否要添加空格
常规情况:
void Foo(int b) { // Good:大括号前应该留空格
int i = 0; // Good:变量初始化时,=前后应该有空格,分号前面不要留空格
int buf[BUF_SIZE] = {0}; // Good:大括号内两侧都无空格
函数定义和函数调用:
int result = Foo(arg1,arg2);
^ // Bad: 逗号后面需要增加空格
int result = Foo( arg1, arg2 );
^ ^ // Bad: 函数参数列表的左括号后面不应该有空格,右括号前面不应该有空格
指针和取地址
x = *p; // Good:*操作符和指针p之间不加空格
p = &x; // Good:&操作符和变量x之间不加空格
x = r.y; // Good:通过.访问成员变量时不加空格
x = r->y; // Good:通过->访问成员变量时不加空格
操作符:
x = 0; // Good:赋值操作的=前后都要加空格
x = -5; // Good:负数的符号和数值之前不要加空格
++x; // Good:前置和后置的++/--和变量之间不要加空格
x--;
if (x && !y) // Good:布尔操作符前后要加上空格,!操作和变量之间不要空格
v = w * x + y / z; // Good:二元操作符前后要加空格
v = w * (x + z); // Good:括号内的表达式前后不需要加空格
int a = (x < y) ? x : y; // Good: 三目运算符, ?和:前后需要添加空格
循环和条件语句:
if (condition) { // Good:if关键字和括号之间加空格,括号内条件语句前后不加空格
...
} else { // Good:else关键字和大括号之间加空格
...
}
while (condition) {} // Good:while关键字和括号之间加空格,括号内条件语句前后不加空格
for (int i = 0; i < someRange; ++i) { // Good:for关键字和括号之间加空格,分号之后加空格
...
}
switch (condition) { // Good: switch 关键字后面有1空格
case 0: // Good:case语句条件和冒号之间不加空格
...
break;
...
default:
...
break;
}
模板和转换
// 尖括号(< and >) 不与空格紧邻, < 前没有空格, > 和 ( 之间也没有.
vector<string> x;
y = static_cast<char*>(x);
// 在类型与指针操作符之间留空格也可以, 但要保持一致.
vector<char *> x;
域操作符
std::cout; // Good: 命名空间访问,不要留空格
int MyClass::GetValue() const {} // Good: 对于成员函数定义,不要留空格
冒号
// 添加空格的场景
// Good: 类的派生需要留有空格
class Sub : public Base {
};
// 构造函数初始化列表需要留有空格
MyClass::MyClass(int var) : someVar_(var)
{
DoSomething();
}
// 位域表示也留有空格
struct XX {
char a : 4;
char b : 5;
char c : 4;
};
// 不添加空格的场景
// Good: 对于public:, private:这种类访问权限的冒号不用添加空格
class MyClass {
public:
MyClass(int var);
private:
int someVar_;
};
// 对于switch-case的case和default后面的冒号不用添加空格
switch (value)
{
case 1:
DoSomething();
break;
default:
break;
}
注意:当前的集成开发环境(IDE)可以设置删除行尾的空格,请正确配置。
建议3.14.1 合理安排空行,保持代码紧凑
减少不必要的空行,可以显示更多的代码,方便代码阅读。下面有一些建议遵守的规则:
- 根据上下内容的相关程度,合理安排空行;
- 函数内部、类型定义内部、宏内部、初始化表达式内部,不使用连续空行
- 不使用连续 3 个空行,或更多
- 大括号内的代码块行首之前和行尾之后不要加空行,但namespace的大括号内不作要求。
int Foo()
{
...
}
int Bar() // Bad:最多使用连续2个空行。
{
...
}
if (...) {
// Bad:大括号内的代码块行首不要加入空行
...
// Bad:大括号内的代码块行尾不要加入空行
}
int Foo(...)
{
// Bad:函数体内行首不要加空行
...
}
类
规则3.15.1 类访问控制块的声明依次序是 public:, protected:, private:,缩进和 class 关键字对齐
class MyClass : public BaseClass {
public: // 注意没有缩进
MyClass(); // 标准的4空格缩进
explicit MyClass(int var);
~MyClass() {}
void SomeFunction();
void SomeFunctionThatDoesNothing()
{
}
void SetVar(int var) { someVar_ = var; }
int GetVar() const { return someVar_; }
private:
bool SomeInternalFunction();
int someVar_;
int someOtherVar_;
};
在各个部分中,建议将类似的声明放在一起, 并且建议以如下的顺序: 类型 (包括 typedef, using 和嵌套的结构体与类), 常量, 工厂函数, 构造函数, 赋值运算符, 析构函数, 其它成员函数, 数据成员。
规则3.15.2 构造函数初始化列表放在同一行或按四格缩进并排多行
// 如果所有变量能放在同一行:
MyClass::MyClass(int var) : someVar_(var)
{
DoSomething();
}
// 如果不能放在同一行,
// 必须置于冒号后, 并缩进4个空格
MyClass::MyClass(int var)
: someVar_(var), someOtherVar_(var + 1) // Good: 逗号后面留有空格
{
DoSomething();
}
// 如果初始化列表需要置于多行, 需要逐行对齐
MyClass::MyClass(int var)
: someVar_(var), // 缩进4个空格
someOtherVar_(var + 1)
{
DoSomething();
}
4 注释
一般的,尽量通过清晰的架构逻辑,好的符号命名来提高代码可读性;需要的时候,才辅以注释说明。 注释是为了帮助阅读者快速读懂代码,所以要从读者的角度出发,按需注释。
注释内容要简洁、明了、无二义性,信息全面且不冗余。
注释跟代码一样重要。 写注释时要换位思考,用注释去表达此时读者真正需要的信息。在代码的功能、意图层次上进行注释,即注释解释代码难以表达的意图,不要重复代码信息。 修改代码时,也要保证其相关注释的一致性。只改代码,不改注释是一种不文明行为,破坏了代码与注释的一致性,让阅读者迷惑、费解,甚至误解。
使用英文进行注释。
注释风格
在 C++ 代码中,使用 /* */和 // 都是可以的。
按注释的目的和位置,注释可分为不同的类型,如文件头注释、函数头注释、代码注释等等;
同一类型的注释应该保持统一的风格。
注意:本文示例代码中,大量使用 ‘//’ 后置注释只是为了更精确的描述问题,并不代表这种注释风格更好。
文件头注释
规则3.1 文件头注释必须包含版权许可
/*
- Copyright (c) 2020 XXX
- Licensed under the Apache License, Version 2.0 (the “License”);
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at *
-
http://www.apache.org/licenses/LICENSE-2.0
*
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an “AS IS” BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License. */
函数头注释
规则4.3.1 公有(public)函数必须编写函数头注释
公有函数属于类对外提供的接口,调用者需要了解函数的功能、参数的取值范围、返回的结果、注意事项等信息才能正常使用。 特别是参数的取值范围、返回的结果、注意事项等都无法做到自注示,需要编写函数头注释辅助说明。
规则4.3.2 禁止空有格式的函数头注释
并不是所有的函数都需要函数头注释; 函数签名无法表达的信息,加函数头注释辅助说明;
函数头注释统一放在函数声明或定义上方,使用如下风格之一:
使用//写函数头
// 单行函数头
int Func1(void);
// 多行函数头
// 第二行
int Func2(void);
使用/* */写函数头
/* 单行函数头 */
int Func1(void);
/*
* 另一种单行函数头
*/
int Func2(void);
/*
* 多行函数头
* 第二行
*/
int Func3(void);
函数尽量通过函数名自注释,按需写函数头注释。 不要写无用、信息冗余的函数头;不要写空有格式的函数头。
函数头注释内容可选,但不限于:功能说明、返回值,性能约束、用法、内存约定、算法实现、可重入的要求等等。 模块对外头文件中的函数接口声明,其函数头注释,应当将重要、有用的信息表达清楚。
例:
/*
* 返回实际写入的字节数,-1表示写入失败
* 注意,内存 buf 由调用者负责释放
*/
int WriteString(const char *buf, int len);
坏的例子:
/*
* 函数名:WriteString
* 功能:写入字符串
* 参数:
* 返回值:
*/
int WriteString(const char *buf, int len);
上面例子中的问题:
- 参数、返回值,空有格式没内容
- 函数名信息冗余
- 关键的 buf 由谁释放没有说清楚
代码注释
规则4.4.1 代码注释放于对应代码的上方或右边
规则4.4.2 注释符与注释内容间要有1空格;右置注释与前面代码至少1空格
代码上方的注释,应该保持对应代码一样的缩进。
选择并统一使用如下风格之一:
使用//
// 这是单行注释
DoSomething();
// 这是多行注释
// 第二行
DoSomething();
使用/*' '*/
/* 这是单行注释 */
DoSomething();
/*
* 另一种方式的多行注释
* 第二行
*/
DoSomething();
代码右边的注释,与代码之间,至少留1空格,建议不超过4空格。 通常使用扩展后的 TAB 键即可实现 1-4 空格的缩进。
选择并统一使用如下风格之一:
int foo = 100; // 放右边的注释
int bar = 200; /* 放右边的注释 */
右置格式在适当的时候,上下对齐会更美观。 对齐后的注释,离左边代码最近的那一行,保证1-4空格的间隔。 例:
const int A_CONST = 100; /* 相关的同类注释,可以考虑上下对齐 */
const int ANOTHER_CONST = 200; /* 上下对齐时,与左侧代码保持间隔 */
当右置的注释超过行宽时,请考虑将注释置于代码上方。
规则4.4.3 不用的代码段直接删除,不要注释掉
被注释掉的代码,无法被正常维护;当企图恢复使用这段代码时,极有可能引入易被忽略的缺陷。 正确的做法是,不需要的代码直接删除掉。若再需要时,考虑移植或重写这段代码。
这里说的注释掉代码,包括用 /* */ 和 //,还包括 #if 0, #ifdef NEVER_DEFINED 等等。
5 头文件
头文件职责
头文件是模块或文件的对外接口,头文件的设计体现了大部分的系统设计。 头文件中适合放置接口的声明,不适合放置实现(内联函数除外)。对于cpp文件中内部才需要使用的函数、宏、枚举、结构定义等不要放在头文件中。 头文件应当职责单一。头文件过于复杂,依赖过于复杂还是导致编译时间过长的主要原因。
建议5.1.1 每一个.cpp文件应有一个对应的.h文件,用于声明需要对外公开的类与接口
通常情况下,每个.cpp文件都有一个相应的.h,用于放置对外提供的函数声明、宏定义、类型定义等。 如果一个.cpp文件不需要对外公布任何接口,则其就不应当存在。 例外:程序的入口(如main函数所在的文件),单元测试代码,动态库代码。
示例:
// Foo.h
#ifndef FOO_H
#define FOO_H
class Foo {
public:
Foo();
void Fun();
private:
int value_;
};
#endif
// Foo.cpp
#include "Foo.h"
namespace { // Good: 对内函数的声明放在.cpp文件的头部,并声明为匿名namespace或者static限制其作用域
void Bar()
{
}
}
...
void Foo::Fun()
{
Bar();
}
头文件依赖
规则5.2.1 禁止头文件循环依赖
头文件循环依赖,指 a.h 包含 b.h,b.h 包含 c.h,c.h 包含 a.h, 导致任何一个头文件修改,都导致所有包含了a.h/b.h/c.h的代码全部重新编译一遍。 而如果是单向依赖,如a.h包含b.h,b.h包含c.h,而c.h不包含任何头文件,则修改a.h不会导致包含了b.h/c.h的源代码重新编译。
头文件循环依赖直接体现了架构设计上的不合理,可通过优化架构去避免。
规则5.2.2 头文件必须编写#define保护,防止重复包含
为防止头文件被重复包含,所有头文件都应当使用 #define 保护;不要使用 #pragma once
定义包含保护符时,应该遵守如下规则: 1)保护符使用唯一名称; 2)不要在受保护部分的前后放置代码或者注释,文件头注释除外。
示例:假定timer模块的timer.h,其目录为timer/include/timer.h,应按如下方式保护:
#ifndef TIMER_INCLUDE_TIMER_H
#define TIMER_INCLUDE_TIMER_H
...
#endif
规则5.2.3 禁止通过声明的方式引用外部函数接口、变量
只能通过包含头文件的方式使用其他模块或文件提供的接口。 通过 extern 声明的方式使用外部函数接口、变量,容易在外部接口改变时可能导致声明和定义不一致。 同时这种隐式依赖,容易导致架构腐化。
不符合规范的案例:
// a.cpp内容
extern int Fun(); // Bad: 通过extern的方式使用外部函数
void Bar()
{
int i = Fun();
...
}
// b.cpp内容
int Fun()
{
// Do something
}
应该改为:
// a.cpp内容
#include "b.h" // Good: 通过包含头文件的方式使用其他.cpp提供的接口
void Bar()
{
int i = Fun();
...
}
// b.h内容
int Fun();
// b.cpp内容
int Fun()
{
// Do something
}
例外,有些场景需要引用其内部函数,但并不想侵入代码时,可以 extern 声明方式引用。 如: 针对某一内部函数进行单元测试时,可以通过 extern 声明来引用被测函数; 当需要对某一函数进行打桩、打补丁处理时,允许 extern 声明该函数。
规则5.2.4 禁止在extern “C"中包含头文件
在 extern “C” 中包含头文件,有可能会导致 extern “C” 嵌套,部分编译器对 extern “C” 嵌套层次有限制,嵌套层次太多会编译错误。
在C,C++混合编程的情况下,在extern “C"中包含头文件,可能会导致被包含头文件的原有意图遭到破坏,比如链接规范被不正确地更改。
示例,存在a.h和b.h两个头文件:
// a.h内容
...
#ifdef __cplusplus
void Foo(int);
#define A(value) Foo(value)
#else
void A(int)
#endif
// b.h内容
...
#ifdef __cplusplus
extern "C" {
#endif
#include "a.h"
void B();
#ifdef __cplusplus
}
#endif
使用C++预处理器展开b.h,将会得到
extern "C" {
void Foo(int);
void B();
}
按照 a.h 作者的本意,函数 Foo 是一个 C++ 自由函数,其链接规范为 “C++"。
但在 b.h 中,由于 #include "a.h" 被放到了 extern "C" 的内部,函数 Foo 的链接规范被不正确地更改了。
例外:
如果在 C++ 编译环境中,想引用纯C的头文件,这些C头文件并没有 extern "C" 修饰。非侵入式的做法是,在 extern "C" 中去包含C头文件。
建议5.2.1尽量避免使用前置声明,而是通过#include来包含头文件
前置声明(forward declaration)通常指类、模板的纯粹声明,没伴随着其定义。
- 优点:
- 前置声明能够节省编译时间,多余的 #include 会迫使编译器展开更多的文件,处理更多的输入。
- 前置声明能够节省不必要的重新编译的时间。 #include 使代码因为头文件中无关的改动而被重新编译多次。
- 缺点:
- 前置声明隐藏了依赖关系,头文件改动时,用户的代码会跳过必要的重新编译过程。
- 前置声明可能会被库的后续更改所破坏。前置声明模板有时会妨碍头文件开发者变动其 API. 例如扩大形参类型,加个自带默认参数的模板形参等等。
- 前置声明来自命名空间
std::的 symbol 时,其行为未定义(在C++11标准规范中明确说明)。 - 前置声明了不少来自头文件的 symbol 时,就会比单单一行的 include 冗长。
- 仅仅为了能前置声明而重构代码(比如用指针成员代替对象成员)会使代码变得更慢更复杂。
- 很难判断什么时候该用前置声明,什么时候该用
#include,某些场景下面前置声明和#include互换以后会导致意想不到的结果。
所以我们尽可能避免使用前置声明,而是使用#include头文件来保证依赖关系。
6 作用域
命名空间
建议6.1.1 对于cpp文件中不需要导出的变量,常量或者函数,请使用匿名namespace封装或者用static修饰
在C++ 2003标准规范中,使用static修饰文件作用域的变量,函数等被标记为deprecated特性,所以更推荐使用匿名namespace。
主要原因如下:
- static在C++中已经赋予了太多的含义,静态函数成员变量,静态成员函数,静态全局变量,静态函数局部变量,每一种都有特殊的处理。
- static只能保证变量,常量和函数的文件作用域,但是namespace还可以封装类型等。
- 统一namespace来处理C++的作用域,而不需要同时使用static和namespace来管理。
- static修饰的函数不能用来实例化模板,而匿名namespace可以。
但是不要在 .h 中使用中使用匿名namespace或者static。
// Foo.cpp
namespace {
const int MAX_COUNT = 20;
void InternalFun() {};
}
void Foo::Fun()
{
int i = MAX_COUNT;
InternalFun();
}
规则6.1.1 不要在头文件中或者#include之前使用using导入命名空间
说明:使用using导入命名空间会影响后续代码,易造成符号冲突,所以不要在头文件以及源文件中的#include之前使用using导入命名空间。 示例:
// 头文件a.h
namespace NamespaceA {
int Fun(int);
}
// 头文件b.h
namespace NamespaceB {
int Fun(int);
}
using namespace NamespaceB;
void G()
{
Fun(1);
}
// 源代码a.cpp
#include "a.h"
using namespace NamespaceA;
#include "b.h"
void main()
{
G(); // using namespace NamespaceA在#include “b.h”之前,引发歧义:NamespaceA::Fun,NamespaceB::Fun调用不明确
}
对于在头文件中使用using导入单个符号或定义别名,允许在模块自定义名字空间中使用,但禁止在全局名字空间中使用。
// foo.h
#include <fancy/string>
using fancy::string; // Bad,禁止向全局名字空间导入符号
namespace Foo {
using fancy::string; // Good,可以在模块自定义名字空间中导入符号
using MyVector = fancy::vector<int>; // Good,C++11可在自定义名字空间中定义别名
}
全局函数和静态成员函数
建议6.2.1 优先使用命名空间来管理全局函数,如果和某个class有直接关系的,可以使用静态成员函数
说明:非成员函数放在名字空间内可避免污染全局作用域, 也不要用类+静态成员方法来简单管理全局函数。 如果某个全局函数和某个类有紧密联系, 那么可以作为类的静态成员函数。
如果你需要定义一些全局函数,给某个cpp文件使用,那么请使用匿名namespace来管理。
namespace MyNamespace {
int Add(int a, int b);
}
class File {
public:
static File CreateTempFile(const std::string& fileName);
};
全局常量和静态成员常量
建议6.3.1 优先使用命名空间来管理全局常量,如果和某个class有直接关系的,可以使用静态成员常量
说明:全局常量放在命名空间内可避免污染全局作用域, 也不要用类+静态成员常量来简单管理全局常量。 如果某个全局常量和某个类有紧密联系, 那么可以作为类的静态成员常量。
如果你需要定义一些全局常量,只给某个cpp文件使用,那么请使用匿名namespace来管理。
namespace MyNamespace {
const int MAX_SIZE = 100;
}
class File {
public:
static const std::string SEPARATOR;
};
全局变量
建议6.4.1 尽量避免使用全局变量,考虑使用单例模式
说明:全局变量是可以修改和读取的,那么这样会导致业务代码和这个全局变量产生数据耦合。
int g_counter = 0;
// a.cpp
g_counter++;
// b.cpp
g_counter++;
// c.cpp
cout << g_counter << endl;
使用单实例模式
class Counter {
public:
static Counter& GetInstance()
{
static Counter counter;
return counter;
} // 单实例实现简单举例
void Increase()
{
value_++;
}
void Print() const
{
std::cout << value_ << std::endl;
}
private:
Counter() : value_(0) {}
private:
int value_;
};
// a.cpp
Counter::GetInstance().Increase();
// b.cpp
Counter::GetInstance().Increase();
// c.cpp
Counter::GetInstance().Print();
实现单例模式以后,实现了全局唯一一个实例,和全局变量同样的效果,并且单实例提供了更好的封装性。
例外:有的时候全局变量的作用域仅仅是模块内部,这样进程空间里面就会有多个全局变量实例,每个模块持有一份,这种场景下是无法使用单例模式解决的。
7 类
构造,拷贝构造,赋值和析构函数
构造,拷贝,移动和析构函数提供了对象的生命周期管理方法:
- 构造函数(constructor):
X() - 拷贝构造函数(copy constructor):
X(const X&) - 拷贝赋值操作符(copy assignment):
operator=(const X&) - 移动构造函数(move constructor):
X(X&&)C++11以后提供 - 移动赋值操作符(move assignment):
operator=(X&&)C++11以后提供 - 析构函数(destructor):
~X()
规则7.1.1 类的成员变量必须显式初始化
说明:如果类有成员变量,没有定义构造函数,又没有定义默认构造函数,编译器将自动生成一个构造函数,但编译器生成的构造函数并不会对成员变量进行初始化,对象状态处于一种不确定性。
例外:
- 如果类的成员变量具有默认构造函数,那么可以不需要显式初始化。
示例:如下代码没有构造函数,私有数据成员无法初始化:
class Message {
public:
void ProcessOutMsg()
{
//…
}
private:
unsigned int msgID_;
unsigned int msgLength_;
unsigned char* msgBuffer_;
std::string someIdentifier_;
};
Message message; // message成员变量没有初始化
message.ProcessOutMsg(); // 后续使用存在隐患
// 因此,有必要定义默认构造函数,如下:
class Message {
public:
Message() : msgID_(0), msgLength_(0), msgBuffer_(nullptr)
{
}
void ProcessOutMsg()
{
// …
}
private:
unsigned int msgID_;
unsigned int msgLength_;
unsigned char* msgBuffer_;
std::string someIdentifier_; // 具有默认构造函数,不需要显式初始化
};
建议7.1.1 成员变量优先使用声明时初始化(C++11)和构造函数初始化列表初始化
说明:C++11的声明时初始化可以一目了然的看出成员初始值,应当优先使用。如果成员初始化值和构造函数相关,或者不支持C++11,则应当优先使用构造函数初始化列表来初始化成员。相比起在构造函数体中对成员赋值,初始化列表的代码更简洁,执行性能更好,而且可以对const成员和引用成员初始化。
class Message {
public:
Message() : msgLength_(0) // Good,优先使用初始化列表
{
msgBuffer_ = nullptr; // Bad,不推荐在构造函数中赋值
}
private:
unsigned int msgID_{0}; // Good,C++11中使用
unsigned int msgLength_;
unsigned char* msgBuffer_;
};
规则7.1.2 为避免隐式转换,将单参数构造函数声明为explicit
说明:单参数构造函数如果没有用explicit声明,则会成为隐式转换函数。 示例:
class Foo {
public:
explicit Foo(const string& name): name_(name)
{
}
private:
string name_;
};
void ProcessFoo(const Foo& foo){}
int main(void)
{
std::string test = "test";
ProcessFoo(test); // 编译不通过
return 0;
}
上面的代码编译不通过,因为ProcessFoo需要的参数是Foo类型,传入的string类型不匹配。
如果将Foo构造函数的explicit关键字移除,那么调用ProcessFoo传入的string就会触发隐式转换,生成一个临时的Foo对象。往往这种隐式转换是让人迷惑的,并且容易隐藏Bug,得到了一个不期望的类型转换。所以对于单参数的构造函数是要求explicit声明。
规则7.1.3 如果不需要拷贝构造函数、赋值操作符 / 移动构造函数、赋值操作符,请明确禁止
说明:如果用户不定义,编译器默认会生成拷贝构造函数和拷贝赋值操作符, 移动构造和移动赋值操作符(移动语义的函数C++11以后才有)。 如果我们不要使用拷贝构造函数,或者赋值操作符,请明确拒绝:
- 将拷贝构造函数或者赋值操作符设置为private,并且不实现:
class Foo {
private:
Foo(const Foo&);
Foo& operator=(const Foo&);
};
-
使用C++11提供的delete, 请参见后面现代C++的相关章节。
-
推荐继承NoCopyable、NoMovable,禁止使用DISALLOW_COPY_AND_MOVE,DISALLOW_COPY,DISALLOW_MOVE等宏。
class Foo : public NoCopyable, public NoMovable {
};
NoCopyable和NoMovable的实现:
class NoCopyable {
public:
NoCopyable() = default;
NoCopyable(const NoCopyable&) = delete;
NoCopyable& operator = (NoCopyable&) = delete;
};
class NoMovable {
public:
NoMovable() = default;
NoMovable(NoMovable&&) noexcept = delete;
NoMovable& operator = (NoMovable&&) noexcept = delete;
};
规则7.1.4 拷贝构造和拷贝赋值操作符应该是成对出现或者禁止
拷贝构造函数和拷贝赋值操作符都是具有拷贝语义的,应该同时出现或者禁止。
// 同时出现
class Foo {
public:
...
Foo(const Foo&);
Foo& operator=(const Foo&);
...
};
// 同时default, C++11支持
class Foo {
public:
Foo(const Foo&) = default;
Foo& operator=(const Foo&) = default;
};
// 同时禁止, C++11可以使用delete
class Foo {
private:
Foo(const Foo&);
Foo& operator=(const Foo&);
};
规则7.1.5 移动构造和移动赋值操作符应该是成对出现或者禁止
在C++11中增加了move操作,如果需要某个类支持移动操作,那么需要实现移动构造和移动赋值操作符。
移动构造函数和移动赋值操作符都是具有移动语义的,应该同时出现或者禁止。
// 同时出现
class Foo {
public:
...
Foo(Foo&&);
Foo& operator=(Foo&&);
...
};
// 同时default, C++11支持
class Foo {
public:
Foo(Foo&&) = default;
Foo& operator=(Foo&&) = default;
};
// 同时禁止, 使用C++11的delete
class Foo {
public:
Foo(Foo&&) = delete;
Foo& operator=(Foo&&) = delete;
};
规则7.1.6 禁止在构造函数和析构函数中调用虚函数
说明:在构造函数和析构函数中调用当前对象的虚函数,会导致未实现多态的行为。 在C++中,一个基类一次只构造一个完整的对象。
示例:类Base是基类,Sub是派生类
class Base {
public:
Base();
virtual void Log() = 0; // 不同的派生类调用不同的日志文件
};
Base::Base() // 基类构造函数
{
Log(); // 调用虚函数Log
}
class Sub : public Base {
public:
virtual void Log();
};
当执行如下语句:
Sub sub;
会先执行Sub的构造函数,但首先调用Base的构造函数,由于Base的构造函数调用虚函数Log,此时Log还是基类的版本,只有基类构造完成后,才会完成派生类的构造,从而导致未实现多态的行为。
同样的道理也适用于析构函数。
规则7.1.7 多态基类中的拷贝构造函数、拷贝赋值操作符、移动构造函数、移动赋值操作符必须为非public函数或者为delete函数
如果报一个派生类对象直接赋值给基类对象,会发生切片,只拷贝或者移动了基类部分,损害了多态行为。 【反例】 如下代码中,基类没有定义拷贝构造函数或拷贝赋值操作符,编译器会自动生成这两个特殊成员函数, 如果派生类对象赋值给基类对象时就发生切片。可以将此例中的拷贝构造函数和拷贝赋值操作符声明为delete,编译器可检查出此类赋值行为。
class Base {
public:
Base() = default;
virtual ~Base() = default;
...
virtual void Fun() { std::cout << "Base" << std::endl;}
};
class Derived : public Base {
...
void Fun() override { std::cout << "Derived" << std::endl; }
};
void Foo(const Base &base)
{
Base other = base; // 不符合:发生切片
other.Fun(); // 调用的时Base类的Fun函数
}
Derived d;
Foo(d); // 传入的是派生类对象
- 将拷贝构造函数或者赋值操作符设置为private,并且不实现:
继承
规则7.2.1 基类的析构函数应该声明为virtual,不准备被继承的类需要声明为final
说明:只有基类析构函数是virtual,通过多态调用的时候才能保证派生类的析构函数被调用。
示例:基类的析构函数没有声明为virtual导致了内存泄漏。
class Base {
public:
virtual std::string getVersion() = 0;
~Base()
{
std::cout << "~Base" << std::endl;
}
};
class Sub : public Base {
public:
Sub() : numbers_(nullptr)
{
}
~Sub()
{
delete[] numbers_;
std::cout << "~Sub" << std::endl;
}
int Init()
{
const size_t numberCount = 100;
numbers_ = new (std::nothrow) int[numberCount];
if (numbers_ == nullptr) {
return -1;
}
...
}
std::string getVersion()
{
return std::string("hello!");
}
private:
int* numbers_;
};
int main(int argc, char* args[])
{
Base* b = new Sub();
delete b;
return 0;
}
Omdat de destructor van de basisklasse Base niet als virtual is gedeclareerd, wordt bij het vernietigen van het object alleen de destructor van de basisklasse aangeroepen en niet de destructor van de afgeleide klasse Sub, wat leidt tot geheugenlekken. Uitzondering: Klassen zoals NoCopyable, NoMovable die geen gedrag hebben en enkel worden gebruikt als identificatie, hoeven geen virtuele destructor of final te definiëren.
Regel 7.2.2 Het is verboden om standaardparameters te gebruiken bij virtuele functies
Toelichting: In C++ worden virtuele functies dynamisch gebonden, maar de standaardparameters van de functie worden statisch gebonden tijdens het compileren. Dit betekent dat je uiteindelijk de functie uitvoert die in de afgeleide klasse is gedefinieerd, maar met de standaardparameterwaarde uit de basisklasse. Om verwarring en problemen te voorkomen die worden veroorzaakt door inconsistente parameterdeclaratie bij het herladen van virtuele functies, is het verboden om standaardparameterwaarden te declareren voor alle virtuele functies. Voorbeeld: de standaardparameterwaarde text van de virtuele functie display wordt bepaald tijdens het compileren, niet tijdens het uitvoeren, waardoor het doel van polymorfisme niet wordt bereikt:
class Base {
public:
virtual void Display(const std::string& text = "Base!")
{
std::cout << text << std::endl;
}
virtual ~Base(){}
};
class Sub : public Base {
public:
virtual void Display(const std::string& text = "Sub!")
{
std::cout << text << std::endl;
}
virtual ~Sub(){}
};
int main()
{
Base* base = new Sub();
Sub* sub = new Sub();
...
base->Display(); // Uitvoer: Base! maar verwachte uitvoer: Sub!
sub->Display(); // Uitvoer: Sub!
delete base;
delete sub;
return 0;
};
Regel 7.2.3 Het is verboden om geërfde niet-virtuele functies opnieuw te definiëren
Toelichting: Omdat niet-virtuele functies geen dynamische binding kunnen realiseren, kan alleen een virtuele functie dynamische binding realiseren: door gebruik te maken van een pointer naar de basisklasse, kan het juiste resultaat worden verkregen.
Voorbeeld:
class Base {
public:
void Fun();
};
class Sub : public Base {
public:
void Fun();
};
Sub* sub = new Sub();
Base* base = sub;
sub->Fun(); // Roept Fun van de subklasse aan
base->Fun(); // Roept Fun van de basisklasse aan
//...
Meervoudige overerving
In de praktische ontwikkeling zijn er weinig scenario’s waarin meervoudige overerving wordt gebruikt, omdat er de volgende typische problemen zijn bij het gebruik van meervoudige overerving:
- De ruitvormige overerving die leidt tot gegevensduplicatie en namen met dubbelzinnigheid. Daarom introduceerde C++ de virtual overerving om dit soort problemen op te lossen;
- Zelfs als het geen ruitvormige overerving is, kunnen de namen van meerdere bovenliggende klassen in conflict zijn, wat leidt tot dubbelzinnigheid;
- Als een subklasse de methoden van meerdere bovenliggende klassen moet uitbreiden of herschrijven, leidt dit tot onduidelijke verantwoordelijkheden van de subklasse en semantische verwarring;
- In vergelijking met delegering is overerving een zogenaamde ‘white-box’ hergebruik, wat betekent dat een subklasse toegang heeft tot de protected leden van de bovenliggende klasse, wat leidt tot een sterkere koppeling. En bij meervoudige overerving, vanwege de koppeling van meerdere bovenliggende klassen, leidt dit in vergelijking met enkele overerving tot een sterkere koppelingsrelatie.
Meervoudige overerving heeft de volgende voordelen: Meervoudige overerving biedt een eenvoudigere manier om meerdere interfaces of klassen samen te voegen en te hergebruiken.
Daarom is het gebruik van meervoudige overerving alleen toegestaan onder de volgende omstandigheden:
Aanbeveling 7.3.1 Gebruik meervoudige overerving om interface-separatie en multi-rolcombinatie te realiseren
Als een bepaalde klasse meerdere interfaces moet implementeren, kunnen via meervoudige overerving meerdere gescheiden interfaces worden samengevoegd, vergelijkbaar met de traits-mixins in scala-taal.
class Role1 {};
class Role2 {};
class Role3 {};
class Object1 : public Role1, public Role2 {
// ...
};
class Object2 : public Role2, public Role3 {
// ...
};
In de C++ standaardbibliotheek zijn er ook vergelijkbare implementatievoorbeelden:
class basic_istream {};
class basic_ostream {};
class basic_iostream : public basic_istream, public basic_ostream {
};
Overbelasting
Er zijn voldoende redenen voor het overbelasten van operatoren, en verander de oorspronkelijke semantiek van de operator niet, bijvoorbeeld gebruik de ‘+’ operator niet voor aftrekken. Operator overbelasting maakt code intuïtiever, maar heeft ook enkele nadelen:
- Verwarring van de intuïtie, men denkt dat de bewerking net zo hoogwaardig is als het ingebouwde type en negeert de mogelijke prestatiedaling;
- Bij het lokaliseren van problemen is het minder intuïtief, het zoeken op functienaam is duidelijker dan het zoeken op operator;
- Als de gedragingen van een overbelaste operator niet intuïtief zijn (bijvoorbeeld de ‘+’ operator gebruiken voor aftrekken), kan dit verwarring in de code veroorzaken.
- De overbelasting van de toewijzingsoperator introduceert impliciete conversies die diepe bugs kunnen verbergen. U kunt functies zoals Equals() of CopyFrom() definiëren om de =, == operatoren te vervangen.
8 Functies
Functie-ontwerp
Regel 8.1.1 Vermijd lange functies, functies mogen niet langer zijn dan 50 regels (niet leeg, geen commentaar)
Functies moeten op één scherm kunnen worden weergegeven (binnen 50 regels), slechts één ding doen en dat goed doen.
Een te lange functie betekent vaak dat de functie niet enkelvoudig is, te complex is of te veel details laat zien zonder verdere abstractie.
Uitzondering: bepaalde functies die algoritmen implementeren, kunnen vanwege de aggregatie en functionaliteit van het algoritme langer zijn dan 50 regels.
Zelfs als een lange functie nu goed werkt, kan iemand die er later wijzigingen in aanbrengt, nieuwe problemen veroorzaken of moeilijk te vinden bugs veroorzaken. We raden aan om deze te splitsen in kortere en makkelijker te beheren functies, zodat anderen de code makkelijker kunnen lezen en wijzigen.
Inline functies
Aanbeveling 8.2.1 Inline functies mogen niet langer zijn dan 10 regels (niet leeg, geen commentaar)
Toelichting: Inline functies hebben de kenmerken van gewone functies, ze verschillen van gewone functies alleen in de verwerking van de functie-aanroep. Bij een gewone functie-aanroep wordt de programmacomputer overgebracht naar de aangeroepen functie, en keert daarna terug naar de functie die het aanriep. Bij een inline functie wordt bij de aanroep de oproepexpressie vervangen door de inline functie body.
Inline functies zijn alleen geschikt voor kleine functies van 1~10 regels. Voor een grote functie met veel instructies is de overhead van functie-aanroep en -retour verwaarloosbaar in vergelijking met de functie zelf, en is het niet nodig om inline functies te gebruiken voor implementatie. De meeste compilers zullen inline functies negeren en gewone functies gebruiken.
Als inline functies complexe controlestructuren bevatten zoals lussen, branches (switch), try-catch instructies, dan beschouwt de compiler de functie meestal als een gewone functie. Virtuele functies en recursieve functies kunnen niet worden gebruikt als inline functies.
Functieparameters
Aanbeveling 8.3.1 Gebruik referenties in plaats van pointers voor functieparameters
Toelichting: Referenties zijn veiliger dan pointers omdat ze altijd niet-lege zijn, nooit naar een ander doel kunnen verwijzen en geen controle op ongeldige NULL-pointers vereisen.
Als u op basis van een oud platform ontwikkelt, geef dan de voorkeur aan de bestaande platformverwerking. Gebruik const om te voorkomen dat parameters worden gewijzigd en om lezers duidelijk te maken dat de parameter niet wordt gewijzigd, wat de leesbaarheid van de code aanzienlijk verbetert.
Uitzondering: Wanneer de ingevoerde parameter een array is waarvan de lengte op compilatie niet bekend is, kan een pointer in plaats van een referentie worden gebruikt.
Aanbeveling 8.3.2 Gebruik sterke typeparameters, vermijd het gebruik van void*
Hoewel verschillende talen hun eigen standpunt hebben over sterke en zwakke typen, wordt algemeen aangenomen dat c/c++ een sterke types taal is. Aangezien we de taal met sterke typen gebruiken, moeten we dergelijke stijl behouden. Het voordeel is dat de compiler in de compilatiefase controleert op type mismatch fouten.
Het gebruik van sterke typen helpt de compiler fouten te ontdekken, zoals in de volgende code let op het gebruik van de functie FooListAddNode:
struct FooNode {
struct List link;
int foo;
};
struct BarNode {
struct List link;
int bar;
}
void FooListAddNode(void *node) // Slecht: hier wordt void * type gebruikt voor parameteroverdracht
{
FooNode *foo = (FooNode *)node;
ListAppend(&g_FooList, &foo->link);
}
void MakeTheList()
{
FooNode *foo = nullptr;
BarNode *bar = nullptr;
...
FooListAddNode(bar); // Fout: Hier bedoelde men foo door te geven, maar per ongeluk bar, en er werd geen fout gemeld
}
- U kunt sjabloonsfuncties gebruiken om parameter type veranderingen te realiseren.
- U kunt base pointer gebruiken om polymorfisme te realiseren.
Aanbeveling 8.3.3 Het aantal functieparameters mag niet meer zijn dan 5
Als het aantal parameters van een functie te groot is, wordt de functie gevoeliger voor externe veranderingen, wat het onderhoud beïnvloedt. Tegelijkertijd verhoogt een groot aantal parameters ook de hoeveelheid werk voor het testen.
Als het aantal parameters meer is dan 5, moet je overwegen:
- Kijken of de functie kan worden gesplitst
- Kijken of gerelateerde parameters kunnen worden samengevoegd en een structuur kunnen definiëren
9 Andere C++ kenmerken
Constanten en initialisatie
Onveranderlijke waarden zijn makkelijker te begrijpen, te volgen en te analyseren, dus moeten constante waarden zoveel mogelijk worden gebruikt in plaats van variabelen. Bij het definiëren van waarden moet const standaard worden genomen.
Regel 9.1.1 Het is niet toegestaan om macro’s te gebruiken om constanten weer te geven
Toelichting: Macro’s zijn eenvoudige tekstvervangingen die tijdens de preprocessorfase worden uitgevoerd. Bij runtimefouten wordt direct de bijbehorende waarde gemeld; bij het volgen van foutopsporing wordt ook de waarde weergegeven in plaats van de macro naam; macro’s hebben geen typecontrole en zijn onveilig; macro’s hebben geen bereik.
#define MAX_MSISDN_LEN 20 // Niet goed
// Gebruik const constanten voor C++
const int MAX_MSISDN_LEN = 20; // Goed
// Voor C++11 en hogere versies kan constexpr worden gebruikt
constexpr int MAX_MSISDN_LEN = 20;
Aanbeveling 9.1.1 Een groep gerelateerde gehele constanten moet worden gedefinieerd als opsomming
Toelichting: Opsommingen zijn veiliger dan #define of const int. De compiler controleert of de parameterwaarde binnen het bereik van de opsomming ligt, waardoor fouten worden voorkomen.
// Goed voorbeeld:
enum Week {
SUNDAY,
MONDAY,
TUESDAY,
WEDNESDAY,
THURSDAY,
FRIDAY,
SATURDAY
};
enum Color {
RED,
BLACK,
BLUE
};
void ColorizeCalendar(Week today, Color color);
ColorizeCalendar(BLUE, SUNDAY); // Compilerfout, verkeerd parametertype
// Slecht voorbeeld:
const int SUNDAY = 0;
const int MONDAY = 1;
const int BLACK = 0;
const int BLUE = 1;
bool ColorizeCalendar(int today, int color);
ColorizeCalendar(BLUE, SUNDAY); // Geen fout
Wanneer de opsommingswaarden moeten worden toegewezen aan specifieke numerieke waarden, moeten ze expliciet worden toegewezen bij de declaratie. Anders is het niet nodig om expliciet toe te wijzen, om dubbele toewijzing te voorkomen en het onderhoudswerk (het toevoegen of verwijderen van leden) te verminderen.
// Goed voorbeeld: de S-protocol definieert apparaat-ID-waarden die worden gebruikt om het apparaattype te identificeren
enum DeviceType {
DEV_UNKNOWN = -1,
DEV_DSMP = 0,
DEV_ISMG = 1,
DEV_WAPPORTAL = 2
};
Voor intern gebruik in programma’s, alleen voor classificatie, mag geen expliciete toewijzing worden gedaan.
// Goed voorbeeld: de opsommingsdefinitie die in het programma wordt gebruikt om de sessiestatus aan te geven
enum SessionState {
INIT,
CLOSED,
WAITING_FOR_RESPONSE
};
Probeer zoveel mogelijk dubbelslagen in opsommingswaarden te vermijden. Als het echt nodig is om dubbelslagen te hebben, moet je een reeds gedefinieerde opsomming gebruiken om deze te modifieren.
enum RTCPType {
RTCP_SR = 200,
RTCP_MIN_TYPE = RTCP_SR,
RTCP_RR = 201,
RTCP_SDES = 202,
RTCP_BYE = 203,
RTCP_APP = 204,
RTCP_RTPFB = 205,
RTCP_PSFB = 206,
RTCP_XR = 207,
RTCP_RSI = 208,
RTCP_PUBPORTS = 209,
RTCP_MAX_TYPE = RTCP_PUBPORTS
};
Regel 9.1.2 Het is niet toegestaan om duivelse getallen te gebruiken
Duivelse getallen zijn onbegrijpelijke, moeilijk te begrijpen cijfers.
Duivelse getallen zijn niet zwart-wit, en het onbegrijpelijke niveau varieert. Je moet het zelf beoordelen.
Bijvoorbeeld, het getal 12 is in verschillende contexten verschillend:
type = 12; is onbegrijpelijk, maar monthsCount = yearsCount * 12; is begrijpelijk.
Het getal 0 is soms ook een duivels getal, bijvoorbeeld status = 0; geeft niet aan welke status het is.
Oplossingsrichting: Voor lokaal gebruikte cijfers kunnen commentaar worden toegevoegd om uitleg te geven. Voor cijfers die op meerdere plaatsen worden gebruikt, moet een constante worden gedefinieerd en moet de naam van het symbool als commentaar worden gebruikt.
Het volgende is verboden:
Geen gebruik van symbolen om de betekenis van cijfers uit te leggen, zoals const int ZERO = 0
Symboolnamen beperken de waarde ervan, zoals const int XX_TIMER_INTERVAL_300MS = 300, gebruik XX_TIMER_INTERVAL_MS om aan te geven dat deze constante de tijdinterval van de timer is.
Regel 9.1.3 Constanten moeten enkele verantwoordelijkheid garanderen
Toelichting: een constante dient slechts één bepaalde functie weer te geven, dat wil zeggen dat een constante niet meerdere doeleinden mag hebben.
// Goed voorbeeld: zowel voor Protocol A als Protocol B is de lengte van het mobiele nummer (MSISDN) 20.
const unsigned int A_MAX_MSISDN_LEN = 20;
const unsigned int B_MAX_MSISDN_LEN = 20;
// Of gebruik verschillende naamruimtes:
namespace Namespace1 {
const unsigned int MAX_MSISDN_LEN = 20;
}
namespace Namespace2 {
const unsigned int MAX_MSISDN_LEN = 20;
}
Regel 9.1.4 Het is verboden om memcpy_s, memset_s te gebruiken voor het initialiseren van niet-POD objecten
Toelichting: POD staat voor Plain Old Data, een concept dat werd geïntroduceerd in de C++ 98-standaard (ISO/IEC 14882, eerste editie, 1998-09-01). POD types omvatten voornamelijk int, char, float, double, enumeration, void, pointers en andere basis types, evenals aggregatie types. Het mag geen gebruik maken van encapsulatie en objectgeoriënteerde kenmerken zoals gebruikers gedefinieerde constructor/toewijzing/destructor, base classes, virtuele functies enzovoort.
Omdat niet-POD types zoals niet-aggregatie klassen objecten mogelijk virtuele functies hebben, een onzekere geheugenlay-out die afhankelijk is van de compiler, en het wijdverspreide gebruik van geheugenkopieerfuncties ernstige problemen kan veroorzaken.
Zelfs voor aggregatie klassen, het gebruik van directe geheugenkopieer- en vergelijkingsbewerkingen zoals memcpy_s en memset_s is niet aan te raden omdat het de werking van informatieverborgenheid en gegevensbescherming verstoort.
Zie de bijlage voor een gedetailleerde uitleg van de definitie van POD types.
Aanbeveling 9.1.2 Variabelen moeten worden gedeclareerd en geïnitialiseerd wanneer ze worden gebruikt
Toelichting: Het gebruik van variabelen die niet zijn geïnitialiseerd voordat ze worden gebruikt, is een veelvoorkomende simpele programmeerfout. Variabelen declareren en initialiseren op het moment van gebruik voorkomt dergelijke simpele fouten heel gemakkelijk.
Alle variabelen declareren op het begin van de functie en deze later gebruiken, waarbij het bereik de gehele functieimplementatie omvat, maakt het programma moeilijk te begrijpen en te onderhouden: de definitie en het gebruik van variabelen zijn gescheiden.
- Variabelen zijn moeilijk op een goede manier te initialiseren: aan het begin van de functie zijn er vaak niet genoeg gegevens beschikbaar om de variabele te initialiseren, en vaak worden standaard lege waarden (zoals nul) gebruikt om de variabele te initialiseren. Dit is meestal een verspilling van tijd, en als de variabele wordt gebruikt voordat deze een geldige waarde krijgt, kan dit ook tot fouten leiden.
Volg het principe van het minimaliseren van het bereik van variabelen en het principe van dichtbijzijnde declaraties. Dit maakt het gemakkelijker om de code te lezen, en om het type en de initiële waarde van de variabele te begrijpen. Vooral het gebruik van initialisatie in plaats van declaratie en vervolgens toewijzing.
// Slecht voorbeeld: declaratie en initialisatie gescheiden
string name; // Niet geïnitialiseerd bij declaratie: standaardconstructor wordt aangeroepen
name = "zhangsan"; // Opnieuw de toewijzingsoperator aanroepen; declaratie en definitie op verschillende plaatsen, moeilijker te begrijpen
// Goed voorbeeld: declaratie en initialisatie in één keer, makkelijker te begrijpen
string name("zhangsan"); // Constructor aanroepen
Expressies
Regel 9.2.1 In expressies die variabele auto-increment of auto-decrement operaties bevatten, is het verboden om die variabele opnieuw te gebruiken
In expressies die auto-increment of auto-decrement operaties bevatten, als de variabele opnieuw wordt gebruikt, is het resultaat in de C++ standaard niet duidelijk gedefinieerd. Verschillende compilers of verschillende versies van dezelfde compiler kunnen verschillende implementaties hebben. Voor een betere draagbaarheid mogen we geen aannames doen over de volgorde van operaties die niet door de standaard zijn gedefinieerd.
Let op, het probleem met de volgorde van operaties kan niet worden opgelost met behulp van haakjes, omdat dit geen kwestie van prioriteit is.
Voorbeeld:
x = b[i] + i++; // Slecht: b[i] bewerking en i++, de volgorde is niet duidelijk.
De juiste schrijfwijze is om de auto-increment of auto-decrement bewerking op een aparte regel te plaatsen:
x = b[i] + i;
i++; // Goed: op aparte regel
Functieparameters
Func(i++, i); // Slecht: bij het doorgeven van de tweede parameter is niet duidelijk of de auto-increment bewerking al heeft plaatsgevonden
De juiste schrijfwijze
i++; // Goed: op aparte regel
x = Func(i, i);
Regel 9.2.2 switch statements moeten een default branch hebben
In de meeste gevallen moet er een default branch zijn in een switch statement, om ervoor te zorgen dat er een standaardverwerking is wanneer een case label wordt overgeslagen.
Uitzondering: Als de switch voorwaardelijke variabele een opsommingswaarde is en de case branches alle mogelijke waarden omvatten, dan is het toevoegen van een default branch overbodig. Moderne compilers hebben de mogelijkheid om te controleren of er bepaalde opsommingswaarden worden overgeslagen in een switch statement, en geven daarvoor een waarschuwingsmelding weer.
enum Color {
RED = 0,
BLUE
};
// Omdat de switch voorwaardelijke variabele een opsommingswaarde is, is het niet nodig om een default verwerkingsbranch toe te voegen
switch (color) {
case RED:
DoRedThing();
break;
case BLUE:
DoBlueThing();
...
break;
}
Aanbeveling 9.2.1 Bij het vergelijken in expressies moet worden gevolgd dat de linkerzijde geneigd is te veranderen en de rechterzijde geneigd is niet te veranderen
Wanneer een variabele wordt vergeleken met een constante, als de constante links staat, zoals if (MAX == v), is dit niet in overeenstemming met de leesgewoonte, terwijl if (MAX > v) moeilijker te begrijpen is. De vergelijking moet worden gemaakt volgens de normale lees- en expressiegewoonte van de mens, met de constante rechts.
if (value == MAX) {
}
if (value < MAX) {
}
Er zijn ook uitzonderingen, zoals: if (MIN < value && value < MAX) om een interval te beschrijven, waarbij de eerste helft links een constante heeft.
Maak je geen zorgen over het per ongeluk schrijven van ‘==’ als ‘=’, want if (value = MAX) zal een compilatie waarschuwing geven, en andere statische controle tools zullen ook foutmeldingen geven. Laat de tools de probleemoplossing van typfouten overnemen, en laat de code voldoen aan de eerste regel van leesbaarheid.
Aanbeveling 9.2.2 Gebruik haakjes om de prioriteit van operatoren duidelijk te maken
Gebruik haakjes om de prioriteit van operatoren duidelijk te maken, om te voorkomen dat de standaard prioriteit niet overeenkomt met het ontwerpopzicht en daardoor programmafouten veroorzaakt; en om de code duidelijker en leesbaarder te maken. Echter, te veel haakjes vermindert de leesbaarheid. Hieronder zijn enkele suggesties voor het gebruik van haakjes.
- Bij binaire of meer operatoren, als er meerdere soorten operatoren zijn, moeten haakjes worden gebruikt
x = a + b + c; /* Dezelfde operator, haakjes zijn niet nodig */
x = Foo(a + b, c); /* Expressies aan weerszijden van het komma, geen haakjes nodig */
x = 1 << (2 + 3); /* Verschillende operatoren, haakjes nodig */
x = a + (b / 5); /* Verschillende operatoren, haakjes nodig */
x = (a == b) ? a : (a – b); /* Verschillende operatoren, haakjes nodig */
Typeconversie
Vermijd type vertakking om gedrag aan te passen: type vertakking om gedrag aan te passen is foutgevoelig, en is een duidelijk teken van het schrijven van C-code in C++. Het is een inflexibele techniek, en als je nieuwe types toevoegt en vergeet om alle vertakkingen te wijzigen, zal de compiler dat ook niet melden. Gebruik templates en virtuele functies, laat het type zelf in plaats van de code die ze aanroept bepalen wat het gedrag is.
We raden aan om type conversie zoveel mogelijk te vermijden. Bij het ontwerpen van het type van een bepaalde gegevens moeten we nadenken over het type van die gegevens in plaats van het gebruik van type conversie als een oplossing. We moeten nadenken over het volgende bij het ontwerpen van een bepaald basis type:
- Is het ondertekend of niet-ondertekend?
- Is het geschikt voor float of double?
- Is het geschikt voor int8, int16, int32 of int64, en is de gehele lengte bepaald?
Maar we kunnen het gebruik van type conversie niet verbieden, omdat C++ een taal is die is gericht op het programmeren van machines, betrokken is bij pointers en adressen, en we zullen interageren met verschillende derde partijen of onderliggende API’s. Hun type ontwerp is niet altijd redelijk, en tijdens het aanpassen van dit proces is het gemakkelijk om type conversie te gebruiken.
Uitzondering: bij het aanroepen van een bepaalde functie, als we echt niet de functieresultaten willen verwerken, moeten we eerst overwegen of dit de beste keuze is. Als we echt niet de functie retourwaarde willen verwerken, kunnen we (void) gebruiken om het probleem op te lossen.
Regel 9.3.1 Als we echt type conversie moeten gebruiken, gebruiken we dan die welke door C++ worden geleverd, in plaats van C-stijl type conversie
Toelichting:
C++ biedt meer gerichte en veiligere type conversies dan C-stijl, die makkelijker te lezen zijn. C++ biedt de volgende conversies:
- Type conversie:
dynamic_cast: wordt voornamelijk gebruikt voor het omzetten van onderliggende types in de erfenisstructuur.dynamic_castheeft de functie van typecontrole. Zorg goed voor het ontwerp van de basisklasse en de afgeleide klasse, en vermijd het gebruik vandynamic_castvoor conversie.static_cast: vergelijkbaar met C-stijl conversie, kan worden gebruikt voor forceerconversie van waarden, of omhoog conversie (het omzetten van een pointer of referentie van een afgeleide klasse in een pointer of referentie van een basisklasse). Deze conversie wordt vaak gebruikt om de dubbelzinnigheid van types die wordt veroorzaakt door meervoudige overerving te elimineren, en is relatief veilig. Als het een pure rekenkundige conversie is, gebruik dan de initialisatiestijl met accolades.reinterpret_cast: wordt gebruikt voor het converteren van ongerelateerde types.reinterpret_castdwingt de compiler ertoe om het geheugen van een objecttype opnieuw te interpreteren als een ander type, wat een onveilige conversie is. We raden aan omreinterpret_castzoveel mogelijk te vermijden.const_cast: wordt gebruikt om hetconstkenmerk van een object te verwijderen, zodat het object kan worden gemodificeerd. Dit verstoort de onveranderlijkheid van gegevens en het wordt aanbevolen omconst_castzoveel mogelijk te vermijden.
- Rekenkundige conversie: (vanaf C++11 ondersteund) Voor die rekenkundige conversies, waarbij geen type-informatie verloren gaat, zoals float naar double, int32 naar int64 conversie, wordt het gebruik van de initialisatiestijl met accolades aanbevolen.
double d{ someFloat };
int64_t i{ someInt32 };
Aanbeveling 9.3.1 Vermijd het gebruik van dynamic_cast
dynamic_castis afhankelijk van het RTTI van C++, waarmee programmeurs tijdens runtime C++ klassenobjecten kunnen identificeren.- Het verschijnen van
dynamic_castgeeft meestal aan dat het ontwerp van onze basisklasse en afgeleide klasse problemen heeft. De afgeleide klasse heeft de belofte van de basisklasse verbroken en moet worden omgezet naar een subklasse voor speciale behandeling viadynamic_cast. In dit geval is het beter om het klasseontwerp te verbeteren in plaats vandynamic_castte gebruiken om het probleem op te lossen.
Aanbeveling 9.3.2 Vermijd het gebruik van reinterpret_cast
Toelichting: reinterpret_cast wordt gebruikt voor het converteren van ongerelateerde types. Het dwingt de compiler om een type te dwingen om te worden geïnterpreteerd als een ander type, wat de veiligheid en betrouwbaarheid van het type vernietigt en een onveilige conversie is.
Aanbeveling 9.3.3 Vermijd het gebruik van const_cast
Toelichting: const_cast wordt gebruikt om het const en volatile karakter van een object te verwijderen.
Het gebruik van een pointer of referentie, die is geconverteerd met const_cast, om een const object te wijzigen, heeft een ongedefinieerd gedrag.
// Slecht voorbeeld
const int i = 1024;
int* p = const_cast<int*>(&i);
*p = 2048; // Gedrag is niet gedefinieerd
// Slecht voorbeeld
class Foo {
public:
Foo() : i(3) {}
void Fun(int v)
{
i = v;
}
private:
int i;
};
int main(void)
{
const Foo f;
Foo* p = const_cast<Foo*>(&f);
p->Fun(8); // Gedrag is niet gedefinieerd
}
Resource allocation and release
Regel 9.4.1 Gebruik delete voor het vrijgeven van een enkel object, en delete [] voor het vrijgeven van een array object
Toelichting: Gebruik delete voor het verwijderen van een enkel object, en delete [] voor het verwijderen van een array object. Reden:
- De acties die worden uitgevoerd bij het aanroepen van new: een stuk geheugen aanvragen van het systeem, en de constructor van dit type aanroepen.
- De acties die worden uitgevoerd bij het aanroepen van new[n]: geheugen aanvragen dat n objecten kan bevatten, en de constructor van elk object aanroepen.
- De acties die worden uitgevoerd bij het aanroepen van delete: eerst de bijbehorende destructor aanroepen, daarna het geheugen teruggeven aan het systeem.
- De acties die worden uitgevoerd bij het aanroepen van delete[]: de destructor van elk object aanroepen, daarna het hele geheugen vrijgeven.
Als het formaat van new en delete niet overeenkomt, is het resultaat onbekend. Voor niet-class types roepen new en delete geen constructor en destructor aan.
Foute schrijfwijze:
const int MAX_ARRAY_SIZE = 100;
int* numberArray = new int[MAX_ARRAY_SIZE];
...
delete numberArray;
numberArray = nullptr;
Juiste schrijfwijze:
const int MAX_ARRAY_SIZE = 100;
int* numberArray = new int[MAX_ARRAY_SIZE];
...
delete[] numberArray;
numberArray = nullptr;
Aanbeveling 9.4.1 Gebruik RAII kenmerken om dynamische toewijzingen te volgen
Toelichting: RAII staat voor “Resource Acquisition Is Initialization” (Resourceverwerving is initialisatie), een eenvoudige techniek die gebruik maakt van de levensduur van objecten om resources te controleren (zoals geheugen, bestandsverwijzingen, netwerkconnecties, mutexen, enz.).
De algemene methode van RAII is als volgt: verkrijg resources tijdens objectconstructie, controleer vervolgens de toegang tot de resources zodat deze gedurende de levensduur van het object effectief blijven, en geef ten slotte de resources vrij tijdens objectdestructie. Deze methode heeft twee grote voordelen:
- We hoeven de resources niet expliciet vrij te geven.
- De resources die het object nodig heeft, blijven gedurende de levensduur van het object effectief. Op deze manier hoeven we geen controle te doen op de validiteit van de resources, wat de logica kan vereenvoudigen en de efficiëntie kan verhogen.
Voorbeeld: gebruik RAII om mutex resources niet expliciet vrij te geven.
class LockGuard {
public:
LockGuard(const LockType& lockType): lock_(lockType)
{
lock_.Acquire();
}
~LockGuard()
{
lock_.Release();
}
private:
LockType lock_;
};
bool Update()
{
LockGuard lockGuard(mutex);
if (...) {
return false;
} else {
// gegevens bewerken
}
return true;
}
Standaard bibliotheek
STL standaard sjabloonsbibliotheek wordt in verschillende producten in verschillende mate gebruikt, hieronder volgen enkele basisregels en suggesties, ter referentie voor alle teams.
Regel 9.5.1 Sla de pointer die wordt geretourneerd door std::string’s c_str() niet op
Toelichting: In de C++ standaard is niet bepaald dat de string::c_str() pointer permanent geldig is, dus een bepaalde STL implementatie kan bij het aanroepen van string::c_str() een tijdelijke opslagruimte retourneren die snel wordt vrijgegeven. Om de draagbaarheid van het programma te garanderen, sla de resultaten van string::c_str() niet op, maar roep het rechtstreeks aan wanneer het nodig is.
Voorbeeld:
void Fun1()
{
std::string name = "demo";
const char* text = name.c_str(); // Na de expressie-einde is de levensduur van name nog steeds actief, de pointer is geldig
// Als de niet-const lidfunctie van string wordt aangeroepen in het midden, wat leidt tot een wijziging van de string, zoals operator[], begin(), enz.
// Dit kan ertoe leiden dat de inhoud van text niet meer beschikbaar is, of niet langer de oorspronkelijke string is.
name = "test";
name[1] = '2';
// Bij het gebruik van de text pointer daarna is de inhoud van de string niet langer "demo"
}
void Fun2()
{
std::string name = "demo";
std::string test = "test";
const char* text = (name + test).c_str(); // Na de expressie-einde is het tijdelijke object dat is gemaakt door + vernietigd, de pointer is niet langer geldig
// Bij het gebruik van de text pointer daarna verwijst deze niet langer naar een geldige geheugenruimte
}
Uitzondering: in enkele zeer prestatiegerichte code kan string::c_str() tijdelijk worden opgeslagen om te voldoen aan de interface van een externe functie die alleen const char* als invoer accepteert. Maar het moet strikt worden gegarandeerd dat de levensduur van het string object langer is dan die van de opgeslagen pointer, en dat het string object niet wordt gewijzigd tijdens de levensduur van de opgeslagen pointer.
Aanbeveling 9.5.1 Gebruik std::string in plaats van char*
Toelichting: Het gebruik van string in plaats van char* heeft veel voordelen, zoals:
- Je hoeft niet te denken aan het einde van ‘\0’;
- Je kunt rechtstreeks de operators +, =, == en andere string-operaties gebruiken;
- Je hoeft niet te denken aan het geheugenallocatieproces, hoeft geen expliciete new/delete te gebruiken, en vermijdt hierdoor fouten;
Er moet worden opgemerkt dat in sommige stl-implementaties string is gebaseerd op een copy-on-write strategie, wat twee problemen oplevert: ten eerste hebben sommige versies van de copy-on-write strategie geen threadsafe implementatie, wat kan leiden tot het instorten van het programma in een multithreadomgeving; ten tweede, wanneer een string met copy-on-write wordt doorgegeven tussen dynamische bibliotheken, kan het gebeuren dat het verwijzingsaantal niet wordt verlaagd bij het ontkoppelen van de dynamische bibliotheek, wat kan leiden tot een drijvende pointer. Daarom is het belangrijk om een betrouwbare stl-implementatie te kiezen voor het behoud van de stabiliteit van het programma.
Uitzondering:
Bij het aanroepen van systemen of API’s van derden, kan voor reeds gedefinieerde interfaces alleen char* worden gebruikt. Maar voorafgaand aan het aanroepen van de interface kan string worden gebruikt, en bij het aanroepen van de interface kan string::c_str() worden gebruikt om de char pointer te verkrijgen.
Wanneer een karakterarray in de stack wordt toegewezen als buffer, kan deze rechtstreeks worden gedefinieerd en is het niet nodig om string te gebruiken, noch is het noodzakelijk om containers zoals vector<char> te gebruiken.
Regel 9.5.2 Het is verboden om auto_ptr te gebruiken
Toelichting: In de stl-bibliotheek heeft std::auto_ptr een impliciete eigendomsoverdrachtsfunctie, zoals in de volgende code:
auto_ptr<T> p1(new T);
auto_ptr<T> p2 = p1;
Nadat de tweede regel is uitgevoerd, verwijst p1 niet langer naar het object dat in de eerste regel is toegewezen, maar wordt het nullptr. Vanwege dit gedrag kunnen auto_ptr niet worden geplaatst in diverse standaardcontainers. Het overdragen van eigendom gedraagt zich meestal niet zoals verwacht. Voor het scenario waarin eigendom moet worden overgedragen, moet geen impliciete overdrachtsmethode worden gebruikt. Dit vereist meestal dat programmeurs extra voorzichtig zijn met het gebruik van auto_ptr, anders kunnen er fouten optreden bij toegang tot null-pointers. Auto_ptr wordt meestal gebruikt in twee scenario’s: het ene is als slimme pointer die buiten de functie die auto_ptr produceert wordt doorgegeven, en het andere is het gebruik van auto_ptr als een RAII-beheerklasse die automatisch bronnen vrijgeeft wanneer de levensduur van auto_ptr eindigt. Voor het eerste scenario kan std::shared_ptr worden gebruikt als vervanging. Voor het tweede scenario kan std::unique_ptr uit de C++11-standaard worden gebruikt. std::unique_ptr is een vervanging voor std::auto_ptr en ondersteunt expliciete eigendomsoverdracht.
Uitzondering: Totdat de C++11-standaard algemeen wordt gebruikt, kan std::auto_ptr worden gebruikt in het geval dat eigendomsoverdracht absoluut noodzakelijk is, maar het wordt aanbevolen om std::auto_ptr te omhullen en de kopieconstructor en toewijzingsoperator van de omhulde klasse te verbieden, zodat deze klasse niet kan worden gebruikt voor standaardcontainers.
Aanbeveling 9.5.2 Gebruik de nieuwe standaard headers
Toelichting:
Gebruik bij het gebruik van C++ standaard headers <cstdlib> in plaats van <stdlib.h>.
Het gebruik van const
Door het toevoegen van het trefwoord const voor de variabele of parameter die wordt gedeclareerd, wordt aangegeven dat de variabele niet mag worden gewijzigd (bijv. const int foo). Voeg het const qualifier toe aan de functie van de klasse om aan te geven dat de functie de status van de klassenlidvariabele niet zal wijzigen (bijv. class Foo { int Bar(char c) const; };). Const variabelen, dataleden, functies en parameters voegen een laag bescherming toe aan de compilatietijdcontrole, wat helpt bij het vroegtijdig ontdekken van fouten. Daarom raden we sterk aan om const te gebruiken in alle mogelijke gevallen.
Soms is het beter om C++11’s constexpr te gebruiken om echte constanten te definiëren.
Regel 9.6.1 Gebruik const voor pointers en referentietypes als parameters die niet hoeven te worden gewijzigd
Onveranderlijke waarden zijn makkelijker te begrijpen/te volgen en te analyseren, neem const als standaardoptie, deze wordt in de compilatiefase gecontroleerd, waardoor de code steviger/veiliger wordt.
class Foo;
void PrintFoo(const Foo& foo);
Regel 9.6.2 Gebruik const voor alle ledenfuncties die geen gegevensleden wijzigen
Probeer zoveel mogelijk ledenfuncties als const te declareren. Toegangsfuncties zouden altijd const moeten zijn. Alle ledenfuncties die geen gegevensleden wijzigen, moeten als const worden gedeclareerd. Voor virtuele functies moet worden overwogen of alle klassen in de overerving vanuit het oogpunt van het ontwerpdoel alle klassen in de overervingsketen zullen moeten wijzigen in de gegevensleden in deze virtuele functie, in plaats van alleen te kijken naar de implementatie van een enkele klasse.
class Foo {
public:
// ...
int PrintValue() const // const修饰成员函数,不会修改成员变量
{
std::cout << value_ << std::endl;
}
int GetValue() const // const修饰成员函数,不会修改成员变量
{
return value_;
}
private:
int value_;
};
Aanbeveling 9.6.1 Definieer const voor lidvariabelen die na initialisatie niet meer worden gewijzigd
class Foo {
public:
Foo(int length) : dataLength_(length) {}
private:
const int dataLength_;
};
Uitzonderingen
Aanbeveling 9.7.1 In C++11, als een functie geen uitzondering gooit, declareren als noexcept
Reden
- Als een functie geen uitzondering gooit, declareren als
noexceptlaat de compiler de functie maximaliseren optimaliseren, zoals het verminderen van uitvoeringspaden en het verbeteren van de efficiëntie van het verlaten van fouten. - STL containers zoals
vector, om de robuustheid van de interface te garanderen, gebruiken geenmovemechanisme, maarcopymechanisme bij het verplaatsen van elementen tijdens container uitbreiding als demove operatorvan het opgeslagen element niet alsnoexceptis gedeclareerd, wat het risico van prestatieverlies met zich meebrengt. Als een functie geen uitzondering kan gooien, of als een programma geen bepaalde functie die een uitzondering gooit opvangt en verwerkt, kan de functie worden gemarkeerd met het nieuwenoexceptsleutelwoord, wat aangeeft dat de functie geen uitzondering gooit of dat de gegooiden uitzondering niet wordt opgevangen en verwerkt. Bijvoorbeeld:
extern "C" double sqrt(double) noexcept; // zal nooit een uitzondering gooien
// Hoewel het mogelijk is om een uitzondering te gooien, kan noexcept ook worden gebruikt
// Hier is geen uitzondering voor het uitputten van geheugen nodig, eenvoudigweg de functie declareren als noexcept
std::vector<int> MyComputation(const std::vector<int>& v) noexcept
{
std::vector<int> res = v; // kan een uitzondering gooien
// do something
return res;
}
Voorbeeld
RetType Function(Type params) noexcept; // maximale optimalisatie
RetType Function(Type params); // minder optimalisatie
// De move operaties van std::vector moeten noexcept worden gedeclareerd
class Foo1 {
public:
Foo1(Foo1&& other); // no noexcept
};
std::vector<Foo1> a1;
a1.push_back(Foo1());
a1.push_back(Foo1()); // trigger container expansion, move existing elements using copy constructor
class Foo2 {
public:
Foo2(Foo2&& other) noexcept;
};
std::vector<Foo2> a2;
a2.push_back(Foo2());
a2.push_back(Foo2()); // trigger container expansion, move existing elements using move constructor
Opmerking
Standaard constructors, destructors, swap functions, move operators zouden geen uitzonderingen mogen gooien.
Templates en generieke programmeerprincipes
Regel 9.8.1 Het is verboden om generiek programmeren in OpenHarmony projecten te gebruiken
Generiek programmeren en de gedachtegang, het concept en de technieken van objectgeoriënteerd programmeren zijn compleet anders, en OpenHarmony projecten gebruiken voornamelijk objectgeoriënteerde ideeën.
C++ biedt krachtige mechanismen voor generiek programmeren, die zeer flexibele, type-veilige interfaces kunnen realiseren, en codehergebruik kunnen realiseren met verschillende types maar hetzelfde gedrag.
Maar C++ generiek programmeren heeft de volgende nadelen:
- Mensen die niet erg bekend zijn met generiek programmeren, gebruiken vaak templates voor objectgeoriënteerde logica, schrijven leden die niet afhankelijk zijn van template parameters in templates, enzovoort, wat leidt tot logische verwarring en code-uitzetting.
- Voor mensen die C++ niet goed beheersen, zijn de technieken die worden gebruikt in template programmeren vaak ondoorzichtig en moeilijk te begrijpen. Code die templates gebruikt op complexe plekken is moeilijker te lezen, en debuggen en onderhouden is erg lastig.
- Template programmeren veroorzaakt vaak onvriendelijke foutmeldingen bij het compileren: als de code een fout bevat, is de foutmelding zelfs bij een zeer eenvoudige interface niet makkelijk te begrijpen, en worden de implementatiedetails van de templates weergegeven in de foutmelding.
- Als templates verkeerd worden gebruikt, kan dit leiden tot te veel runtime code-uitzetting.
- Template code is moeilijk te wijzigen en te herschikken. De code van de template wordt in veel contexten uitgebreid, dus het is moeilijk om te bevestigen dat de herschikking bruikbaar is voor alle uitgebreide code.
Daarom is het gebruik van template programmeren verboden in de meeste onderdelen van OpenHarmony, en slechts een paar onderdelen mogen generiek programmeren gebruiken, en de ontwikkelde templates moeten gedetailleerde commentaren bevatten. Uitzondering:
- STL-adapterlagen kunnen templates gebruiken
Macro’s
In de C++ taal raden we sterk aan om zoveel mogelijk complexe macro’s te vermijden
- Voor constante definities, gebruik const of enumeratie volgens de voorgaande secties;
- Voor macro functies, probeer ze zo eenvoudig mogelijk te maken en volg de onderstaande principes. Gebruik liever inline functies, template functies, enz. als vervanging.
// Gebruik van macro functies wordt niet aanbevolen
#define SQUARE(a, b) ((a) * (b))
// Gebruik liever template functies, inline functies, enz. als vervanging.
template<typename T> T Square(T a, T b) { return a * b; }
Als het gebruik van macro’s noodzakelijk is, raadpleeg dan de betreffende secties in de C taal specificatie. Uitzondering: sommige algemeen gebruikte en gerijpte toepassingen, zoals het omhullen van new, delete, kunnen het gebruik van macro’s behouden.
10 Moderne C++ kenmerken
Met ISO die in 2011 de C++11 taalstandaard publiceerde en in maart 2017 C++17, hebben moderne C++ (C++11/14/17, enz.) enorme hoeveelheden nieuwe taalkenmerken en standaardbibliotheken toegevoegd om programmeerefficiëntie en codekwaliteit te verbeteren. Deze sectie beschrijft een aantal richtlijnen om het team efficiënter te laten werken met moderne C++ en om valkuilen in de taal te vermijden.
Code helderheid en veiligheid verbetering
Aanbeveling 10.1.1 Gebruik auto op een verantwoorde manier
Reden
autokan het schrijven van lange, herhalende typenamen vermijden, en kan ook garanderen dat variabelen worden geïnitialiseerd bij de declaratie.autotype-afleiding is complex en vereist zorgvuldig begrip.- Als het de code duidelijker maakt, gebruik dan liever expliciete types, en gebruik
autoalleen voor lokale variabelen.
Voorbeelden
// Vermijd lange typenamen
std::map<string, int>::iterator iter = m.find(val);
auto iter = m.find(val);
// Vermijd herhaling van typenamen
class Foo {...};
Foo* p = new Foo;
auto p = new Foo;
// Zorg voor initialisatie
int x; // Compileren lukt, niet geïnitialiseerd
auto x; // Compileren faalt, moet worden geïnitialiseerd
Auto type-afleiding kan tot verwarring leiden:
auto a = 3; // int
const auto ca = a; // const int
const auto& ra = a; // const int&
auto aa = ca; // int, const en reference worden genegeerd
auto ila1 = { 10 }; // std::initializer_list<int>
auto ila2{ 10 }; // std::initializer_list<int>
auto&& ura1 = x; // int&
auto&& ura2 = ca; // const int&
auto&& ura3 = 10; // int&&
const int b[10];
auto arr1 = b; // const int*
auto& arr2 = b; // const int(&)[10]
Als auto type-afleiding die references negeert niet wordt opgemerkt, kan dit leiden tot moeilijk te ontdekken prestatieproblemen:
std::vector<std::string> v;
auto s1 = v[0]; // auto wordt afgeleid als std::string, kopieert v[0]
Als auto wordt gebruikt om interfaces te definiëren, zoals constanten in headerbestanden, kan het type veranderen als ontwikkelaars de waarde wijzigen.
Regel 10.1.1 Gebruik het override of final sleutelwoord bij het herschrijven van virtuele functies
Reden
De sleutelwoorden override en final garanderen dat de functie een virtuele functie is en de virtuele functie van de basisklasse overschrijft. Als de functie in de subklasse niet overeenkomt met de functie in de basisklasse, zal er een compilatie waarschuwing worden gegenereerd. final garandeert ook dat de virtuele functie niet opnieuw kan worden overschreven door subklassen.
Als het prototype van de virtuele functie in de basisklasse wordt gewijzigd, maar de subklasse wordt vergeten te wijzigen, kan dit in de compilatiefase worden ontdekt als override of final wordt gebruikt. Dit kan ook voorkomen dat bij meerdere subklassen het overschrijven van virtuele functies wordt vergeten.
Voorbeeld
class Base {
public:
virtual void Foo();
virtual void Foo(int var);
void Bar();
};
class Derived : public Base {
public:
void Foo() const override; // Compilerfout: Derived::Foo en Base::Foo zijn niet consistent, geen overschrijving
void Foo() override; // Correct: Derived::Foo overschrijft Base::Foo
void Foo(int var) final; // Correct: Derived::Foo(int) overschrijft Base::Foo(int), en Derived's subklassen kunnen deze functie niet meer overschrijven
void Bar() override; // Compilerfout: Base::Bar is geen virtuele functie
};
Samenvatting
- De eerste keer dat een virtuele functie in de basisklasse wordt gedefinieerd, gebruik dan het sleutelwoord
virtual - Bij het herschrijven van een virtuele functie in de subklasse (inclusief de destructor), gebruik dan het sleutelwoord
overrideoffinal(maar niet beide), en gebruik niet het sleutelwoordvirtual - Gebruik geen
virtual,overrideoffinalvoor niet-virtuele functies
Regel 10.1.2 Gebruik het delete sleutelwoord om functies te verwijderen
Reden
In vergelijking met het declareren van een klasse lidfunctie als private maar deze niet implementeren, is het sleutelwoord delete duidelijker en breder toepasbaar.
Voorbeeld
class Foo {
private:
// Je kunt niet zien uit de header dat de copy constructor is verwijderd
Foo(const Foo&);
};
class Foo {
public:
// Duidelijk aangegeven dat de copy assignment functie is verwijderd
Foo& operator=(const Foo&) = delete;
};
Het sleutelwoord delete ondersteunt ook het verwijderen van niet-lid functies
template<typename T>
void Process(T value);
template<>
void Process<void>(void) = delete;
Regel 10.1.3 Gebruik nullptr in plaats van NULL of 0
Reden Al heel lang heeft C++ geen sleutelwoord voor een null pointer, wat erg ongemakkelijk is:
#define NULL ((void *)0)
char* str = NULL; // Fout: void* kan niet automatisch worden geconverteerd naar char*
void(C::*pmf)() = &C::Func;
if (pmf == NULL) {} // Fout: void* kan niet automatisch worden geconverteerd naar een member functie pointer
Als NULL wordt gedefinieerd als 0 of 0L, dan worden de bovenstaande problemen opgelost.
Of gebruik 0 rechtstreeks op plaatsen waar een null pointer nodig is. Maar dit introduceert een ander probleem, namelijk onduidelijke code, vooral bij gebruik van auto automatische afleiding:
auto result = Find(id);
if (result == 0) { // Find() retourneert een pointer of een integer?
// do something
}
0 is letterlijk een int type (0L is long), dus NULL en 0 zijn geen pointer types.
Wanneer functies die pointers en integers overladen, worden NULL of 0 aangeroepen, roept het de integer type overload aan:
void F(int);
void F(int*);
F(0); // Roept F(int) aan, niet F(int*)
F(NULL); // Roept F(int) aan, niet F(int*)
Bovendien is het niet altijd waar dat sizeof(NULL) == sizeof(void*), wat ook een potentieel risico is.
Samenvatting: Direct gebruik van 0 of 0L maakt de code onduidelijk en biedt geen type veiligheid; gebruik van NULL biedt geen type veiligheid. Dit zijn allemaal potentiële risico’s.
De voordelen van nullptr zijn niet alleen dat het letterlijk een null pointer vertegenwoordigt en de code duidelijker maakt, maar ook dat het niet langer een integer type is.
nullptr is van het type std::nullptr_t, en std::nullptr_t kan impliciet worden geconverteerd naar alle primitieve pointer types, waardoor nullptr zich kan gedragen als een null pointer die naar elk type wijst.
void F(int);
void F(int*);
F(nullptr); // Roept F(int*) aan
auto result = Find(id);
if (result == nullptr) { // Find() retourneert een pointer
// do something
}
Regel 10.1.4 Gebruik using in plaats van typedef
Voor C++11, konden we typedef gebruiken om type-aliassen te definiëren. Niemand wil std::map<uint32_t, std::vector<int>> herhaaldelijk schrijven.
typedef std::map<uint32_t, std::vector<int>> SomeType;
Type-aliassen zijn eigenlijk een vorm van encapsulatie. Door encapsulatie kunnen we de code duidelijker maken en in grote mate het verspreidingsprobleem van code wijzigingen vermijden.
Vanaf C++11 biedt C++ using aan voor het declareren van aliassen:
using SomeType = std::map<uint32_t, std::vector<int>>;
Vergelijk de twee formaten:
typedef Type Alias; // Type eerst, of Alias eerst
using Alias = Type; // Volgt het 'toewijzings'-gebruik, makkelijker te begrijpen, minder foutgevoelig
Als je denkt dat dit nog niet genoeg is om over te schakelen op using, laten we dan kijken naar alias template:
// Definieer een alias voor een template, één regel code
template<class T>
using MyAllocatorVector = std::vector<T, MyAllocator<T>>;
MyAllocatorVector<int> data; // Gebruik het alias dat met using is gedefinieerd
template<class T>
class MyClass {
private:
MyAllocatorVector<int> data_; // Gebruik het alias dat met using is gedefinieerd in een templateklasse
};
En typedef ondersteunt geen alias met template parameters, en kan alleen worden gebruikt via een “omweg”:
// "Omweg" met een template dat typedef omvat, moet een templateklasse implementeren
template<class T>
struct MyAllocatorVector {
typedef std::vector<T, MyAllocator<T>> type;
};
MyAllocatorVector<int>::type data; // Gebruik het alias dat met typedef is gedefinieerd, moet ::type toevoegen
template<class T>
class MyClass {
private:
typename MyAllocatorVector<int>::type data_; // Gebruik in een templateklasse, moet ::type toevoegen en ook typename
};
Regel 10.1.5 Het is verboden om std::move te gebruiken op const objecten
Vanuit het oogpunt van de betekenis, betekent std::move dat een object moet worden verplaatst. Aangezien een const object niet mag worden gewijzigd, kan het ook niet worden verplaatst. Het gebruik van std::move op een const object zal dus verwarring veroorzaken bij de codelezer.
In termen van daadwerkelijke functionaliteit zal std::move een object converteren naar een rechts-waarde referentie type; voor een const object zal het worden geconverteerd naar een const rechts-waarde referentie. Aangezien zeer weinig types een move constructor en move toewijzingsoperator hebben die zijn gedefinieerd met een const rechts-waarde referentie als parameter, zal de werking van de code in de praktijk vaak worden teruggebracht tot het kopiëren van het object in plaats van het verplaatsen ervan, wat leidt tot prestatieverlies.
Voorbeeld van fout:
std::string g_string;
std::vector<std::string> g_stringList;
void func()
{
const std::string myString = "String content";
g_string = std::move(myString); // slecht: verplaatst myString niet, maar kopieert het
const std::string anotherString = "Another string content";
g_stringList.push_back(std::move(anotherString)); // slecht: verplaatst anotherString niet, maar kopieert het
}
Slimme pointers
Regel 10.2.1 Gebruik liever raw pointers dan slimme pointers voor singleton, klasseleden, enz., waarvan het eigendom niet door meerdere partijen wordt gehouden
Reden Slimme pointers geven automatisch bronnen vrij om bronverlies te voorkomen, maar brengen extra bronkosten met zich mee. Bijvoorbeeld: overhead van automatisch gegenereerde klassen van slimme pointers, kosten van constructie en destructie, meer geheugengebruik, enz. In gevallen zoals singleton, klasseleden, enz., waarvan het eigendom niet door meerdere partijen wordt gehouden, hoeft alleen de klasse destructor bronnen vrij te geven. Er is geen reden om slimme pointers te gebruiken en extra kosten te betalen.
Voorbeeld
class Foo;
class Base {
public:
Base() {}
virtual ~Base()
{
delete foo_;
}
private:
Foo* foo_ = nullptr;
};
Uitzondering
- Bij het retourneren van gecreëerde objecten, kunnen slimme pointers worden gebruikt als de pointer destructie functie nodig is.
class User;
class Foo {
public:
std::unique_ptr<User, void(User *)> CreateUniqueUser() // kan unique_ptr gebruiken om ervoor te zorgen dat objecten worden gemaakt en vrijgegeven in dezelfde runtime
{
sptr<User> ipcUser = iface_cast<User>(remoter);
return std::unique_ptr<User, void(User *)>(::new User(ipcUser), [](User *user) {
user->Close();
::delete user;
});
}
std::shared_ptr<User> CreateSharedUser() // kan shared_ptr gebruiken om ervoor te zorgen dat objecten worden gemaakt en vrijgegeven in dezelfde runtime
{
sptr<User> ipcUser = iface_cast<User>(remoter);
return std::shared_ptr<User>(ipcUser.GetRefPtr(), [ipcUser](User *user) mutable {
ipcUser = nullptr;
});
}
};
- Gebruik shared_ptr bij het retourneren van gecreëerde objecten die door meerdere partijen moeten worden gedeeld.
Regel 10.2.2 Gebruik std::make_unique in plaats van new om unique_ptr te maken
Reden
make_uniquebiedt een meer eenvoudige creatie methode- Garandeert uitvoeringsveiligheid bij complexe expressies
Voorbeeld
// Slecht: MyClass verschijnt twee keer, herhaling brengt risico's met zich mee
std::unique_ptr<MyClass> ptr(new MyClass(0, 1));
// Goed: MyClass verschijnt slechts één keer, geen risico op inconsistentie
auto ptr = std::make_unique<MyClass>(0, 1);
Herhaling van het type kan zeer ernstige problemen veroorzaken, en is moeilijk te ontdekken:
// Compileren lukt, maar new en delete zijn niet consistent
std::unique_ptr<uint8_t> ptr(new uint8_t[10]);
std::unique_ptr<uint8_t[]> ptr(new uint8_t);
// Niet veilig bij uitvoering: compiler kan de parameters in de volgende volgorde berekenen:
// 1. geheugen toewijzen voor Foo,
// 2. Foo construeren,
// 3. Bar aanroepen,
// 4. unique_ptr<Foo> construeren.
// Als Bar een uitzondering gooit, wordt Foo niet vernietigd, wat leidt tot geheugenlek.
F(unique_ptr<Foo>(new Foo()), Bar());
// Veilig bij uitvoering: functieaanroepen kunnen niet worden onderbroken.
F(make_unique<Foo>(), Bar());
Uitzondering
std::make_unique ondersteunt geen aangepaste deleter.
In gevallen waar aangepaste deleter nodig is, wordt aanbevolen om een aangepaste versie van make_unique in je eigen naamruimte te implementeren.
Gebruik new om een unique_ptr te maken met een aangepaste deleter is de laatste keuze.
Regel 10.2.4 Gebruik std::make_shared in plaats van new om shared_ptr te maken
Reden
Naast consistentie en andere redenen, zoals std::make_unique, heeft std::make_shared ook prestatieredenen.
std::shared_ptr beheert twee entiteiten:
- Controleblok (slaagt referentieaantallen,
deleterenz. op) - Beheerde objecten
std::make_shared maakt std::shared_ptr door één keer genoeg geheugen op de heap toe te wijzen om het controleblok en het beheerde object te bevatten. Gebruik std::shared_ptr<MyClass>(new MyClass) om std::shared_ptr te maken, naast het feit dat new MyClass een keer heap toewijzing activeert, activeert de constructor van std::shard_ptr ook een tweede keer heap toewijzing, wat extra overhead oplevert.
Uitzondering
Net als std::make_unique ondersteunt std::make_shared geen aangepaste deleter
Lambda
Aanbeveling 10.3.1 Gebruik lambda wanneer functies niet werken (variabelen vastleggen, of lokale functies schrijven)
Reden
Functies kunnen geen lokale variabelen vastleggen of in een lokaal bereik declareren; als dat nodig is, kies dan liever lambda in plaats van handgeschreven functor.
Aan de andere kant worden lambda en functor niet overladen; als overloading nodig is, gebruik dan functies.
Als lambda en functies beide kunnen worden gebruikt, geef dan de voorkeur aan functies; gebruik zoveel mogelijk het eenvoudigste hulpmiddel.
Voorbeeld
// Schrijf een functie die alleen int of string accepteert
// -- overloading is de natuurlijke keuze
void F(int);
void F(const string&);
// Nodig heeft om lokale status vast te leggen, of verschijnt in statement of expressie bereik
// -- lambda is de natuurlijke keuze
vector<Work> v = LotsOfWork();
for (int taskNum = 0; taskNum < max; ++taskNum) {
pool.Run([=, &v] {...});
}
pool.Join();
Regel 10.3.1 Gebruik geen lambdas met capture by reference buiten lokaal bereik
Reden
lambdas buiten lokaal bereik omvatten retourwaarden, opslag op de heap, of doorgeven aan andere threads. Lokale pointers en referenties zouden niet buiten hun bereik bestaan. lambdas die by reference capturen, slaan lokale objectreferenties op. Als dit leidt tot het bestaan van referenties buiten de levensduur van lokale variabelen, mag by reference niet worden gevangen.
Voorbeeld
// Slecht
void Foo()
{
int local = 42;
// Capture local by reference.
// Na de functie retourneert, bestaat local niet meer,
// dus het gedrag van Process() is ongedefinieerd!
threadPool.QueueWork([&]{ Process(local); });
}
// Goed
void Foo()
{
int local = 42;
// Capture local by value.
// Omdat het een kopie is, is local altijd geldig tijdens het proces van Process()
threadPool.QueueWork([=]{ Process(local); });
}
Aanbeveling 10.3.2 Als this wordt gevangen, geef dan expliciet alle variabelen op
Reden
In een member functie lijkt [=] by value te vangen. Maar omdat het een impliciete capture by value is van de this pointer en alle member variabelen kunnen worden bewerkt, worden member variabelen eigenlijk by reference gevangen, wat meestal wordt afgeraden. Als dit echt nodig is, geef dan expliciet de this capture op.
Voorbeeld
class MyClass {
public:
void Foo()
{
int i = 0;
auto Lambda = [=]() { Use(i, data_); }; // Slecht: lijkt op copy/by value capture, maar member variabelen zijn eigenlijk by reference captured
data_ = 42;
Lambda(); // calls use(42);
data_ = 43;
Lambda(); // calls use(43);
auto Lambda2 = [i, this]() { Use(i, data_); }; // Goed, expliciet specificeren dat het by value capture is, het duidelijkst, minste verwarring
}
private:
int data_ = 0;
};
Aanbeveling 10.3.3 Vermijd het gebruik van standaard capture modes
Reden Lambda expressies bieden twee standaard capture modes: by reference (&) en by value (=). De standaard capture by reference vangt impliciet alle lokale variabele referenties, wat gemakkelijk leidt tot het gebruik van zwevende referenties. In vergelijking met het expliciet opschrijven van de variabelen die moeten worden gevangen, kan dit gemakkelijker leiden tot het controleren van de object levensduur en het verminderen van fouten. De standaard capture by value vangt impliciet de this pointer en maakt het moeilijk om te zien welke variabelen de lambda functie afhankelijk zijn van. Als er statische variabelen zijn, zou het ook de lezer kunnen misleiden dat de lambda een kopie van de statische variabele maakt. Daarom zou men in het algemeen de variabelen die de lambda moet vangen expliciet opschrijven in plaats van het gebruik van standaard capture modes.
Fout voorbeeld
auto func()
{
int addend = 5;
static int baseValue = 3;
return [=]() { // Eigenlijk alleen addend kopiëren
++baseValue; // Wijziging beïnvloedt de waarde van de statische variabele
return baseValue + addend;
};
}
Correct voorbeeld
auto func()
{
int addend = 5;
static int baseValue = 3;
return [addend, baseValue = baseValue]() mutable { // Gebruik C++14 capture initialization om een kopie van de variabele te maken
++baseValue; // Wijziging beïnvloedt alleen de eigen kopie, niet de statische variabele
return baseValue + addend;
};
}
Referentie: “Effective Modern C++”: Item 31: Avoid default capture modes.
Interfaces
Aanbeveling 10.4.1 Gebruik T* of T& als parameters, niet slimme pointers, in scenario’s die geen betrekking hebben op eigendom
Reden
- Gebruik slimme pointers alleen om eigendom te verplaatsen of te delen als dat expliciet nodig is.
- Door slimme pointers door te geven, beperk je de functie oproepers om slimme pointers te moeten gebruiken (zoals wanneer de oproeper de voorkeur geeft aan het doorgeven van
this). - Het doorgeven van shared ownership slimme pointers heeft runtime overhead.
Voorbeeld
// Accepteert elke int*
void F(int*);
// Accepteert alleen int die eigendom willen overdragen
void G(unique_ptr<int>);
// Accepteert alleen int die eigendom willen delen
void G(shared_ptr<int>);
// Verandert niet het eigendom, maar heeft specifieke eigendoms oproepers nodig
void H(const unique_ptr<int>&);
// Accepteert elke int
void H(int&);
// Slecht
void F(shared_ptr<Widget>& w)
{
// ...
Use(*w); // Gebruikt alleen w -- helemaal geen betrekking op levenscyclusbeheer
// ...
};