enable_shared_from_this 实现原理

最新推荐文章于 2024-09-23 03:36:46 发布

原创最新推荐文章于 2024-09-23 03:36:46 发布 · 762 阅读

15 ·

CC 4.0 BY-SA版权

文章标签：

#c++

C++ 专栏收录该内容

19 篇文章

订阅专栏

前言

enable_shared_from_this 可以帮助我们用 this 指针安全地创建 shared_ptr。

enable_shared_from_this

假设我们的程序使用 shared_ptr 管理 Widget 对象，我们用一个 vector 来记录已经处理过的 Widget 对象：

std::vector<std::shared_ptr<Widget>> processedWidgets;

继续，假设 Widget 有一个用于处理的成员函数：

class Widget {
 public:
  void process() {
    // 处理 Widget
    // 然后将它添加到已处理过的 Widget 列表中
    processedWidgets.emplace_back(this);
  }
};

上面的代码可以通过编译，但是向 shared_ptr 的容器传递一个原始指针（this），shared_ptr 会由此为指向的 Widget 创建一个控制块（使用原始指针创建 shared_ptr 时会创建一个控制块来控制资源的释放）。

听起来没什么问题，直到你意识到如果成员函数外面早已存在指向那个 Widget 对象的指针，这时有多个控制块控制同一个资源，会导致资源重复释放。

shared_ptr API 中早已有处理这种情况的设施。它就是 enable_shared_from_this。如果你想创建一个用 shared_ptr 管理的类，这个类能够用 this 指针安全的创建一个 shared_ptr，enable_shared_from_this 就可作为基类的模板类。

class Widget: public std::enable_shared_from_this<Widget> {
 public:
  void process() {
    processedWidgets.emplace_back(shared_from_this());
  }
};

继承 enable_shared_from_this 后，如果想从 this 指针创建一个 shared_ptr，只需要调用 shared_from_this() 函数即可。

实现原理

enable_shared_from_this 的源码如下：

template <class _Tp>
class enable_shared_from_this {
  mutable weak_ptr<_Tp> __weak_this_;
protected:
  enable_shared_from_this() {}
  ~enable_shared_from_this() {}
public:
  shared_ptr<_Tp> shared_from_this() {
    return shared_ptr<_Tp>(__weak_this_);
  }
  shared_ptr<_Tp const> shared_from_this() const {
    return shared_ptr<const _Tp>(__weak_this_);
  }
  template <class _Up> friend class shared_ptr;
};

enable_shared_from_this 的代码看起来平平无奇，内部有一个成员 __weak_this_，当调用 shared_from_this() 时就根据这个 weak_ptr 创建一个 shared_ptr。

那是怎么用 weak_ptr 创建 shared_ptr 的，这个 __weak_this_ 又是什么时候初始化的呢，我们可以在 shared_ptr 的构造函数中找到答案。

template <class _Tp>
class shared_ptr {
 public:
  using element_type = _Tp;
 private:
  element_type*        __ptr_;
  __shared_weak_count* __cntrl_;
 public:
  template<class _Yp>
  shared_ptr(_Yp* __p)
    : __ptr_(__p) {
      __cntrl_ = new __shared_weak_count();
    __enable_weak_this(__p);
  }
  
  template<class _Yp>
  shared_ptr(const weak_ptr<_Yp>& __r)
    : __ptr_(__r.__ptr_),
      __cntrl_(__r.__cntrl_ ? __r.__cntrl_->lock() : __r.__cntrl_) {
    if (__cntrl_ == 0) {
      assert(!"bad_weak_ptr");
    }
  }
 private:
  template <class _Yp>
  void __enable_weak_this(const enable_shared_from_this<_Yp>* __e)  {
    if (__e) {
      // __e 是 Widget 类型的指针，this 是 shared_ptr<Widget> 类型的
      // 初始化它内部的 weak_ptr，以便后面根据指向的控制块创建 shared_ptr
      __e->__weak_this_ = *this;
    }
  }
};