命名空间
变体
操作

std::shared_ptr

来自 cppreference.cn
< cpp‎ | memory
 
C++
 
内存管理库
(仅供演示*)
未初始化内存算法
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)
(C++17)
(C++17)
(C++17)
(C++20)
受约束的未初始化
内存算法
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20) 
(C++20)
C 库

分配器
(C++11)
(C++23)
(C++11)
(C++11)
(C++20)
(C++20)
(C++20) 
(C++11)
(C++17)
内存资源
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
垃圾回收支持
(C++11)(直到 C++23)
(C++11)(直到 C++23)
(C++11)(直到 C++23)
(C++11)(直到 C++23)
(C++11)(直到 C++23)
(C++11)(直到 C++23)
未初始化存储
(直到 C++20*)
(直到 C++20*)
(直到 C++20*)
显式生命周期管理
(C++23)(C++23)
 
std::shared_ptr
成员函数
修改器
观察器
(C++17)
(直到 C++20*)
(C++26)
(C++26)
非成员函数
(C++20)
(C++20)
(C++17)
(直到 C++20)(直到 C++20)(直到 C++20)(直到 C++20)(直到 C++20)(C++20)
函数 (直到 C++26*)
辅助类
(C++20)
推导指引(C++17)
 
定义于头文件 <memory>
template< class T > class shared_ptr;
 (自 C++11 起)

std::shared_ptr 是一种智能指针，通过指针保持对象的所有权共享。多个 shared_ptr 对象可以拥有同一对象。当下列情况之一发生时，对象被销毁，其内存被释放

  • 拥有该对象的最后一个剩余 shared_ptr 被销毁；
  • 拥有该对象的最后一个剩余 shared_ptr 通过 operator= 或 reset() 被赋予另一个指针。

对象使用 delete 表达式 或在构造期间提供给 shared_ptr 的自定义删除器销毁。

shared_ptr 可以共享对象的所有权，同时存储指向另一个对象的指针。此功能可用于指向成员对象，同时拥有它们所属的对象。存储的指针是通过 get()、解引用和比较运算符访问的指针。当使用计数达到零时，托管指针是传递给删除器的指针。

shared_ptr 也可能不拥有任何对象，在这种情况下，它被称为空（如果使用别名构造函数创建空 shared_ptr，则它可能具有非空存储指针）。

shared_ptr 的所有特化都满足 CopyConstructible、CopyAssignable 和 LessThanComparable 的要求，并且是语境可转换为 bool。

所有成员函数（包括复制构造函数和复制赋值）都可以由不同 shared_ptr 对象上的多个线程调用，即使这些对象是副本并共享同一对象的所有权，也无需额外的同步。如果多个执行线程在没有同步的情况下访问同一个 shared_ptr 对象，并且任何这些访问使用 shared_ptr 的非 const 成员函数，则会发生数据竞争；std::atomic<shared_ptr> 可用于防止数据竞争。

内容

[编辑] 成员类型

成员类型 定义
element_type
T (直到 C++17)
std::remove_extent_t<T> (自 C++17 起)
weak_type (自 C++17 起) std::weak_ptr<T>

[编辑] 成员函数

 构造新的 shared_ptr
(公开成员函数) [编辑]
 如果没有更多 shared_ptr 链接到它，则析构拥有的对象
(公开成员函数) [编辑]
 赋值 shared_ptr
(公开成员函数) [编辑]
修改器
 替换托管对象
(公开成员函数) [编辑]
 交换托管对象
(公开成员函数) [编辑]
观察器
 返回存储的指针
(公开成员函数) [编辑]
 解引用存储的指针
(公开成员函数) [编辑]
(C++17)
 提供对存储数组的索引访问
(公开成员函数) [编辑]
 返回引用同一托管对象的 shared_ptr 对象的数量
(公开成员函数) [编辑]
(直到 C++20)
 检查托管对象是否仅由当前 shared_ptr 对象管理
(公开成员函数) [编辑]
 检查存储的指针是否非空
(公开成员函数) [编辑]
 提供基于所有者的共享指针排序
(公开成员函数) [编辑]
(C++26)
 提供基于所有者的共享指针哈希
(公开成员函数) [编辑]
(C++26)
 提供基于所有者的共享指针相等比较
(公开成员函数) [编辑]

[编辑] 非成员函数

(C++20)
 创建管理新对象的共享指针
(函数模板) [编辑]
(C++20)
 创建管理使用分配器分配的新对象的共享指针
(函数模板) [编辑]
(C++17)
 将 static_cast、dynamic_cast、const_cast 或 reinterpret_cast 应用于存储的指针
(函数模板) [编辑]
 返回指定类型的删除器（如果拥有）
(函数模板) [编辑]
(C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20)
 与另一个 shared_ptr 或 nullptr 进行比较
