设计模式之Pimpl模式

瞻邈

已于 2025-02-24 11:19:28 修改

阅读量3k

点赞数 9

分类专栏：编程艺术文章标签：设计模式算法

于 2021-01-18 21:41:41 首次发布

本文链接：https://blog.csdn.net/xhtchina/article/details/112795569

版权

编程艺术专栏收录该内容

9 篇文章

订阅专栏

1. PIMPL模式引入

Pimpl（pointer to implementation，指向实现的指针）是一种常用的，用来对“类的接口与实现”进行解耦的方法。这个技巧可以避免在头文件中暴露私有细节（见下图1），因此是促进API接口与实现保持完全分离的重要机制。但是Pimpl并不是严格意义上的设计模式（它是受制于C++特定限制的变通方案），这种惯用法可以看作桥接设计模式的一种特例。

在类中使用Pimpl惯用法，具有如下优点：

降低耦合
信息隐藏
降低编译依赖，提高编译速度
接口与实现分离

2. Pimpl模式的基本结构

为了实现Pimpl，我们先来看一种普通的类的设计方法。

假如我们要设计一书籍类Book，Book包含目录属性，并提供打印书籍信息的对外接口，Book设计如下：

class Book
{
public:
  void print();
 
private:
  std::string  m_Contents;
};

Book的使用者只需要知道print()接口，便可以使用Book类，看起来一切都很美好。

然而，当某一天，发现Book需要增加一标题属性，对Book类的修改如下：

class Book
{
public:
  void print();
 
private:
  std::string  m_Contents;
  std::string  m_Title;
};

虽然使用print()接口仍然可以直接输出书籍的信息，但是Book类的使用者却不得不重新编译所有包含Book类头文件的代码。

为了隐藏Book类的实现细节，实现接口与实现的真正分离，可以使用Pimpl方法。

我们依然对Book类提供相同的接口，但Book类中不再包含原有的数据成员，其所有操作都由BookImpl类实现。

/* public.h */
#ifndef PUBLIC_H_INCLUDED
#define PUBLIC_H_INCLUDED
 
class Book
{
public:
  Book();
  ~Book();
  void print();
 
private:
  class BookImpl;  // Book实现类的前置声明
  BookImpl* pimpl;
};
 
#endif

在对外的头文件public.h中，只包含Book类的外部接口，将真正的实现细节被封装到BookImpl类。为了不对外暴露BookImpl类，将其声明为Book类的内嵌类，并声明为private。

BookImpl类的头文件如下。

/* private.h */
#ifndef PRIVATE_H_INCLUDED
#define PRIVATE_H_INCLUDED
 
#include "public.h"
#include <iostream>
 
class Book::BookImpl
{
public:
  void print();
 
private:
  std::string  m_Contents;
  std::string  m_Title;
};
 
#endif

private.h并不需要提供给Book类的使用者，因此，如果往后需要重新设计书籍类的属性，外界对此一无所知，从而保持接口的不变性，并减少了文件之间的编译依赖关系。


/* book.cpp */
#include "private.h"  // 我们需要调用BookImpl类的成员函数，
                      // 所以要包含BookImpl的定义头文件
#include "public.h"  // 我们正在实现Book类，所以要包含Book类
                     // 的头文件
 
Book::Book()
{
  pimpl = new BookImpl();
}
 
Book::~Book()
{
  delete pimpl;
}
 
void Book::print()
{
  pimpl->print();
}
 
/* BookImpl类的实现函数 */
 
void Book::BookImpl::print()
{
  std::cout << "print from BookImpl" << std::endl;
}

使用Book类的接口的方法如下：


/* main.cpp */
#include "public.h"
 
int main()
{
    Book book;
    book.print();
 
    return 0;

像Book类这样使用Pimpl的类，往往被称为handle class，BookImpl类作为实现类，被称为implementation class。

为简单实现起见，Book类省略了复制构造函数和复制赋值函数。在实际应用中，一般有两种可选方案解决Book的复制和赋值的语义问题。

2.1. 禁止复制类

如果不打算让用户创建对象的副本，那么可以将对象声明为不可复制的。可以将复制构造函数和复制赋值函数声明为私有的，这样在复制或者赋值时就会产生编译错误。

以下代码通过声明私有的复制构造函数和复制赋值函数来使得对象不可以复制，不需要修改相关的.cpp文件。

/* public.h */
#ifndef PUBLIC_H_INCLUDED
#define PUBLIC_H_INCLUDED
 
class Book
{
public:
  Book();
  ~Book();
  void print();
 
private:
  // 禁止复制类
  Book(const Book&);
  const Book &operator = (const Book &);
 
  class BookImpl;  // Book实现类的前置声明
  BookImpl* pimpl;
};