使用多个 .cpp 文件替代 C++ 中的条件编译

Question

假设我有一个使用条件编译的 C++ 类：

hpp

namespace NS{
  class C {
    public:
      C(void);
      ~C(void);
      int func( int arg1 );
    private:
      int memberVar;
}

C.cpp：

#include "C.hpp"

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
  int C::func( int arg1 ){
    int retval = 0;
    memberVar = arg1;
#ifdef DEV_BUILD
    retval = memberVar;
    printf( "memberVar was set.\n" );
#endif
    return retval;
  }
}

（这是一个简化的例子；想象一下这个类C有几百行长，它的一些函数使用条件编译，每个函数都使用相同的条件：#ifdef DEV_BUILD。应用程序是一个嵌入式系统应用程序，条件被使用区分测试硬件和生产硬件，它们有一些区别）

我被建议改为在单独的 .cpp 文件中实现 funcs ......但我有点不知道最好的方法是什么。

我的第一个冲动是创建 C_dev.cpp 和 C_prod.cpp，C::func()在每个中实现不同，并因此编辑 C.cpp：

#include "C.hpp"
#ifdef DEV_BUILD
#include "C_dev.cpp"
#else
#include "C_prod.cpp"
#endif

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
}

...但这是坏风格吗？或者其他问题？

附加限制：

• 不能使用子类。
• 不能使用模板类。

（更新：建议使用单独的文件，但不是必需的。我愿意接受其他建议）

Answer 1

要点 1：如果你有数百个小改动散布在一大堆相同的代码中，请使用条件编译。它通常更易于阅读和维护。

但是，如果您在功能级别分解了差异，则可以在不同的实现文件中拆分不同的功能。通常我是用操作系统包装器来做这件事的，比如在 Linux 和 Windows 上获取目录列表的差异是非常粗粒度的。（注意：此示例已被 C++17 废弃）

重要点 2：不要制作多个标题。这只会使问题复杂化。您希望公开两个实现之间的公共接口。如果你不能，你已经迷路了，需要找到一条不同的道路。制作一个适合所有实现的通用标头。

对于此答案，所有实现都使用 Asker 的原始标头 C.hpp：

namespace NS{
  class C {
    public:
      C(void);
      ~C(void);
      int func( int arg1 );
    private:
      int memberVar;
}

我将 Asker 的示例分成三个 cpp 文件：一个具有跨所有构建的通用功能，两个实现包含差异的功能。这样您就不会重复任何您绝对不需要重复的功能。

C_common.cpp 所有共享功能都在这里

#include "C.hpp"

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
}

C_debug.cpp：带有调试语句的函数在此处

#include "C.hpp"

namespace NS{
  int C::func( int arg1 ){
    int retval = 0;
    memberVar = arg1;
    retval = memberVar;
    printf( "memberVar was set.\n" );
    return retval;
  }
}

C_no_debug.cpp：没有调试语句的函数放在这里

#include "C.hpp"

namespace NS{
  int C::func( int arg1 ){
    memberVar = arg1;
    return memberVar;
  }
}

链接程序时，始终链接 C_common 并指定要链接的 C_debug 和 C_no_debug。

有时您可以通过分解复杂函数并仅隔离差异并为差异提供从共享函数中调用的函数来更进一步。

C_common.cpp

#include "C.hpp"

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
  int C::func( int arg1 ){
    memberVar = arg1;
    debugstuff(); // calls the different functionality
    return memberVar;
  }
}

C_debug.cpp：

#include "C.hpp"

namespace NS{
    void debugstuff()
    {
        printf( "memberVar was set.\n" );
    }
}

C_no_debug.cpp：

#include "C.hpp"

namespace NS{
    void debugstuff()
    {
    }
}

这往往很难扩展，因为您可能会得到许多单一的线性函数。请参阅上面的大点 1。但是，如果差异的形状恰到好处，您可以利用传递函数参数来减少垃圾邮件。在这种情况下，合乎逻辑的做法是传入调试字符串。一个打印，另一个丢弃。

C_common.cpp

#include "C.hpp"

namespace NS{
  C::C( void ){ memberVar = 0; }
  C::~C( void ) {}
  int C::func( int arg1 ){
    memberVar = arg1;
    debugstuff("memberVar was set.\n"); // calls the different functionality
                                        // and tells it what to do!
    return memberVar;
  }
}

C_debug.cpp：

#include "C.hpp"

namespace NS{
    void debugstuff(const char * message)
    {
        printf( message );
    }
}

C_no_debug.cpp：

#include "C.hpp"

namespace NS{
    void debugstuff(const char * )
    {
    }
}