【转载】C++ 中的 .hpp 文件

913 阅读4分钟

原文地址:C++ 中的 .hpp 文件

我对文章中重要的部分进行了标注,并对语义不明语句不通顺之处进行了补充

定义与优点

.hpp, 其实质就是将 .cpp 的实现代码混入 .h 头文件当中,定义与实现都包含在同一文件,则该类的调用者只需要 include 该 hpp 文件即可,无需再将 cpp 加入到 project 中进行编译。

  1. 是 Header Plus Plus 的简写。
  2. 与 *.h 类似,hpp 是 C++ 程序头文件 。
  3. VC 专用的头文件,已预编译。
  4. 是一般模板类的头文件。
  5. 一般来说,*.h 里面只有声明,没有实现,而 *.hpp 里声明实现都有,后者可以减少 .cpp 的数量。

实现代码将直接编译到调用者的 obj 文件中,不再生成单独的 obj, 采用 hpp 将大幅度减少调用 project 中的 cpp 文件数与编译次数,也不用再发布烦人的 lib 与 dll, 因此非常适合用来编写公用的开源库。

*.hpp 的注意事项

不能用 using namespace std

*.h 里面可以有 using namespace std,而 *.hpp 里则无。

不可包含全局对象和全局函数

由于 hpp 本质上是作为 .h 被调用者 include ,所以当 hpp 文件中存在全局对象或者全局函数,而该 hpp 被多个调用者 include 时,将在链接时导致符号重定义错误。要避免这种情况,需要去除全局对象,将全局函数封装为类的静态方法。

类之间不可循环调用

在 .h 和 .cpp 的场景中,当两个类或者多个类之间有循环调用关系时,只要预先在头文件进行被调用类的声明即可,如下:

class B;
class A
{
public:
    void someMethod(B b);
};
class B
{
public:
    void someMethod(A a);
};

在 hpp 场景中,由于定义与实现都已经存在于一个文件,调用者必须明确知道被调用者的所有定义,而不能等到 cpp 中去编译。因此 hpp 中必须整理类之间调用关系,不可产生循环调用。同理,对于当两个类 A 和 B 分别定义在各自的 hpp 文件中,形如以下的循环调用也将导致编译错误:

// a.hpp

#include "b.hpp"
    class A
{
public:
    void someMethod(B b);
};
//b.hpp

#include "a.hpp"
class B
{
public:
    void someMethod(A a);
}

不可使用静态成员

静态成员的使用限制在于如果类含有静态成员,则在 hpp 中必须加入静态成员初始化代码,当该 hpp 被多个文档 include 时,将产生符号重定义错误。唯一的例外是 const static 整型成员,因为在 vs2003 中,该类型允许在定义时初始化,如:

class A
{
public:
    const static int intValue = 123;
};

由于静态成员的使用是很常见的场景,无法强制清除,因此可以考虑以下几种方式(以下示例均为同一类中方法)

解决方法

  • 类中仅有一个静态成员时,且仅有一个调用者时,可以通过局部域静态变量模拟
// 方法模拟获取静态成员
someType getMember()
{
    static someType value(xxx); // 作用域内静态变量

    return value;
}
  • 类中有多个方法需要调用静态成员,而且可能存在多个静态成员时,可以将每个静态成员封装一个模拟方法,供其他方法调用。
someType getMemberA()
{
    static someType value(xxx); // 作用域内静态变量
    return value;
}
someType getMemberB()
{
    static someType value(xxx); // 作用域内静态变量
    return value;
}
void accessMemberA()
{
    someType member = getMemberA(); // 获取静态成员
};
//获取两个静态成员

void accessStaticMember()
{
    someType a = getMemberA(); // 获取静态成员
    someType b = getMemberB();
};
  • 第二种方法对于大部分情况是通用的,但是当所需的静态成员过多时,编写封装方法的工作量将非常巨大,在此种情况下,建议使用 Singleton 模式,将被调用类定义成普通类,然后使用 Singleton 将其变为全局唯一的对象进行调用。

如原 h+cpp 下的定义如下:

class A
{
public:
    type getMember()
    {
        return member;
    }
    static type member; // 静态成员
}

采用 Singleton 方式,实现代码可能如下(Singleton 实现请自行查阅相关文档)

// 实际实现类
class Aprovider
{
public:
    type getMember()
    {
        return member;
    }
    type member; //变为普通成员

}

// 提供给调用者的接口类
class A
{
public:
    type getMember()
    {
        return Singleton<AProvider>::getInstance()->getMember();
    }
}