c++ - 为什么模板只能在头文件中实现？

Question

目前使用模板的唯一可移植方式是通过使用内联函数在头文件中实现它们。

为什么是这样？

（澄清：头文件不是唯一的可移植解决方案。但它们是最方便的可移植解决方案。）

score 1808 · Accepted Answer

警告：没有必要将实现放在头文件中，请参阅此答案末尾的替代解决方案。

无论如何，您的代码失败的原因是，在实例化模板时，编译器会使用给定的模板参数创建一个新类。例如：

template<typename T>
struct Foo
{
    T bar;
    void doSomething(T param) {/* do stuff using T */}
};

// somewhere in a .cpp
Foo<int> f;

读到这一行时，编译器会新建一个类（我们称之为FooInt），相当于如下：

struct FooInt
{
    int bar;
    void doSomething(int param) {/* do stuff using int */}
}

因此，编译器需要访问方法的实现，以使用模板参数（在本例中int）实例化它们。如果这些实现不在标头中，它们将无法访问，因此编译器将无法实例化模板。

一个常见的解决方案是在头文件中编写模板声明，然后在实现文件（例如 .tpp）中实现该类，并将该实现文件包含在头文件的末尾。

Foo.h

template <typename T>
struct Foo
{
    void doSomething(T param);
};

#include "Foo.tpp"

文件.tpp

template <typename T>
void Foo<T>::doSomething(T param)
{
    //implementation
}

这样，实现仍然与声明分离，但编译器可以访问。

替代解决方案

另一种解决方案是保持实现分离，并显式实例化您需要的所有模板实例：

Foo.h

// no implementation
template <typename T> struct Foo { ... };

Foo.cpp

// implementation of Foo's methods

// explicit instantiations
template class Foo<int>;
template class Foo<float>;
// You will only be able to use Foo with int or float

如果我的解释不够清楚，您可以查看有关此主题的 C++ Super-FAQ。

score 311 · Accepted Answer

这是因为需要单独编译并且因为模板是实例化风格的多态性。

让我们更接近具体的解释。假设我有以下文件：

foo.h
- 声明接口class MyClass<T>
foo.cpp
- 定义了实现class MyClass<T>
酒吧.cpp
- 用途MyClass<int>

单独编译意味着我应该能够独立于bar.cpp编译foo.cpp。编译器完全独立地对每个编译单元进行分析、优化和代码生成的所有艰苦工作；我们不需要做整个程序分析。只有链接器需要一次处理整个程序，而链接器的工作要容易得多。

编译foo.cpp时bar.cpp甚至不需要存在，但是我仍然应该能够将我已经拥有的foo.o与我刚刚生成的 bar.o 链接在一起，而无需重新编译foo .cpp。foo.cpp甚至可以编译成动态库，在没有foo.cpp的情况下分发到其他地方，并与他们在我编写foo.cpp多年后编写的代码链接。

“实例化风格的多态性”意味着模板MyClass<T>并不是一个真正的泛型类，它可以编译为可以用于任何值的代码T。这会增加诸如装箱之类的开销，需要将函数指针传递给分配器和构造函数等。C++ 模板的目的是避免编写几乎相同class MyClass_int的 ,class MyClass_float等，但仍然能够以编译后的代码结束大部分情况下，就好像我们分别编写了每个版本一样。所以一个模板实际上就是一个模板。类模板不是T类，它是为我们遇到的每个创建新类的秘诀。模板不能编译成代码，只能编译模板实例化的结果。

所以当foo.cpp被编译时，编译器看不到bar.cpp就知道它MyClass<int>是需要的。它可以看到模板MyClass<T>，但不能为此发出代码（它是模板，而不是类）。并且当bar.cpp被编译时，编译器可以看到它需要创建 a MyClass<int>，但是它看不到模板MyClass<T>（只有它在foo.h中的接口）所以它不能创建它。

如果foo.cpp本身使用，则在编译foo.cppMyClass<int>时将生成该代码，因此当bar.o链接到foo.o时，它们可以连接并工作。我们可以利用这一事实，通过编写单个模板，在 .cpp 文件中实现一组有限的模板实例化。但是bar.cpp无法将模板用作模板并在它喜欢的任何类型上实例化它；它只能使用foo.cpp的作者认为提供的模板类的预先存在版本。