(函数模板) [编辑]
 将存储指针的值输出到输出流
(函数模板) [编辑]
(C++11)
 特化 std::swap 算法
(函数模板) [编辑]
(C++20 中弃用)(C++26 中移除)
 为 std::shared_ptr 特化原子操作
(函数模板) [编辑]

[编辑] 辅助类

(C++20)
 原子共享指针
(类模板特化) [编辑]
(C++11)
 对 std::shared_ptr 的哈希支持
(类模板特化) [编辑]

[编辑] 推导指引 (自 C++17 起)

[编辑] 注解

对象的所有权只能通过复制构造或复制赋值其值给另一个 shared_ptr 来与另一个 shared_ptr 共享。使用另一个 shared_ptr 拥有的原始底层指针构造新的 shared_ptr 会导致未定义行为。

std::shared_ptr 可以与不完整类型 T 一起使用。但是，来自原始指针的构造函数（template<class Y> shared_ptr(Y*)）和 template<class Y> void reset(Y*) 成员函数只能使用指向完整类型的指针调用（请注意，std::unique_ptr 可以从指向不完整类型的原始指针构造）。

std::shared_ptr<T> 中的 T 可以是函数类型：在这种情况下，它管理指向函数的指针，而不是对象指针。这有时用于保持动态库或插件的加载，只要引用其任何函数即可

void del(void(*)()) {}
 
void fun() {}
 
int main()
{
    std::shared_ptr<void()> ee(fun, del);
    (*ee)();
}

[编辑] 实现注解

在典型的实现中，shared_ptr 仅保存两个指针

  • 存储的指针（由 get() 返回的指针）；
  • 指向控制块的指针。

控制块是动态分配的对象，它保存

  • 指向托管对象的指针或托管对象本身；
  • 删除器（类型擦除）；
  • 分配器（类型擦除）；
  • 拥有托管对象的 shared_ptr 的数量；
  • 引用托管对象的 weak_ptr 的数量。

当通过调用 std::make_shared 或 std::allocate_shared 创建 shared_ptr 时，控制块和托管对象的内存都通过单次分配创建。托管对象在控制块的数据成员中就地构造。当通过 shared_ptr 构造函数之一创建 shared_ptr 时，托管对象和控制块必须单独分配。在这种情况下，控制块存储指向托管对象的指针。

shared_ptr 直接持有的指针是由 get() 返回的指针，而控制块持有的指针/对象是当共享所有者的数量达到零时将被删除的指针/对象。这些指针不一定相等。

shared_ptr 的析构函数会减少控制块的共享所有者数量。如果计数器达到零，则控制块调用托管对象的析构函数。控制块在 std::weak_ptr 计数器也达到零之前不会自行释放分配。

在现有实现中，如果存在指向同一控制块的共享指针，则弱指针的数量会增加（[1]、[2]）。

为了满足线程安全要求，引用计数器通常使用等效于 std::atomic::fetch_add 和 std::memory_order_relaxed 的操作来递增（递减需要更强的排序以安全地销毁控制块）。

[编辑] 示例

运行此代码
#include <chrono>
#include <iostream>
#include <memory>
#include <mutex>
#include <thread>
 
using namespace std::chrono_literals;
 
struct Base
{
    Base() { std::cout << "Base::Base()\n"; }
 
    // Note: non-virtual destructor is OK here
    ~Base() { std::cout << "Base::~Base()\n"; }
};
 
struct Derived : public Base
{
    Derived() { std::cout << "Derived::Derived()\n"; }
 
    ~Derived() { std::cout << "Derived::~Derived()\n"; }
};
 
void print(auto rem, std::shared_ptr<Base> const& sp)
{
    std::cout << rem << "\n\tget() = " << sp.get()
              << ", use_count() = " << sp.use_count() << '\n';
}
 
void thr(std::shared_ptr<Base> p)
{
    std::this_thread::sleep_for(987ms);
    std::shared_ptr<Base> lp = p; // thread-safe, even though the
                                  // shared use_count is incremented
    {
        static std::mutex io_mutex;
        std::lock_guard<std::mutex> lk(io_mutex);
        print("Local pointer in a thread:", lp);
    }
}
 
int main()
{
    std::shared_ptr<Base> p = std::make_shared<Derived>();
 
    print("Created a shared Derived (as a pointer to Base)", p);
 
    std::thread t1{thr, p}, t2{thr, p}, t3{thr, p};
    p.reset(); // release ownership from main
 
    print("Shared ownership between 3 threads and released ownership from main:", p);
 
    t1.join();
    t2.join();
    t3.join();
 
    std::cout << "All threads completed, the last one deleted Derived.\n";
}

可能的输出

