C++中的.cpp文件包含:深入解析与最佳实践 | 技术详解

C++中的.cpp文件包含:深入解析与最佳实践 #

在C++开发中,通常我们只包含头文件而不是源文件。但有时会遇到直接包含.cpp文件的情况,这种做法是否可行?本文将深入分析include .cpp文件的原理和最佳实践。

前两天突然看见部门有个项目的代码里通篇全是#include “xxx.cpp”,我表示从来没见过这种写法,引发了我的一些思考:

问题一:这啥玩意?

C++是一门高深莫测的语言,什么写法都有,而且#include本质上就是复制粘贴代码,我也不敢说别人写的不对,可能开发者是C++大佬,写了一些我们普通人无法理解的代码也是正常的。

问题二:整个项目都是这种引用方式,不会导致某一函数重复定义吗?

为此我查了一些资料,并做了一些测试:

代码段1:

// file1.cc
#include <iostream>
using std::cout;

void ddd() { 
    cout << "ddd \n"; 
}

代码段2:

// file2.cc
#include "file1.cc"

int main() {    
    ddd();    
    return 0;
}

代码段3:

// filec.cc
#include "file1.cc"

void f() {    
    ddd();
}

然后三个源文件一起编译链接:

img

发现报错了,的确出现了multiple definition的错误,确实一个函数不能有多个定义。我又改了下代码:

// file1.cc
#include <iostream>
using std::cout;

inline void ddd() { 
    cout << "ddd \n"; 
}

将ddd函数改成了内联函数,然后三个源文件一起编译链接:

img

编译成功且正常输出。

我将普通函数改成成员函数又测试了一次:

代码段1:

// file1.cc
#include <iostream>
using std::cout;

struct A {    
    int a_;    
    void func();
};

void A::func() { 
    cout << "file1.cc a " << a_ << "\n"; 
}

代码段2:

// file2.cc
#include "file1.cc"

int main() {    
    A a;    
    a.func();    
    return 0;
}

代码段3:

// filec.cc
#include "file1.cc"

void f() {    
    A a;    
    a.func();
}

然后一起编译链接:

img

发现成员函数这样定义也会报错,也会有multiple definition的错误,我又改了一下代码:

// file1.cc
#include <iostream>
using std::cout;

struct A {    
    int a_;    
    void func() { 
        cout << "file1.cc a " << a_ << "\n"; 
    }
};

将函数的定义搬运到了类中,编译链接:

img

程序正常运行,熟悉C++的朋友可能都知道原因,类中定义的函数就相当于是内联函数,所以编译链接不会有问题。

所以得出结论:

  • 内联函数的定义可以被多个源文件引入(内联函数到最后其实不是个函数)
  • 类的定义可以被多个源文件引入(这是必须的,要不然编译器怎么知道类的对象布局)

问题三:貌似平时使用的模板就多数都定义在头文件中,这个不会导致某一函数重复定义吗?

直接看三段代码吧:

代码段1:

// temp.h
#include <iostream>

template <typename T>
struct B {    
    T a;    
    void ff() { 
        std::cout << "temph \n"; 
    }
};

代码段2:

// filec.cc
#include "temp.h"

void f() {    
    B<int> a;    
    a.ff();
}

代码段3:

// file2.cc
#include "temp.h"

int main() {    
    B<int> a;    
    a.ff();    
    return 0;
}

所有源文件编译链接:

img

发现编译成功且正常运行,那如果函数的定义不在类内会怎么样呢?

// temp.h
#include <iostream>

template <typename T>
struct B {    
    T a;    
    void ff();
};

template <typename T>
void B<T>::ff() {    
    std::cout << "temph \n";
}

程序编译链接后:

img

编译链接成功且输出正常结果。

所以得出结论:编译器对模板做了特殊处理,不论模板类中函数是否内联,都可以正常链接。

这个结论其实不是我得出的(所以可信),而是gnu文档(参考资料的最后一个链接)写的,上述代码只是为了印证结论。

大体意思如下:编译器对模板做了特殊处理,如果函数不是内联函数,那可以有两种处理方式:

  1. 链接时随机选择一个定义,其它的丢弃掉
  2. 编译器会把函数的定义单独提出来,提到单独一个文件中,对此文件单独编译,就不会出现重复定义的问题。

参考资料

https://zybuluo.com/uuprince/note/81709

https://stackoverflow.com/questions/15866258/template-class-multiple-definition

https://gcc.gnu.org/onlinedocs/gcc/Template-Instantiation.html