EffectiveModernCppChinese/4.SmartPointers/item20.md
2020-11-01 17:28:51 +08:00

8.4 KiB
Raw Blame History

Item 20:像std::shared_ptr一样使用std::weak_ptr可能造成dangle

自相矛盾的是,如果有一个像std::shared_ptr的指针但是不参与资源所有权共享的指针是很方便的。换句话说,类似std::shared_ptr的指针但是不影响对象的引用计数。这种类型的智能指针必须要解决一个std::shared_ptr不存在的问题可能指向已经销毁的对象。一个真正的智能指针应该跟踪所值对象在dangle时知晓比如当指向对象不再存在。那就是对std::weak_ptr最精确的描述。

你可能想知道什么时候该用std::weak_ptr。你可能想知道关于std::weak_ptrAPI的更多。它什么都好除了不太智能。std::weak_ptr不能解引用,也不能测试是否为空值。因为std::weak_ptr不是一个独立的智能指针。它是std::shared_ptr的增强。

这种关系在它创建之时就建立了。std::weak_ptr通常从std::shared_ptr上创建。当从std::shared_ptr上创建std::weak_ptr时两者指向相同的对象,但是std::weak_ptr不会影响所指对象的引用计数:

auto spw = 					// after spw is constructed
std::make_shared<Widget>(); // the pointed-to Widget's
							// ref count(RC) is 1
							// See Item 21 for in on std::make_shared

std::weak_ptr<Widget> wpw(spw); // wpw points to same Widget as spw. RC remains 1

spw = nullptr; 					// RC goes to 0, and the
								// Widget is destroyed.
								// wpw now dangles

std::weak_ptrexpired来表示已经dangle。你可以用它直接做测试

if (wpw.expired())  // if wpw doesn't point to an object

但是通常你期望的是检查std::weak_ptr是否已经失效,如果没有失效则访问其指向的对象。这做起来比较容易。因为缺少解引用操作,没有办法写这样的代码。即使有,将检查和解引用分开会引入竞态条件:在调用expired和解引用操作之间,另一个线程可能对指向的对象重新赋值或者析构,并由此造成对象已析构。这种情况下,你的解引用将会产生未定义行为。

你需要的是一个原子操作实现检查是否过期,如果没有过期就访问所指对象。这可以通过从std::weak_ptr创建std::shared_ptr来实现,具体有两种形式可以从std::weak_ptr上创建std::shared_ptr,具体用哪种取决于std::weak_ptr过期时你希望std::shared_ptr表现出什么行为。一种形式是std::weak_ptr::lock,它返回一个std::shared_ptr,如果std::weak_ptr过期这个std::shared_ptr为空:

std::shared_ptr<Widget> spw1 = wpw.lock();  // if wpw's expired, spw1 is null
 											
auto spw2 = wpw.lock(); 					// same as above, but uses auto

另一种形式是以std::weak_ptr为实参构造std::shared_ptr。这种情况中,如果std::weak_ptr过期,会抛出一个异常:

std::shared_ptr<Widget> spw3(wpw);			// if wpw's expired, throw std::bad_weak_ptr

但是你可能还想知道为什么std::weak_ptr就有用了。考虑一个工厂函数它基于一个UID从只读对象上产出智能指针。根据Item18的描述工厂函数会返回一个该对象类型的std::unique_ptr

	std::unique_ptr<const Widget> loadWidget(WidgetID id);

如果调用loadWidget是一个昂贵的操作比如它操作文件或者数据库I/O并且对于ID来重复使用很常见一个合理的优化是再写一个函数除了完成loadWidget做的事情之外再缓存它的结果。当请求获取一个Widget时阻塞在缓存操作上这本身也会导致性能问题所以另一个合理的优化可以是当Widget不再使用的时候销毁它的缓存。

对于可缓存的工厂函数,返回std::unique_ptr不是好的选择。调用者接受缓存后的对象的只能指针调用者也应该确定这些对象的生命周期但是缓存本身也需要一个指针指向它所缓的对象。缓存对象的指针需要知道它是否已经dangle因为当工厂客户端使用完工厂产生的对象后对象将被销毁关联的缓存条目会dangle。所以缓存应该使用std::weak_ptr这可以知道是否已经dangle。这意味着工厂函数返回值类型应该是std::shared_ptr,因为std::weak_ptr依赖std::shared_ptr

