接口是程序的两个部分之间的契约。 准确地说明对服务供应商和该服务的用户的期望是至关重要的。 良好(易于理解,鼓励有效使用,不容易出错,支持测试等)接口可能是代码组织最重要的单一方面。
I.1:使接口显式化
Reason
正确性。 在接口没有规定的假设很容易被忽视,很难测试。
Example, bad
通过全局(命名空间范围)变量(调用模式)控制函数的行为是隐式的,可能会造成混淆。 例如:
int round(double d)
{
return (round_up) ? ceil(d) : d; // don't: "invisible" dependency
}
对于调用者来说,两个round(7.2)
调用的含义可能给出不同的结果并不明显。
Exception
有时我们通过环境变量控制一组操作的细节,例如,正常与详细输出或调试与优化。 使用非本地控件可能会造成混淆,但仅控制其他固定语义的实现细节。
Example, bad
通过非局部变量(例如,errno
)进行报告很容易被忽略。 例如:
// don't: no test of printf's return value
fprintf(connection, "logging: %d %d %d\n", x, y, s);
如果连接断开以便不产生日志记录输出怎么办? 见我。???。
替代方案:抛出异常。 一个例外是不容忽视的。
备选方案:避免通过非本地或隐式状态在接口上传递信息。 请注意,非const成员函数通过其对象的状态将信息传递给其他成员函数。
替代公式:接口应该是一个函数或一组函数。 函数可以是模板函数,函数集可以是类或类模板。
Enforcement
- (简单)函数不应基于在命名空间范围内声明的变量值来做出控制流决策。
- (简单)函数不应该写在命名空间内声明的变量。
I.2:避免使用非const全局变量
Reason
非const
全局变量隐藏依赖关系并使依赖关系受到不可预测的更改。
Example, bad
struct Data {
// ... lots of stuff ...
} data; // non-const data
void compute() // don't
{
// ... use data ...
}
void output() // don't
{
// ... use data ...
}
还有谁可以修改 data
?
Note
Global constants are useful.
Note
针对全局变量的规则也适用于命名空间范围变量。
Note
替代方法:如果使用全局(更常见的命名空间作用域)数据来避免复制,请考虑通过引用将数据作为对象传递给const。 另一种解决方案是将数据定义为某个对象的状态,将操作定义为成员函数。
警告:注意数据竞争:如果一个线程可以访问非本地数据(或通过引用传递的数据),而另一个线程执行被调用者,我们可以进行数据竞争。 每个指针或对可变数据的引用都是潜在的数据竞争。
Note
您不能在不可变数据上有竞争条件。
References: See the rules for calling functions.
Enforcement
规则是"avoid",而不是“don't use”。 当然会有(罕见的)例外,例如cin
,cout
和cerr
。
Enforcement
(简单)在命名空间范围内声明的所有非const变量。
I.3:避免单例
Reason
单例基本都是复杂变相全局对象。
Example
class Singleton {
// ... lots of stuff to ensure that only one Singleton object is created,
// that it is initialized properly, etc.
};
There are many variants of the singleton idea. That's part of the problem.
Note
如果您不想更改全局对象,请将其声明为const
或constexpr
。
Exception
您可以使用最简单的“单例”(如此简单以至于通常不被视为单例)在首次使用时进行初始化(如果有):
X& myX()
{
static X my_x {3};
return my_x;
}
这是与初始化顺序相关的问题的最有效解决方案之一。 在多线程环境中,静态对象的初始化不会引入竞争条件(除非您不小心从其构造函数中访问共享对象)。
请注意,本地static
的初始化并不意味着竞争条件。 但是,如果X
的销毁涉及需要同步的操作,我们必须使用不太简单的解决方案。 例如:
X& myX()
{
static auto p = new X {3};
return *p; // potential leak
}
现在有人必须以某种适当的线程安全方式delete
该对象。 这很容易出错,所以我们不会使用那种技术
-
myX
是多线程代码, - 需要销毁
X
对象(例如,因为它释放了资源) -
X
的析构函数代码需要同步。
如果您像许多人一样将单例定义为仅为其创建一个对象的类,则像myX
这样的函数不是单例,并且这种有用的技术不是非单例规则的例外。
Enforcement
一般来说很难。
- 查找名称包含
singleton
的类。 - 查找仅创建单个对象的类(通过计算对象或检查构造函数)。
- 如果类X有一个公共静态函数,它包含类'X类的函数局部静态并返回指针或引用它,那就禁止它。
I.4:接口类型必须明确
Reason
类型是最简单和最好的文档,具有定义良好的含义,并且保证在编译时进行检查。而且,精确类型的代码通常会得到更好的优化。
Example, don’t Consider:
void pass(void* data); // void* is suspicious
现在被调用者必须将数据指针(后面)转换为正确的类型才能使用它。 这容易出错并且经常冗长。 避免 void *
,特别是在接口中。 考虑使用变量或指针来代替。
Alternative:
通常,模板参数可以消除void *
将其转化为T&或者T*,对于通用代码,这些Ts可以是通用或概念约束的模板参数。
Example, bad Consider:
void draw_rect(int, int, int, int); // great opportunities for mistakes
draw_rect(p.x, p.y, 10, 20); // what does 10, 20 mean?
int
可以携带任意形式的信息,因此我们必须猜测四个int
的含义。 最有可能的是,前两个是x,y坐标对,但最后两个是什么? 注释和参数名称可以提供帮助,但我们可以明确:
void draw_rectangle(Point top_left, Point bottom_right);
void draw_rectangle(Point top_left, Size height_width);
draw_rectangle(p, Point{10, 20}); // two corners
draw_rectangle(p, Size{10, 20}); // one corner and a (height, width) pair