使用vcpkg自动链接tinyxml2时莫名链接其他库(例如boost)
vcpkg
的自动链接功能非常方便,但在某些情况下会出现过度链接的问题。
链接错误症状
以tinyxml2
为例,程序中调用tinyxml2
的函数后,若vcpkg中同时存在opencv
和boost
库,自动链接会把本不需要的这两个库的lib也链接上,导致最后生成的可执行程序exe也依赖opencv
和boost
的动态库dll。
主程序:
#include <iostream>
#include <tinyxml2.h>
int main()
{
tinyxml2::XMLDocument doc;
std::cout << "Hello World!\n";
return 0;
}
错误链接boost后,由于boost某些头文件还包含了BOOST_DLLEXPORT(也就是__declspec(dllexport))字段,会导致生成.exe的同时还生成.lib和.exp文件,非常烦人:
链接错误原理
vcpkg
的自动链接功能是通过遍历所有的.lib
文件实现的,为程序引用的符号找到对应依赖库。
上述错误是由于tinyxml2
引用的某些函数所引用的函数在其他.lib
中首先被找到——即tinyxml2引用的某些函数同时在opencv和boost库中也有定义,遍历时后者的.lib先于tinyxml2.lib被找到,从而导致链接了opencv和boost的.lib文件而未链接tinyxml2.lib,进而仅拷贝了opencv和boost的动态库。
解决方法
对症下药,提供两种方法避免链接错误。
方法一:不关闭自动链接功能,在链接器-输入
中指定tinyxml2.lib
。链接器-输入
指定的库链接优先级高于vcpkg的自动链接,因此链接器首先从tinyxml2.lib中找到了所需函数后,就终止遍历、不再搜索boost或opencv等vcpkg环境中其他lib里的函数表,最后只链接tinyxml2.lib。
方法二:关闭自动链接功能,在链接器-输入
中指定所依赖库的.lib文件。推荐在方法一不奏效时使用。
vcpkg自动链接功能
vcpkg
是一个跨平台的c++库工具链,提供了c++库的编译、安装和配置等功能,可以与MSBuild(VS)、CMake等工具集成使用,非常方便。
以VS为例,vcpkg在项目属性中提供了一系列的功能开关,以使用户更方便地使用库:
其中的开关顾名思义,例如“Use Vcpkg”即控制是否在当前项目中使用Vcpkg;“Use AutoLink”控制是否自动链接项目所需.lib库而不需要手动在链接器-输入
中指定。这两个开关默认都是开启状态。
自动链接功能在项目需要依赖包含多个.lib的库时特别有用,例如点云处理算法库pcl。
pcl
在编译时就需要依赖Boost、Eigen、Vtk等库,编译完成后生成一大堆.lib和.dll。
若没有vcpkg,使用pcl库时更是需要在链接器-输入
中按需列上boost、vtk和pcl自身的诸多.lib文件,例如:
为避免重复工作,多数人选择使用项目属性表将上面的配置记录下来,以便后续项目使用。
**但是,**在有了vcpkg之后,链接工作就大大简化了。vcpkg提供的自动链接功能会遍历所有lib文件,找到项目所引用函数后将对应lib自动链接上,不需要用户手动指定链接哪一个lib,非常省心。
并且,在编译生成可执行程序后,vcpkg还会自动将依赖的动态库拷贝到可执行程序所在目录,方便运行。以包含了OpenCV库的项目为例,编译生成的结果如下图所示:
可见,opencv的一系列动态库和依赖的jpeg、png库都被拷贝到exe旁边了。