怎样削减C++代码间依赖

2023-10-03 20:10
文章标签 代码 c++ 依赖 削减 怎样

本文主要是介绍怎样削减C++代码间依赖,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

1. 介绍

C++程序编译很慢,特别是大型工程,你都可以趁着编译的功夫喝杯咖啡。这里面既有天灾也有人祸。

天灾请看此文,本文探讨怎么避免人祸。

2. 编译过程

后文需要,我们先了解C++源代码的编译过程
这里写图片描述
为叙述方便,图中各文件类型称呼如下:

  • .h 头文件
  • .cc 源文件
  • .o 目标文件

本文不探讨链接过程,只考虑编译和预处理。

预处理

经过预处理后,头文件就消失了。因为 #include 预处理指令将其展开在源文件中,编译阶段是不需要头文件的。常见的预处理指令还有 #if, #elif, #end, #ifndef, #define 等。

#include 其实非常简单,就是把文件在当前位置展开,没有任何多余的功能和限制。所以你不仅能 #include 头文件,还可以 #include .cc文件, 甚至任何文件。

编译

经过预处理后,只剩下源文件了,编译就是把每个源文件转换成目标文件。记住,源文件和目标文件是一一对应的。

编译的实质,是根据源文件生成目标文件的代码段数据段。这一点对于理解前向声明非常重要。

图解说

假设我们有4个源文件和4个头文件,include关系如下

//  A.h                             A.cc
#include "B.h"                     #include "A.h"----------------------------------------------------
//  B.h                             B.cc
#include "C.h"                     #include "B.h"----------------------------------------------------
//  C.h                             C.cc
#include nothing                   #include "C.h"----------------------------------------------------
//  D.h                             D.cc
#include "A.h"                     #include "D.h"#include "C.h" 

我们可以用一张图来表示这8个文件的预处理和编译两个阶段
这里写图片描述
虚箭头表示编译,是一对一的,没什么好说的。实箭头表示 #incude 关系。如果一个文件有修改,那么所有直接或间接依赖它的源文件都要重新编译。下面我们就根据此图讲解C++工程中的代码依赖问题。

3. 重复include

D.cc两次包含C.h,一次直接包含,一次通过间接包含。这会引起重定义错误,有两种方法解决。

经典的 ifndef

// A.h
#ifndef A_H
#define A_H// class definition#endif

或者 pragma once

// A.h
#pragma once// class defnition

4. 循环依赖

一旦代码中有循环依赖,编译将失败。上文的8个文件没有循环依赖,图中找不到有向循环路径。

万一你的代码出现循环依赖,请将导致循环依赖的代码提出来,放到新文件中。

5. 前向声明

前两个问题关乎对错,跟编译速度关系不大。现在开始,我们探讨怎么加快代码编译速度。

我们向文件中加点东西

//  A.h                             A.cc
#include "B.h"                     #include "A.h"class A {                          ....
public:void f1(B* b);                   void A::f1(B* b) {b->f3();void f2();                       }
};----------------------------------------------------
//  B.h                             B.cc
#include "C.h"                     #include "B.h"class B {
public:void f3();
};----------------------------------------------------
//  C.h                             C.cc
#include nothing                   #include "C.h"----------------------------------------------------
//  D.h                             D.cc
#include "A.h"                     #include "D.h"#include "C.h"class D {
public:
private:A a;
};

根据前文的依赖图,如果 B.h 修改,那么 A.cc 和 D.cc 都要重新编译。但是, D.cc 不应该重新编译,因为 class D 只受 class A 内存布局的影响,而 class A 的内存布局与 class B 没有关系,只是f1需要一个class B指针的参数而已。

于是C++允许 A.h 不包含 B.h ,只需声明 class B 即可,告诉编译器 B 这丫是个类名哈。A.h用前向声明替代include,但是 A.cc 中利用了 class B 的实现,所以 A.cc 要加一条 include(放心,源文件中的include不会传染,很少有 include 源文件的)

//  A.h                             A.cc
class B;                           #include "A.h"#include "B.h"class A {                          ....
public:void f1(B* b);                   void A::f1(B* b) {b->f3();void f2();                       }
};

依赖线一增一减,数量虽然没变,但是效果改善不少啊
这里写图片描述

6. Pimpl idiom

是不是有点儿累了,先歇会儿,然后再来看另外一个削减依赖的重磅武器 Piml(pointer to implementation)。

pimpl idiom主要运用在库的接口设计中。如果团队人数达100,有一个维护基础库的小组。原则上除了接口升级,基础库的任何升级都不应该触发应用层模块的重编译。

我们假设 A.h 是基础库的接口,B.cc 是应用层源文件。

// A.h                      A.cc
#include "xx.h"
#include "yy.h"
#include "zz.h"class A {                       
public: A();                     A() { ... }~A();                    ~A() { ... }void f1();               void A::f1() { ... }void f2();               void A::f2() { ... }
private:XX x;YY y;ZZ z;
};-----------------------------------------------------
// B.cc
#include "A.h"class B {
public:
private:A a;
};

依赖图如下
这里写图片描述
从依赖图明显看出这种代码组织方式有缺陷,XX.h, YY.h, ZZ.h 任何一个文件的修改都会触发 B.cc 重编译。那三个文件都是库内部的文件,原则上是与B.cc无关的,并且这三个头文件很可能包含别的头文件,导致程序库最深处的修改都能轻易触发应用层代码重编译。

