C++惯用法之RAII思想: 资源管理

C++编程技巧专栏：http://t.csdnimg.cn/eolY7

1.概述

2.RAII的应用

2.1.智能指针

2.2.文件句柄管理

2.3.互斥锁

3.注意事项

3.1.禁止复制

3.2.对底层资源使用引用计数法

3.3.复制底部资源(深拷贝)或者转移资源管理权(移动语义)

4.RAII的优势和挑战

5.总结

1.概述

RAII是Resource Acquisition Is Initialization的缩写，即“资源获取即初始化”。RAII原则的基本思想是将资源的生命周期与对象的生命周期绑定在一起。它是C++语言的一种管理资源、避免资源泄漏的惯用法，利用栈的特点来实现，这一概念最早由Bjarne Stroustrup提出。在函数中由栈管理的临时对象，在函数结束时会自动析构，从而自动释放资源，因此，我们可以通过构造函数获取资源，通过析构函数释放资源。这种自动管理资源的方式可以大大减少资源泄漏、野指针和其他与资源管理相关的问题。常见的写法为：

Object() {
    // acquire resource in constructor
}
~Object() {
    // release resource in destructor
}

2.RAII的应用

2.1.智能指针

智能指针是RAII原则在内存管理中的一个典型应用。C++11引入了多种智能指针类型，如std::unique_ptr、std::shared_ptr和std::weak_ptr，它们可以自动管理动态分配的内存。

例如，使用std::unique_ptr可以确保在不需要动态分配的内存时自动释放它：

#include <iostream>
#include <memory>

class MyClass {
public:
    MyClass() { std::cout << "MyClass created\n"; }
    ~MyClass() { std::cout << "MyClass destroyed\n"; }
};

int main() {
    {
        std::unique_ptr<MyClass> ptr(new MyClass()); // MyClass对象被创建
        // 当ptr离开这个作用域时，它会自动释放所指向的MyClass对象
    } // MyClass对象在这里被销毁，输出"MyClass destroyed"
    return 0;
}

在这个例子中，当ptr离开其作用域时，std::unique_ptr的析构函数会被调用，从而释放它所指向的MyClass对象。这种自动的内存管理方式避免了手动调用delete可能导致的错误。

2.2.文件句柄管理

另一个常见的应用是使用RAII原则管理文件句柄。通过创建一个封装了文件句柄的类，可以确保在不需要文件时自动关闭它。

例如：

#include <fstream>
#include <iostream>

class FileWrapper {
public:
    FileWrapper(const std::string& filename, std::ios_base::openmode mode)
        : file_(filename, mode) {
        if (!file_.is_open()) {
            throw std::runtime_error("无法打开文件: " + filename);
        }
    }

    ~FileWrapper() {
        file_.close(); // 在析构函数中关闭文件句柄
    }

    // 提供对内部文件的访问（如果需要的话）
    std::fstream& file() { return file_; }

private:
    std::fstream file_; // 封装文件句柄的成员变量
};

在这个例子中，FileWrapper类的构造函数打开一个文件，并在析构函数中关闭它。这确保了即使在异常情况下，文件句柄也会被正确关闭。

2.3.互斥锁

在多线程编程中，std::lock_guard, std::unique_lock, std::shared_lock等也利用了RAII的原理，用于管理互斥锁。当这些类的等对象创建时，会自动获取互斥锁；当对象销毁时，会自动释放互斥锁。

std::lock_guard的构造函数如下：

template< class Mutex > class lock_guard;

std::lock_guard的析构函数会自动释放互斥锁，因此，我们可以通过std::lock_guard来管理互斥锁，从而避免忘记释放互斥锁。如：

std::mutex mtx;
std::lock_guard<std::mutex> lock(mtx); // unlock when lock is out of scope

不使用RAII的情况下，我们需要手动释放互斥锁，如下所示：

std::mutex mtx;
mtx.lock();
// ...
mtx.unlock();

3.注意事项

在资源管理类中小心copy行为

拷贝RAII对象必须考虑其管理的资源，针对其资源做出拷贝行为的实现
常见的RAII对象拷贝行为：拒绝拷贝、引用计数法、深拷贝、资源所有权转移

并非所有资源都是基于堆的（heap-based），对于这种对象不能直接使用智能指针，需要自定义其资源管理类。例如：为了说明锁的资源管理行为，我们这里给定义一个锁，来替代C++里的锁

struct MyMutex {
    MyMutex() {
        printf("Construct MyMutex\n");
    }

    ~MyMutex() {
        printf("Deconstruct MyMutex\n");
    }
};

其上锁解锁行为:

void lock(MyMutex *) {
    printf("lock\n");
}

void unlock(MyMutex *) {
    printf("unlock\n");
}

锁的资源管理类,在构造函数获取资源(加锁),在析构函数释放资源(解锁):

struct Lock {
private:
    MyMutex *myMutex;
public:
    explicit Lock(MyMutex *mutex) : myMutex(mutex) {
        lock(myMutex);
    }

    ~Lock() {
        unlock(myMutex);
    }
};

使用:

int main() {
    MyMutex myMutex;
    {
        printf("---------\n");
        Lock lk(&myMutex);
        printf("---------\n");
        // 离开代码块将自动析构局部对象,因此会释放锁
    }
}
/*
Construct MyMutex
---------
lock
---------
unlock
Deconstruct MyMutex
*/

潜在风险,如果发生了拷贝行为:

Lock l1(&mutex);
Lock l2(l1);

那么将立即死锁(Linux里一般是非递归锁,重复加锁会造成死锁)

3.1.禁止复制

继承nocopyable,或者将拷贝相关函数设置为delete。如：

//[1]
class NonCopyable
{
protected:
    NonCopyable(const NonCopyable&){}
    NonCopyable& operator=(NonCopyable&){}
};

或

//[2]
class NonCopyable
{
public:
    NonCopyable(const NonCopyable&)=delete;
    NonCopyable& operator=(const NonCopyable&)=delete;
};

3.2.对底层资源使用引用计数法

思想:维护一个计数器,当最后一个使用者被销毁时,才真正释放资源,如：

struct Lock {
private:
    shared_ptr<MyMutex> mutexPtr;
public:
	// 将unlock函数设置为删除器
    explicit Lock(MyMutex *mutex) : mutexPtr(mutex, unlock) {
        lock(mutexPtr.get());
    }
    // 不必声明析构函数,因为mutexPtr是栈上对象,所以会被默认释放,那么智能指针就会调用其释放器unlock
};

3.3.复制底部资源(深拷贝)或者转移资源管理权(移动语义)

在资源管理类中提供对原始资源的访问

API常需要要求访问原始资源,所以RAII资源管理类应该提供访问原始资源的接口
对原始资源可以由显示转换或者隐式转换获得.其在安全性和方便性上各有取舍

智能指针提供了get接口来访问原始资源

在其中要注意,不可以get一个智能指针去初始化另一个智能指针,否则会发生重复释放

int main() {
    shared_ptr<MyMutex> p1 = make_shared<MyMutex>();
    {
        shared_ptr<MyMutex> p2(p1.get());
        cout << p1.use_count() << " " << p2.use_count() << endl;
//        1 1
//        p2离开代码块，释放其管理的资源，p1指针指向被释放的内存
    }
}

程序将异常退出