大型项目开发: 头文件顺序-阿里云开发者社区

开发者社区> horky> 正文

大型项目开发: 头文件顺序

简介: 经验告诉我们,某些编码实践虽然在C++中完全合法,但是绝对不能应用于大型项目环境中。 大型项目环境下必须有适当的约束,否则很容易变得难以控制并很难维护(摘自)。
+关注继续查看

经验告诉我们,某些编码实践虽然在C++中完全合法,但是绝对不能应用于大型项目环境中。 大型项目环境下必须有适当的约束,否则很容易变得难以控制并很难维护(摘自<<大规模C++程序设计>>)。下面以Chromium中运用的两个Coding Style中定义的头文件顺序为例。

头文件顺序的差异

WebKit/Blink遵循业界标准的定义,其实也是Lakos在<<大规模C++程序设计>>中建议的顺序 :

  1. 编译单元对应的头文件 (Related header file)。
  2. 工程内的其它头文件。
  3. 库及系统头文件。

(Blink特殊的一点是编译单元必须先包含config.h。)

这样做的目的是为避免隐性依赖。每个头文件都应当做到自包含(Self-Contained, or Self Sufficient), 这样保证用户能直接头文件中理解它的物理依赖。如果遵循这个顺序,当出现隐性依赖时,是无法编译通过的。

下面这个例子:
my_class.h中依赖了std::string, 但没有显式的包含,当main里先包含标准库的头文件string时,编译是不会出错的。

main.cc

#include <string>
#include <iostream>
#include "my_class.h"

int main(int argc, char* argv[]) {
  MyClass aInstance;
  std::cout << aInstance.value() << std::endl;
}

my_class.h

#ifndef MY_CLASS_H_
#define MY_CLASS_H_
class MyClass {
 public:
  MyClass();
  const std::string& value();
 private:
  std::string value_;
};
#endif

如果遵循上面的规则,就会在编译main.cc时报错:
In file included from main.cc:1:
./my_class.h:6:9: error: use of undeclared identifier 'std'
  const std::string& value();

在一个层次更为清晰的项目下,错误最好归属到作者身上。这里main.cc做为my_class.h的用户,这样的错误最好由my_class.h的作者来解决。所以Google定义了如下的规则:
关联的头文件
C库头文件
C++库头文件
其它库头文件
* 项目中的其它头文件。
实现如下的my_class.cc时就会收到报错:
my_class.cc
#include "my_class.h"
#include <string>


MyClass::MyClass()
  :value_("Hello!") {
}

在这种情况下,这个错误将只报给my_class.h对应的编译单元my_class.cc。
In file included from my_class.cc:1:
./my_class.h:6:9: error: use of undeclared identifier 'std'
  const std::string& value();

如果是一个小项目,可能察觉不到这样做的差异。但在讲求职责清晰,分工协作的大型项目下,它就会变得很有价值。
这是一个很小的点,可见大型项目中一些规则定义的冰山一角。再比如大型项目中的头文件还有一些设计上的权衡。比如避免不必要包含头文件会拖慢项目的构建效率,引入了前置声明。但它却在一些场景下会造成歧义(比如前置声明标准库中的类,或者模板类),或者引入一些的维护成本和风险(比如函数的参数变化,需要对应修改前置声明)。Google早期是鼓励使用前置声明,而现在只是强调在明确带来好处的情况下才建议使用前置声明。

扩展阅读:

Self-sufficient header files in C/C++
Headers and Includes: Why and How
C/C++ include file order/best practices

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
程序员知识体系探索:点、线、面、体(下)
程序员知识体系探索:点、线、面、体(下)
10 0
安卓平板体验Java开发,还能白嫖一年阿里无影云!真香
阿里无影云早有耳闻,前两天看朋友发体验照片,可能是程序员天生爱折腾的特性又发挥作用了,自己也没能忍住,赶快下载体验了一把,没想到“很香”。我体验了浏览器端、Windows 客户端和安卓平板端,下面就来聊聊使用的过程和使用体验。内含一年免费无影云的白嫖方法,千万别错过哦~
29 0
【另类架构】之驾车感悟(上)
【另类架构】之驾车感悟(上)
4 0
Linux 基本操作 | 学习笔记
快速学习 Linux 基本操作。
5 0
使用 Go 语言编写的恶意软件激增 2000%
  近日,网络安全公司 Intezer 发布了 2022 年基于 Go 语言恶意软件的报告。报告指出:恶意软件的开发者已经从 C 和 C++ 逐渐转向 Go 语言,自 2017 年以来,基于 Go 语言的恶意软件数量呈现爆发式增长,增幅超过了 2000%。   自从 2012 年发现了第一个使用 Go 语言编写的恶意软件之后,Go 语言就在恶意软件领域渐渐流行起来了。2019 年 7 月,Palo Alto Networks 发布了一份使用 Go 语言编写的恶意软件分析报告。报告发现,2019 年以前使用 Go 语言编写恶意软件是一件罕见的事情,但到了 2019 年,这种情况每天都会发生,2
6 0
后端缓存的23个关键关注点(2)
后端缓存的23个关键关注点(2)
4 0
程序员为什么要持续学习(升级版)
程序员为什么要持续学习(升级版)
3 0
Spring Boot 基础教程:使用 Swagger3 生成 API 接口文档
主要介绍如何使用 Spring Boot 集成 Swagger3,构建我们自己的 API 接口文档,并对比了 Swagger2 和 Swagger3 的区别,让我们从 Swagger2 向 Swagger3 过渡更加顺滑。
8 0
漫谈“架构团队”之组织架构(下)
漫谈“架构团队”之组织架构(下)
6 0
+关注
horky
Web及移动开发技术
294
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
《2021云上架构与运维峰会演讲合集》
立即下载
《零基础CSS入门教程》
立即下载
《零基础HTML入门教程》
立即下载