您可能会认为在编译模板时，编译器应该“生成所有版本”，在链接期间将那些从未使用过的版本过滤掉。除了巨大的开销和这种方法将面临的极端困难之外，因为像指针和数组这样的“类型修饰符”特性甚至允许内置类型产生无限数量的类型，当我现在扩展我的程序时会发生什么通过增加：

baz.cpp
- 声明、实现class BazPrivate和使用MyClass<BazPrivate>

除非我们

每次我们更改程序中的任何其他文件时都必须重新编译foo.cpp，以防它添加了一个新的新实例MyClass<T>
要求baz.cpp包含（可能通过标头包含）的完整模板MyClass<T>，以便编译器可以MyClass<BazPrivate>在编译baz.cpp期间生成。

没有人喜欢（1），因为整个程序分析编译系统需要很长时间才能编译，并且因为它使得在没有源代码的情况下分发编译的库是不可能的。所以我们有（2）。

score 265 · Accepted Answer

这里有很多正确的答案，但我想添加这个（为了完整性）：

如果您在实现 cpp 文件的底部对模板将使用的所有类型进行显式实例化，则链接器将能够像往常一样找到它们。

编辑：添加显式模板实例化的示例。在定义了模板并且定义了所有成员函数后使用。

template class vector<int>;

这将实例化（并因此使链接器可用）类及其所有成员函数（仅）。类似的语法适用于函数模板，因此如果您有非成员运算符重载，您可能需要对它们执行相同的操作。

上面的例子是相当无用的，因为向量是在头文件中完全定义的，除非一个通用的包含文件（预编译的头文件？）使用extern template class vector<int>它以防止它在所有其他（1000 个？）使用向量的文件中实例化它。

score 90 · Accepted Answer

在将模板实际编译为目标代码之前，需要由编译器对其进行实例化。只有在模板参数已知的情况下才能实现此实例化。现在想象一个模板函数在中声明a.h、定义a.cpp和使用的场景b.cpp。编译时a.cpp，不一定知道即将进行的编译b.cpp将需要模板的一个实例，更不用说那是哪个特定实例了。对于更多的头文件和源文件，情况很快就会变得更加复杂。

有人可能会争辩说，编译器可以变得更智能，以便为模板的所有用途“向前看”，但我确信创建递归或其他复杂的场景并不难。AFAIK，编译器不会做这样的展望。正如 Anton 所指出的，一些编译器支持模板实例化的显式导出声明，但并非所有编译器都支持它（还没有？）。

score 68 · Accepted Answer

实际上，在 C++11 之前，该标准定义了可以在头文件中声明模板并在其他地方实现它们的export关键字。（从某种意义上说。并非如此，正如唯一实现该功能的人指出的那样。）

没有一个流行的编译器实现了这个关键字。该功能的唯一实现是在 Edison Design Group 编写的前端中，Comeau C++ 编译器使用该前端。所有其他人都要求您在头文件中编写模板，因为编译器需要模板定义才能正确实例化（正如其他人已经指出的那样）。

因此，ISO C++ 标准委员会决定在exportC++11 中移除模板的特性。

score 37 · Accepted Answer

尽管标准 C++ 没有这样的要求，但一些编译器要求所有函数和类模板都需要在它们使用的每个翻译单元中可用。实际上，对于那些编译器，模板函数的主体必须在头文件中可用。重复一遍：这意味着那些编译器不允许在非头文件（如 .cpp 文件）中定义它们

有一个export关键字应该可以缓解这个问题，但它离可移植还差得很远。

score 35 · Accepted Answer

模板经常用在头文件中，因为编译器需要实例化不同版本的代码，具体取决于模板参数给定/推导的参数，并且（作为程序员）更容易让编译器重新编译相同的代码多次并在以后进行重复数据删除. 请记住，模板并不直接代表代码，而是该代码的多个版本的模板。当你在一个文件中编译一个非模板函数时.cpp，你正在编译一个具体的函数/类。模板不是这样，它可以用不同的类型实例化，即用具体类型替换模板参数时必须发出具体代码。

有一个带有export关键字的功能，旨在用于单独编译。该export功能已被弃用，C++11并且，AFAIK，只有一个编译器实现了它。你不应该使用export. 单独编译是不可能的，C++或者C++11，但也许是C++17，如果有概念，我们可以有一些单独编译的方法。

为了实现单独的编译，必须可以进行单独的模板主体检查。似乎可以通过概念解决问题。看看最近在标准委员会会议上提交的这篇论文。我认为这不是唯一的要求，因为您仍然需要在用户代码中为模板代码实例化代码。

