【C++】std::weak_ptr

std::weak_ptr学习笔记

1. 基本概念

std::weak_ptr是C++标准库中的智能指针，用于解决std::shared_ptr的循环引用问题。它是一种弱引用智能指针，不会增加所指向对象的引用计数，也不会影响对象的生命周期，但可以观测到所指向对象的生命周期状态。因此，它经常与std::shared_ptr一起使用，用于解决共享对象的所有权问题。

2. 内部原理

弱引用

std::weak_ptr对象不会直接影响所指向对象的生命周期。它仅仅是指向std::shared_ptr对象所管理的对象的一个引用，称为弱引用。当std::shared_ptr对象释放了所管理的对象，弱引用指向的对象也会被释放。

计数器

std::weak_ptr内部维护了一个指向引用计数对象的指针，通过引用计数对象来共享所指向对象的引用计数信息。这样做的目的是为了避免std::weak_ptr对象在复制和销毁时对所指向对象的引用计数造成影响。

观测生命周期

通过std::weak_ptr的lock()成员函数可以创建一个std::shared_ptr对象，从而观测到所指向对象的生命周期。如果所指向对象仍然存在，则lock()函数返回一个有效的std::shared_ptr对象；如果所指向对象已经被销毁，则返回一个空的std::shared_ptr对象。

3. 应用场景

解决循环引用

循环引用是指两个或多个对象之间相互引用，导致它们的引用计数无法归零，从而导致内存泄漏。通过使用std::weak_ptr可以打破循环引用，避免内存泄漏的发生。

缓存系统

在缓存系统中，经常需要缓存一些不常用的对象，但又不希望缓存的对象影响到其生命周期。这时可以使用std::weak_ptr来保存对缓存对象的弱引用，当需要使用缓存对象时，可以通过lock()函数获取一个有效的std::shared_ptr对象，如果缓存对象已经被销毁，则获取到的指针为空。

回调函数

在异步编程中，经常需要在任务完成后执行回调函数。如果回调函数需要访问异步任务中的一些局部变量，可以将这些变量通过std::weak_ptr传递给回调函数，以避免在回调函数执行时产生悬空指针或内存访问错误。

4. 使用技巧

使用lock()函数检查对象是否存在

在使用std::weak_ptr观测所指向对象的生命周期时，应该始终使用lock()函数来检查对象是否存在，以避免在访问已销毁对象时产生未定义行为。

std::weak_ptr<int> wp;
{
    std::shared_ptr<int> sp = std::make_shared<int>(42);
    wp = sp;
    std::shared_ptr<int> locked = wp.lock();
    if (locked) {
        // 对象存在，可以安全地访问
        std::cout << "Value: " << *locked << std::endl;
    } else {
        // 对象已销毁
        std::cout << "Object has been destroyed" << std::endl;
    }
}

避免过度使用lock()

虽然lock()函数可以获取一个有效的std::shared_ptr对象，但过度使用lock()函数可能会导致性能问题，因为每次调用lock()函数都会增加引用计数并进行内存分配。应该尽量减少对lock()函数的调用次数，避免影响性能。

使用expired()函数检查对象是否已经销毁

除了使用

lock()函数来检查对象是否存在之外，还可以使用expired()函数来检查对象是否已经销毁。expired()函数返回一个布尔值，指示std::weak_ptr对象是否已经失效。

std::weak_ptr<int> wp;
{
    std::shared_ptr<int> sp = std::make_shared<int>(42);
    wp = sp;
    if (!wp.expired()) {
        // 对象存在，可以安全地访问
        std::shared_ptr<int> locked = wp.lock();
        std::cout << "Value: " << *locked << std::endl;
    } else {
        // 对象已销毁
        std::cout << "Object has been destroyed" << std::endl;
    }
}

5. 实战案例

图像处理

#include <memory>
#include <opencv2/opencv.hpp>

void processImage(std::weak_ptr<cv::Mat> image) {
    if (!image.expired()) {
        std::shared_ptr<cv::Mat> locked = image.lock();
        // 对图像进行处理
        cv::imshow("Processed Image", *locked);
        cv::waitKey(0);
    } else {
        std::cout << "Image has been destroyed" << std::endl;
    }
}

int main() {
    std::shared_ptr<cv::Mat> image = std::make_shared<cv::Mat>();
    // 从文件加载图像
    *image = cv::imread("image.jpg");
    processImage(image);
    return 0;
}

异步任务

#include <memory>
#include <thread>
#include <iostream>

void asyncTask(std::weak_ptr<bool> flag) {
    std::this_thread::sleep_for(std::chrono::seconds(2));
    if (!flag.expired()) {
        std::shared_ptr<bool> locked = flag.lock();
        *locked = true;
    } else {
        std::cout << "Flag has been destroyed" << std::endl;
    }
}

int main() {
    std::shared_ptr<bool> flag = std::make_shared<bool>(false);
    std::thread t(asyncTask, flag);
    t.detach();
    // 等待异步任务完成
    std::this_thread::sleep_for(std::chrono::seconds(3));
    if (*flag) {
        std::cout << "Async task completed" << std::endl;
    } else {
        std::cout << "Async task not completed" << std::endl;
    }
    return 0;
}

通过以上学习笔记，我们深入理解了std::weak_ptr的基本概念、内部原理、应用场景、使用技巧以及实战案例，为我们在实际项目中正确、高效地使用std::weak_ptr提供了指导。