下面是一个粗制滥造的缓存版本的loadWidget实现:

std::shared_ptr<const Widget> fastLoadWidget(WidgetID id)
{
	static std::unordered_map<WidgetID,
								std::weak_ptr<const Widget>> cache; // 译者注:这里是高亮
	auto objPtr = cache[id].lock(); 	// objPtr is std::shared_ptr to cached object (or null if object's not in cache)
	if (!objPtr) { 						// if not in cache
		objPtr = loadWidget(id); 		// load it 
		cache[id] = objPtr; 			// cache it 
	}
	return objPtr;
}

这个实现使用了C++11的hash表容器std::unordered_map,尽管没有显式表明需要WidgetID哈希和相等性比较的能力。

fastLoadWidget的实现忽略了以下事实cache可能会累积expired的与已经销毁的Widget相关联的std::weak_ptr。可以改进实现方式,但不要花时间在不会引起对std :: weak_ptr的深入了解的问题上让我们考虑第二个用例观察者设计模式。此模式的主要组件是subjects状态可能会更改的对象和observers状态发生更改时要通知的对象。在大多数实现中每个subject都包含一个数据成员该成员持有指向其observer的指针。这使subject很容易发布状态更改通知。subject对控制observers的生命周期例如当它们被销毁时没有兴趣但是subject对确保observers被销毁时不会访问它具有极大的兴趣 。一个合理的设计是每个subject持有其observers的std::weak_ptr因此可以在使用前检查是否已经dangle。

作为最后一个使用std::weak_ptr的例子考虑一个持有三个对象A,B,C的数据结构A和C共享B的所有权因此持有std::shared_ptr

image-20201101170753295

假定从B指向A的指针也很有用。应该使用哪种指针

image-20201101170921305

有三种选择:

  • 原始指针。使用这种方法如果A被销毁但是C继续指向BB就会有一个指向A的悬垂指针。而且B不知道指针已经悬垂所以B可能会继续访问就会导致未定义行为
  • std::shared_ptr。这种设计A和B都互相持有对方的std::shared_ptr,导致std::shared_ptr在销毁时出现循环。即使A和B无法从其他数据结构被访问比如C不再指向B每个的引用计数都是1.如果发升了这种情况A和B都被泄露程序无法访问它们但是资源并没有被回收。
  • std::weak_ptr。这避免了上述两个问题。如果A被销毁B还是有dangle指针但是B可以检查。尤其是尽管A和B互相指向B的指针不会影响A的引用计数因此不会导致无法销毁。

使用std::weak_ptr显然是这些选择中最好的。但是,需要注意使用std::weak_ptr打破std::shared_ptr循环并不常见。在严格分层的数据结构比如树,子节点只被父节点持有。当父节点被销毁时,子节点就被销毁。从父到子的链接关系可以使用std::unique_ptr很好的表征。从子到父的反向连接可以使用原始指针安全实现,因此子节点的生命周期肯定短于父节点。因此子节点解引用一个悬垂的父节点指针是没有问题的。

当然不是所有的使用指针的数据结构都是严格分层的所以当发生这种情况时比如上面所述cache和观察者情况知道std::weak_ptr随时待命也是不错的。

从效率角度来看,std::weak_ptrstd::shared_ptr基本相同。两者的大小是相同的使用相同的控制块参见Item 19构造、析构、赋值操作涉及引用计数的原子操作。这可能让你感到惊讶因为本Item开篇就提到std::weak_ptr不影响引用计数。我写的是std::weak_ptr不参与对象的共享所有权,因此不影响指向对象的引用计数。实际上在控制块中还是有第二个引用计数,std::weak_ptr操作的是第二个引用计数。想了解细节的话继续看Item 21吧。

记住

  • std::shared_ptr使用std::weak_ptr可能会dangle
  • std::weak_ptr的潜在使用场景包括caching、observer lists、打破std::shared_ptr指向循环