rust-lang-zh_CN/src/Ch15_Smart_Pointers.md
2023-05-13 08:35:49 +08:00

85 KiB
Raw Blame History

灵巧指针

Smart Pointers

所谓 指针pointer,是个一般的概念,指的是包含了内存中某个地址的变量。该地址引用,或者说 “指向” 另一数据。Rust 中最常见的指针类别,便是咱们在第 4 章中曾了解过的引用。引用由 & 符号表示,并借用他们指向的值。除了引用数据之外,他们没有任何特殊功能,并且没有开销。

另一方面,灵巧指针smart pointer 是一种数据结构,其作用类似于指针,但还具有额外的元数据与能力。灵巧指针这个概念,并非 Rust 所独有的:灵巧指针起源于 C++且在其他语言中也存在。Rust 在标准库中定义了各种智能指针,他们提供了超越引用所提供的功能。为了探讨一般概念,我们将看几个不同的智能指针示例,包括 引用计数reference counting 智能指针类型。引用计数这种指针,通过追踪数据所有者的数目,实现了允许数据有着多个所有者,在没有所有者剩下时,就清除该数据。

在所有权和借用的概念下Rust 在引用和智能指针之间还有一个区别:引用只借用数据,而在很多情况下,灵巧指针则 拥有own 他们所指向的数据。

虽然当时咱们没有这样称呼他们,但在本书中我们已经遇到了一些智能指针,包括第 8 章中的 StringVec<T>。这两种类型都算作灵巧指针,因为他们拥有一些内存,并允许咱们对其进行操作。他们也有元数据和额外的能力或保证。例如,String 将其容量存储为元数据,并有额外的能力来确保其数据将始终是有效的 UTF-8。

灵巧指针通常是使用结构体来实现的。与寻常结构体不同,灵巧指针实现了 DerefDrop 特质。Deref 特质允许灵巧指针结构体实例像引用那样行事,如此咱们便可编写出处理引用或灵巧指针的代码。而 Drop 特质则允许咱们定制在灵巧指针超出作用域时要运行的代码。本章中,咱们将讨论这两种特质,并演示他们为何对灵巧指针很重要。

鉴于灵巧指针模式是 Rust 中频繁用到的一种通用设计模式,本章不会涵盖每个既有灵巧指针。许多库都有自己的灵巧指针,咱们甚至也可以编写自己的灵巧指针。咱们将介绍标准库中最常见的灵巧指针:

  • 用于在内存堆上分配值的 Box<T>
  • Rc<T>,一个引用计数类型,可以实现多重所有权,Rc<T>, a reference counting type that enables multiple ownership
  • Ref<T>RefMut<T>,通过 RefCell<T> 访问,该类型在运行时而不是编译时执行借用规则检查,Ref<T> and RefMut<T>, accessed through RefCell<T>, a type that enforces the borrowing rules at runtime instead of compile time。

此外,咱们还将讨论 内部可变性interior mutability 模式,在这种模式下,不可变的类型会暴露出一个用于改变内部值的 API。我们还将讨论引用循环他们如何泄漏内存以及如何防止他们。

下面就来切入正题吧!

使用 Box<T> 指向内存堆上的数据

最直接了当的灵巧指针,便是 匣子box ,其类型写为 Box<T>。匣子允许咱们将数据存储在堆上,而非在栈上。留在栈上的指向堆数据的指针。请参考第 4 章,回顾一下栈与堆的区别。

除了在内存堆而不是栈上存储数据外,匣子数据结构并无性能方面的开销。但他们也没有很多额外能力。在下面这些情况下,咱们将经常用到他们:

  • 当咱们有个在编译时无法知道其大小的类型并且咱们想在需要精确大小的上下文中使用该类型的值时when you have a type whose size can't be known at compile time and you want to use a value of that type in a context that requires an exact size;
  • 当咱们有着大量数据而想转移所有权但要确保转移时数据不会被拷贝时when you have a large amount of data and you want to transfer ownership but ensure the data won't be copied when you do so
  • 当咱们想拥有某个值却只关心他是个实现了特定特质的类型而非某个特定类型时when you want to own a value and you care only that it's a type that implements a particular trait rather than being of a specific type。

我们将在 “用匣子数据结构得到递归类型” 小节演示第一种情况。在第二种情形下,转移大量数据的所有权可能需要很长的时间,因为数据在堆栈上被拷过来拷过去。为改进这种情况下的性能,咱们可以将内存堆上的大量数据,存储在一个匣子中。尔后,在栈上便只有少量的指针数据被拷来拷去了,同时其所引用的数据,则会保持在堆上的一处。第三种情况被称为 特质对象trait object,第 17 章用了一整节,“使用允许不同类型值的特质对象”,来讨论这个话题。因此,咱们在这里学到的东西,将在第 17 章中再度得到应用!

使用 Box<T> 在内存堆上存储数据

在咱们讨论 Box<T> 的内存堆存储用例之前,咱们将介绍其语法与怎样与存储在 Box<T> 中的值交互。

下面清单 15-1 展示了如何使用匣子,在内存堆上存储一个 i32 的值:

文件名:src/main.rs

fn main() {
    let b = Box::new(5);
    println! ("b = {}", b);
}

清单 15-1使用匣子在内存堆上存储一个 i32

我们将变量 b 定义为具有指向值 5Box 的值,该值分配在堆上。此程序将打印出 b = 5;在这种情况下,咱们可以像访问栈上的数据一样,访问匣子中的数据。就像任何拥有的值一样,当某个匣子超出作用域时,如同 bmain 结尾处那样,他将被解除内存分配。解除内存分配,同时发生在匣子(存储在栈上)和他指向的数据(存储在内存堆上)。

用匣子数据结构得到递归类型

Enabling Recursive Types with Boxes

递归类型recursive type 的值可以有另一个相同类型的值作为其自身的一部分。递归类型带来了一个问题,因为在编译时 Rust 需要知道一个类型占用了多少空间。然而,理论上递归类型的值的嵌套可以无限地继续下去,所以 Rust 无法知道值需要多少空间。因为盒子有一个已知的大小,我们可以通过在递归类型定义中插入一个盒子来得到递归类型。

作为一个递归类型的示例,咱们来探讨一下 构造列表cons listthe cons tructs list)。这是函数式编程语言中常见的一种数据类型。除了其中的递归之外,咱们将定义的构造列表类型是简单明了的;因此,当咱们遇到涉及递归类型的更复杂情况时,我们将使用的例子中的概念会很有用。

构造列表的更多信息

所谓 构造列表cons list,是来自 Lisp 编程语言及其方言的一种数据结构,由嵌套对组成,是 Lisp 版本的链表is made up of nested pairs, and is the Lisp version of a linked list。其名称来自于 Lisp 的 cons 函数是构造函数construct function的简称该函数从其两个参数构造出一个新嵌套对。通过对由一个值与另一嵌套对组成的嵌套对上调用 cons,咱们便可构造出由递归嵌套对组成的构造链表。

例如,下面是一个包含列表 1、2、3 的构造列表的伪代码表示,每个嵌套对都在括号里:

(1, (2, (3, Nil)))

构造列表中的每个条目都包含了两个元素:当前条目的值与下一条目。列表中最后条目,只包含名为 Nil 的值,而没有下一条目。构造列表是由递归调用 cons 函数产生的。表示递归基础的规范名称是 Nilthe canonical name to denote the base case of the recursion is Nil。请注意,这与第 6 章中的 “null” 或 “nil” 概念不同,后者是一个无效或不存在的值。

在 Rust 中,构造列表并不是一种常用的数据结构。大多数时候,当咱们在 Rust 中有一个条目清单时,Vec<T> 是一个更好的选择。那么别的时候的各种情况下,更复杂的递归数据类型,则都是 有用的,而在本章中以构造列表开始,咱们便可专心探讨匣子数据结构如何让我们定义出递归数据类型。

下面清单 15-2 包含了构造列表的一种枚举定义。请注意,这段代码还不能编译,因为 List 类型没有一个已知的大小,我们将证明这一点。

文件名:src/main.rs

enum List {
    Cons(i32, List),
    Nil,
}

清单 15-2第一次尝试定义一个枚举来表示 i32 值的构造列表数据结构

注意:出于这个示例的目的,咱们正在实现一个仅包含 i32 值的构造列表。咱们本可以使用泛型来实现他,就像咱们在第 10 章中讨论的那样,定义出一个可存储任何类型值的构造列表。

使用 List 类型来存储列表 1, 2, 3,看起来就会像下面清单 15-3 中的代码:

文件名:src/main.rs

use crate::List::{Cons, Nil};

fn main() {
    let list = Cons(1, Cons(2, Cons(3, Nil)));
}

清单 15-3使用 List 枚举来存储列表 1, 2, 3

其中第一个 Cons 保存着 1 与另一 List 值。这个 List 值是另一个 Cons 值,保存了 2 与另一 List。这个 List 值则是又一个 Cons 值,其保存了 3 与一个为 Nil 的最后 List 值,这个非递归变种表示列表的结束。

如果我们尝试编译清单 15-3 中的代码,我们会得到下面清单 15-4 中的报错:

$ cargo run
   Compiling sp_demos v0.1.0 (/home/lennyp/rust-lang/sp_demos)
error[E0072]: recursive type `List` has infinite size
 --> src/main.rs:1:1
  |
