C++ 模板函数，重复定义
背景
最近尝试编译C++项目，编译的时候遇到如下报错：
.obj/Inotify.o:(.bss+0x0): multiple definition of `EVENT_NAME'
.obj/FileServer.o:(.bss+0x0): first defined here
.obj/server_main.o:(.bss+0x0): multiple definition of `EVENT_NAME'
.obj/FileServer.o:(.bss+0x0): first defined here
collect2: error: ld returned 1 exit status
Makefile:71: recipe for target 'server_main' failed
make: *** [server_main] Error 1
回头看代码发现头文件Inotify.h这个文件在FileServer.h中已经被引用，然后再server_main.cc文件中又引用了FileServer.h这个文件,但是在最后执行
g++ .obj/Server.grpc.pb.o .obj/Server.pb.o .obj/Prepare.o .obj/FileServer.o .obj/Thread.o .obj/Inotify.o .obj/server_main.o -L /usr/local/lib -std=c++11 `pkg-config --libs protobuf grpc++ grpc` -Wl,--no-as-needed -lgrpc++_reflection -Wl,--as-needed -ldl util/.obj/File.o -o server_main
命令进行链接的时候，将所有的目标文件装载到同一环境的时候出现了重复定义的问题，后来尝试将变量EVENT_NAME变成static就好了，于是就研究了一下出现这种问题的原因。
编译、链接过程
预处理将伪指令（宏定义、条件编译、和引用头文件）和特殊符号进行处理
预处理程序将include头文件的内容包含进源文件，这个过程完成后，头文件就没用了
编译过程通过词法分析、语法分析等步骤生成汇编代码的过程，过程中还会进行优化
汇编过程将汇编代码翻译为目标机器指令的过程（.o文件，至少包含代码段和数据段）
链接程序将所有需要用到的目标代码（变量函数或其他库文件等）装配到一个整体中（可分为静态链接和动态链接）
问题
如果在头文件中定义了变量（是定义不是声明），并分别在a.c和b.c中进行了引用，编译过程中这个变量的符号会同时包含在a.o和b.o中，导致链接失败，原因是C语言规定“一个变量可以多次声明但只能定义一次”，解决办法是在头文件中加上#ifndef X条件编译，使该变量只定义一次，但是这里又有一个问题，该解决办法只适用C而不适用C++，在C++中，即使在头文件中加了#ifndef X，链接错误同样会发生，原因是C++中#ifndef X的作用域仅在单个文件中，因此只要在.h中定义了变量并在不同.cpp中进行引用，链接时都会报重定义错误，再说得直白点，a.cpp和b.cpp都引用了条件编译的g.h，g.h的条件编译只能分别保证在a.cpp和b.cpp中不出现重复定义，但在链接a.o和b.o的过程中就会发现重复定义。
下面是一个错误的例子：
#ifndef __CONST_H__
#define __CONST_H__
const char *zutypes[] = {
"CL", "CY", "GM", "SSD", "XC", "ZS", "ZWX", "LS"
, "KQWR", "LY", "KT", "DY", "FS", "GJ", "HC"
, "JT", "LK", "YS", "MF", "YSH", "PJ", "FFZ"
, "HZ", "TGWD", "FH", "XQ", "YD", "YH"
}; // 28种指数类型映射表
#endif // __CONST_H__
// hfTrans.h
#ifndef __HFTRANS_H__
#define __HFTRANS_H__
#include "const.h"
#endif // __HFTRANS_H__
// hfTrans.cpp
#include "hfTrans.h"
...
// main.cpp
#include "hfTrans.h"
...
编译输出:
Linking console executable: bin/Debug/main
obj/Debug/main.o:(.data+0x0): multiple definition of `zutypes'
obj/Debug/hfTrans.o:(.data+0x0): first defined here
collect2: ld 返回 1
Process terminated with status 1 (0 minutes, 0 seconds)
0 errors, 0 warnings
解决方法
变量前用static修饰
static限制了变量的作用域，该变量仅在引用.h的源文件中有效，也就是说.h被引用了几次这个变量就被定义了几次，且各变量之间互不影响（各变量具有不同的内存地址）。这种方法不适用于定义全局变量，因为它们不是同一个变量（相当于多个同名的人住在不同的地方）。
例子：
// global.h
#ifndef __GLOBAL_H__
#define __GLOBAL_H__
#include <stdio.h>
static int var = 10;
#endif
// test1.cpp
#include "global.h"
void print1()
{
printf("%p = %d\n", &var, var); // 打印变量的内存地址
}
// test2.cpp
#include "global.h"
void print2()
{
printf("%p = %d\n", &var, var);
}
// main.cpp
#include "global.h"
extern void print1();
extern void print2();
int main()
{
print1();
var = 5;
printf("%p = %d\n", &var, var);
print2();
return 0;
}
输出结果：
0x8049840 = 10
0x804983c = 5
0x8049844 = 10 # var地址各不相同，内容互不影响
Process returned 0 (0x0) execution time : 0.046 s
Press ENTER to continue.
根据static的上述特性，在源文件开头处（紧跟include后）可直接定义static非全局变量。
变量前用const修饰
表示此变量是常量，内容不可修改，与static特性相似，该常量仅在引用.h的源文件中有效。将上述例子中的static关键字修改为const，可以发现每个源文件的var地址依然不同，因此这种方法也不适用于定义全局变量（当然，在某种程度上，如果不在乎重复分配内存也可以用这种方法）。
例子：
// global.h
#ifndef __GLOBAL_H__
#define __GLOBAL_H__
#include <stdio.h>
const int var = 10;
#endif
输出结果：
0x80485e0 = 10
0x80485d0 = 10
0x80485f0 = 10
Process returned 0 (0x0) execution time : 0.005 s
Press ENTER to continue.
到这里可以发现在C++中，const和static一样都可以使变量具有内部链接属性。只有变量的作用域为当前模块时，该变量才可以在头文件中定义，否则链接时就会报重定义错误，因此只有const和static变量可以在头文件中定义。另外在C++中，const值在编译期间被保存在符号表中，即使在运行期间通过间接方法改变了const值（改变的其实是内存中的拷贝），输出值也不会改变。
根据const的上述特性，在源文件开头处（紧跟include后）可直接定义const非全局常量。
定义一般常量没有问题，需要注意的是用const定义指针，指针必须符合上述原则才能通过链接：
// global.h
const char str[][8] = { "Hello, ", "World!" }; // 正确, str是常量字符串数组
char const str[][8] = { "Hello, ", "World!" }; // 正确, 同上
static char str[][8] = { "Hello, ", "World!" }; // 正确
static const char str[][8] = { "Hello, ", "World!" }; // 正确
const char* str[] = { "Hello, ", "World!" }; // 错误，str非内部链接
char* const str[] = { "Hello, ", "World!" }; // 正确，但不建议常量字符串到char*的转换
const char* const str[] = { "Hello, ", "World!" }; // 正确, str是指向常量字符串的常量指针数组
static char* str[] = { "Hello, ", "World!" }; // 正确，但不建议
定义全局常量时经常将const和extern结合使用
前面提到const修饰的变量具有内部链接属性，用extern修饰的变量具有外部链接属性，也就是说将两者结合就可以实现全局和只读变量的目的，但需要说明的是，变量必须在头文件中给出声明而不是定义，然后在与头文件对应的源文件中给出定义（也可以在任意引用该头文件的源文件中给出定义，但不推荐）。
// global.h
#ifndef GLOBAL_H_INCLUDED
#define GLOBAL_H_INCLUDED
#include <stdio.h>
extern const int var; // 声明var
#endif // GLOBAL_H_INCLUDED
// global.cpp
#include "global.h"
const int var = 10; // 正确，定义var
// test1.cpp
#include "global.h"
//const int var = 10; // 正确，但不推荐，容易出现重定义
void print1()
{
const int var = 0; // 错误，var的作用域为print1()
printf("%p = %d\n", &var, var); // 局部变量var覆盖了全局变量
}
// test2.cpp
#include "global.h"
void print2()
{
printf("%p = %d\n", &var, var);
}
// main.cpp
#include "global.h"
extern void print1();
extern void print2();
int main()
{
print1();
printf("%p = %d\n", &var, var);
print2();
return 0;
}
输出结果：
0xbfcff14c = 0
0x80485d0 = 10
0x80485d0 = 10 # var地址相同
Process returned 0 (0x0) execution time : 0.014 s
Press ENTER to continue.
可以看到在global.cpp中定义的var具有全局唯一性，在每个模块中访问的var地址都相同，例子的var是常量，不能改变它的值，如果在头文件中声明extern int var并在源文件中定义int var = 10，然后在需要用到var的模块中引入该头文件，就可以实现C语言的全局变量，并且它的值可以被改变。
补充
原则：注意声明和定义的区别，避免在头文件中定义变量。
编译单元：一个编译单元就是一个经过预处理的源文件（.c.cpp）。
内部链接：如果一个名称对于它的编译单元来说是局部的，并且在链接的时候不会与其它编译单元中同样的名称相冲突，则这个名称具有内部链接。
外部链接：如果一个名称在链接时可以和其他编译单元交互，那么这个名称就具有外部链接。
分别编译：每个文件中所用到的名字及其类型，必须在这个文件中进行声明，使该文件的编译工作与整个程序的其他文件无关。
C++规定，有const修饰的变量，不但不可修改，还都将具有内部链接属性，也就是只在本文件可见。这是原来C语言的static修饰字的功能，现在const也有这个功能了。
C++又补充规定，extern const联合修饰时，extern将压制const的内部链接属性。
C++定义全局变量的方法：在.h文件中声明extern int var; 在.cpp文件中定义int var = 10;
分割线
最近遇到问题：头文件中定义函数时，函数如果声明不是inline就会出现multiple definition错误，总结原因是因为inline字段没有理解清楚
1、引入 inline 关键字的原因
在 c/c++ 中，为了解决一些频繁调用的小函数大量消耗栈空间（栈内存）的问题，特别的引入了 inline 修饰符，表示为内联函数。
栈空间就是指放置程序的局部数据（也就是函数内数据）的内存空间。
在系统下，栈空间是有限的，假如频繁大量的使用就会造成因栈空间不足而导致程序出错的问题，如，函数的死循环递归调用的最终结果就是导致栈内存空间枯竭。
下面我们来看一个例子：
实例
include <stdio.h>
//函数定义为inline即:内联函数
inline char* dbtest(int a) {
return (i % 2 > 0) ? "奇" : "偶";
}
int main()
{
int i = 0;
for (i=1; i < 100; i++) {
printf("i:%d 奇偶性:%s /n", i, dbtest(i));
}
}
上面的例子就是标准的内联函数的用法，使用 inline 修饰带来的好处我们表面看不出来，其实，在内部的工作就是在每个 for 循环的内部任何调用 dbtest(i) 的地方都换成了 (i%2>0)?"奇":"偶"，这样就避免了频繁调用函数对栈内存重复开辟所带来的消耗。
2、inline使用限制
inline 的使用是有所限制的，inline 只适合涵数体内代码简单的涵数使用，不能包含复杂的结构控制语句例如 while、switch，并且不能内联函数本身不能是直接递归函数（即，自己内部还调用自己的函数）。
3、inline仅是一个对编译器的建议
inline 函数仅仅是一个对编译器的建议，所以最后能否真正内联，看编译器的意思，它如果认为函数不复杂，能在调用点展开，就会真正内联，并不是说声明了内联就会内联，声明内联只是一个建议而已。
4、建议 inline 函数的定义放在头文件中
其次，因为内联函数要在调用点展开，所以编译器必须随处可见内联函数的定义，要不然就成了非内联函数的调用了。所以，这要求每个调用了内联函数的文件都出现了该内联函数的定义。
因此，将内联函数的定义放在头文件里实现是合适的，省却你为每个文件实现一次的麻烦。
声明跟定义要一致：如果在每个文件里都实现一次该内联函数的话，那么，最好保证每个定义都是一样的，否则，将会引起未定义的行为。如果不是每个文件里的定义都一样，那么，编译器展开的是哪一个，那要看具体的编译器而定。所以，最好将内联函数定义放在头文件中。
5、类中的成员函数与inline
定义在类中的成员函数默认都是内联的，如果在类定义时就在类内给出函数定义，那当然最好。如果在类中未给出成员函数定义，而又想内联该函数的话，那在类外要加上 inline，否则就认为不是内联的。
class A
{
public:void Foo(int x, int y) { } // 自动地成为内联函数
}
将成员函数的定义体放在类声明之中虽然能带来书写上的方便，但不是一种良好的编程风格，上例应该改成：
// 头文件
class A
{
public:
void Foo(int x, int y);
}
// 定义文件
inline void A::Foo(int x, int y){}
6、inline 是一种"用于实现的关键字"
关键字 inline 必须与函数定义体放在一起才能使函数成为内联，仅将 inline 放在函数声明前面不起任何作用。
如下风格的函数 Foo 不能成为内联函数：
inline void Foo(int x, int y); // inline 仅与函数声明放在一起
void Foo(int x, int y){}
而如下风格的函数 Foo 则成为内联函数：
void Foo(int x, int y);
inline void Foo(int x, int y) {} // inline 与函数定义体放在一起
所以说，inline 是一种"用于实现的关键字"，而不是一种"用于声明的关键字"。一般地，用户可以阅读函数的声明，但是看不到函数的定义。尽管在大多数教科书中内联函数的声明、定义体前面都加了inline 关键字，但我认为inline不应该出现在函数的声明中。这个细节虽然不会影响函数的功能，但是体现了高质量C++/C 程序设计风格的一个基本原则：声明与定义不可混为一谈，用户没有必要、也不应该知道函数是否需要内联。
7、慎用 inline
内联能提高函数的执行效率，为什么不把所有的函数都定义成内联函数？如果所有的函数都是内联函数，还用得着"内联"这个关键字吗？
内联是以代码膨胀（复制）为代价，仅仅省去了函数调用的开销，从而提高函数的执行效率。
如果执行函数体内代码的时间，相比于函数调用的开销较大，那么效率的收获会很少。另一方面，每一处内联函数的调用都要复制代码，将使程序的总代码量增大，消耗更多的内存空间。
以下情况不宜使用内联：
（1）如果函数体内的代码比较长，使用内联将导致内存消耗代价较高。
（2）如果函数体内出现循环，那么执行函数体内代码的时间要比函数调用的开销大。类的构造函数和析构函数容易让人误解成使用内联更有效。要当心构造函数和析构函数可能会隐藏一些行为，如"偷偷地"执行了基类或成员对象的构造函数和析构函数。所以不要随便地将构造函数和析构函数的定义体放在类声明中。一个好的编译器将会根据函数的定义体，自动地取消不值得的内联（这进一步说明了 inline 不应该出现在函数的声明中）。
8、总结
内联函数并不是一个增强性能的灵丹妙药。只有当函数非常短小的时候它才能得到我们想要的效果；但是，如果函数并不是很短而且在很多地方都被调用的话，那么将会使得可执行体的体积增大。
最令人烦恼的还是当编译器拒绝内联的时候。在老的实现中，结果很不尽人意，虽然在新的实现中有很大的改善，但是仍然还是不那么完善的。一些编译器能够足够的聪明来指出哪些函数可以内联哪些不能，但是大多数编译器就不那么聪明了，因此这就需要我们的经验来判断。如果内联函数不能增强性能，就避免使用它！
作者：ben大福
链接：https://www.jianshu.com/p/c028fee0f202
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
