编写全头文件化的C++库

Published on 十月 26, 2009
3,987

     全头文件的C++库其实就是相关功能的定义与实现都包含在同一文件中，该类的调用者只需要include该文件即可，无需再将cpp加入到project中进行编译。而实现代码将直接编译到调用者的obj文件中，不再生成单独的obj，采用这种方式将大幅度减少调用 project中的cpp文件数与编译次数，只需“#include <xxx>”就可以使用类库的相应功能，不需要link到.lib/.a/.so/.dll等静/动态库。使用者方便，维护者省事，特别是对于一些轻量级的类库，因此非常适合用来编写公用的开源库。类似的例子有STL和boost中的一些组件以及正则库DEELX等等。

    此种方式优点很多，但是编写中有以下几点要注意(以下假设hpp即为全头文件化的C++库的头文件)：

    1、不可包含全局对象和全局函数。
    由于此种方式本质上是作为头文件被调用者include，所以当其中存在全局对象或者全局函数，而该文件被多个调用者include时，将在链接时导致符号重定义错误。要避免这种情况，需要去除全局对象，将全局函数封装为类的静态方法。
 
    2、类之间不可循环调用。
    在.h和.cpp的场景中，当两个类或者多个类之间有循环调用关系时，只要预先在头文件做被调用类的声明即可，如下：
    class B;
    class A{
    public:
         void someMethod(B b);
    };
    class B{
    public:
         void someMethod(A a);
    };
    但在全头文件C++库场景中，由于定义与实现都已经存在于一个文件，调用者必需明确知道被调用者的所有定义，而不能等到cpp中去编译。因此其中必须整理类之间调用关系，不可产生循环调用。同理，对于当两个类A和B分别定义在各自的头文件中，形如以下的循环调用也将导致编译错误：
    //a.hpp
    #include "b.hpp"
    class A{
    public:
        void someMethod(B b);
    };

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

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

    public:
       const static int intValue = 123;
    };
    由于静态成员的使用是很常见的场景，无法强制清除，因此可以考虑以下几种方式（以下示例均为同一类中方法）
    1.类中仅有一个静态成员时，且仅有一个调用者时，可以通过局域静态变量模拟
    //方法模拟获取静态成员
    someType getMember()
    {
       static someType value(xxx);//作用域内静态变量
       return value;
    }

    2.类中有多个方法需要调用静态成员，而且可能存在多个静态成员时，可以将每个静态成员封装一个模拟方法，供其他方法调用。

 

    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();
    };
    3.第二种方法对于大部分情况是通用的，但是当所需的静态成员过多时，编写封装方法的工作量将非常巨大，在此种情况下，建议使用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();
        }
    }

--------------------
题后话：
    此种方式并不具有广泛性。比如某个类库在项目中的cpp中引用很多次，如果这个类库是全头文件化的C++库并且常常改变，则会增加每次的编译文件数。这种方式的最大特点是可以减小类库使用和维护的代价，但有些时候又得不偿失，因此是否使用便因地因情而异了。





原创文章，版权所有。转载请注明：转载自Vimer的程序世界 [ http://www.vimer.cn ]

本文链接地址: http://www.vimer.cn/?p=293

Posted in: C/C++ by Dante,3,987 views Tags: ,


较旧一篇«
»较新一篇


我要评论

*

*