模板的单独编译问题我猜这也是迁移到模块时出现的问题，目前正在解决这个问题。

编辑：截至 2020 年 8 月，C++ 模块已经成为现实：https ://en.cppreference.com/w/cpp/language/modules

score 19 · Accepted Answer

尽管上面有很多很好的解释，但我还是缺少一种将模板分成标题和正文的实用方法。
当我更改其定义时，我主要关心的是避免重新编译所有模板用户。
在模板主体中包含所有模板实例对我来说不是一个可行的解决方案，因为模板作者可能不知道所有模板的用法，并且模板用户可能无权修改它。
我采用了以下方法，它也适用于较旧的编译器（gcc 4.3.4，aCC A.03.13）。

对于每个模板用法，在其自己的头文件中都有一个 typedef（从 UML 模型生成）。它的主体包含实例化（最终在最后链接的库中）。
模板的每个用户都包含该头文件并使用 typedef。

示意图示例：

我的模板.h：

#ifndef MyTemplate_h
#define MyTemplate_h 1

template <class T>
class MyTemplate
{
public:
  MyTemplate(const T& rt);
  void dump();
  T t;
};

#endif

我的模板.cpp：

#include "MyTemplate.h"
#include <iostream>

template <class T>
MyTemplate<T>::MyTemplate(const T& rt)
: t(rt)
{
}

template <class T>
void MyTemplate<T>::dump()
{
  cerr << t << endl;
}

MyInstantiatedTemplate.h：

#ifndef MyInstantiatedTemplate_h
#define MyInstantiatedTemplate_h 1
#include "MyTemplate.h"

typedef MyTemplate< int > MyInstantiatedTemplate;

#endif

MyInstantiatedTemplate.cpp：

#include "MyTemplate.cpp"

template class MyTemplate< int >;

主.cpp：

#include "MyInstantiatedTemplate.h"

int main()
{
  MyInstantiatedTemplate m(100);
  m.dump();
  return 0;
}

这样，只有模板实例需要重新编译，而不是所有模板用户（和依赖项）。

score 16 · Accepted Answer

这意味着定义模板类的方法实现的最可移植的方式是在模板类定义中定义它们。

template < typename ... >
class MyClass
{

    int myMethod()
    {
       // Not just declaration. Add method implementation here
    }
};

score 9 · Accepted Answer

当您在编译步骤中使用模板时，编译器将为每个模板实例化生成代码。在编译和链接过程中，.cpp 文件被转换为纯对象或机器代码，其中包含引用或未定义的符号，因为 main.cpp 中包含的 .h 文件还没有实现。这些已准备好与另一个定义模板实现的目标文件链接，因此您拥有完整的 a.out 可执行文件。

但是，由于模板需要在编译步骤中进行处理，以便为您定义的每个模板实例化生成代码，所以简单地编译一个与其头文件分开的模板是行不通的，因为它们总是手牵手，原因很简单从字面上看，每个模板实例化都是一个全新的类。在常规类中，您可以将 .h 和 .cpp 分开，因为 .h 是该类的蓝图，而 .cpp 是原始实现，因此可以定期编译和链接任何实现文件，但是使用模板 .h 是如何使用模板的蓝图类的外观不应是对象的外观，这意味着模板 .cpp 文件不是类的原始常规实现，它只是类的蓝图，因此 .h 模板文件的任何实现都可以

因此，模板永远不会单独编译，并且只会在您在其他源文件中有具体实例的地方编译。但是具体的实例化需要知道模板文件的实现，因为简单的修改typename T在 .h 文件中使用具体类型不会完成这项工作，因为有什么 .cpp 可以链接，我以后找不到它，因为记住模板是抽象的，无法编译，所以我被迫现在给出实现，所以我知道要编译和链接什么，现在我有了实现，它被链接到封闭的源文件中。基本上，当我实例化一个模板时，我需要创建一个全新的类，如果我不知道在使用我提供的类型时该类应该是什么样子，除非我通知编译器模板实现，所以现在编译器可以T用我的类型替换并创建一个可以编译和链接的具体类。

