C++ error LNK2005, fatal error LNK1169等重定义问题彻底解决的几种方案

背景

最近在写一套计算程序，主要用于进行专业上的一些仿真。期间需要自定义一些常用的数学函数，比如最常用的各种维度的线性插值、矩阵运算等。一种方法是统一定义一个数学库，将所有类型的函数全放进去，但这会导致该文件越来越大，且不便于分类管理。为此为打算为每类数学函数单独写一个类，以插值类为例，类里边包含从1维到4维的各插值函数等。

问题

但这样在其他类使用插值类时，就涉及到了一个调用的问题。可以在每一个需要调用插值类的类内部，如气动类中设置一个插值类的成员变量，但感觉这样会造成存储空间的浪费，因此想考虑使用类似Python那种引入一个通用的对象的形式。最开始是非常天真的直接在插值类声明后定义

//interp.h
#include"stdafx.h"

class interp
{
   ....
}itp;    

然后在其他使用插值类的类中直接调用itp使用其成员函数，由于使用插值类的使用者很多，如气动类，质量类等，在编译后会出现类似下面的错误

期初以为这是由于头文件重复包含导致的，但由于已经添加了#pragma once等处理，因此觉得莫名其妙。所以又专门学习了一下C++的内存模型，变量的存储持续性、链接性和作用域的知识，最后确定问题是由于C++的单定义规格(One Definition Rule，ODR)被违反引发的。所谓ODR是指C++在代码的编译和链接过程中不允许变量定义2次。为此简单记录一下存储持续性、链接性和作用域的知识。

原理

C++中的变量按存储类型，可以分为自动型，动态型，静态型，以及11中引入的线程，具体定义不再赘述。

链接性分为：

1.外部链接性，即定义该变量的文件内部和同一工程中其他文件中都可见，定义方式为在文件头部代码块的外部，如下图中的demoVar1.

// demo1.cpp
#include"stdafx.h"
#include"demo1.h"

int demoVar1{1};

void funcs ()
{
    ...
}

 

 

在其他文件中使用该变量时，需要采用extern引用声明

...
extern int demoVar1;
...

如果试图在其他文件的代码块外部再次重新定义该变量，则会在编译时引发重定义错误。 

2.内部链接性，即仅在定义该变量的文件内部可见，但对外部文件不可见，定义方式为在文件头部代码块的外部，并添加static关键字，如下图中的demoVar2：

// demo2.cpp
#include"stdafx.h"
#include"demo2.h"

static int demoVar2{1};

void funcs ()
{
    ...
}

3.无链接性，仅在代码块内部可见. 只有静态存储连续性的变量才具有外部链接型或内部链接型，自动连续性全为无链接性。当在代码块内定义静态变量时，同样采用static关键字，与本问题关系不大，略去。

作用域分为

1.全局：指变量的作用范围为一个文件内部；

2.局部：变量的作用范围在一个代码块内部。

具体的定义可以参考The C++ Progamming Language等各种参考书。

分析

在工程文件的一个.h文件或.cpp文件中代码块外部直接定义变量时，根据链接性规则可知该变量将成为外部链接型变量。而

根据C++的ODR原则，以及C++在编译时将所有工程文件统一处理的基本方式，如果我在Interp类的头文件中定义了一个外部变量itp1,而在气动类和质量类中均#include了Interp类，由于#include的处理是展开，这就相当于在气动类和质量类中又各自重复定义了一个外部链接性的itp1变量，在编译时出现了重复定义，这是不允许的，从而导致了重定义错误。

解决的基本思路就是避免重复定义，这是最基本的原则。其一是仅定义一次外部链接变量，并在其他使用该变量的文件中使用extern 引用该变量；其二就是使用内部链接型变量，在每个文件内定义的相同名称的内部链接变量不会导致重复定义问题，这和在一个头文件里统一定义const常量是同一个道理，因为const定义的变量默认是内部链接型的，因此可以总结出以下解决方法。

解决

1.在interp类的头文件中定义static型的全局变量itp，这样使用它的文件都相当于在本文件中定义了一个内部链接static的全局变量，个人认为这个是最方便的方法。

2.在每一个使用interp类，如气动类和质量类的.cpp,注意是.cpp文件中，单独定义static的itp对象。如果定义在头文件中，那么由于main.cpp主程序中不可避免的会include所有类的头文件，则相当于在main.cpp中重复定义了相同名称的static对象，因此会触发错误。

3.在interp类的cpp中定义外部链接变量，在使用它的类的cpp中使用extern声明引用。C++不建议采用这种全局的方式。

4.尽量避免在头文件中定义变量，因为互相include非常容易混乱，项目更复杂时就不那么好分析了。

总结

上述分析和解决可以总结得到，处理这个问题的一个基本出发点就是避免重定义，各个文件之间不能有重复定义的外部链接变量，一个文件内部（包括展开的inlcude)不能有重复定义的内部链接变量。以这个为基本原则根据具体的项目进行分析就可以解决具体的问题，毕竟项目文件的组织形式千差万别，上面提出的解决方式可能对另外一些项目就不适用了，只有基本原理是不变的。熟记避免头文件重复定义机制、头文件的本质以及变量ODR原则，就能够对各种可能出现的问题进行针对性的处理。