RefCell<T> 和内部可变性模式
内部可变性是 Rust 中的一种设计模式，它允许你即使在存在对数据的不可变引用时也能修改数据；通常，这种操作是被借用规则禁止的。为了修改数据，该模式在数据结构内部使用 unsafe 代码来绕过 Rust 管理修改和借用的常规规则。不安全代码向编译器表明我们正在手动检查规则，而不是依赖编译器为我们检查；我们将在第 19 章更详细地讨论不安全代码。
我们只能在可以确保在运行时遵循借用规则的情况下才能使用使用内部可变性模式的类型，即使编译器无法保证这一点。然后将涉及的 unsafe 代码包装在一个安全的 API 中，并且外部类型仍然是不可变的。
让我们通过查看遵循内部可变性模式的 RefCell<T> 类型来探索这个概念。
使用 RefCell<T> 在运行时强制执行借用规则
与 Rc<T> 不同，RefCell<T> 类型表示对其持有的数据的单一所有权。那么，是什么让 RefCell<T> 与 Box<T> 这样的类型不同呢？回想一下你在第 4 章中学到的借用规则
- 在任何给定时间，你只能拥有一个可变引用或任意数量的不可变引用（但不能同时拥有）。
- 引用必须始终有效。
对于引用和 Box<T>，借用规则的不变量是在编译时强制执行的。而对于 RefCell<T>，这些不变量是在运行时强制执行的。对于引用，如果你违反了这些规则，你将得到一个编译错误。而对于 RefCell<T>，如果你违反了这些规则，你的程序将会 panic 并退出。
在编译时检查借用规则的优点是，错误会在开发过程的早期就被发现，并且对运行时性能没有影响，因为所有的分析都是在之前完成的。由于这些原因，在大多数情况下，在编译时检查借用规则是最好的选择，这也是 Rust 的默认行为。
在运行时检查借用规则的优点是，这样就允许某些内存安全的场景，而这些场景在编译时检查中是不允许的。静态分析，比如 Rust 编译器，本质上是保守的。代码的某些属性是不可能通过分析代码来检测的：最著名的例子是停机问题，这超出了本书的范围，但它是一个值得研究的有趣话题。
因为有些分析是不可能的，如果 Rust 编译器不能确定代码是否符合所有权规则，它可能会拒绝一个正确的程序；在这种情况下，它是保守的。如果 Rust 接受了一个不正确的程序，用户将无法信任 Rust 做出的保证。然而，如果 Rust 拒绝了一个正确的程序，程序员会感到不便，但不会发生灾难性的事情。当你确信你的代码遵循借用规则，但编译器无法理解和保证这一点时，RefCell<T> 类型就很有用。
与 Rc<T> 类似，RefCell<T> 只能用于单线程场景，如果你尝试在多线程环境中使用它，将会得到一个编译时错误。我们将在第 16 章讨论如何在多线程程序中获得 RefCell<T> 的功能。
以下是选择 Box<T>、Rc<T> 或 RefCell<T> 的理由回顾
Rc<T>支持同一数据的多个所有者；Box<T>和RefCell<T>只有一个所有者。Box<T>允许在编译时检查的不可变或可变借用；Rc<T>只允许在编译时检查的不可变借用；RefCell<T>允许在运行时检查的不可变或可变借用。- 因为
RefCell<T>允许在运行时检查的可变借用，所以即使RefCell<T>是不可变的，你也可以修改RefCell<T>内部的数据。
修改不可变值内部的数据就是内部可变性模式。让我们来看看内部可变性有用的情况，并研究它是如何实现的。
内部可变性：对不可变值的可变借用
借用规则的一个结果是，当你有一个不可变值时，你不能可变地借用它。例如，这段代码将无法编译
fn main() {
let x = 5;
let y = &mut x;
}如果你尝试编译这段代码，你将会得到以下错误
$ cargo run
Compiling borrowing v0.1.0 (file:///projects/borrowing)
error[E0596]: cannot borrow `x` as mutable, as it is not declared as mutable
--> src/main.rs:3:13
|
3 | let y = &mut x;
| ^^^^^^ cannot borrow as mutable
|
help: consider changing this to be mutable
|
2 | let mut x = 5;
| +++
For more information about this error, try `rustc --explain E0596`.
error: could not compile `borrowing` (bin "borrowing") due to 1 previous error
然而，在某些情况下，如果一个值可以在其方法中发生改变，但对于其他代码来说是不可变的，这将非常有用。值方法之外的代码将无法改变该值。使用 RefCell<T> 是获得内部可变性能力的一种方法，但 RefCell<T> 并没有完全绕过借用规则：编译器中的借用检查器允许这种内部可变性，而借用规则是在运行时检查的。如果您违反了规则，您将得到一个 panic! 而不是编译错误。
让我们通过一个实际的例子来了解如何使用 RefCell<T> 来改变一个不可变的值，并看看为什么这样做很有用。
内部可变性的用例：模拟对象
有时在测试过程中，程序员会使用一种类型来代替另一种类型，以便观察特定的行为并断言其实现是否正确。这种占位符类型被称为*测试替身*。可以把它理解为电影制作中的“特技替身”，特技替身会代替演员完成特定的高难度场景。测试替身在我们运行测试时会代替其他类型。*模拟对象*是一种特殊的测试替身，它会记录测试过程中发生的事情，以便您可以断言是否发生了正确的操作。
Rust 中的对象与其他语言中的对象含义不同，而且 Rust 也没有像其他一些语言那样在标准库中内置模拟对象功能。但是，您绝对可以创建一个结构体来实现与模拟对象相同的目的。
以下是我们将要测试的场景：我们将创建一个库，该库跟踪一个值相对于最大值的变化，并根据当前值与最大值的接近程度发送消息。例如，该库可用于跟踪用户允许进行的 API 调用次数配额。
我们的库只提供跟踪值与最大值的接近程度以及在何时发送何种消息的功能。使用我们库的应用程序将需要提供发送消息的机制：应用程序可以将消息放入应用程序中，发送电子邮件，发送短信或其他方式。库不需要知道这些细节。它只需要一个实现了我们将提供的名为 Messenger 的特征的东西。清单 15-20 显示了库代码
文件名：src/lib.rs
pub trait Messenger {
fn send(&self, msg: &str);
}
pub struct LimitTracker<'a, T: Messenger> {
messenger: &'a T,
value: usize,
max: usize,
}
impl<'a, T> LimitTracker<'a, T>
where
T: Messenger,
{
pub fn new(messenger: &'a T, max: usize) -> LimitTracker<'a, T> {
LimitTracker {
messenger,
value: 0,
max,
}
}
pub fn set_value(&mut self, value: usize) {
self.value = value;
let percentage_of_max = self.value as f64 / self.max as f64;
if percentage_of_max >= 1.0 {
self.messenger.send("Error: You are over your quota!");
} else if percentage_of_max >= 0.9 {
self.messenger
.send("Urgent warning: You've used up over 90% of your quota!");
} else if percentage_of_max >= 0.75 {
self.messenger
.send("Warning: You've used up over 75% of your quota!");
}
}
}清单 15-20：一个用于跟踪值与最大值的接近程度并在值达到特定级别时发出警告的库
这段代码的一个重要部分是 Messenger 特征有一个名为 send 的方法，该方法接收一个对 self 的不可变引用和消息文本。这个特征是我们的模拟对象需要实现的接口，以便模拟对象可以像真实对象一样使用。另一个重要部分是我们想要测试 LimitTracker 上 set_value 方法的行为。我们可以更改传递给 value 参数的内容，但 set_value 不会返回任何我们可以断言的内容。我们希望能够说，如果我们使用实现了 Messenger 特征的东西和一个特定的 max 值创建一个 LimitTracker，当我们为 value 传递不同的数字时，会通知 messenger 发送相应的消息。
我们需要一个模拟对象，它在调用 send 时不会发送电子邮件或短信，而只会跟踪它被告知要发送的消息。我们可以创建一个新的模拟对象实例，创建一个使用模拟对象的 LimitTracker，调用 LimitTracker 上的 set_value 方法，然后检查模拟对象是否具有我们期望的消息。清单 15-21 显示了尝试实现一个模拟对象来做到这一点，但借用检查器不允许这样做
文件名：src/lib.rs
pub trait Messenger {
fn send(&self, msg: &str);
}
pub struct LimitTracker<'a, T: Messenger> {
messenger: &'a T,
value: usize,
max: usize,
}
impl<'a, T> LimitTracker<'a, T>
where
T: Messenger,
{
pub fn new(messenger: &'a T, max: usize) -> LimitTracker<'a, T> {
LimitTracker {
messenger,
value: 0,
max,
}
}
pub fn set_value(&mut self, value: usize) {
self.value = value;
let percentage_of_max = self.value as f64 / self.max as f64;
if percentage_of_max >= 1.0 {
self.messenger.send("Error: You are over your quota!");
} else if percentage_of_max >= 0.9 {
self.messenger
.send("Urgent warning: You've used up over 90% of your quota!");
} else if percentage_of_max >= 0.75 {
self.messenger
.send("Warning: You've used up over 75% of your quota!");
}
}
}
#[cfg(test)]
mod tests {
use super::*;
struct MockMessenger {
sent_messages: Vec<String>,
}
impl MockMessenger {
fn new() -> MockMessenger {
MockMessenger {
sent_messages: vec![],
}
}
}
impl Messenger for MockMessenger {
fn send(&self, message: &str) {
self.sent_messages.push(String::from(message));
}
}
#[test]
fn it_sends_an_over_75_percent_warning_message() {
let mock_messenger = MockMessenger::new();
let mut limit_tracker = LimitTracker::new(&mock_messenger, 100);
limit_tracker.set_value(80);
assert_eq!(mock_messenger.sent_messages.len(), 1);
}
}清单 15-21：尝试实现一个借用检查器不允许的 MockMessenger
这段测试代码定义了一个 MockMessenger 结构体，它有一个 sent_messages 字段，该字段包含一个 Vec 的 String 值，用于跟踪它被告知要发送的消息。我们还定义了一个关联函数 new，以便于创建从空消息列表开始的新 MockMessenger 值。然后，我们为 MockMessenger 实现 Messenger 特征，以便我们可以将 MockMessenger 提供给 LimitTracker。在 send 方法的定义中，我们将作为参数传入的消息存储在 MockMessenger 的 sent_messages 列表中。
在测试中，我们正在测试当 LimitTracker 被告知将 value 设置为大于 max 值的 75% 时会发生什么。首先，我们创建一个新的 MockMessenger，它将从一个空的消息列表开始。然后，我们创建一个新的 LimitTracker，并为其提供对新 MockMessenger 的引用和 max 值 100。我们使用值 80 调用 LimitTracker 上的 set_value 方法，该值大于 100 的 75%。然后，我们断言 MockMessenger 正在跟踪的消息列表现在应该包含一条消息。
但是，此测试存在一个问题，如下所示
$ cargo test
Compiling limit-tracker v0.1.0 (file:///projects/limit-tracker)
error[E0596]: cannot borrow `self.sent_messages` as mutable, as it is behind a `&` reference
--> src/lib.rs:58:13
|
58 | self.sent_messages.push(String::from(message));
| ^^^^^^^^^^^^^^^^^^ `self` is a `&` reference, so the data it refers to cannot be borrowed as mutable
|
help: consider changing this to be a mutable reference
|
2 | fn send(&mut self, msg: &str);
| ~~~~~~~~~
For more information about this error, try `rustc --explain E0596`.
error: could not compile `limit-tracker` (lib test) due to 1 previous error
我们无法修改 MockMessenger 来跟踪消息，因为 send 方法接收对 self 的不可变引用。我们也不能采用错误文本中的建议使用 &mut self 来代替，因为那样 send 的签名将与 Messenger 特征定义中的签名不匹配（您可以尝试一下，看看会得到什么错误消息）。
在这种情况下，内部可变性可以提供帮助！我们将把 sent_messages 存储在 RefCell<T> 中，然后 send 方法将能够修改 sent_messages 来存储我们看到的消息。清单 15-22 显示了它的样子
文件名：src/lib.rs
pub trait Messenger {
fn send(&self, msg: &str);
}
pub struct LimitTracker<'a, T: Messenger> {
messenger: &'a T,
value: usize,
max: usize,
}
impl<'a, T> LimitTracker<'a, T>
where
T: Messenger,
{
pub fn new(messenger: &'a T, max: usize) -> LimitTracker<'a, T> {
LimitTracker {
messenger,
value: 0,
max,
}
}
pub fn set_value(&mut self, value: usize) {
self.value = value;
let percentage_of_max = self.value as f64 / self.max as f64;
if percentage_of_max >= 1.0 {
self.messenger.send("Error: You are over your quota!");
} else if percentage_of_max >= 0.9 {
self.messenger
.send("Urgent warning: You've used up over 90% of your quota!");
} else if percentage_of_max >= 0.75 {
self.messenger
.send("Warning: You've used up over 75% of your quota!");
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::cell::RefCell;
struct MockMessenger {
sent_messages: RefCell<Vec<String>>,
}
impl MockMessenger {
fn new() -> MockMessenger {
MockMessenger {
sent_messages: RefCell::new(vec![]),
}
}
}
impl Messenger for MockMessenger {
fn send(&self, message: &str) {
self.sent_messages.borrow_mut().push(String::from(message));
}
}
#[test]
fn it_sends_an_over_75_percent_warning_message() {
// --snip--
let mock_messenger = MockMessenger::new();
let mut limit_tracker = LimitTracker::new(&mock_messenger, 100);
limit_tracker.set_value(80);
assert_eq!(mock_messenger.sent_messages.borrow().len(), 1);
}
}清单 15-22：使用 RefCell<T> 在外部值被视为不可变的情况下改变内部值
sent_messages 字段现在是 RefCell<Vec<String>> 类型，而不是 Vec<String>。在 new 函数中，我们围绕空向量创建一个新的 RefCell<Vec<String>> 实例。
对于 send 方法的实现，第一个参数仍然是对 self 的不可变借用，这与特征定义相匹配。我们在 self.sent_messages 中的 RefCell<Vec<String>> 上调用 borrow_mut 来获取对 RefCell<Vec<String>> 内部值的 mutable 引用，该值是向量。然后，我们可以在对向量的 mutable 引用上调用 push，以跟踪测试期间发送的消息。
我们必须进行的最后一个更改是在断言中：要查看内部向量中有多少项，我们在 RefCell<Vec<String>> 上调用 borrow 来获取对向量的不可变引用。
现在您已经了解了如何使用 RefCell<T>，让我们深入了解它是如何工作的！
使用 RefCell<T> 在运行时跟踪借用
在创建不可变和可变引用时，我们分别使用 & 和 &mut 语法。对于 RefCell<T>，我们使用 borrow 和 borrow_mut 方法，它们是属于 RefCell<T> 的安全 API 的一部分。borrow 方法返回智能指针类型 Ref<T>，而 borrow_mut 返回智能指针类型 RefMut<T>。这两种类型都实现了 Deref，因此我们可以像对待常规引用一样对待它们。
RefCell<T> 会跟踪当前有多少个 Ref<T> 和 RefMut<T> 智能指针处于活动状态。每次我们调用 borrow 时，RefCell<T> 都会增加其活动不可变借用计数。当 Ref<T> 值超出范围时，不可变借用计数将减少 1。就像编译时借用规则一样，RefCell<T> 允许我们在任何时间点拥有多个不可变借用或一个可变借用。
如果我们试图违反这些规则，与使用引用时会收到编译错误不同，RefCell<T> 的实现将在运行时发生 panic。清单 15-23 显示了对清单 15-22 中 send 实现的修改。我们故意尝试为同一个作用域创建两个活动的 mutable 借用，以说明 RefCell<T> 在运行时阻止我们这样做。
文件名：src/lib.rs
pub trait Messenger {
fn send(&self, msg: &str);
}
pub struct LimitTracker<'a, T: Messenger> {
messenger: &'a T,
value: usize,
max: usize,
}
impl<'a, T> LimitTracker<'a, T>
where
T: Messenger,
{
pub fn new(messenger: &'a T, max: usize) -> LimitTracker<'a, T> {
LimitTracker {
messenger,
value: 0,
max,
}
}
pub fn set_value(&mut self, value: usize) {
self.value = value;
let percentage_of_max = self.value as f64 / self.max as f64;
if percentage_of_max >= 1.0 {
self.messenger.send("Error: You are over your quota!");
} else if percentage_of_max >= 0.9 {
self.messenger
.send("Urgent warning: You've used up over 90% of your quota!");
} else if percentage_of_max >= 0.75 {
self.messenger
.send("Warning: You've used up over 75% of your quota!");
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::cell::RefCell;
struct MockMessenger {
sent_messages: RefCell<Vec<String>>,
}
impl MockMessenger {
fn new() -> MockMessenger {
MockMessenger {
sent_messages: RefCell::new(vec![]),
}
}
}
impl Messenger for MockMessenger {
fn send(&self, message: &str) {
let mut one_borrow = self.sent_messages.borrow_mut();
let mut two_borrow = self.sent_messages.borrow_mut();
one_borrow.push(String::from(message));
two_borrow.push(String::from(message));
}
}
#[test]
fn it_sends_an_over_75_percent_warning_message() {
let mock_messenger = MockMessenger::new();
let mut limit_tracker = LimitTracker::new(&mock_messenger, 100);
limit_tracker.set_value(80);
assert_eq!(mock_messenger.sent_messages.borrow().len(), 1);
}
}清单 15-23：在同一个作用域中创建两个 mutable 引用，以查看 RefCell<T> 会发生 panic
我们为从 borrow_mut 返回的 RefMut<T> 智能指针创建一个变量 one_borrow。然后，我们以相同的方式在变量 two_borrow 中创建另一个 mutable 借用。这会在同一个作用域中创建两个 mutable 引用，这是不允许的。当我们为库运行测试时，清单 15-23 中的代码将编译而不会出现任何错误，但测试将失败
$ cargo test
Compiling limit-tracker v0.1.0 (file:///projects/limit-tracker)
Finished test [unoptimized + debuginfo] target(s) in 0.91s
Running unittests src/lib.rs (target/debug/deps/limit_tracker-e599811fa246dbde)
running 1 test
test tests::it_sends_an_over_75_percent_warning_message ... FAILED
failures:
---- tests::it_sends_an_over_75_percent_warning_message stdout ----
thread 'tests::it_sends_an_over_75_percent_warning_message' panicked at src/lib.rs:60:53:
already borrowed: BorrowMutError
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
failures:
tests::it_sends_an_over_75_percent_warning_message
test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
error: test failed, to rerun pass `--lib`
请注意，代码会因为消息 already borrowed: BorrowMutError 而发生 panic。这就是 RefCell<T> 在运行时处理违反借用规则的方式。
选择在运行时而不是编译时捕获借用错误，就像我们在这里所做的那样，意味着您可能会在开发过程的后期才发现代码中的错误：可能要到您的代码部署到生产环境中才会发现。此外，由于在运行时而不是编译时跟踪借用，您的代码会招致少量的运行时性能损失。但是，使用 RefCell<T> 可以创建一个模拟对象，该对象可以修改自身以跟踪它在仅允许使用不可变值的上下文中看到的消息。您可以使用 RefCell<T> 来获得比常规引用提供的更多功能，尽管它存在一些缺点。
通过组合 Rc<T> 和 RefCell<T> 来拥有多个可变数据的所有者
使用 RefCell<T> 的一种常见方式是与 Rc<T> 结合使用。回想一下，Rc<T> 允许您拥有某些数据的多个所有者，但它只提供对该数据的不可变访问权限。如果您有一个持有 RefCell<T> 的 Rc<T>，那么您可以获得一个可以拥有多个所有者*并且*可以改变的值！
例如，回想一下清单 15-18 中的 cons 列表示例，其中我们使用 Rc<T> 来允许多个列表共享另一个列表的所有权。因为 Rc<T> 只持有不可变值，所以一旦创建了列表中的值，我们就无法更改它们。让我们添加 RefCell<T> 来获得更改列表中值的能力。清单 15-24 显示，通过在 Cons 定义中使用 RefCell<T>，我们可以修改存储在所有列表中的值
文件名：src/main.rs
#[derive(Debug)] enum List { Cons(Rc<RefCell<i32>>, Rc<List>), Nil, } use crate::List::{Cons, Nil}; use std::cell::RefCell; use std::rc::Rc; fn main() { let value = Rc::new(RefCell::new(5)); let a = Rc::new(Cons(Rc::clone(&value), Rc::new(Nil))); let b = Cons(Rc::new(RefCell::new(3)), Rc::clone(&a)); let c = Cons(Rc::new(RefCell::new(4)), Rc::clone(&a)); *value.borrow_mut() += 10; println!("a after = {a:?}"); println!("b after = {b:?}"); println!("c after = {c:?}"); }
清单 15-24：使用 Rc<RefCell<i32>> 创建一个我们可以改变的 List
我们创建一个 Rc<RefCell<i32>> 实例的值，并将其存储在名为 value 的变量中，以便稍后可以直接访问它。然后，我们在 a 中创建一个 List，其中包含一个持有 value 的 Cons 变体。我们需要克隆 value，以便 a 和 value 都拥有内部 5 值的所有权，而不是将所有权从 value 转移到 a 或让 a 从 value 借用。
我们将列表 a 包装在 Rc<T> 中，以便当我们创建列表 b 和 c 时，它们都可以引用 a，就像我们在清单 15-18 中所做的那样。
在我们创建了列表 a、b 和 c 之后，我们想给 value 中的值加上 10。我们通过调用 value 上的 borrow_mut 来实现这一点，它使用了我们在第 5 章中讨论的自动解引用功能（参见“-> 运算符在哪里？”一节 “Where’s the -> Operator?”）将 Rc<T> 解引用为内部的 RefCell<T> 值。 borrow_mut 方法返回一个 RefMut<T> 智能指针，我们对其使用解引用运算符并更改内部值。
当我们打印 a、b 和 c 时，我们可以看到它们都具有修改后的值 15，而不是 5。
$ cargo run
Compiling cons-list v0.1.0 (file:///projects/cons-list)
Finished dev [unoptimized + debuginfo] target(s) in 0.63s
Running `target/debug/cons-list`
a after = Cons(RefCell { value: 15 }, Nil)
b after = Cons(RefCell { value: 3 }, Cons(RefCell { value: 15 }, Nil))
c after = Cons(RefCell { value: 4 }, Cons(RefCell { value: 15 }, Nil))
这种技术非常巧妙！通过使用 RefCell<T>，我们拥有一个外部不可变的 List 值。但是我们可以使用 RefCell<T> 上的方法来访问其内部可变性，以便在需要时修改数据。借用规则的运行时检查可以保护我们免受数据竞争的影响，并且有时为了数据结构的灵活性而牺牲一点速度是值得的。请注意，RefCell<T> 不适用于多线程代码！ Mutex<T> 是 RefCell<T> 的线程安全版本，我们将在第 16 章中讨论 Mutex<T>。