类模板的分文件编写

类模板的分文件编写

在 C++ 中，分文件编写通常涉及将模板声明放在头文件（.h 或 .hpp 文件）中，而将实现细节放在源文件（.cpp 文件）中。但是，对于模板类，由于模板的实例化在编译时进行，编译器需要在处理模板时就可以找到其定义，故通常推荐将模板的定义（实现）也放在头文件中，或者使用其他技术来确保模板的正确链接。下面是如何进行操作的一些基本指导：

1.在头文件中声明和定义模板类

这是最简单也是最常见的方法，可以避免链接时的复杂性。示例：

// MyTemplate.h

#ifndef MY_TEMPLATE_H
#define MY_TEMPLATE_H

template<typename T>
class MyTemplate {
public:
    MyTemplate(T value) : value_(value) {}
    void display() const;
private:
    T value_;
};

template<typename T> //注意，函数定义前也要加上模板参数声明
void MyTemplate<T>::display() const {
    std::cout << value_ << std::endl;
}

#endif

2.将cpp文件后缀改为inl

在 C++ 中，使用 .inl 文件来包含模板类的实现是一种常见的做法。.inl（意为“inline”）文件通常被用来存放模板类或者模板函数的实现代码，以保持头文件的清晰和简洁。这种方法可以将模板的声明和定义分离，同时保证模板的所有实现在编译时可见( // 包含模板定义的文件)，从而避免链接错误。这里是如何操作的步骤：

2.1 创建头文件 (.h)

在头文件中，你将声明模板类及其成员函数。

#ifndef MY_TEMPLATE_H
#define MY_TEMPLATE_H

template<typename T>
class MyTemplate {
public:
    MyTemplate(T value);
    void display() const;

private:
    T value_;
};

#include "MyTemplate.inl" // 包含模板定义的文件

#endif

2.2 创建 .inl 文件

在 .inl 文件中，你将实现之前在头文件中声明的模板类的构造函数和成员函数。这个文件被包含在头文件的末尾，确保模板的声明和定义在同一翻译单元内。

MyTemplate.inl:

// MyTemplate.inl

template<typename T>
MyTemplate<T>::MyTemplate(T value) : value_(value) {}

template<typename T>
void MyTemplate<T>::display() const {
    std::cout << value_ << std::endl;
}

2.3. 在源文件中使用模板类

在你的 .cpp 源文件或者其他需要使用模板类的地方，你只需包含 .h 文件。

#include “MyTemplate.h”

#include "MyTemplate.h"

int main() {
    MyTemplate<int> myInt(42);
    myInt.display();

    MyTemplate<std::string> myString("Hello, World!");
    myString.display();

    return 0;
}

优点

清晰性和组织：通过分离声明和定义，代码更加整洁和易于管理。

一般来说，

注意事项

虽然使用 .inl 文件可以使头文件看起来更干净，但你需要确保 .inl 文件在模板声明之后被包含，通常是在相同的头文件的底部，这样做是为了确保在编译时模板的定义对编译器可见，从而正确地实例化模板。
具体而言：.inl 文件在头文件的末尾被包含。因此，当包含头文件时，.inl 文件也将被包含。这意味着模板的定义总是对编译器可见，这是必要的，因为模板的实例化需要在编译时看到完整的定义。

补充：类模板在编译时进行实例化，需要完整的类模板定义，为何传统的分文件编写方法不能满足要求？
a:
在 C++ 中，模板（无论是函数模板还是类模板）的定义必须在每一个使用它们的文件中可见，以便编译器可以在遇到具体类型的实例化请求时，正确地生成模板的具体实现。

编译器需要模板定义的原因是模板机制的核心在于“编译时的代码生成”。没有定义，编译器就无法完成这一生成工作，也就无法创建实际工作的代码。因此，保证模板定义在需要实例化模板的每个编译单元中都是可见的，是编写 C++ 模板代码的重要规则。

普通文件的分文件编写原理：
而普通的分文件编写，只需要有函数或者类的声明，是因为编译器在编译时，它假设定义将在其他地方提供(对程序员十分信任啊)。
具体的定义（实现)可以通过链接过程找到。链接器将一个或多个对象文件和库合并成一个可执行文件。在这个阶段，所有之前编译阶段假定的函数或类的定义都需要被找到。如果一个函数或类被声明了但在链接时找不到其定义，链接器会报错（如未解析的外部符号错误）。