总而言之，模板是类外观的蓝图，类是对象外观的蓝图。我不能将模板与具体实例分开编译，因为编译器只编译具体类型，换句话说，至少在 C++ 中的模板是纯语言抽象。可以这么说，我们必须对模板进行去抽象化，我们通过给它们一个具体的类型来处理它们，这样我们的模板抽象就可以转换为一个常规的类文件，进而可以正常编译它。将模板 .h 文件和模板 .cpp 文件分开是没有意义的。这是荒谬的，因为 .cpp 和 .h 的分离仅是 .cpp 可以单独编译和单独链接的地方，因为我们不能单独编译它们，因为模板是一种抽象，

意思typename T是 get 在编译步骤而不是链接步骤中被替换，所以如果我尝试编译模板而不T被替换为对编译器完全没有意义的具体值类型，因此无法创建目标代码，因为它没有知道是什么T。

在技术上可以创建某种功能来保存 template.cpp 文件并在它在其他来源中找到它们时切换类型，我认为该标准确实有一个关键字export可以让您将模板放在单独的cpp 文件，但实际上并没有多少编译器实现这一点。

附带说明一下，在对模板类进行特化时，您可以将标头与实现分开，因为定义上的特化意味着我专门针对可以单独编译和链接的具体类型。

score 9 · Accepted Answer

只是在这里添加一些值得注意的东西。当它们不是函数模板时，可以在实现文件中定义模板类的方法。

我的队列.hpp：

template <class T> 
class QueueA {
    int size;
    ...
public:
    template <class T> T dequeue() {
       // implementation here
    }

    bool isEmpty();

    ...
}

我的队列.cpp：

// implementation of regular methods goes like this:
template <class T> bool QueueA<T>::isEmpty() {
    return this->size == 0;
}


main()
{
    QueueA<char> Q;

    ...
}

score 7 · Accepted Answer

这是完全正确的，因为编译器必须知道分配的类型。因此，模板类、函数、枚举等必须在头文件中实现，如果它要公开或作为库的一部分（静态或动态），因为头文件不像 c/cpp 文件那样编译是。如果编译器不知道类型是无法编译的。在 .Net 中它可以，因为所有对象都派生自 Object 类。这不是.Net。

score 7 · Accepted Answer

如果担心将 .h 编译为使用它的所有 .cpp 模块的一部分而产生的额外编译时间和二进制大小膨胀，在许多情况下，您可以做的是使模板类从非模板化基类下降接口的非类型相关部分，并且该基类可以在 .cpp 文件中实现。

score 6 · Accepted Answer

一种单独实现的方法如下。

//inner_foo.h

template <typename T>
struct Foo
{
    void doSomething(T param);
};


//foo.tpp
#include "inner_foo.h"
template <typename T>
void Foo<T>::doSomething(T param)
{
    //implementation
}


//foo.h
#include <foo.tpp>

//main.cpp
#include <foo.h>

inner_foo 具有前向声明。foo.tpp 有实现并包含 inner_foo.h；并且 foo.h 将只有一行，包括 foo.tpp。

在编译时，将 foo.h 的内容复制到 foo.tpp，然后将整个文件复制到 foo.h，然后编译。这样就没有任何限制，而且命名一致，换来一个额外的文件。

我这样做是因为代码的静态分析器在看不到 *.tpp 中的类的前向声明时会中断。在任何 IDE 中编写代码或使用 YouCompleteMe 或其他人时，这很烦人。

score 2 · Accepted Answer

我建议查看这个 gcc 页面，该页面讨论了模板实例化的“cfront”和“borland”模型之间的权衡。

https://gcc.gnu.org/onlinedocs/gcc-4.6.4/gcc/Template-Instantiation.html

“borland”模型对应于作者的建议，提供完整的模板定义，并多次编译。

它包含有关使用手动和自动模板实例化的明确建议。例如，“-repo”选项可用于收集需要实例化的模板。或者另一种选择是使用“-fno-implicit-templates”禁用自动模板实例化以强制手动模板实例化。

根据我的经验，我依赖于为每个编译单元实例化的 C++ 标准库和 Boost 模板（使用模板库）。对于我的大型模板类，我会为我需要的类型进行一次手动模板实例化。

这是我的方法，因为我提供的是工作程序，而不是用于其他程序的模板库。这本书的作者 Josuttis 在模板库方面做了很多工作。

如果我真的担心速度，我想我会探索使用预编译头 https://gcc.gnu.org/onlinedocs/gcc/Precompiled-Headers.html

这在许多编译器中获得了支持。但是，我认为模板头文件很难预编译头文件。

score -3 · Accepted Answer

在头文件中编写声明和定义是个好主意的另一个原因是为了便于阅读。假设 Utility.h 中有这样一个模板函数：