Base::Base()
Derived::Derived()
Created a shared Derived (as a pointer to Base)
	get() = 0x118ac30, use_count() = 1
Shared ownership between 3 threads and released ownership from main:
	get() = 0, use_count() = 0
Local pointer in a thread:
	get() = 0x118ac30, use_count() = 5
Local pointer in a thread:
	get() = 0x118ac30, use_count() = 4
Local pointer in a thread:
	get() = 0x118ac30, use_count() = 2
Derived::~Derived()
Base::~Base()
All threads completed, the last one deleted Derived.

[编辑] 示例

运行此代码
#include <iostream>
#include <memory>
 
struct MyObj
{
    MyObj() { std::cout << "MyObj constructed\n"; }
 
    ~MyObj() { std::cout << "MyObj destructed\n"; }
};
 
struct Container : std::enable_shared_from_this<Container> // note: public inheritance
{
    std::shared_ptr<MyObj> memberObj;
 
    void CreateMember() { memberObj = std::make_shared<MyObj>(); }
 
    std::shared_ptr<MyObj> GetAsMyObj()
    {
        // Use an alias shared ptr for member
        return std::shared_ptr<MyObj>(shared_from_this(), memberObj.get());
    }
};
 
#define COUT(str) std::cout << '\n' << str << '\n'
 
#define DEMO(...) std::cout << #__VA_ARGS__ << " = " << __VA_ARGS__ << '\n'
 
int main()
{
    COUT("Creating shared container");
    std::shared_ptr<Container> cont = std::make_shared<Container>();
    DEMO(cont.use_count());
    DEMO(cont->memberObj.use_count());
 
    COUT("Creating member");
    cont->CreateMember();
    DEMO(cont.use_count());
    DEMO(cont->memberObj.use_count());
 
    COUT("Creating another shared container");
    std::shared_ptr<Container> cont2 = cont;
    DEMO(cont.use_count());
    DEMO(cont->memberObj.use_count());
    DEMO(cont2.use_count());
    DEMO(cont2->memberObj.use_count());
 
    COUT("GetAsMyObj");
    std::shared_ptr<MyObj> myobj1 = cont->GetAsMyObj();
    DEMO(myobj1.use_count());
    DEMO(cont.use_count());
    DEMO(cont->memberObj.use_count());
    DEMO(cont2.use_count());
    DEMO(cont2->memberObj.use_count());
 
    COUT("Copying alias obj");
    std::shared_ptr<MyObj> myobj2 = myobj1;
    DEMO(myobj1.use_count());
    DEMO(myobj2.use_count());
    DEMO(cont.use_count());
    DEMO(cont->memberObj.use_count());
    DEMO(cont2.use_count());
    DEMO(cont2->memberObj.use_count());
 
    COUT("Resetting cont2");
    cont2.reset();
    DEMO(myobj1.use_count());
    DEMO(myobj2.use_count());
    DEMO(cont.use_count());
    DEMO(cont->memberObj.use_count());
 
    COUT("Resetting myobj2");
    myobj2.reset();
    DEMO(myobj1.use_count());
    DEMO(cont.use_count());
    DEMO(cont->memberObj.use_count());
 
    COUT("Resetting cont");
    cont.reset();
    DEMO(myobj1.use_count());
    DEMO(cont.use_count());
}

输出

Creating shared container
cont.use_count() = 1
cont->memberObj.use_count() = 0
 
Creating member
MyObj constructed
cont.use_count() = 1
cont->memberObj.use_count() = 1
 
Creating another shared container
cont.use_count() = 2
cont->memberObj.use_count() = 1
cont2.use_count() = 2
cont2->memberObj.use_count() = 1
 
GetAsMyObj
myobj1.use_count() = 3
cont.use_count() = 3
cont->memberObj.use_count() = 1
cont2.use_count() = 3
cont2->memberObj.use_count() = 1
 
Copying alias obj
myobj1.use_count() = 4
myobj2.use_count() = 4
cont.use_count() = 4
cont->memberObj.use_count() = 1
cont2.use_count() = 4
cont2->memberObj.use_count() = 1
 
Resetting cont2
myobj1.use_count() = 3
myobj2.use_count() = 3
cont.use_count() = 3
cont->memberObj.use_count() = 1
 
Resetting myobj2
myobj1.use_count() = 2
cont.use_count() = 2
cont->memberObj.use_count() = 1
 
Resetting cont
myobj1.use_count() = 1
cont.use_count() = 0
MyObj destructed

[编辑] 参见

(C++11)
 具有唯一对象所有权语义的智能指针
(类模板) [编辑]
(C++11)
 对 std::shared_ptr 管理的对象的弱引用
(类模板) [编辑]
已从“https://cppreference.cn/mwiki/index.php?title=cpp/memory/shared_ptr&oldid=173514”检索