在大型C++项目中,多个动态库可能定义了同名的全局函数、变量或者类,这些符号在链接或者运行时会发生冲突,导致程序出现异常。我们可以通过namespace隔离和符号隐藏属性两种方式来解决这个问题。
动态库符号重名冲突的产生原因
动态库在编译时会将内部的函数、变量、类等定义为导出符号,当多个动态库导出了同名的全局符号时,程序在加载动态库或者链接阶段就会出现符号重复定义的错误。比如两个动态库都导出了一个名为print_data的全局函数,就会触发冲突。
使用namespace隔离导出符号
namespace是C++提供的命名空间机制,可以将内部的符号包裹在特定的命名空间下,不同命名空间的同名符号会被编译器识别为不同的符号,从而避免冲突。
基础使用示例
我们可以在动态库内部将所有需要导出的符号都放在自定义的namespace中,其他库使用的时候通过命名空间限定即可。
// 动态库A的头文件 lib_a.h
#ifndef LIB_A_H
#define LIB_A_H
namespace lib_a {
// 导出函数,放在lib_a命名空间下
void print_data(int data);
}
#endif
// 动态库A的源文件 lib_a.cpp
#include "lib_a.h"
#include <iostream>
namespace lib_a {
void print_data(int data) {
std::cout << "lib_a print: " << data << std::endl;
}
}
// 动态库B的头文件 lib_b.h
#ifndef LIB_B_H
#define LIB_B_H
namespace lib_b {
// 同名函数,放在lib_b命名空间下
void print_data(int data);
}
#endif
// 动态库B的源文件 lib_b.cpp
#include "lib_b.h"
#include <iostream>
namespace lib_b {
void print_data(int data) {
std::cout << "lib_b print: " << data << std::endl;
}
}
在使用这两个动态库的时候,通过命名空间区分即可,不会出现冲突:
#include "lib_a.h"
#include "lib_b.h"
int main() {
lib_a::print_data(10);
lib_b::print_data(20);
return 0;
}
通过隐藏属性控制符号导出
除了用namespace隔离,我们还可以通过控制符号的导出属性,让动态库只导出我们需要的符号,未导出的符号不会参与全局符号解析,从而避免冲突。
GCC编译器下的符号隐藏
GCC默认会导出动态库的所有全局符号,我们可以通过__attribute__((visibility("hidden")))属性将不需要导出的符号设置为隐藏,只保留需要导出的符号。
// 设置默认隐藏所有符号,需要导出的符号单独标记
#if defined(__GNUC__) && __GNUC__ >= 4
#define EXPORT_API __attribute__((visibility("default")))
#define HIDDEN_API __attribute__((visibility("hidden")))
#else
#define EXPORT_API
#define HIDDEN_API
#endif
// 需要导出的函数,标记为default
EXPORT_API void export_func();
// 不需要导出的内部函数,标记为hidden
HIDDEN_API void internal_func();
也可以在编译时添加-fvisibility=hidden参数,让所有符号默认隐藏,再手动标记需要导出的符号:
# 编译动态库时添加参数 g++ -fPIC -shared -fvisibility=hidden -o libtest.so libtest.cpp
MSVC编译器下的符号隐藏
MSVC通过__declspec(dllexport)和__declspec(dllimport)控制符号导出,只有显式标记了__declspec(dllexport)的符号才会被导出,未标记的符号默认不会导出,天然可以避免大部分无意义的符号冲突。
#ifdef BUILD_DLL
#define EXPORT_API __declspec(dllexport)
#else
#define EXPORT_API __declspec(dllimport)
#endif
// 只有标记了EXPORT_API的符号才会被导出
EXPORT_API int add(int a, int b);
// 未标记的内部函数不会导出,不会参与全局符号解析
int internal_add(int a, int b);
两种方式的适用场景
如果多个动态库确实需要使用同名的符号,并且这些符号需要被外部调用,优先使用namespace隔离,逻辑更清晰;如果只是想避免动态库内部符号被外部感知到,减少冲突概率,优先使用符号隐藏属性,还能减小动态库的体积,提升加载效率。
实际开发中可以将两种方式结合使用,既用namespace做好模块隔离,又通过隐藏属性控制不必要的符号导出,最大程度避免动态库符号重名冲突问题。