从模板继承的MSVC DLL导出类导致LNK2005已定义错误

时间:2017-07-07 00:28:52

标签: c++ visual-studio templates dll lnk2005

我已经在一个巨大的项目中跟踪了一个错误3天,最后得到了一个可重复的最小例子。我想分享这个问题,并就Visual Studio的奇怪行为提出一些问题。

导出从实例化模板类继承的类时,如

class __declspec(dllexport) classA : public Template<double>{}

MSVC还将在DLL中导出实例化的模板类Template<double>

如果消费者在他的代码中包含"template.h"然后同时实例化Template<double>,qnd,链接到上面的DLL,他将获得Template<double>的两个定义,这会导致 LNK2005 LNK1169 错误。 Microsoft DLL export and C++ templates中讨论了这个问题。

以下是此问题的最小可重现示例(完整代码为here):

// ----------- Project AA ------------
// aa/CMakeLists.txt
cmake_minimum_required(VERSION 3.1)
project(AA)
add_library(AA SHARED classA.cpp)                          //(1)
set_target_properties(AA PROPERTIES COMPILE_FLAGS "-DBUILD_AA")

// aa/config.h
#pragma once

#ifdef _WIN32
#  ifdef BUILD_AA
#    define AA_API __declspec( dllexport )
#  else
#    define AA_API __declspec( dllimport )
#  endif
#else
#   define AA_API
#endif

// aa/template.h
#pragma once
template<class T>
class Template {
public:
    Template() {}
};

//  aa/classA.h
#pragma once
#include "config.h"
#include "template.h"
class AA_API classA : public Template<double> {         //(2)
public:
    int fun();
};

// aa/classA.cpp
#include "classA.h"
int classA::funA(){return 123;}

// ----------- Project Main ----------
//CMakeLists.txt
cmake_minimum_required(VERSION 3.1)
project(Main)
set (CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
set (CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
add_subdirectory(aa)
add_executable(Main main.cpp test.cpp)
target_link_libraries(Main PUBLIC AA)

// main.cpp
#include "aa/classA.h"
#include <iostream>
int main(){
    Template<double> a;                                //(3)
    //classA aa;                                       //(4)
    //std::cout << aa.funA() << std::endl;             //(5)
    return 0;
}

// test.cpp
#include "aa/template.h"
class classB {
    Template<double> t;
};
class classC : public Template<double> {};

void fun() {
    Template<double> b;                               //(6)
    //class classB;                                   //(7)
    //class classC;                                   //(8)
}

我在VS2015调试模式下编译代码,它给出了多重定义的错误

1>------ Build started: Project: AA, Configuration: Debug x64 ------
1>  classA.cpp
1>  AA.vcxproj -> D:\sandbox\build\aa\Debug\AA.dll
2>------ Build started: Project: Main, Configuration: Debug x64 ------
2>  main.cpp
2>AA.lib(AA.dll) : error LNK2005: "public: __cdecl Template<double>::Template<double>(void)" (??0?$Template@N@@QEAA@XZ) already defined in test.obj
2>D:\sandbox\build\Debug\Main.exe : fatal error LNK1169: one or more multiply defined symbols found
========== Build: 1 succeeded, 1 failed, 1 up-to-date, 0 skipped ==========

如果我执行 ONE OF 以下更改,则不会出现错误:

  1. 更改为发布模式
  2. AA_API移除(2),在(1)
  3. 将链接模式更改为STATIC
  4. 评论(3)并取消注释(4)(5)
  5. 评论(6)并取消注释(7)(8)
  6. 通过gcc在Linux中编译
  7. 在VS中更改项目参数:将/FORCE:MULTIPLE添加到项目主要
  8. 的链接器

    问题:

    为什么更改1,2,3,4和5有效?我认为3和4可以工作真是太奇怪了。

    如何在Visual Studio中正确解决此问题?

1 个答案:

答案 0 :(得分:1)

我最近遇到了同样的问题。我设法最终修复它,所以我将分享我的知识。

问题的根源:

模板多次实例化。那是因为你使用了隐式实例化。一旦你宣布类AA_API classA并且在声明Template&lt;双&gt;一个;在主要。

这意味着您将拥有多个模板定义。

  • 1,我不确定它为何在发布模式下工作(考虑到我对模板缺乏深入了解)
  • 2,3,4,当你摆脱任何隐式模板实例化时,你摆脱了多个定义
  • 5,也许gcc以不同的方式进行实例化,或者在某处有一个力倍增标志......我不知道
  • 6,这并不能解决你的问题,它只是强制接受多个瞬间。

<强>解决方案:

显式实例化。

// aa/template.h
#pragma once
template<class T>
class Template {
public:
    Template() {}
};
template class Template<double>;  // Put this line after your template class.

注意:如果模板类位于不同的项目中,则需要导出实例化。

我希望这能解决你的问题。它固定了我的。