1 | enum List {
  | ^^^^^^^^^ recursive type has infinite size
2 |     Cons(i32, List),
  |               ---- recursive without indirection
  |
help: insert some indirection (e.g., a `Box`, `Rc`, or `&`) to make `List` representable
  |
2 |     Cons(i32, Box<List>),
  |               ++++    +

For more information about this error, try `rustc --explain E0072`.
error: could not compile `sp_demos` due to previous error

清单 15-4在尝试定义递归枚举时咱们得到的报错

报错显示此类型“具有无限大小has infinite size”。原因是咱们一个递归的变种定义了 List其直接持有自己的的另一个值。因此Rust 无法计算出他需要多少空间来存储一个 List 值。咱们来分析一下为什么咱们会得到这个报错。首先,咱们来看看 Rust 如何确定出他需要多少内存空间来存储某个非递归类型的值。

计算非递归类型的大小

回顾咱们在第 6 章讨论枚举定义时,在清单 6-2 中定义的 Message 枚举:

enum Message {
    Quit,
    Move { x: i32, y: i32 },
    Write(String),
    ChangeColor(i32, i32, i32),
}

为了确定出给一个 Message 值分配多少内存空间Rust 会检查每个变种找出哪个变种需要最多的空间。Rust 发现 Message::Quit 不需要任何空间,Message::Move 需要存储两个 i32 值的足够空间,以此类推。由于只会用到一个变种,因此某个 Message 值所需的最大内存空间,便是其存储最大变种的空间。

将此与 Rust 尝试确定递归类型(如清单 15-2 中的 List 枚举)需要多少空间时发生的情况进行对比。编译器从查看 Cons 变种开始,其持有一个 i32 类型的值和一个 List 类型的值。因此,Cons 需要的空间量等于 i32 的大小加上 List 的大小。为了计算出 List 类型需要多少内存,编译器会从 Cons 变体开始查看变种。 Cons 变种保存了一个 i32 类型的值和一个 List 类型的值,这个过程会无限继续下去,如图 15-1 所示。

由无限的 Cons 变种组成的一个无限 List

图 15-01由无限的 Cons 变种组成的一个无限 List

使用 Box<T> 获得已知大小的递归类型

因为 Rust 无法计算出要为以递归方式定义出的类型分配多少空间,所以编译器会给出带有下面这个有用的建议的报错:

help: insert some indirection (e.g., a `Box`, `Rc`, or `&`) to make `List` representable
  |
2 |     Cons(i32, Box<List>),
  |               ++++    +

在此建议中“间接indirection” 意味着我们不应直接存储一个值,而应该改变数据结构,通过存储一个指向该值的指针,间接存储该值。

由于 Box<T> 是个指针Rust 总是知道 Box<T> 需要多少内存空间:指针的大小不会根据他指向的数据量而变化。这意味着咱们可以在 Cons 变种里放入一个 Box<T>,而不是直接放入另一个 List 值。Box<T> 将指向下一个 List 值,他将在内存堆上而不是在 Cons 变种内。从概念上讲,咱们仍然有一个列表,用持有其他列表的列表来创建,但现在这种实现更像是把列表项目放在彼此的旁边,而不是放在彼此的里面。

咱们可以把清单 15-2 中 List 枚举的定义和清单 15-3 中 List 的用法,改为下面清单 15-5 中的代码,这样就可以编译了:

文件名:src/main.rs

#[derive(Debug)]
enum List {
    Cons(i32, Box<List>),
    Nil,
}

use crate::List::{Cons, Nil};

fn main() {
    let list = Cons(1, Box::new(Cons(2, Box::new(Cons(3, Box::new(Nil))))));

    println! ("list: {:?}", list);
}

清单 15-5使用 Box<T>List 的定义,以便有已知的大小

Cons 变种需要一个 i32 的大小,加上存储匣子指针数据的内存空间。Nil 变种不存储存储任何值,所以他需要的空间比 Cons 变种少。咱们现在知道,任何 List 值都会占用一个 i32 的大小,加上一个匣子的指针数据的大小。通过使用匣子,咱们已经破解了无限的递归链,因此编译器可以计算出存储 List 值所需的内存大小。下图 15-2 显示了 Cons 变种现在的样子:

由于 Cons 保存了一个 Box 而不在是无限大小的 List

图 15-02不在是无限大小的 List,因为 Cons 持有着一个 Box

匣子仅提供这种间接与内存堆的内存分配;他们不具备任何像咱们在其他灵巧指针类型中,将看到的其他特别能力。他们也没有这些特殊能力所带来的性能开销,所以在像构造列表这样的情况下,他们就能很有用,因为间接性是我们唯一需要的功能。在第 17 章,咱们还会看一下匣子的更多用例。

Box<T> 类型是一个智能指针,因为他实现了 Deref 特质,他允许 Box<T> 值被当作引用。当 Box<T> 值超出作用域时,由于 Drop 特质的实现,匣子所指向的内存堆数据也会被清理。这两个特质对于咱们在本章后面将讨论的其他灵巧指针所提供的功能,将更加重要。咱们来更深入地探讨这两个特质。

使用 Deref 特质将智能指针视为常规引用

Treating Smart Pointers Like Regular References with Deref Trait

实现 Deref 特质允许咱们自定义 解引用操作符, the dereference operator'*' (不要与乘法或 glob 运算符相混淆)的行为。通过实现 Deref,智能指针可以被当作普通的引用来对待,咱们便可编写对引用进行操作的代码,并将该代码也用于智能指针。

咱们首先来看看解除引用操作符是如何在常规引用中工作的。然后咱们将尝试定义一个行为类似于 Box<T> 的自定义类型,并看看为什么解除引用操作符在咱们新定义的类型上不像引用那样工作。咱们将探讨实现 Deref 特性如何使智能指针的工作方式与引用相似。然后咱们将看看 Rust 的 解引用强制转换deref coercion 特性,以及其如何让咱们使用引用或智能指针工作的。

注意:咱们将要建立的 MyBox<T> 类型和真正的 Box<T> 之间有一个很大的区别:咱们的版本不会将其数据存储在堆中。咱们把这个例子的重点放在 Deref 上,所以数据实际存储在哪里并不重要,重要的是类似指针的行为。

顺着指针找到值

Following the Pointer to the Value

常规引用是一种指针,而看待指针的一种方式,便是指向存储于别处值的一个箭头。在下面清单 15-6 种,咱们创建了一个对 i32 值的引用,然后使用解引用操作符,来跟随对该值的引用:

文件名:src/main.rs

fn main() {
    let x = 5;
    let y = &x;

    assert_eq! (5, x);
    assert_eq! (5, *y);
}

清单 15-6使用解引用操作符来跟随一个 i32 值的引用

变量 x 保存着一个 i325。咱们将 y 设置为等于到 x 的引用。咱们可以断言 x 等于 5。然而,如果咱们想对 y 中的值进行断言,咱们必须使用 *y 来跟随其所指向的值的音乐(因此是 解引用dereference),这样编译器才能比较具体值。一旦咱们解引用了 y,咱们就可以访问咱们可将其与 5 比较的 y 指向的整数值。

相反,如果咱们尝试编写 assert_eq! (5, y);,咱们便会得到下面这样的编译报错:

$ cargo run                                                      ✔  
   Compiling sp_demos v0.1.0 (/home/peng/rust-lang/sp_demos)
error[E0277]: can't compare `{integer}` with `&{integer}`
 --> src/main.rs:6:5
  |
6 |     assert_eq! (5, y);
  |     ^^^^^^^^^^^^^^^^^ no implementation for `{integer} == &{integer}`
  |
  = help: the trait `PartialEq<&{integer}>` is not implemented for `{integer}`
  = help: the following other types implement trait `PartialEq<Rhs>`:
            f32
            f64
            i128
            i16
            i32
            i64
            i8
            isize
          and 6 others
  = note: this error originates in the macro `assert_eq` (in Nightly builds, run with -Z macro-backtrace for more info)

For more information about this error, try `rustc --explain E0277`.
error: could not compile `sp_demos` due to previous error

比较数字与对数字的引用是不允许的,因为他们属于不同的类型。咱们必须使用解引用操作符来跟随引用到他所指向的值。

像引用一样使用 Box<T>

Using Box<T> Like a Reference

咱们可将清单 15-6 中的代码,重写为使用 Box<T> 而不是引用;下面清单 15-7 中 Box<T> 上使用的解引用操作符,与清单 15-6 中引用上使用的解引用操作符功能相同:

文件名:src/main.rs

fn main() {
    let x = 5;
    let y = Box::new(x);

    assert_eq! (5, x);
    assert_eq! (5, *y);
}

清单 15-7Box<i32> 上使用解引用操作符

清单 15-7 和清单 15-6 之间的主要区别在于,这里我们将 y 设置为指向 x 的拷贝值的 Box<T> 实例,而不是指向 x 值的引用。在最后的断言中,我们可以使用解除引用操作符来跟随 Box<T> 的指针,就像我们在 y 是一个引用时一样。接下来,我们将探讨 Box<T> 有什么特别之处,使我们能够通过定义我们自己的类型来使用解引用操作符。

定义咱们自己的灵巧指针

咱们来建立一个类似于标准库提供的 Box<T> 类型的灵巧指针,以体验灵巧指针的行为与默认的引用有什么不同。然后咱们将看看如何增加使用解除引用操作符的能力。

Box<T> 最终被定义为了具有一个元素的元组结构体a tuple struct因此清单 15-8 以同样方式,定义了一个 MyBox<T> 类型。咱们还将定义一个 new 函数,来匹配在 Box<T> 上定义的 new 函数。

文件名:src/main.rs

struct MyBox<T>(T);

impl<T> MyBox<T> {
    fn new(x: T) -> MyBox<T> {
        MyBox(x)
    }
}

清单 15-8定义 MyBox<T> 类型

我们定义了一个名为 MyBox 的结构,并声明了一个通用参数 T,因为我们希望我们的类型可以容纳任何类型的值。MyBox 类型是一个元组结构,其中一个元素为 T 类型。MyBox::new 函数接收一个 T 类型的参数,并返回一个 MyBox 实例,该实例保存着传入的值。

我们来试着将清单 15-7 中的 main 函数添加到清单 15-8 中,并将其改为使用我们定义的 MyBox<T> 类型而不是 Box<T>。清单 15-9 中的代码不会被编译,因为 Rust 不知道如何解除对 MyBox 的引用。

文件名:src/main.rs

fn main() {
    let x = 5;
    let y = MyBox::new(x);

    assert_eq! (5, x);
    assert_eq! (5, *y);
}

清单 15-9试图以咱们使用引用和 Box<T> 的方式使用 MyBox<T>

下面就是产生的编译报错:

$ cargo run
   Compiling sp_demos v0.1.0 (/home/peng/rust-lang/sp_demos)
error[E0614]: type `MyBox<{integer}>` cannot be dereferenced
  --> src/main.rs:14:20
   |
14 |     assert_eq! (5, *y);
   |                    ^^

For more information about this error, try `rustc --explain E0614`.
error: could not compile `sp_demos` due to previous error

由于咱们未曾在这个 MyBox<T> 类型上实现过其被解引用的能力,因此他无法被解引用。为实现使用 * 运算符的解引用,就要实现 Deref 特质。

通过实现 Deref 特质将类型视为引用

Treating a Type Like a Reference by Implementing the Deref Trait

正如第 10 章 "在类型上实现特质" 小节中所讨论的,要实现某个特质,咱们需要为该特质的必要方法提供实现。由标准库提供的 Deref 特质,要求咱们实现一个名为 deref 的方法,该方法借用 self 并返回对内部数据的引用。下面清单 15-10 包含 Deref 的一个实现,来添加到 MyBox 的定义中:

文件名:src/main.rs

use std::ops::Deref;

struct MyBox<T>(T);

impl<T> MyBox<T> {
    fn new(x: T) -> MyBox<T> {
        MyBox(x)
    }
}

impl<T> Deref for MyBox<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

清单 15-10MyBox<T> 上实现 Deref

type Target = T; 语法定义了一个关联类型an associated typeDeref 特质使用。关联类型是声明泛型参数的一种些许不同的方式,但现在咱们无需担心他们;咱们将在第 19 章中更详细地介绍他们。

我们在 deref 方法的主体中填入 &self.0,这样 deref 就会返回一个我们想用 * 操作符访问的值的引用;回顾一下第五章 “使用没有命名字段的元组结构体来创建不同的类型” 小节,.0 可以访问一个元组结构体中的第一个值。清单 15-9 中调用 MyBox<T> 值的 main 函数现在可以编译了,而且断言也通过了!

如果没有 Deref 特质,编译器只能对 & 引用进行解引用。deref 方法给了编译器这样的能力:取一个实现 Deref 的任何类型的值,并调用 deref 方法来获得一个他知道如何解除引用的 & 引用。

当我们在清单 15-9 中输入 *y 时,在幕后 Rust 实际上运行了下面这段代码:

*(y.deref())

Rust 将 * 运算符替换为对 deref 方法的调用,然后是普通的解引用,这样咱们就不必考虑是否需要调用 deref 方法。这个 Rust 特性让我们可以编写功能相同的代码,无论我们有一个常规引用还是一个实现了 Deref 的类型。

deref 方法返回一个值的引用,以及 *(y.deref()) 中括号外的普通解引用仍然是必要的,其原因与所有权系统有关。如果 deref 方法直接返回值,而不是返回值的引用,值就会被移出 self。在这种情况下,或者在大多数使用解引用操作符的情况下,我们不希望取得 MyBox<T> 内部的值的所有权。

请注意,每次我们在代码中使用 * 时, * 运算符被替换为对 deref 方法的调用,然后仅调用一次 * 运算符。因为 * 运算符的替换不会无限递归,所以我们最终得到类型为 i32 的数据,他与清单 15-9 中 assert_eq! 中的 5 匹配。

函数与方法下的隐式解引用强制转换

Implicit Deref Coercions with Functions and Methods

解引用强制转换deref coercion 将对实现了 Deref 特质的某种类型的引用,转换为对另一类型的引用。例如,解引用强制转换可以将 &String 转换为 &str,因为 String 实现了 Deref,所以他会返回 &str。解引用强制转换是 Rust 对函数和方法的参数执行的一种便利,只对实现 Deref 特质的类型起作用。当我们把对某一特定类型的值的引用作为参数传递给函数或方法时,它就会自动发生,而该参数与函数或方法定义中的参数类型并不匹配。一系列对 Deref 方法的调用将我们提供的类型转换为参数需要的类型。

注:在面向对象编程语言 Java 中,类似的特性叫 "自动装箱"

解引用强制转换被添加到 Rust 中,这样编写函数和方法调用的程序员就不需要用 &* 添加那么多显式引用和解引用。解引用强制转换特性,也让咱们写出更多既可以用于引用,也可以用于灵巧指针的代码。

为了看到解引用强制转换的作用,下面咱们来使用清单 15-8 中定义的 MyBox<T> 类型,以及清单 15-10 中添加的 Deref 的实现。清单 15-11 给出了一个有字符串切片参数的函数定义:

文件名:src/main.rs

fn hello(name: &str) {
    println! ("你好,{name}");
}

清单 15-11参数 name&str 类型的 hello 函数

我们可以用一个字符串切片作为参数来调用 hello 函数,例如 hello("Rust");。解引用强制转换使我们可以用对 MyBox<String> 类型值的引用来调用 hello,如清单 15-12 所示:

文件名:src/main.rs

fn main() {
    hello("Rust");

    let m = MyBox::new(String::from("Rust"));
    hello(&m);
}

清单 15-12使用对 MyBox<String> 值的引用调用 hello,由于解引用强制转换,其可以工作

这里我们用参数 &m 调用 hello 函数,他是对 MyBox<String> 值的一个引用。因为我们在清单 15-10 中对 MyBox<T> 实现了 Deref 特性Rust 可以通过调用 deref&MyBox<String> 变成 &String。标准库提供了一个 String 上的 Deref 的实现,其返回一个字符串片,这在 DerefAPI 文档中。Rust 再次调用 deref,将 &String 变成 &str,这与 hello 函数的定义相符。

如果 Rust 没有实现解引用强制转换,为了用一个 &MyBox<String> 类型的值调用 hello,我们就必须写清单 15-13 中的代码,而不是清单 15-12 中的代码。

文件名:src/main.rs

fn main() {
    let m = MyBox::new(String::from("Rust"));
    hello(&(*m)[..]);
}

清单 15-13如果 Rust 没有解引用强制转换,我们将不得不编写的代码

(*m)MyBox<String> 解引用为 String。然后 &[..] 获取 String 等于整个字符串的一个字符串切片,以匹配 hello 的签名。由于涉及所有这些符号,这段没有解引用强制转换的代码更难阅读、编写和理解。 解引用强制转换允许 Rust 自动为我们处理这些转换。

在所涉及的类型定义了 Deref 特质时Rust 将分析这些类型,并根据需要多次使用 Deref::deref,来获得与参数类型匹配的引用。所需插入 Deref::deref 次数,是在编译时就已确定,所以利用解引用强制转换的优势,没有运行时的代价!

解引用强制转换与可变性的互动方式

How Deref Coercion Interacts with Mutability

与使用 Deref 特质重写不可变引用上的 * 运算符类似,咱们可以使用 DerefMut 特质,重写可变引用上的 * 运算符。

在以下三种情形下找到类型与特质实现时Rust 会执行解引用强制转换:

  • T: Deref<Target=U> 时,会从 &T 转换为 &U;
  • T: DerefMut<Target=U> 时,会从 &mut T 转换为 &mut U;
  • T: Deref<Target=U> 时,会从 &mut T 转换为 &U

前两种情况彼此相同,只是第二种情况实现了可变性。第一种情况表明,如果咱们有一个 &T,并且 T 实现了对某种类型 UDeref,咱们可以透明地得到一个 &U。第二种情况表明相同的解引用强制转换发生在可变引用上。

第三种情况比较棘手Rust 还会将可变引用强制转换为不可变引用。但反过来是 可行的不可变引用永远不会强制转换为可变引用。由于借用规则如果咱们有一个可变引用则该可变引用必须是对那个数据的唯一引用否则程序将无法编译。将一个可变引用转换为一个不可变引用永远不会违反借用规则。将不可变引用转换为可变引用则要求那个初始不可变引用是对那个数据的唯一不可变引用但借用规则并不能保证这一点。因此Rust 不能假设将不可变引用转换为可变引用是可行的。

使用 Drop 特质运行清理代码

Running Code on Cleanup with Drop Trait

对于灵巧指针模式来讲,第二个重要的特质是 Drop,他允许咱们定制某个值即将超出作用域时发生的事情。咱们可以在任何类型上,为 Drop 特质提供一个实现,实现代码可用于释放文件或网络连接等资源。

咱们之所以在灵巧指针上下文中引入 Drop 特质,是由于 Drop 特质的功能在实现某个灵巧指针时几乎都会用到。比如,当 Box<T> 被弃用时,他将释放该匣子指向的堆上的内存空间。

在某些语言中对于某些类型程序员必须在每次使用完这些类型的实例后调用代码来释放内存或资源。这方面的例子包括文件句柄、套接字或锁file handles, sockets, or locks。如果他们忘记了系统可能会变得过载并崩溃。在 Rust 中,咱们可以指定在值超出范围时运行一段特定的代码,编译器将自动插入这段代码。因此,咱们无需小心地将清理代码,放在程序中某个特定类型的实例完成后的任何地方 -- 咱们仍然不会泄露资源!

咱们通过实现 Drop 特质,来指定当一个值超出作用域时要运行的代码。Drop 特质要求咱们实现一个名为 drop 的方法,他需要一个对 self 的可变引用。为了了解Rust 何时调用 drop,现在咱们就来用 println! 语句实现 drop

下面清单 15-14 给出了仅有着一项定制功能,即在其实例超出作用域时打印出 正在弃用 CustomSmartPointer 的一个 CumstomSmartPointer 结构体,以展示出 Rust 在何时运行这个 drop 函数。

文件名:src/main.rs

struct CustomSmartPointer {
    data: String,
}

impl Drop for CustomSmartPointer {
    fn drop(&mut self) {
        println! ("正在使用数据 `{}` 弃用 CustomSmartPointer", self.data);
    }
}

fn main() {
    let c = CustomSmartPointer {
        data: String::from("c - 我的事情"),
    };
    let d = CustomSmartPointer {
        data: String::from("d - 其他事情"),
    };
    println! ("已创建出一些 CustomSmartPointer 实例");
}

清单 15-14一个实现了 Drop 特质的 CustomSmartPointer 结构体,咱们将把咱们的清理代码放在这里

Drop 特质包含在前奏中included in the prelude所以我们不需要把他带入作用域。我们在 CustomSmartPointer 上实现了 Drop 特质,并为 drop 方法提供到一个调用了 println! 的实现。drop 函数的主体是在咱们的类型的实例超出作用域时,打算运行的任何逻辑的地方。咱们在这里打印一些文本来直观地演示 Rust 何时调用 drop

main 中,我们创建了两个 CustomSmartPointer 的实例,然后打印已创建出一些 CumstomSmartPointer 实例。在 main 的结尾,我们的 CustomSmartPointer 实例将超出作用域Rust 将调用我们放在 drop 方法中的代码,打印我们的最终信息。注意,我们不需要显式地调用 drop 方法。

当我们运行这个程序时,我们会看到以下输出:

$ cargo run
   Compiling sp_demos v0.1.0 (/home/lennyp/rust-lang/sp_demos)
    Finished dev [unoptimized + debuginfo] target(s) in 0.50s
     Running `target/debug/sp_demos`
已创建出一些 CustomSmartPointer 实例
正在使用数据 `d - 其他事情` 弃用 CustomSmartPointer
正在使用数据 `c - 我的事情` 弃用 CustomSmartPointer

当我们的实例超出作用域时Rust 自动为我们调用了 drop,从而调用我们指定的代码。变量的弃用顺序与其创建顺序相反,因此 dc 之前被弃用。这个例子的目的是给咱们一个直观了解 drop 方法如何工作的直观指引;通常咱们会指定咱们类型需要运行的清理代码,而不是打印消息。

使用 std::mem::drop 提前弃用值

Drop a Value Early with std::mem::drop

不幸的是,要禁用自动 drop 功能并不简单。通常情况下,禁用 drop 功能是没有必要的;Drop 特质的全部意义在于他是自动处理的。然而在少数情况下,咱们可能想要提前清理一个值。一个例子便是在运用管理锁的灵巧指针时:咱们可能想要强制使用释放锁的 drop 方法这样同一作用域内的其他代码就可以获得锁。Rust 不允许咱们手动调用 Drop 特质的 drop 方法;相反,如果咱们打算强制一个值在其作用域结束前被弃用,咱们必须调用标准库提供的 std::mem::drop 函数。

若我们试图通过修改清单 15-14 中的 main 函数来手动调用 Drop 特质的 drop 方法如清单15-15所示我们会得到一个编译器报错

文件名:src/main.rs

fn main() {
    let c = CustomSmartPointer {
        data: String::from("一些数据"),
    };
    println! ("已创建出一个 CustomSmartPointer 实例。");
    c.drop();
    println! ("在 main 结束之前这个 CustomSmartPointer 已被弃用。")
}

清单 15-15尝试调用 Drop 特质的 drop 方法来提前清理

当我们试图编译这段代码时,我们会得到这样的报错:

$ cargo run
   Compiling sp_demos v0.1.0 (/home/lennyp/rust-lang/sp_demos)
error[E0040]: explicit use of destructor method
  --> src/main.rs:17:7
   |
17 |     c.drop();
   |     --^^^^--
   |     | |
   |     | explicit destructor calls not allowed
   |     help: consider using `drop` function: `drop(c)`

For more information about this error, try `rustc --explain E0040`.
error: could not compile `sp_demos` due to previous error

这个错误信息指出,我们不允许显式调用 drop。这条错误信息使用了术语 “解构函数destructor”这是清理实例的函数的通用编程术语。解构函数类似于 构造函数constructor后者创建一个实例。Rust 中的 drop 函数就是一个特殊的解构函数。

Rust 之所以不允许咱们显式地调用 drop,是因为 Rust 仍然会在 main 函数结尾处自动调用值上的 drop,这将导致 双重释放double free 的错误,由于 Rust 会试图对同一个值进行两次清理。

当值超出作用域时,我们无法禁用 drop 的自动插入,也无法显式调用 drop 方法。所以,如果我们需要强制一个值提前被清理,我们就使用 std::mem::drop 函数。

std::mem::drop 函数与 Drop 特质中的 drop 方法不同。咱们通过把咱们想要强制弃用的值作为参数传递来调用他。这个函数在前奏中,所以我们可以修改清单 15-15 中的 main 来调用 drop 函数,如清单 15-16 所示:

文件名:src/main.rs

fn main() {
    let c = CustomSmartPointer {
        data: String::from("我的事情"),
    };
    println! ("已创建出一个 CustomSmartPointer 实例。");
    drop(c);
    println! ("在 main 结束之前这个 CustomSmartPointer 已被弃用。")
}

清单 15-16调用 std::mem::drop 在值超出作用域前,显式地弃用该值

运行这段代码将打印出以下内容:

$ cargo run
   Compiling sp_demos v0.1.0 (/home/lennyp/rust-lang/sp_demos)
    Finished dev [unoptimized + debuginfo] target(s) in 0.40s
     Running `target/debug/sp_demos`
已创建出一个 CustomSmartPointer 实例。
正在使用数据 `一些数据` 弃用 CustomSmartPointer!
在 main 结束之前这个 CustomSmartPointer 已被弃用。

文本 正在使用数据 `一些数据` 弃用 CustomSmartPointer! 被打印在 已创建出一个 CustomSmartPointer 实例。在 main 结束之前这个 CustomSmartPointer 已被弃用。 之间,显示 drop 方法在这个时间点被调用来弃用 c

咱们可以通过多种方式使用 Drop 特质实现中指定的代码,来方便和安全地进行清理:例如,咱们可以用他来创建咱们自己的内存分配器! 有了 Drop 特质和 Rust 的所有权系统,咱们不需要记得清理内存,因为 Rust 会自动完成。

咱们也不必担心因意外清理仍在使用的值而导致的问题:确保引用始终有效的所有权系统,还确保在值不再被使用时,drop 只被调用一次。

现在我们已经研究了 Box<T> 和灵巧指针的一些特性,让我们看看标准库中定义的其他几个智能指针。

Rc<T>,引用计数灵巧指针

Rc<T>, the Reference Counted Smart Pointer

在大多数情况下,所有权是明确的:咱们确切地知道哪个变量拥有给定值。然而,在有些情况下,单个值可能有多个所有者。例如,在图数据结构中,多条边可能指向同一个节点,而该节点在概念上被所有指向他的边所拥有。一个节点不应该被清理,除非没有任何边指向他,因此没有了所有者。

咱们必须使用 Rust 类型 Rc<T> 显式启用多重所有权,Rc<T>引用计数reference counting 的缩写。Rc<T> 类型记录了对一个值的引用数量,以确定该值是否仍在使用。如果对某个值的引用为零,那么这个值就可以被清理掉,而不会有任何引用变得无效。

请将 Rc<T> 设想为客厅里的一台电视。在有人进来看电视时,他们会打开他。其他人可以进入客厅并观看电视。当最后一人离开客厅时,他们会关掉电视,因为他已不再被使用了。如果有人在其他人还在看电视的情况下关掉电视,剩下的看电视的人就会哗然!

当我们想在内存堆上分配一些数据给程序的多个部分读取,且无法在编译时确定哪个部分会最后使用完这些数据时,我们就会使用 Rc<T> 类型。如果我们知道哪个部分会最后完成,我们就可以让那个部分成为数据的所有者,而在编译时执行的正常所有权规则就会生效。

请注意 Rc<T> 仅适用于单线程场景only for use in single-threaded scenarios。当咱们在第 16 章中讨论并发时,咱们将介绍如何在多线程程序中进行引用计数。

使用 Rc<T> 来共用数据

Using Rc<T> to Share Data

让我们回到清单 15-5 中咱们的构造列表示例。回想一下,我们用 Box<T> 定义了他。这一次,我们将创建两个列表,二者会公用第三个列表的所有权。从概念上看,这类似于下图 15-3

b 与 c 两个列表,共用了第三列表 a 的所有权

图 15-03两个列表bc,共用第三个列表 a 的所有权

咱们将创建一个包含 510 的列表。然后我们再做两个列表:以 3 开头的 b 和以 4 开头的 c,然后 bc 的列表都会延续到第一个包含 510a 列表。换句话说,这两个列表将共用第一个包含 510 的列表。

尝试使用带有 Box<T>List 定义来实现这个场景是行不通的,如示例 15-17 所示:

文件名:src/main.rs

enum List {
    Cons(i32, Box<List>),
    Nil,
}

use crate::List::{Cons, Nil};

fn main() {
    let a = Cons(5, Box::new(Cons(10, Box::new(Nil))));
    let b = Cons(3, Box::new(a));
    let c = Cons(4, Box::new(a));
}

清单 15-17演示咱们不允许有两个使用 Box<T> 的列表,试图共用第三个列表的所有权

当我们编译这段代码时,我们得到了这样的报错:

$ cargo run
   Compiling sp_demos v0.1.0 (/home/peng/rust-lang/sp_demos)
error[E0382]: use of moved value: `a`
  --> src/main.rs:11:30
   |
9  |     let a = Cons(5, Box::new(Cons(10, Box::new(Nil))));
   |         - move occurs because `a` has type `List`, which does not implement the `Copy` trait
10 |     let b = Cons(3, Box::new(a));
   |                              - value moved here
11 |     let c = Cons(4, Box::new(a));
   |                              ^ value used here after move

For more information about this error, try `rustc --explain E0382`.
error: could not compile `sp_demos` due to previous error;

Cons 变种拥有他们持有的数据,所以当我们创建 b 列表时,a 被迁移到 b 中,b 拥有了 a。然后,当我们在创建 c 时试图再次使用 a,我们不被允许,因为 a 已经被迁移了。

咱们原本可以将 Cons 的定义修改为持有引用,但那样咱们就必须指定生命周期参数。通过指定生命周期参数,咱们将指定列表中的每个元素,都至少与整个列表的寿命一样长。清单 15-17 中的元素与列表就是这种情况,但并非在所有情况下都如此。

相反,我们将改变 List 的定义,使用 Rc<T> 来代替 Box<T>,如下清单 15-18 所示。现在每个 Cons 变种将持有一个值和一个指向 ListRc<T>。当我们创建 b 时,我们将克隆 a 所持有的 Rc<List>,而不是取得 a 的所有权,从而将引用的数量从一个增加到两个,并让 ab 共用该 Rc<List> 中数据的所有权。在创建 c 时,我们也将克隆 a,将引用的数量从两个增加到三个。每次我们调用 Rc::cloneRc<List> 中数据的引用数就会增加,除非对他的引用为零,否则数据不会被清理掉。

文件名:src/main.rs

{{#rustdoc_include ../projects/rc_demo/src/main.rs}}

清单 15-18使用 Rc<T>List 定义

我们需要添加一个 use 语句来将 Rc<T> 引入作用域,因为他不在 Rust 前奏中。在 main 中,我们创建了包含 510 的列表,并将其存储在 a 中的新 Rc<List> 中。然后当我们创建 bc 时,我们调用了 Rc::clone 函数,并将对 a 中的 Rc<List> 的引用作为参数传递。

我们本可以调用 a.clone() 而不是 Rc::clone(&a),但是 Rust 的惯例是在这种情况下使用 Rc::cloneRc::clone 的实现并不像大多数类型的 clone 实现那样对所有数据进行深度拷贝。对 Rc::clone 的调用只是增加引用计数,这不会花费很多时间。数据的深度拷贝会花费很多时间。通过使用 Rc::clone 进行引用计数,我们可以直观地区分出深拷贝的那种克隆和增加引用计数的那种克隆。当寻找代码中的性能问题时,我们只需要考虑深拷贝的克隆,而可以不考虑对 Rc::clone 的调用。

注:第 4 章 变量与数据交互方式之二:克隆 中,曾提到:“当咱们看到对 clone 的调用时,咱们就知道一些任意的代码正在被执行,而这些代码可能开销很大。这是表明正在发生一些不同寻常事情的明显标志。”

克隆 Rc<T> 会增加引用计数

Cloning an Rc<T> Increases the Reference Count

我们来修改示例 15-18 中的工作示例,以便我们可以看到在我们创建和删除对 a 中的 Rc<List> 的引用时,引用计数会发生变化。

在下面清单 15-19 中,我们将更改 main,使其具有围绕列表 c 的内部作用域;然后我们可以看到当 c 超出作用域时引用计数如何变化。

文件名:src/main.rs

fn main() {
    let a = Rc::new(Cons(5, Rc::new(Cons(10, Rc::new(Nil)))));
    println! ("在创建出 a 后,引用计数为 {}", Rc::strong_count(&a));

    let b = Cons(3, Rc::clone(&a));
    println! ("在创建出 b 后,引用计数为 {}", Rc::strong_count(&a));

    {
        let c = Cons(4, Rc::clone(&a));
        println! ("在创建出 c 后,引用计数为 {}", Rc::strong_count(&a));
    }

    println! ("在 c 超出作用域后,引用计数为 {}", Rc::strong_count(&a));
}

清单 15-19打印出引用计数

在程序中引用计数发生变化的每一点上,我们都会打印引用计数,我们通过调用 Rc::strong_count 函数得到这个计数。这个函数被命名为 strong_count 而不是 count,是因为 Rc<T> 类型也有一个 weak_count;我们将在 “防止引用循环:将 Rc<T> 变成 Weak<T> 小节中看到 weak_count 的用途。

这段代码打印出以下内容:

$ cargo run
   Compiling sp_demos v0.1.0 (/home/lennyp/rust-lang/sp_demos)
    Finished dev [unoptimized + debuginfo] target(s) in 0.40s
     Running `target/debug/sp_demos`
在创建出 a 后,引用计数为 1
在创建出 b 后,引用计数为 2
在创建出 c 后,引用计数为 3
在 c 超出作用域后,引用计数为 2

我们可以看到 a 中的 Rc<List> 的初始引用计数为 1;然后每次我们调用 clone,计数都会增加 1。当 c 超出作用域时,计数会减少 1。我们不必像调用 Rc::clone 增加引用计数那样调用一个函数来减少引用计数:当 Rc<T> 值超出作用域时,Drop 特质的实现会自动减少引用计数。

我们在这个例子中看不到的是,当 bamain 的末尾超出作用域时,计数为 0,并且 Rc<List> 会被完全清除。使用 Rc<T> 允许单个值拥有多个所有者,而计数确保只要任何所有者仍然存在,该值就保持有效。

通过不可变的引用,Rc<T> 允许咱们在程序的多个部分之间共用数据,仅供读取。如果 Rc<T> 还允许咱们有多个可变引用,咱们可能会违反第四章中讨论的一个借用规则:对同一个地方的多个可变借用,会导致数据竞赛和不一致。但是,能够修改数据是非常有用的!在下一节中,我们将讨论内部可变性模式和 RefCell<T> 类型,咱们可以将其与 Rc<T> 结合起来使用,以应对这种不可变性限制。

RefCell<T> 与内部可变性模式

RefCell<T> and the Interior Mutability Pattern

内部可变性interior mutability 属于 Rust 中的一种设计模式,他实现了即使在有着到数据的一些不可变引用之下,对数据加以改变;一般情况下,这样的行为是借用规则所不允许的。为了改变数据,这种模式便运用了数据结构内部的一些 unsafe 代码,来改变了 Rust 监管可变性与借用的一些一般规则。这些不安全代码向编译器表明,咱们自己在手动检查那些规则,而非依赖于编译器为咱们检查那些规则;在第 19 章将进一步讨论这些不安全代码。

只有当我们可以确保在运行时遵循借用规则时,我们才能使用使用内部可变性模式的类型,即使编译器不能保证这一点。然后将涉及的不安全代码包装在安全的 API 中,并且外部类型仍然是不可变的。

咱们来通过检视遵循内部可变性模式的 RefCell<T> 类型来探讨这个概念。

使用 RefCell<T> 在运行时执行借用规则检查

Enforcing Borrowing Rules at Runtime with RefCell<T>

Rc<T> 不同,RefCell<T> 类型表示对其所持有的数据的单一所有权。那么,是什么使 RefCell<T>Box<T> 这样的类型不同呢?回顾咱们在第四章学到的借用规则:

  • 在任何给定时间,咱们都可以有着 要么 (而非同时) 一个可变引用,要么任意数量的不可变引用;
  • 引用必须始终有效。

对于引用与 Box<T>借用规则的不变性the borrowing rules' invariants, 是在编译时强制执行的。对于 RefCell<T>,这些不变性则是在运行时强制执行的。对于引用,如果咱们破坏了这些规则,咱们会得到编译器报错。而在 RefCell<T> 中,如果咱们破坏了这些规则,咱们的程序将终止运行。

在编译时检查借用规则的好处是在开发过程中会更早地发现错误,而且对运行时性能没有影响,因为所有分析都是事先完成的。由于这些原因,在大多数情况下,在编译时检查借用规则是最好的选择,这就是为什么这是 Rust 的默认设置。

相反,在运行时检查借用规则的优点是允许某些内存安全的场景,而编译时检查则不会允许这些场景。与 Rust 编译器一样静态分析static analysis本质上是保守的。代码的某些属性无法通过分析代码来检测最著名的例子是停机问题the Halting Problem, 它超出了本书的范围,但却是一个值得研究的有趣主题。

由于某些分析是不可行的,那么如果 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> 中的值。

改变不可变值内部的值,就是 内部可变性模式the interior mutablity pattern。让我们看一下内部可变性有用的一种情况,并检视其如何可行。

内部可变性:对不可变值的可变借用

Interior Mutability: A Mutable Borrow to an Immutable Value

借用规则的一种后果是,当咱们有一个不可变的值时,咱们不能以可变方式借用他。比如,下面这段代码就不能编译:

fn main() {
    let x = 5;
    let y = &mut x;
}

如果咱们试图编译这段代码,咱们会得到以下错误:

$ cargo run
   Compiling sp_demos v0.1.0 (/home/lennyp/rust-lang/sp_demos)
error[E0596]: cannot borrow `x` as mutable, as it is not declared as mutable
 --> src/main.rs:3:13
  |
2 |     let x = 5;
  |         - help: consider changing this to be mutable: `mut x`
3 |     let y = &mut x;
  |             ^^^^^^ cannot borrow as mutable

For more information about this error, try `rustc --explain E0596`.
error: could not compile `sp_demos` due to previous error;

然而,在有些情况下,值在其方法中改变自身,但对其他代码来说却显得不可改变,这将是非常有用的。在该值的方法之外的代码将不能改变该值。使用 RefCell<T> 是获得内部可变性能力的一种方法,但是 RefCell<T> 并没有完全绕过借用规则:编译器中的借用检查器会放行这种内部可变性,而代之以在运行时借用规则得以检查。如果咱们违反了这些规则,咱们会得到一个 pani! 而不是一个编译器报错。

咱们来通过一个其中咱们可以使用 RefCell<T> 改变一个不可变的值的实际示例,看看为什么这很有用。

内部可变性的用例:模拟对象

A Use Case for Interior Mutability: Mock Objects

有时在测试过程中,程序员会使用一个类型来代替另一类型,以便观察特定的行为并断定其实现是正确的。这种占位符类型被称为 测试替身test double。请从电影制作中的“特技替身stunt double”的角度来考虑他某人代替一名演员来完成特别棘手的一场戏。当咱们运行测试时测试替身代表其他类型。模拟对象mock objects 是特定类型的测试替身,他记录了测试过程中发生的事情,因此咱们可以断言发生了正确的动作。

Rust 没有像其他语言那样拥有对象Rust 也没有像其他一些语言那样在标准库中内置模拟对象功能。但是,咱们绝对可以创建一个与模拟对象具有相同用途的结构。

下面是我们要测试的情景:我们将创建一个库,跟踪某个数值与最大值的关系,并根据当前数值与最大值的接近程度发送消息。例如,这个库可以用来跟踪用户允许调用的 API 数量配额。

这个库将提供跟踪某个值接近最大值的程度,及在什么时刻发出什么消息的功能。使用这个库的应用,将被期望提供发送消息的机制:应用可以在应用中放置消息、发送电子邮件、发出手机短信或其他东西。库不需要知道这个细节。他所需的只是实现了咱们将提供的名为 Messenger 特质的东西。以下清单 15-20 给出库的代码:

文件名:src/lib.rs

{{#include ../projects/limit_tracker/src/lib.rs::35}}

清单 15-20跟踪某个值与最大值接近程度并在值处于不同水平时发出告警的库

这段代码的一个重要部分是 Messenger 特质有个叫做 send 的方法,其接收一个不可变 self 的引用和消息文本。这个特质是咱们模拟对象需要实现的接口,这样模拟对象就可以和真实对象一样被使用。另一个重要的部分是,我们要测试 LimitTrackerset_value 方法的行为。我们可以改变我们传入的 value 参数,但 set_value 并没有返回任何东西让我们做断言。我们希望能够表达出,若咱们用实现了 Messenger 特质的东西,与 max 的一个特定值创建了一个 LimitTracker,当我们为 value 传递不同的数字时,messenger 就会被告知要发送相应的消息。

the interface, 借鉴了 Java 语言的叫法,参见 使用接口来拯救!。而这种内部可变性模式用到的数据结构,则类似于 Java 中的内部类。

我们需要一个模拟对象,他不会在我们调用 send 时发送电子邮件或文本消息,而只会记录他被告知要发送的消息。我们可以创建模拟对象的一个新实例,创建一个使用该模拟对象的 LimitTracker 实例,调用 LimitTracker 实例的 set_value 方法,然后检查该模拟对象是否有我们期望的消息。清单 15-21 给出了一个实现模拟对象的尝试,来就这样做,但借用检查器不允许这样做:

文件名:src/lib.rs

#[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 结构体,他有一个 send_messages 字段,里面有一个 String 值的 Vec,用来记录他被告知要发送的消息。我们还定义了一个关联函数 new,以方便创建新的 MockMessenger 值,该值以一个空的消息列表开始。然后我们为 MockMessenger 实现了 Messenger 特质,这样我们就可以给 LimitTracker 一个 MockMessenger。在 send 方法的定义中,我们将传入的消息作为参数,并将其存储在 MockMessengersend_messages 列表中。

在测试中,我们正在测试当 LimitTracker 被告知将 value 设置为超过最大值的 75% 时会发生什么。首先,我们创建一个新的 MockMessenger,他将以一个空的消息列表开始。然后我们创建一个新的 LimitTracker 并为其提供对新 MockMessenger 的引用和最大值 100。我们在 LimitTracker 上用一个大于 75% 的值 80 调用 set_value 方法。然后我们断言 MockMessenger 正在跟踪的消息列表现在应有一条消息。

但是,此测试存在一个问题,如下所示:

$ cargo test
   Compiling limit_tracker v0.1.0 (/home/lennyp/rust-lang/limit_tracker)
error[E0596]: cannot borrow `self.sent_messages` as mutable, as it is behind a `&` reference
  --> src/lib.rs:58:13
   |
2  |     fn send(&self, msg: &str);
   |             ----- help: consider changing that to be a mutable reference: `&mut self`
...
58 |             self.sent_messages.push(String::from(message));
   |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ `self` is a `&` reference, so the data it refers to cannot be borrowed as mutable

For more information about this error, try `rustc --explain E0596`.
error: could not compile `limit_tracker` due to previous error
warning: build failed, waiting for other jobs to finish...

我们不能修改 MockMessenger 来记录消息,因为 send 方法需要一个对 self 的不可变的引用。我们也不能采纳错误文本中的建议,使用 &mut self 来代替,因为那样的话,send 的签名就无法与 Messenger 特质定义中的签名相匹配(请随意尝试,看看咱们会得到什么样的报错消息)。

这种情况下,内部可变性可以起到帮助作用!我们将把 send_messages 存储在一个 RefCell<T> 中,然后 send 方法将能够修改 send_messages 来存储我们所看到的信息。清单 15-22 显示了这是什么样子:

文件名:src/lib.rs

{{#include ../projects/limit_tracker/src/lib.rs:37:}}

清单 15-22使用 RefCell<T> 来改变内层值,而外部值被认为是不可变的

sent_messages 字段现在的类型是 RefCell<Vec<String>,而不是 Vec<String>。在 new 函数中,我们围绕空向量创建一个新的 RefCell<Vec<String> 实例。

对于 send 方法的实现,第一个参数仍然是 self 的不可变借用,这与特质定义相匹配。我们对 self.send_messages 中的 RefCell<Vec<String> 调用 borrow_mut,以获得 RefCell<Vec<String> 中值的可变引用,也就是那个矢量。然后,我们可以对该矢量的可变引用调用 push,以记录测试期间发送的消息。

我们必须做的最后一个更改是在断言中:为了查看内层矢量中有多少个条目,我们在 RefCell<Vec<String>> 上调用 borrow 以获得对该矢量的不可变引用。

现在咱们已经看到了如何使用 RefCell<T>,咱们来深入了解其工作原理!

使用 RefCell<T> 在运行时记录借用

Keeping Track of Borrows at Runtime with RefCell<T>

当创建不可变和可变引用时,我们分别使用 &&mut 语法。而对于 RefCell<T>,我们使用 borrowborrow_mut 方法,他们属于 RefCell<T> 安全 API 的一部分。borrow 方法返回灵巧指针类型 Ref<T>,而 borrow_mut 返回灵巧指针类型 RefMut<T>。这两种类型都实现了 Deref,所以我们可以像对待普通引用一样对待他们。

RefCell<T> 会记录当前有多少个 Ref<T>RefMut<T> 灵巧指针是活动的。每次我们调用 borrowRefCell<T> 都会增加他的计数,即有多少个不可变借用是活动的。当一个 Ref<T> 值超出作用域时,不可变借用的计数就会减少一个。就像编译时的借用规则一样,RefCell<T> 允许我们在任何时候有许多不可变借用或一个可变的借用。

在咱们尝试违反这些规则时,与在引用下咱们会得到编译器报错不同,RefCell<T> 的实现将在运行时终止运行。下面清单 15-23 给出了清单 15-22 中那个 send 实现的修改。咱们故意为同一作用域创建了两个可变借用,以演示 RefCell<T> 在运行时阻止咱们这样做。

文件名:src/lib.rs

    impl Messenger for MockMessenger {
        fn send(&self, message: &str) {
            let mut borrow_one = self.sent_messages.borrow_mut();
            let mut borrow_two = self.sent_messages.borrow_mut();

            borrow_one.push(String::from(message));
            borrow_two.push(String::from(message));
        }
    }

清单 15-23在同一作用域中创建两个可变引用以发现 RefCell<T> 会终止运行

我们为从 borrow_mut 返回的 RefMut<T> 智能指针创建了一个变量 one_borrow。然后我们以同样的方式在变量 two_borrow 中创建了另一个可变的借用。这就在同一作用域中产生了两个可变引用,这是不允许的。当我们运行咱们库的测试时,清单 15-23 中的代码将被不带任何报错地编译,但测试将失败:

$ cargo test
   Compiling limit_tracker v0.1.0 (/home/peng/rust-lang/limit_tracker)
    Finished test [unoptimized + debuginfo] target(s) in 0.46s
     Running unittests src/lib.rs (target/debug/deps/limit_tracker-98d6159d1b15eb72)

running 1 test
test tests::it_sends_an_over_75_percent_waring_message ... FAILED

failures:

---- tests::it_sends_an_over_75_percent_waring_message stdout ----
thread 'tests::it_sends_an_over_75_percent_waring_message' panicked at 'already borrowed: BorrowMutError', src/lib.rs:60:53
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace


failures:
    tests::it_sends_an_over_75_percent_waring_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 终止运行的。这正是 RefCell<T> 处理运行时违反借用规则的方式。

选择在运行时而不是编译时捕获借用错误,正如我们在这里所做的那样,意味着咱们可能会在开发过程后期,才发现代码中的错误:可能直到咱们的代码部署到生产环境中才发现。此外,由于在运行时而不是编译时记录借用,咱们的代码会招致小的运行时性能损失。但是,使用 RefCell<T> 可以编写出模拟对象,该对象可以修改自身,来记录在咱们仅允许不可变值的上下文中使用他时,其所见到的消息。尽管 RefCell<T> 为获得比常规引用所提供的更多功能而有所取舍,咱们可以使用他。

通过结合 Rc<T>RefCell<T>,实现可变数据的多个所有者

Having Multiple Owners of Mutable Data by Combining Rc<T> and RefCell<T>

使用 RefCell<T> 的一种常见方式是与 Rc<T> 结合使用。回顾一下,Rc<T> 实现了某个数据的多个所有者,但只提供对数据的不可变访问。如果咱们有一个持有 RefCell<T>Rc<T>,咱们可以得到一个可以有着多个所有者, 咱们可以改变的值。

比如,回顾清单 15-18 中的构造列表示例,咱们使用 Rc<T> 来实现多个列表共用另一列表所有权。由于 Rc<T> 只保存不可变值,因此一旦咱们创建出列表中的任何值,咱们就再也不能改变他们。咱们来加入 RefCell<T>,以获得修改列表中值的能力。下面清单 15-24 显示,通过在 Cons 定义中使用 RefCell<T>,咱们可以修改所有列表中存储的值:

文件名:src/main.rs

{{#include ../projects/cons_list_demo/src/main.rs}}

清单 15-24使用 Rc<RefCell<i32>> 创建一个咱们可改变的 List

我们创建了一个值,他是 Rc<RefCell<i32>> 的一个实例,并将其存储在一个名为 value 的变量中,以便我们稍后可以直接访问。然后我们以持有 value 的一个 Cons 变种,在 a 中创建了一个 List。我们需要克隆 value,以便 avalue 都拥有内部值 5 的所有权,而不是将所有权从 value 转移到 a 或让 avalue 借用。

我们将列表 a 包装在 Rc<T> 中,这样当我们创建列表 bc 时,他们都可以引用 a,这就是我们在示例 15-18 中所做的。

在我们创建了 abc 中的列表后,我们打算在 value 中的值上加 10。我们通过在 value 上调用 borrow_mut 来实现这一目的,他使用了我们在第 5 章中讨论过的自动解引用功能the automatic dereferencing feature参见 -> 操作符去哪儿了? 小节),将 Rc<T> 解引用到内部的 RefCell<T> 值。borrow_mut 方法返回一个 RefMut<T> 灵巧指针,我们对其使用解引用操作符,并改变内部值。

在打印 abc 时,就可以看到他们都有了修改后的值 15 而非 5

$ cargo run                                                       lennyp@vm-manjaro
   Compiling cons_list_demo v0.1.0 (/home/lennyp/rust-lang/cons_list_demo)
    Finished dev [unoptimized + debuginfo] target(s) in 0.17s
     Running `target/debug/cons_list_demo`
之后的 a = Cons(RefCell { value: 15 }, Nil)
之后的 b = Cons(RefCell { value: 3 }, Cons(RefCell { value: 15 }, Nil))
之后的 c = Cons(RefCell { value: 4 }, Cons(RefCell { value: 15 }, Nil))

这个技巧非常整洁! 通过使用 RefCell<T>,我们有一个对外不可变的 List 值。但是我们可以使用 RefCell<T> 上提供对其内部可变性访问的方法,这样我们就可以在需要的时候修改我们的数据。借用规则的运行时检查可以保护我们不受数据竞赛的影响,有时值得用一点速度来换取我们数据结构中的这种灵活性。请注意,RefCell<T> 对多线程代码不起作用! Mutex<T>RefCell<T> 的线程安全版本,我们将在第 16 章讨论 Mutex<T>

引用循环可能会泄露内存

Reference Cycles Can Leak Memory

Rust 的内存安全保证,使得意外创建出从未清理过的内存(称为 内存泄漏memory leak)很难,但并非不可能。完全防止内存泄漏不是 Rust 的保证之一,这意味着内存泄漏在 Rust 中是内存安全的。通过使用 Rc<T>RefCell<T>,我们可以看到 Rust 允许内存泄漏:创建出其中项目在循环中相互指向的引用是可能的。这会造成内存泄漏,因为循环中各个项目的引用计数永远不会达到 0而值永远不会被弃用。

创建引用循环

Creaing a Reference Cycle

咱们以清单 15-25 中的 List 枚举和 tail 方法开始,来看看循环引用是如何发生的,以及怎样防止他:

文件名:src/main.rs

{{#include ../projects/ref_cycle_demo/src/main.rs::18}}

清单 15-25包含 RefCell<T> 的构造列表定义,因此我们可以修改 Cons 变种指向的内容

这里用的是清单 15-5 中那个 List 定义的另一变体。Cons 变种中的第二个元素,现在是 RefCell<Rc<List>>,表示这里不是要如同在清单 15-24 中所做的那样,具备修改那个 i32 值的能力,这里是要修改某个 Cons 变种所指向的那个 List 值。这里还添加了在有着某个 Cons 变种时,实现便于访问其第二个项目的 tail 方法。

在下面清单 15-26 中,咱们添加了用到清单 15-25 中那些定义的 main 函数。此代码创建了变量 a 中的一个清单,以及变量 b 中指向 a 中清单的一个清单。随后他将 a 中的清单指向了 b,这就创建了一个循环引用。其间有着一些 println! 语句,来显示此过程中不同点位的那些引用计数。

文件名:src/main.rs

{{#include ../projects/ref_cycle_demo/src/main.rs:20:}}

清单 15-26创建出相互指向的两个 List 的循环引用

我们创建一个 Rc<List> 实例,在变量 a 中持有一个 List 值,初始列表为 5 Nil。然后我们创建一个 Rc<List> 实例,在变量 b 中保存另一个 List 值,其中包含值 10,并指向 a 中的列表。

我们修改 a 使其指向 b 而不是 Nil从而创建一个循环。为此我们使用 tail 方法获取对 aRefCell<Rc<List>> 的引用,我们将其放入变量 link 中。然后我们使用 RefCell<Rc<List>> 上的 borrow_mut 方法,将里面的值从一个持有 Nil 值的 Rc<List> 更改为 b 中的 Rc<List>

咱们暂时保持最后的 println! 注释掉,而运行此代码时,咱们将得到下面的输出:

$ cargo run
   Compiling ref_cycle_demo v0.1.0 (/home/lennyp/rust-lang/ref_cycle_demo)
    Finished dev [unoptimized + debuginfo] target(s) in 1.20s
     Running `target/debug/ref_cycle_demo`
a 的初始 rc 计数 = 1
a 的下一条目 = Some(RefCell { value: Nil })
b 的创建后 a 的 rc 计数 = 2
b 的初始 rc 计数 = 1
b 的下一条目 = Some(RefCell { value: Cons(5, RefCell { value: Nil }) })
在修改 a 之后 b 的 rc 计数 = 2
在修改 a 之后 a 的 rc 计数 = 2

在咱们将 a 中的列表改为指向 b 后,ab 中的 Rc<List> 实例的引用计数均为 2。在 main 的最后Rust 弃用了变量 b,这使得 b 中的 Rc<List> 实例的引用计数从 2 减少到 1Rc<List> 在内存堆中的内存此时不会被弃用,因为其引用计数为 1 而不是 0。然后 Rust 弃用 a,将 a 中的 Rc<List> 实例的引用计数从 2 减少到 1。由于另一 Rc<List> 实例仍指向他,因此该实例的内存也不能被弃用。分配给列表内存将永远保持未被收集的状态。为直观地表示这个引用循环,咱们创建了下图 15-4 中的图表。

相互指向的列表 a 与 b 的一个循环引用

图 15-04列表 ab 相互指向的引用循环

在取消注释掉其中最后一个 println! 而运行该程序时Rust 就会尝试以 a 指向 b 指向 a 如此往复,打印出这个循环,直到他溢出内存栈为止。

相较于真实世界的程序,这个示例中创建出循环引用的那些后果并不算非常残酷:在这里创建出那个循环引用之后,这个程序就立马结束了。然而,在更为复杂的程序在某个循环中分配了大量内存,并在其上耗费较长时间时,那么这个程序就会用到相比于其所需要更多的内存,且可能会是系统不堪重负,造成系统耗尽可用内存。

循环引用的创建并非一蹴而就,但也并非是不可能的。在有着包含着 Rc<T> 值的一些 RefCell<T> 值,或类似的带有内部可变性及引用计数的嵌套类型组合时,咱们就必须确保不会创建出循环引用。咱们不能依靠 Rust 来捕获到循环引用。创建出循环引用来,是属于程序中的逻辑错误,咱们应运用自动化测试、代码审阅,及其他一些软件开发实践来消除。

避免循环引用的另一种方案,便是重组咱们的数据结构,从而实现一些引用表达所有权,而一些引用则不是。结果就是,咱们是可以有着由一些所有权关系,与一些非所有权关系构成的循环,而只有所有权关系会影响到某个值是否可被丢弃。在清单 15-25 中,咱们是一直要那些 Cons 变种拥有他们清单的所有权那么重组其中的数据结构就是不可行的。接下来要看到用到了由一些父节点与子节点组成的图数据结构graphs made up of parent nodes and child nodes的示例来发现在什么时候非所有权关系是防止循环引用的恰当方式。

防止引用循环:将 Rc<T> 转变为 Weak<T>

到目前为止,咱们已经证实了调用 Rc::clone 会增加某个 Rc<T> 示例的 strong_count,同时 Rc<T> 示例只会在其 strong_count0 时被清理掉。咱们还可以通过调用 Rc::downgrade 并传入一个到某个 Rc<T> 的引用,而创建出到该 Rc<T> 实例中值的 弱引用weak reference。强引用是咱们可共用某个 Rc<T> 实例的方式。弱引用并不表示某种所有权关系,且在某个 Rc<T> 实例被清理掉时,他们的计数不会受影响。由于在一旦所涉及到那些值的强引用计数为 0涉及到弱引用的全部循环都将被破坏因此弱引用就不会导致循环引用weak references don't express an ownership relationship, and their count doesn't affect when an Rc<T> instance is cleaned up. They won't cause a reference cycle because any cycle involving some weak references will be broken once the strong reference count of values involved is 0)。

在调用 Rc::downgrade 时,就会得到类型 Weak<T> 的灵巧指针。调用 Rc::downgrade 不是把 Rc<T> 实例中的 strong_count1,而是把 weak_count1。与 strong_count 类似,Rc<T> 类型使用 weak_count 来追踪存在多少个 Weak<T>。不同之处在于,对于 Rc<T> 的被清理,是无需 weak_count0 的。

由于 Weak<T> 所引用的值,可能已被启用了,因此在以某个 Weak<T> 所指向值来完成任何事情时,咱们必须确保那个值仍是存在的。而要确保这一点,是通过在 Weak<T> 实例上调用 upgrade 方法实现的,该方法将返回一个 Option<Rc<T>> 值。在那个 Rc<T> 值尚未被弃用时,咱们就会得到一个 Some 的结果,而若那个 Rc<T> 值已被弃用,则就会得到 None 的结果。由于 upgrade 返回的是一个 Option<Rc<T>>Rust 就将确保 SomeNone 两种情形都被处理,进而就将不会有无效指针。

下面的示例,这里将创建其条目了解各自的子条目 以及 各自的父条目的一种树形数据结构,而非之前的其条目仅了解其下一条目的列表数据结构。

创建一种树形数据结构:有着字节点的节点, Creating a Tree Data Structure: a Node with Child Nodes

作为开头,这里将构建有着了解其子节点的一些节点。这里将创建出一个名为 Node 的结构体,保存着自身的 i32 值,以及到其子 Node 值的一些引用。

文件名:src/main.rs

use std::cell::RefCell;
use std::rc::Rc;

#[derive(Debug)]
struct Node {
    value: i32,
    children: RefCell<Vec<Rc<Node>>>,
}

这里要的是某个 Node 拥有其子节点,并想要以一些变量,来共用那样的所有权,从而就可以直接访问树中的各个 Nodewe want a Node to own its children, and we want to share that ownership with variables so we can access each Node in the tree directly。为了完成这一点这里把其中的那些 Vec<T> 条目,定义为了类型 Rc<Node> 的一些值。这里还打算修改哪些节点是另一节点的子节点,因此这里就有一个在 children 字段中,包裹着 Vec<Rc<Node>>RefCell<T>

接下来,这里就将使用这个结构体定义,并创建出有着值 3 而没有子节点的一个名为 leafNode 实例,以及另一个有着值 5 及将 leaf 作为其子节点的 branch 实例,如下清单 15-27 中所示:

文件名:src/main.rs

fn main() {
    let leaf = Rc::new(Node {
        value: 3,
        children: RefCell::new(vec! []),
    });

    let branch = Rc::new(Node {
        value: 5,
        children: RefCell::new(vec! [Rc::clone(&leaf)]),
    });
}

清单 15-27创建出没有子节点的一个 leaf 节点及将 leaf 作为其一个子节点的 branch 节点

这里克隆了 leaf 中的 Rc<Node> 并将其存储在了 branch 中,表示 leaf 中的 Node 现在有了两个所有者:leafbranch。这里就可以经由 branch.children,从 branch 到达 leaf,但并无从 leafbranch 的途径。原因就在于 leaf 没有到 branch 的引用,而就不知道他们是相关的。这里想要 leaf 明白,branch 是其父节点。接下来就要完成这一点。

在子节点中添加到其父节点的引用Adding a Reference from a Child to Its Parent

要让那个字节点了解他的父节点,这里就需要添加一个 parent 字段到这里的 Node 结构体定义。麻烦在于确定出 parent 字段应为何种类型。咱们清楚他不能包含一个 Rc<T>,因为那样就会以 leaf.parent 指向 branchbranch.children 指向 leaf,而创建出循环引用,这将导致他们的 strong_count 值用不为零。

以另外一种方式,来设想这样的关系,父节点因拥有他的子节点:在父节点被弃用时,他的那些子节点也应被弃用。然而,子节点则不应拥有他的父节点:在咱们弃用某个子节点时,那个父节点应存在。这正是弱引用的情况!

因此这里将把 parent 字段的类型,构造为使用 Weak<T>,具体而言就是 RefCell<Weak<Node>>,而非 Rc<T>。现在这个 Node 结构体定义看起来像下面这样:

文件名:src/main.rs

use std::cell::RefCell;
use std::rc::Rc;

#[derive(Debug)]
struct Node {
    value: i32,
    parent: RefCell<Weak<Node>>,
    children: RefCell<Vec<Rc<Node>>>,
}

节点将能够引用他的副节点,而不拥有父节点。在下面清单 15-28 中,把 main 更新为使用这个新定义,进而 leaf 节点将有引用其父节点,branch 的一种途径:

文件名:src/main.rs

fn main() {
    let leaf = Rc::new(Node {
        value: 3,
        parent: RefCell::new(Weak::new()),
        children: RefCell::new(vec! []),
    });

    println! ("叶子节点的父节点 = {:?}", leaf.parent.borrow().upgrade());

    let branch = Rc::new(Node {
        value: 5,
        parent: RefCell::new(Weak::new()),
        children: RefCell::new(vec! [Rc::clone(&leaf)]),
    });

    *leaf.parent.borrow_mut() = Rc::downgrade(&branch);

    println! ("叶子节点的父节点 = {:?}", leaf.parent.borrow().upgrade());
}

清单 15-28带有到其父节点 branch 的弱引用的 leaf 节点

这个 leaf 节点的创建,与清单 15-27 类似,除了其中的 parent 字段:leaf 以不带父节点开始,因此这里创建了一个新的、空 Weak<Node> 引用实例。

到这里,在咱们尝试通过使用 upgrade 方法,获取 leaf 的父节点的引用时,就会得到一个 None 值。在首个 println! 语句的输出中,就看到了这点:

叶子节点的父节点 = None

在创建那个 branch 节点时,由于 branch 没有父节点,他也将有一个 parent 字段中的新 Weak<Node> 引用。这里仍将 leaf 作为 branch 的子节点之一。一旦咱们有了 branch 变量中的那个 Node 实例,就可以修改 leaf,来给到他一个到其父节点的 Weak<Node> 引用。这里使用了 leafparent 字段中,RefCell<Weak<Node>> 上的 borrow_mut 方法,并于随后使用了 Rc::downgrade 函数,来子 branch 变量中的那个 Rc<Node>,创建出到 branchWeak<Node> 引用。

当咱们再度打印 leaf 的父节点时,这次就会得到保存着 branch 的一个 Some 变种:现在 leaf 就可以访问其父节点了!在打印 leaf 时,同样避免了清单 15-26 中曾有过的,最终以栈一出而告终的那个循环引用;其中的 Weak<Node> 引用,是作为 (Weak) 被打印出的:

叶子节点的父节点 = Some(Node { value: 5, parent: RefCell { value: (Weak) }, children: RefCell { value: [Node { value: 3, parent: RefCell { value: (Weak) }, children: RefCell { value: [] } }] } })

没有了无限输出,就表示此代码并未创建出循环引用。咱们还可以通过查看从调用 Rc::strong_countRc::weak_count 得到的值,来说明这一点。

strong_countweak_count 变化的直观表示Visualizing Changes to strong_count and weak_count

下面来看看这些 Rc<Node> 实例,是怎样通过创建出新的内层作用域,并将 branch 定义迁移到那个作用域而变化的。通过这样做,咱们就可以看到在 branch 被创建出,及在其超出作用域而被弃用时,会发生什么。下面清单 15-29 中给出了这些修改:

文件名:src/main.rs

fn main() {
    let leaf = Rc::new(Node {
        value: 3,
        parent: RefCell::new(Weak::new()),
        children: RefCell::new(vec! []),
    });

    println! (
        "叶子节点的强引用计数:{},弱引用计数:{}\n",
        Rc::strong_count(&leaf),
        Rc::weak_count(&leaf),
    );

    {
        let branch = Rc::new(Node {
            value: 5,
            parent: RefCell::new(Weak::new()),
            children: RefCell::new(vec! [Rc::clone(&leaf)]),
        });

        *leaf.parent.borrow_mut() = Rc::downgrade(&branch);

        println! (
            "枝干节点的强引用计数:{},弱引用计数:{}\n",
            Rc::strong_count(&branch),
            Rc::weak_count(&branch),
        );
        println! (
            "叶子节点的强引用计数:{},弱引用计数:{}\n",
            Rc::strong_count(&leaf),
            Rc::weak_count(&leaf),
        );

    }
    println! ("叶子节点的父节点 = {:?}\n", leaf.parent.borrow().upgrade());
    println! (
        "叶子节点的强引用计数:{},弱引用计数:{}\n",
        Rc::strong_count(&leaf),
        Rc::weak_count(&leaf),
    );
}

清单 15-29在内层作用域中创建 branch 并对那些强弱引用计数进行检查

leaf 节点被创建出了后,其 Rc<Node> 便有了强引用计数 1 及弱引用计数 0。在那个内层作用域中,这里创建了 branch 并将其与 leaf 关联,在打印两种计数的那个时间点,branchRc<Node> 将有着强计数 1 与弱计数 1(由于 leaf.parent 以一个 Weak<Node> 指向了 branch)。在打印 leaf 中的两个计数时,由于 branch 现在有着存储在 branch.childeren 中,leafRc<Node> 的一份克隆,因此咱们就会看到他将有着强引用计数 2,而他仍将有着弱引用计数 0

在那个内存作用域结束时,brach 就超出了作用域,而那个 Rc<Node> 的强引用计数就会降低到 0,因此他的 Node 就被丢弃了。源自 leaf.parent 的弱引用计数 1,与这个 Node 是否被弃用无关,因此这里就不会得到任何内存泄露!

在那个内层作用域结束之后,若咱们尝试访问 leaf 的父节点,就将再度得到 None。在该程序结束处,由于变量 leaf 此时又仅是到那个 Rc<Node> 的唯一引用,因此他里面的 Rc<Node>,将有着强引用计数 1 与弱引用计数 0

管理这两种计数与值的弃用的全部逻辑,都被内建到了 Rc<T>Weak<T>,以及二者的 Drop 特质实现中。通过在 Node 定义中,指明某个子节点到其父节点的关系,应为 Weak<T> 的引用,咱们就能够在不创建出循环引用与内存泄露之下,让父节点指向子节点,并反过来让子节点也指向父节点。

本章小节

本章涵盖了怎样运用灵巧指针,来做出相比与 Rust 默认在常规引用下所做出的不同保证及权衡this chapter covered how to use smart pointers to make different gurantees and trade-offs from those Rust makes by default with regular references。其中的 Box<T> 类型,有着已知大小,并指向分配在内存堆上的数据。而 Rc<T> 类型,则对到内存堆上数据的引用数量加以追踪,因此那个数据变可以有多个所有者。RefCell<T> 类型,以其内部可变性,而给到在需要一种不可变类型,却又需要修改那种类型的内层值时,咱们可用的一种类型;这种类型还强制要求在运行时,而非编译时的借用规则检查。

本章还讨论了 DerefDrop 两个特质,他们实现了灵巧指针的很多功能。这里探讨了可导致内存泄露的循环引用,以及怎样运用 Weak<T> 来防止他们。

若这一章激发了你的兴趣,而打算实现自己的灵巧指针,那么请查看 The Rustonomicon 了解更多有用信息。

接下来,咱们就将谈谈 Rust 中的并发问题了。咱们将了解到少数几个新的灵巧指针。