以前都沒有用過enable_shared_from_this模板類,雖然經常遇到但是也沒怎麼去關注,今天抽時間好好學習了下enable_shared_from_this模板類,發現在使用shared_ptr模板類和enable_shared_from_this模板類時有許多陷阱的,故記錄於此。
什麼時候該使用enable_shared_from_this模板類
在看下面的例子之前,簡單說下使用背景,單有一個類,某個函數需要返回當前對象的指針,我們返回的是shared_ptr,爲什麼使用智能指針呢,這是因爲:當我們使用智能指針管理資源時,必須統一使用智能指針,而不能再某些地方使用智能指針,某些地方使用原始指針,否則不能保持智能指針的語義,從而產生各種錯誤。好了,介紹完背景,看下面的一段小程序:
#include <iostream>
#include <boost/shared_ptr.hpp>
class Test
{
public:
//析構函數
~Test() { std::cout << "Test Destructor." << std::endl; }
//獲取指向當前對象的指針
boost::shared_ptr<Test> GetObject()
{
boost::shared_ptr<Test> pTest(this);
return pTest;
}
};
int main(int argc, char *argv[])
{
{
boost::shared_ptr<Test> p( new Test( ));
boost::shared_ptr<Test> q = p->GetObject();
}
return 0;
}
程序輸出:
Test Destructor.
Test Destructor.
從上面的輸出你發現了什麼,很明顯的發現只創建new了一個Test對象,但是卻調用了兩次析構函數,這對程序來說肯定是一個災難。爲什麼會出現這種情況呢?main函數中的boost::shared_ptr<Test> p( new Test( ));
將shared_ptr中引用計數器的值設置爲1,而在GetObject函數中又通過boost::shared_ptr<Test> pTest(this);
又將shared_ptr中的引用計數器的值增加了1,故在析構時一個Test對象被析構了兩次。即產生這個錯誤的原因是通過同一個Test指針對象創建了多個shared_ptr,這是絕對禁止的。同時這也提醒我們在使用shared_ptr時一定不能通過同一個指針對象創建一個以上的shared_ptr對象。那麼有什麼方法從一個類的成員函數中獲取當前對象的shared_ptr呢,其實方法很簡單:只需要該類繼承至enable_shared_from_this模板類,然後在需要shared_prt的地方調用enable_shared_from_this模板類的成員函數shared_from_this()即可,下面是改進後的代碼:
#include <iostream>
#include <boost/enable_shared_from_this.hpp>
#include <boost/shared_ptr.hpp>
class Test : public boost::enable_shared_from_this<Test> //改進1
{
public:
//析構函數
~Test() { std::cout << "Test Destructor." << std::endl; }
//獲取指向當前對象的指針
boost::shared_ptr<Test> GetObject()
{
return shared_from_this(); //改進2
}
};
int main(int argc, char *argv[])
{
{
boost::shared_ptr<Test> p( new Test( ));
boost::shared_ptr<Test> q = p->GetObject();
}
return 0;
}
程序輸出:
Test Destructor.
從輸出對象只被析構了一次,這是我們想要的結果,因此enable_shared_from_this模板類的作用是:用來作爲一個基類,它允許從一個成員函數中獲得一個當前對象的shared_ptr。那麼enable_shared_from_this模板類到底是如何工作的了?請看下文分解~
enable_shared_from_this模板類實現
打開enable_shared_from_this.hpp文件,會發現enable_shared_from_this模板類的實現如下:
template<class T> class enable_shared_from_this
{
protected:
enable_shared_from_this() BOOST_NOEXCEPT
{
}
enable_shared_from_this(enable_shared_from_this const &) BOOST_NOEXCEPT
{
}
enable_shared_from_this & operator=(enable_shared_from_this const &) BOOST_NOEXCEPT
{
return *this;
}
~enable_shared_from_this() BOOST_NOEXCEPT // ~weak_ptr<T> newer throws, so this call also must not throw
{
}
public:
shared_ptr<T> shared_from_this()
{
shared_ptr<T> p( weak_this_ );
BOOST_ASSERT( p.get() == this );
return p;
}
shared_ptr<T const> shared_from_this() const
{
shared_ptr<T const> p( weak_this_ );
BOOST_ASSERT( p.get() == this );
return p;
}
public: // actually private, but avoids compiler template friendship issues
// Note: invoked automatically by shared_ptr; do not call
template<class X, class Y> void _internal_accept_owner( shared_ptr<X> const * ppx, Y * py ) const
{
if( weak_this_.expired() )
{
weak_this_ = shared_ptr<T>( *ppx, py );
}
}
private:
mutable weak_ptr<T> weak_this_;
};
從enable_shared_from_this模板類的實現文件中我們可以很容易的發現我們只能使用返回shared_ptr的shared_from_this()和返回shared_ptr的shared_from_this(),因爲這兩個版本的shared_from_this()是public權限的,還有一個public權限的是internal_accept_owner函數,但是註釋中已經明顯指出不能調用這個函數,這個函數會被shared_ptr自動調用,internal_accept_owner函數用來初始化enable_shared_from_this模板類中的唯一成員變量weak_ptr weak_this。而shared_from_this()中是通過將weak_ptr weak_this轉化成shared_ptr和shared_ptr來返回的,因此在使用shared_from_this()之前需要先初始化weak_ptr weak_this對象,而weak_ptr weak_this對象是在_internal_accept_owner函數中進行的初始化,也就是說先需要創建shared_ptr對象。即在使用shared_from_this()函數之前,應該先初始化對象的基類enable_shared_from_this,接着再初始化對象,最後初始化shared_ptr。正因爲有這個特點所以會出現以下常見的錯誤:
使用enable_shared_from_this常見錯誤
先來看情形1:
class Test : public boost::enable_shared_from_this<Test>
{
Test() { boost::shared_ptr<Test> pTest = shared_from_this(); }
};
這種用法明顯是錯的,雖然對象的基類enable_shared_from_this類的構造函數已經被調用,但是shared_ptr的構造函數並沒有被調用,因此weak_ptr weak_this_並沒有被初始化,所以這時調用shared_from_this()是錯誤的。
接着我們來看情形2:
class Test : public boost::enable_shared_from_this<Test>
{
void func() { boost::shared_ptr<Test> pTest = shared_from_this(); }
};
int main()
{
Test test;
test.func(); //錯誤
Test pTest = new Test;
pTest->func(); //錯誤
}
同樣這種做法也是錯誤的,和情形1同樣的原因shared_ptr的構造函數並沒有被調用,因此weak_ptr weak_this_並沒有被初始化。
正確的做法應該是:
class Test : public boost::enable_shared_from_this<Test>
{
void func() { boost::shared_ptr<Test> pTest = shared_from_this(); }
};
int main()
{
shared_ptr<Test> pTest( new Test() );
pTest->func();
}
shared_ptr<Test> pTest( new Test() );
這句話依次執行的順序是:1 調用enable_shared_from_this的構造函數。2 調用Test的構造函數。 3 調用shared_ptr的構造函數初始化weak_ptr weak_this_。最後才能通過func()函數使用shared_from_this函數。
從上面的錯誤中我們知道在使用enable_shared_from_this類中的shared_from_this()函數時應該注意:
1. 不能在對象的構造函數中使用shared_from_this()函數。
2. 先需要調用enable_shared_from_this類的構造函數,接着調用對象的構造函數,最後需要調用shared_ptr類的構造函數初始化enable_shared_from_this的成員變量weak_this_。然後才能使用shared_from_this()函數。
3. 如何程序中使用了智能指針shared_ptr,則程序中統一使用智能指針,不能使用原始指針,以免出現錯誤。