Defining constructor in header file vs. implementation (.cpp) file

守給你的承諾、 提交于 2019-11-28 05:20:05

Keep your headers free of implementations, unless you want the implementations to be inlined (e.g. trivial getters/setters). And unless they're templates, of course.

I see no reason to make an exception for constructors. Put them in the .cpp file.

One important point to note is that if a member function is defined inside a header file, it must be either inside the class body or it must be marked explicitly as inline. In other words, it is plain wrong to do this in a header file:

class A {
  public:
    A();
};

A::A() {
  // constructor body
}

The reason it's wrong is because it will make the compiler include the definition in each compilation unit, while it's obvious that any function must be defined only once. Here are correct ways to do the same thing:

class A {
  public:
    inline A();
};

inline A::A() {
  // constructor body
}

Or:

class A {
  public:
    inline A() { // inline isn't required here, but it's a good style
     // constructor body
    }
};

In both cases the constructor is inline. The only correct way to make it a regular out-of-line function would be to define it in the implementation file, not in the header. This is the most important difference between these two approaches.

Now, it is worth noting that inlining is an optimization. And as always with optimizations, they are best avoided until proved necessary. Among other problems inlining can lead to, there is the compatibility problem: if you change the body of a function that is not inlined, you only need to recompile the unit where it is defined, and everyone starts using the new implementation right away. With inlined functions, you need to recompile every unit that includes the relevant header, which can be a pain, especially if the header is used across different projects by different people.

In other words, use regular out-of-line definitions wherever possible until it is proved by profiling that a particular function call is a performance bottleneck. The only reasonable exception to this rule are trivial setters and getters, and even with them it is better to be careful - one day they may become non-trivial and it will mean a lot of recompilation and compatibility breaking.

Another note to consider: any changes to a header file require rebuilding all files that include that header file. Most build systems will rebuild source (*.cpp/.cc) files that depend on the modified header file.

If you change a method of a class defined in a header file, all sources files including the header file will be rebuilt. If you change a method in a source file, only the source file is rebuilt. This could be an issue for medium to larger projects.

To simplify the build process, most methods of a class should be defined in a source file. Small methods and other candidates for inlining should be defined in the header file.

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!