template <class T>
T min(T const& one, T const& theOther);

在 Utility.cpp 中：

#include "Utility.h"
template <class T>
T min(T const& one, T const& other)
{
    return one < other ? one : other;
}

这要求这里的每个 T 类都实现小于运算符 (<)。当您比较两个未实现“<”的类实例时，它将引发编译器错误。

因此，如果您将模板声明和定义分开，您将无法仅读取头文件以查看此模板的来龙去脉，以便在您自己的类上使用此 API，尽管编译器会在此告诉您关于需要覆盖哪个运算符的情况。

score -9 · Accepted Answer

您实际上可以在 .template 文件而不是 .cpp 文件中定义模板类。谁说你只能在头文件中定义它是错误的。这一直可以追溯到 c++ 98。

不要忘记让您的编译器将您的 .template 文件视为 c++ 文件以保持智能感知。

这是一个动态数组类的示例。

#ifndef dynarray_h
#define dynarray_h

#include <iostream>

template <class T>
class DynArray{
    int capacity_;
    int size_;
    T* data;
public:
    explicit DynArray(int size = 0, int capacity=2);
    DynArray(const DynArray& d1);
    ~DynArray();
    T& operator[]( const int index);
    void operator=(const DynArray<T>& d1);
    int size();

    int capacity();
    void clear();

    void push_back(int n);

    void pop_back();
    T& at(const int n);
    T& back();
    T& front();
};

#include "dynarray.template" // this is how you get the header file

#endif

现在在您的 .template 文件中，您可以按照通常的方式定义函数。

template <class T>
DynArray<T>::DynArray(int size, int capacity){
    if (capacity >= size){
        this->size_ = size;
        this->capacity_ = capacity;
        data = new T[capacity];
    }
    //    for (int i = 0; i < size; ++i) {
    //        data[i] = 0;
    //    }
}

template <class T>
DynArray<T>::DynArray(const DynArray& d1){
    //clear();
    //delete [] data;
    std::cout << "copy" << std::endl;
    this->size_ = d1.size_;
    this->capacity_ = d1.capacity_;
    data = new T[capacity()];
    for(int i = 0; i < size(); ++i){
        data[i] = d1.data[i];
    }
}

template <class T>
DynArray<T>::~DynArray(){
    delete [] data;
}

template <class T>
T& DynArray<T>::operator[]( const int index){
    return at(index);
}

template <class T>
void DynArray<T>::operator=(const DynArray<T>& d1){
    if (this->size() > 0) {
        clear();
    }
    std::cout << "assign" << std::endl;
    this->size_ = d1.size_;
    this->capacity_ = d1.capacity_;
    data = new T[capacity()];
    for(int i = 0; i < size(); ++i){
        data[i] = d1.data[i];
    }

    //delete [] d1.data;
}

template <class T>
int DynArray<T>::size(){
    return size_;
}

template <class T>
int DynArray<T>::capacity(){
    return capacity_;
}

template <class T>
void DynArray<T>::clear(){
    for( int i = 0; i < size(); ++i){
        data[i] = 0;
    }
    size_ = 0;
    capacity_ = 2;
}

template <class T>
void DynArray<T>::push_back(int n){
    if (size() >= capacity()) {
        std::cout << "grow" << std::endl;
        //redo the array
        T* copy = new T[capacity_ + 40];
        for (int i = 0; i < size(); ++i) {
            copy[i] = data[i];
        }

        delete [] data;
        data = new T[ capacity_ * 2];
        for (int i = 0; i < capacity() * 2; ++i) {
            data[i] = copy[i];
        }
        delete [] copy;
        capacity_ *= 2;
    }
    data[size()] = n;
    ++size_;
}

template <class T>
void DynArray<T>::pop_back(){
    data[size()-1] = 0;
    --size_;
}

template <class T>
T& DynArray<T>::at(const int n){
    if (n >= size()) {
        throw std::runtime_error("invalid index");
    }
    return data[n];
}

template <class T>
T& DynArray<T>::back(){
    if (size() == 0) {
        throw std::runtime_error("vector is empty");
    }
    return data[size()-1];
}

template <class T>
T& DynArray<T>::front(){
    if (size() == 0) {
        throw std::runtime_error("vector is empty");
    }
    return data[0];
    }

c++ - 为什么模板只能在头文件中实现？

17 回答 17

替代解决方案

Related

Reference