这时候该Pimpl显身手了,我们把 A.h, A.cc 改造如下

// A.h                         A.cc
class A {                      #include "A.h"   
public:                        #include "XX.h"A();                         #include "YY.h"~A();                        #include "ZZ.h"void f1();                 void f2();                   class A::Impl {
private:                       public:class Impl;                    Impl() { ... }Impl* impl_;                   ~Impl() { ... }
};                               void f1() { ... }void f2() { ... }private:XX x;YY y;ZZ z;};A::A() : impl_(new A::Impl()) {}A::~A() { delete impl_; }void A::f1() {impl_->f1();}void A::f2() {impl_->f2();}

把A中所有非接口的东西都移到Impl中去,依赖图变成下面的样子。
这里写图片描述
从依赖图看出,只有 A.h 的修改才能触发 B.cc 重编译,而 A.h 中只有库接口,库的接口都变了,应用层当然要重编译咯。

7. 参考资料

1.C++ Compilation Speed
2.Pimpl For Compile-Time Encapsulation (Modern C++)
本文转自:怎样削减C++代码间依赖
作者:wankai

这篇关于怎样削减C++代码间依赖的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/652

相关文章

C#使用SQLite进行大数据量高效处理的代码示例

《C#使用SQLite进行大数据量高效处理的代码示例》在软件开发中,高效处理大数据量是一个常见且具有挑战性的任务,SQLite因其零配置、嵌入式、跨平台的特性,成为许多开发者的首选数据库,本文将深入探... 目录前言准备工作数据实体核心技术批量插入:从乌龟到猎豹的蜕变分页查询:加载百万数据异步处理:拒绝界面

用js控制视频播放进度基本示例代码

《用js控制视频播放进度基本示例代码》写前端的时候,很多的时候是需要支持要网页视频播放的功能,下面这篇文章主要给大家介绍了关于用js控制视频播放进度的相关资料,文中通过代码介绍的非常详细,需要的朋友可... 目录前言html部分:JavaScript部分:注意:总结前言在javascript中控制视频播放

Spring Boot 3.4.3 基于 Spring WebFlux 实现 SSE 功能(代码示例)

《SpringBoot3.4.3基于SpringWebFlux实现SSE功能(代码示例)》SpringBoot3.4.3结合SpringWebFlux实现SSE功能,为实时数据推送提供... 目录1. SSE 简介1.1 什么是 SSE?1.2 SSE 的优点1.3 适用场景2. Spring WebFlu

java之Objects.nonNull用法代码解读

《java之Objects.nonNull用法代码解读》:本文主要介绍java之Objects.nonNull用法代码,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录Java之Objects.nonwww.chinasem.cnNull用法代码Objects.nonN

SpringBoot实现MD5加盐算法的示例代码

《SpringBoot实现MD5加盐算法的示例代码》加盐算法是一种用于增强密码安全性的技术,本文主要介绍了SpringBoot实现MD5加盐算法的示例代码,文中通过示例代码介绍的非常详细,对大家的学习... 目录一、什么是加盐算法二、如何实现加盐算法2.1 加盐算法代码实现2.2 注册页面中进行密码加盐2.

python+opencv处理颜色之将目标颜色转换实例代码

《python+opencv处理颜色之将目标颜色转换实例代码》OpenCV是一个的跨平台计算机视觉库,可以运行在Linux、Windows和MacOS操作系统上,:本文主要介绍python+ope... 目录下面是代码+ 效果 + 解释转HSV: 关于颜色总是要转HSV的掩膜再标注总结 目标:将红色的部分滤

在C#中调用Python代码的两种实现方式

《在C#中调用Python代码的两种实现方式》:本文主要介绍在C#中调用Python代码的两种实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录C#调用python代码的方式1. 使用 Python.NET2. 使用外部进程调用 Python 脚本总结C#调

C++ 中的 if-constexpr语法和作用

《C++中的if-constexpr语法和作用》if-constexpr语法是C++17引入的新语法特性,也被称为常量if表达式或静态if(staticif),:本文主要介绍C++中的if-c... 目录1 if-constexpr 语法1.1 基本语法1.2 扩展说明1.2.1 条件表达式1.2.2 fa

Java时间轮调度算法的代码实现

《Java时间轮调度算法的代码实现》时间轮是一种高效的定时调度算法,主要用于管理延时任务或周期性任务,它通过一个环形数组(时间轮)和指针来实现,将大量定时任务分摊到固定的时间槽中,极大地降低了时间复杂... 目录1、简述2、时间轮的原理3. 时间轮的实现步骤3.1 定义时间槽3.2 定义时间轮3.3 使用时

Java中&和&&以及|和||的区别、应用场景和代码示例

《Java中&和&&以及|和||的区别、应用场景和代码示例》:本文主要介绍Java中的逻辑运算符&、&&、|和||的区别,包括它们在布尔和整数类型上的应用,文中通过代码介绍的非常详细,需要的朋友可... 目录前言1. & 和 &&代码示例2. | 和 ||代码示例3. 为什么要使用 & 和 | 而不是总是使