从 enable_shared_from_this 说开来

从shared_ptr 还在boost库里的时候，就开始使用boost::shared_ptr, 中间有几年做其他工作了，等转回头看，已经是亲切的std::shared_ptr了。在重新温习shared_ptr相关知识的时候，偶然间发现了一个自己之前没关注过的模板类： enable_shared_from_this。 稍作调研，简单记录如下：

省时总结：

enable_shared_from_this是一个模板类，用来给可能被放在shared_ptr里面用的类来继承。

这个模板类主要提供了从裸指针获取管理自身的生命周期的shared_ptr(如果有的话)的能力。其理念与于boost的侵入式容器（Boost.Intrusive）一致。

详述如下：

需求：

一个应用场景是客户要求我们的API提供裸指针而不是shared_ptr，并且按照谁申请谁释放的内存管理原则，还要我们提供API来释放这个指针。因此当用户又把这个裸指针传回来给我们要释放的时候，我们需要保持对这个裸指针的生命周期管理的能力。

即，如果用户多次调用get API获取同一个内存的引用，我们需要对称的 release API调用来释放它，直到最后一次的release API 调用，我们才真正的delete这个对象。

分析

从shared_ptr获取其管理的裸指针很容易， shared_ptr.get() 即可。但是反过来呢？如果我们拿到了一个已经被shared_ptr管理的对象的裸指针，有没有办法可以获取到这个shared_ptr的相关信息呢？按照shared_ptr的非入侵设计理念，被shared_ptr 管理的对象，应该是完全不知道自己被一个智能指针管理着，因此一旦从shared_ptr 里提取了裸指针，单纯从裸指针本身几乎不可能做到这一点（不是完全不可能，比如保留所有传出的指针索引待查，但是会复杂低效）。我们需要用侵入式的理念来改写我们提供的对象。所谓侵入式，说白了就是作为对象，自身需要知道自己被哪个shared_ptr 管理了， 简而言之，我们需要在对象里存储某种形式的对std::shared_ptr的引用，具体来说，是保留了std::weak_ptr 的成员变量，以保证可以索引到 control block 的能力。

因此，我们需要对拟支持这一功能的对象下手修改。enable_shared_from_this 就是标准库对这一需求的支持。

实际使用中，我们需要实例化并继承enable_shared_from_this。 enable_shared_from_this 的成员函数 shared_from_this()即可返回管理当前对象的 shared_ptr的一个copy。

例子代码

#include <iostream>
#include <memory>

class X: public std::enable_shared_from_this<X>
{
	
};

int main()
{
	X* rawX = new X();
	//rawX->shared_from_this();//will not work, not owned by a shared_ptr yet;

	std::shared_ptr<X> spX (rawX);
	std::cout << spX.use_count() << std::endl; // 1


	X* rawX2 = spX.get();//get the raw ptr to do sth. smart.

	//given we could not access spX nor spX1.
	std::shared_ptr<X> spX2 = rawX2->shared_from_this();
	std::cout << spX2.use_count() << std::endl; // 2

	std::shared_ptr<X> spX3(rawX2->weak_from_this());
	std::cout << spX3.use_count() << std::endl; // 3

	//Will not work! two shared_ptr with independent ref counts point to the same object. 
	//std::shared_ptr<X> spX4(rawX2); 
	//std::cout << spX4.use_count() << std::endl; // 1
}

实现分析

以下是来自Visual Studio 的标准库的实现，可以看到 enable_shared_from_this 的核心内容是保留了一个指向  weak_ptr 的指针 （mutable weak_ptr<_Ty> _Wptr). 

_EXPORT_STD template <class _Ty>
class enable_shared_from_this { // provide member functions that create shared_ptr to this
public:
    using _Esft_type = enable_shared_from_this;

    _NODISCARD shared_ptr<_Ty> shared_from_this() {
        return shared_ptr<_Ty>(_Wptr);
    }

    _NODISCARD shared_ptr<const _Ty> shared_from_this() const {
        return shared_ptr<const _Ty>(_Wptr);
    }

    _NODISCARD weak_ptr<_Ty> weak_from_this() noexcept {
        return _Wptr;
    }

    _NODISCARD weak_ptr<const _Ty> weak_from_this() const noexcept {
        return _Wptr;
    }

protected:
    constexpr enable_shared_from_this() noexcept : _Wptr() {}

    enable_shared_from_this(const enable_shared_from_this&) noexcept : _Wptr() {
        // construct (must value-initialize _Wptr)
    }

    enable_shared_from_this& operator=(const enable_shared_from_this&) noexcept { // assign (must not change _Wptr)
        return *this;
    }

    ~enable_shared_from_this() = default;

private:
    template <class _Yty>
    friend class shared_ptr;

    mutable weak_ptr<_Ty> _Wptr;
};

在std::shared_ptr的构造函数中，会调用 std::shared_ptr::_Set_ptr_rep_and_enable_shared()  函数来对这个weak_ptr进行初始化。

特别注意

1. 必须是被shared_ptr管理过的对象才有效，直接new一个对象，它的weak_ptr是空的，我们需要把std::shared_ptr::_Set_ptr_rep_and_enable_shared() 里面做过的工作再做一遍才能保证这个裸指针能正常使用。折腾下来，还是直接调用std::make_shared() 或者std::shared_ptr()构造函数来做这个最简单。
2. 用户如果想接手管理对象生命周期，不可以用std::shared_ptr 直接管理该裸指针，要调用rawPtr->shared_from_this() 直接返回一个shared_ptr 或者通过 rawPtr->weak_from_this() 来初始化一个 std::shared_ptr。这一点似乎是可以优化的地方, 也许是个bug？