├── .gitignore ├── README.md ├── SUMMARY.md ├── chapter1.md └── chapter2.md /.gitignore: -------------------------------------------------------------------------------- 1 | # Node rules: 2 | ## Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 3 | .grunt 4 | 5 | ## Dependency directory 6 | ## Commenting this out is preferred by some people, see 7 | ## https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-into-git 8 | node_modules 9 | 10 | # Book build output 11 | _book 12 | 13 | # eBook build output 14 | *.epub 15 | *.mobi 16 | *.pdf -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Rust 程序设计语言实例教程 2 | 3 | 本作品采用 [知识共享署名-禁止演绎 4.0 国际许可协议](https://creativecommons.org/licenses/by-nd/4.0/deed.zh) 进行许可 4 | 5 | ## 在线阅读 6 | 7 | 点击 [此处](https://3442853561.gitbooks.io/rustcasestudymanual/content/) 链接或将地址复制到浏览其中: [https://3442853561.gitbooks.io/rustcasestudymanual/content/](https://3442853561.gitbooks.io/rustcasestudymanual/content/) 8 | 9 | GitHub仓库地址: [https://github.com/3442853561/RustCaseStudyManual](https://github.com/3442853561/RustCaseStudyManual) 10 | 11 | ## 本书作者 12 | 13 | + [@3442853561](https://github.com/3442853561) 14 |  - 联系邮箱: [3442853561@qq.com](3442853561@qq.com) 15 | 16 | ## 致谢 17 | 18 | 特别感谢以下读者的勘误、批评与建议: 19 | [@wayslog](https://github.com/wayslog) 20 | -------------------------------------------------------------------------------- /SUMMARY.md: -------------------------------------------------------------------------------- 1 | # Summary 2 | 3 | * [第1章 快速入门](chapter1.md) 4 | * [第2章 从零开始创建 Rust 库](chapter2.md) -------------------------------------------------------------------------------- /chapter1.md: -------------------------------------------------------------------------------- 1 | # 第1章 快速入门 2 | 3 | 对于任何一个想要自我提升的开发者来说，学习新的语言绝对是一个值得花费时间和精力尝试的事情。Rust 在最近两年成为了一部分优秀的开发者中眼中的当红语言。不过对于很多其他语言的程序员来说，Rust 似乎有着非常复杂的语法。至少它的报错信息给人一种感觉——我在别的语言里面做同样的事情是不会报错，这让很多程序员对 Rust 敬而远之。作为一个过去的 C/C++ 程序员（目前在工作中用到了 Rust），笔者将展示一系列的案例来向已经掌握至少一门编程语言的读者们讲解如何着手 Rust 的开发，以及怎么在工作中用到 Rust。那么阅读这个教程之前请您确认自己能够读懂 C、C++、Java 或 C# 中至少一种语言的源代码。这并不是一个面向毫无编程基础的读者的教程。如果您还没有编程基础，笔者建议您先去看一看其他的教程。 4 | 5 | 那么现在我们就来开始我们的开发案例。很多程序设计的教程都会让您在屏幕上先输出 “Hello, World”。不过鉴于本教程的读者都是有经验的程序员（估计其中有一些人已经是高级工程师或者技术总监了），我们就跳过这个无聊的例子好了。我们一上来就做一个有点儿意思的程序。大致就是对可以自称是工程师的那些人的 “Hello, World” ——我们来做一个电话簿。当然了这个电话簿根本就没有图形化的界面，只能在控制台运行。笔者在刚刚当上程序员的时候（大约2004年前后），做这种东西就能轻车熟路。这里我们只是把它当成一个欢迎大家学习 Rust 语言的例子就好了。 6 | 7 | 因为这个例子需要对文件进行操作，而且还需要有输入的功能。所以您不得不下载 Rust 的开发工具。您可以在官方网站（ [https://www.rust-lang.org/zh-CN/](https://www.rust-lang.org/zh-CN/) ）找到多种形式以及配合不同环境的工具。在 Linux 或 Mac（OS X）上您仅需要在终端输入： 8 | 9 | ``` 10 | curl https://sh.rustup.rs -sSf | sh 11 | ``` 12 | 13 | 而在 Windows 需要下载 rustup-init.exe 当然您也可以下载离线的安装包，不过使用 rustup 实际上是一个一劳永逸的方法，因为您不必要像使用离线安装包那样在升级和切换默认工具链时忙手忙脚。这也是笔者作为一个有经验的 Rust 开发者给您的忠告。当然了，您也可以选择使用镜像。只需要设置两个环境变量就可以了： 14 | 15 | ``` 16 | RUSTUP_DIST_SERVER=https://mirrors.ustc.edu.cn/rust-static 17 | RUSTUP_UPDATE_ROOT=https://mirrors.ustc.edu.cn/rust-static/rustup 18 | ``` 19 | 20 | 在 Windows 系统下笔者为您写好了一个批处理，当然了前提条件是单纯为了从镜像获取升级为目的使用批处理，并且您已经安装好了 rustup。批处理的获取地址是： 21 | 22 | ``` 23 | https://github.com/3442853561/rust-housework/blob/master/batch/update.bat 24 | ``` 25 | 26 | 这里还有一个用于 Linux 的版本，由 GitHub 上的 [@Linger2](https://github.com/Linger2) 提供。在这里笔者为他做出的无私贡献表示深深地感谢。获取地址是： 27 | 28 | ``` 29 | https://github.com/3442853561/rust-housework/blob/master/batch/update.sh 30 | ``` 31 | 32 | 此外您还可以下载离线的安装包，虽然这是不推荐的做法。现在就让我们开始愉快的编程吧。首先要注意的是 Rust 在保存时必须以 UTF-8 进行编码（建议无 BOM 头），并且以 .rs 作为扩展名。此外请务必暂时忘记其他语言中学到的某些经验，特别是那些像 Java 那样的语言中的经验。 33 | 34 | Rust允许我们使用汉字作为标识符了，不过您必须选择 Nightly 版本的 Rust 进行开发。并需要在开头写上： 35 | 36 | ```rust 37 | #![feature(non_ascii_idents)] 38 | ``` 39 | 40 | 我们的第一个程序是这样的： 41 | 42 | ```rust 43 | #![feature(non_ascii_idents)] 44 | 45 | #[derive(Debug)] 46 | struct 联系人 { 47 | 姓名: String, 48 | 电话: String, 49 | } 50 | 51 | impl 联系人 { 52 | fn 构建新的联系人>(新的人姓名: T, 新的人电话: T) -> Self { 53 | 联系人 { 54 | 姓名: 新的人姓名.into(), 55 | 电话: 新的人电话.into(), 56 | } 57 | } 58 | } 59 | 60 | fn main() { 61 | let mut 联系人列表: Vec<联系人> = Vec::new(); 62 | 联系人列表.push(联系人::构建新的联系人("刘祺", "156********")); 63 | println!("{:?}", 联系人列表[0]); 64 | } 65 | ``` 66 | 67 | 不过对于任何一个有经验的开发者来说，使用汉字作为标识符都是非常不舒服的行为。因为您必须要在中文和英文的输入法之间来回切换，而且有的时候编译器会仅仅是因为使用了汉字就进行报错。而使用英语字母则不会出现这个问题。这里笔者举这个例子只是为了告诉您 Rust 是可以把汉字当做标识符的，而不是鼓励您这样做。与之相反，任何一个成熟的程序员都应该对这种做法嗤之以鼻。此外把汉语拼音当做标识符仍然是不妥的。因为在我们的语言里面，存在着同音异意的词汇。这很容易引起误解。对于标识符的选择来说，如果您的母语本来就是属于类似英语的语言，譬如说西班牙语。那么您去掉几个重音符号也许勉强还能接受。不过如果您的母语是像中文、日语这样存在大量汉字的语言。那么，建议您还是老老实实地把标识符写成英语。当我们修改之后程序就变成了： 68 | 69 | ```rust 70 | #[derive(Debug)] 71 | struct Contact { 72 | name: String, 73 | phone: String, 74 | } 75 | 76 | impl Contact { 77 | fn new>(new_name: T, new_phone: T) -> Self { 78 | Contact { 79 | name: new_name.into(), 80 | phone: new_phone.into(), 81 | } 82 | } 83 | } 84 | 85 | fn main() { 86 | let mut contacts_list: Vec = Vec::new(); 87 | contacts_list.push(Contact::new("刘祺", "156********")); 88 | println!("{:?}", contacts_list[0]); 89 | } 90 | ``` 91 | 92 | 现在这个程序就舒服多了。我们来讲解一些这个程序都干了什么。以及怎么干的。当然了鉴于本教程的读者都应该是有经验的程序员。笔者并不会巨细靡遗地讲解什么是主函数，主函数是程序的入口之类的话题。我们会发现 `fn` 实际上是一个关键字来表示函数（在 C# 之类的语言里面叫做方法）那么 `fn main()` 是程序的主函数。也就是程序的入口。我们从这里看起。第一句是： `let mut contacts_list: Vec = Vec::new();` 这句话定义了一个 `Vec` 类型的 `contacts_list` 变量。在 Rust 中这叫做绑定，和定义变量的含义并不完全相同，不过目的是一样的。`Vec` 是一个带有泛型的类型。它的含义相当于每个元素都是 `Contact` 类型的栈，不过这个东西实际上叫动态数组。它包括 `push`、`pop` 等一系列方法。第二句是 `contacts_list.push(Contact::new("刘祺", "156********"));` 这是为 `contacts_list` 数组增加（`push`）了一个元素。这个元素是 `Contact::new("刘祺", "156********")` 这个方法的返回值。具体这个方法是什么我们一会儿再说。最后一句是 `println!("{:?}", contacts_list[0]);` 它的含义是以 debug 的方式输出 `contacts_list` 数组中下标为0的元素。 `{:?}` 的含义是以 debug 方式的意思。 想要使用 `{:?}` 必须要明确输出的内容已经实现了一个叫做 `Debug` 的特征。在程序的最开始我们写了这样几行代码： 93 | 94 | ```rust 95 | #[derive(Debug)] 96 | struct Contact { 97 | name: String, 98 | phone: String, 99 | } 100 | ``` 101 | 102 | 第一句就是为下面紧挨着的构造类型（或枚举类型）实现 `Debug` 特征的意思。下面构建了一个构造类型。相当于 C++，Java 和 C# 中类中的数据的部分。下面的 `impl` 则是相当于类的方法，在 Rust 中叫做方法语法。不过 Rust 中为了让您能够好好写程序把数据和方法分开处理了。您不能认为方法语法和构造类型就等于类。这是很不一样的东西。因为在 Rust 中，数据没有继承。而对于方法的继承也要通过特征来实现。这样做有一个好处就是避免了多继承中的菱形继承。而且还能把数据和方法分开管理。方法语法中的函数（方法）默认是私有的。不过我们现在没有分文件，也就没有必要对其进行公开（`pub`）。这个函数实现的功能是返回一个自身的类型，来构建一个新的 `Contact` 类型的值。`Self` 的意思就是自身的类型，这里代指 `Contact`。在函数末尾的 `->` 用来标注返回值的类型。函数中实际上只有一个表达式： 103 | 104 | ```rust 105 | Contact { 106 | name: new_name.into(), 107 | phone: new_phone.into(), 108 | } 109 | ``` 110 | 111 | 注意这一部分是一条表达式，而不是一条语句。在 Rust 中函数的最后一个表达式的计算结果代表返回值。如果您给它加上分号改成语句是不可以的。此外我们还没有讲 `T: Into` 是什么东西。`T` 这里是一个泛型。它又一个约束条件，就是实现了 `Into` 的类型。凡是实现了 `Into` 特征的类型都可以通过值在后面接一个 `.into()` 来转换成一个 `String` 类型的值。用双引号包裹的值的类型是 `&str` 而不是 `String`。所以这里需要这个泛型来简化编程。我们为了让程序变得美一点儿可以把它改写成： 112 | 113 | ```rust 114 | use std::fmt; 115 | 116 | struct Contact { 117 | name: String, 118 | phone: String, 119 | } 120 | 121 | impl Contact { 122 | fn new>(new_name: T, new_phone: T) -> Self { 123 | Contact { 124 | name: new_name.into(), 125 | phone: new_phone.into(), 126 | } 127 | } 128 | } 129 | 130 | impl fmt::Debug for Contact { 131 | fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> { 132 | write!(f, "联系人: {}\n电话: {}", self.name, self.phone) 133 | } 134 | } 135 | 136 | fn main() { 137 | let mut contacts_list: Vec = Vec::new(); 138 | contacts_list.push(Contact::new("刘祺", "156********")); 139 | println!("{:?}", contacts_list[0]); 140 | } 141 | ``` 142 | 143 | 这里我们发现多了两个东西，一个是 `use std::fmt;` 这条语句的意思是使用一个模块。类似于 C++ 里面的名字空间。这个名字空间实际上来自于标准库。标准库中的一大部分内容实际上都会被默认引入，不过还是有一些内容需要我们手动的去引入。另一个大家伙就是： 144 | 145 | ```rust 146 | impl fmt::Debug for Contact { 147 | fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> { 148 | write!(f, "联系人: {}\n电话: {}", self.name, self.phone) 149 | } 150 | } 151 | ``` 152 | 153 | 这个东西就是特征（`trait`）的实现。有一个叫做 `Debug` 的特征已经在标准库里面写好了，我们这里只是把它实现一下。这类似于 C# 里面的接口。`impl fmt::Debug for Contact` 的意思是为 `Contact` 类型实现 `Debug` 特征。里面有一个 `fmt` 函数（方法）： 154 | 155 | ```rust 156 | fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> { 157 | write!(f, "联系人: {}\n电话: {}", self.name, self.phone) 158 | } 159 | ``` 160 | 161 | 这个函数的细节在标准库里面有明确的定义，我们能改的只有 `write!(f, "联系人: {}\n电话: {}", self.name, self.phone)` 这条表达式，而且这条表达式实际上还是个宏。在 Rust 中，宏长得非常像函数，不过宏会在宏名后面加一个叹号，当然也有比较特殊的 `try!` 宏写成一个问号。这些细节我们以后再讲。不过如果我们瞎改的话，实际上我们就得不到 `Result<(), fmt::Error>` 的返回值了。说到底我们只能改 `"联系人: {}\n电话: {}", self.name, self.phone` 这一小部分。大致和 C 语言的情况类似。不过 Rust 中不区分类型的用 `{}` 表示格式占位。 162 | 163 | 那么接下来为了方便联系人列表的增删改查我们最好还是为其建立一个数据结构。 164 | 165 | ```rust 166 | use std::collections::HashMap; 167 | 168 | struct ContactsData { 169 | list: Vec, 170 | index: HashMap, 171 | } 172 | ``` 173 | 174 | 注意这里我们使用了 `HashMap` 这个数据类型以至于我们需要通过 `use std::collections::HashMap;` 将其引入。它是标准库里面的一种集合类型和我们之前见过的 `Vec` 一样，不过 `Vec` 是自动被引入的。在 Rust 语言中构造类型的名称一般采用一种改良的驼峰式写法，即首字母需要大写的驼峰式写法。如果想要写出优美的语义化程序，请您保持这种写法。当您见到一个有着良好规范的 Rust 程序这种被改良的驼峰式写法往往表示这一个独立的事物——一个构造类型、一个枚举类型或者一个枚举类型中的某种枚举情况。因为在 Rust 语言中枚举的含义包含了共用体的含义。所以这种首字母大写的驼峰写法是恰当的。有一些程序员可能更习惯采用首字母小写的驼峰写法，这样在 Rust 语言中引起一种混乱——当一个构造类型只有一个单词的时候，那么我们就很难区分它到底是不是 Rust 中提供的基础类型了。而且会导致编译器发出一个 warning。在您编写 Rust 程序的一般情况下您无需理会 warning，不过当您重构或优化代码时这些信息就起到了重要的作用。这和某些必须要调整 warning 的语言是不同的。在 Rust 中 warning 表示一些不痛的问题，换句话说它并不会出现运行时报错这种难以预料的灾难。不过如果不修复它则可能给生成代码的质量以及后期维护带来本不必要的开销。 175 | 176 | 这里我们也涉及了哈希表（`HashMap`）这种类型，如果您是一个成熟的程序员一定了解类似的数据结构。简单的说它就是一个键对应着一个值。它的类型中仍然包括泛型 `HashMap<键的类型, 值的类型>` 不过哈希表类型在 Rust 中有一个特殊的要求，就是其键的类型必须的可哈希的。具体在 Rust 中表现为类型实现了 `Hash` 特征（`trait`）的类型。而且 Rust 还额外需要您键的类型是可比较的也就是实现了 `PartialEq` 和 `Eq` 的特征。 177 | 178 | 179 | 我们首先要实现的功能就是联系人的增加和查询，以及整个联系人列表的新建。初步的可以把程序写成： 180 | 181 | ```rust 182 | use std::fmt; 183 | use std::collections::HashMap; 184 | 185 | #[derive(Clone)] 186 | struct Contact { 187 | name: String, 188 | phone: String, 189 | } 190 | 191 | impl Contact { 192 | fn new>(new_name: T, new_phone: T) -> Self { 193 | Contact { 194 | name: new_name.into(), 195 | phone: new_phone.into(), 196 | } 197 | } 198 | } 199 | 200 | impl fmt::Debug for Contact { 201 | fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> { 202 | write!(f, "联系人: {}\n电话: {}", self.name, self.phone) 203 | } 204 | } 205 | 206 | #[derive(Clone)] 207 | struct ContactsData { 208 | list: Vec, 209 | index: HashMap, 210 | } 211 | 212 | impl ContactsData { 213 | fn new() -> Self { 214 | ContactsData { 215 | list: Vec::new(), 216 | index: HashMap::new(), 217 | } 218 | } 219 | 220 | // 这里有一个可变引用，可以把它简单理解为给引用加上了可变性 221 | fn add>(&mut self, new_name: T, new_phone: T) { 222 | let name = new_name.into(); 223 | self.list.push(Contact::new(name.clone(), new_phone.into())); 224 | if self.index.contains_key(&name) { 225 | println!("已有同名联系人"); 226 | } else { 227 | self.index.insert(name.clone(), self.list.len() - 1); 228 | } 229 | } 230 | 231 | fn query>(&self, name: T) -> Option { 232 | match self.index.get(&name.into()) { 233 | Some(query_index) => Some(self.list[*query_index].clone()), 234 | _ => None, 235 | } 236 | } 237 | 238 | fn get_query_result_string>(&self, name: T) -> String { 239 | let _name = name.into(); 240 | if let Some(query_result) = self.query(_name.clone()) { 241 | return format!("{:?}", query_result); 242 | } 243 | format!("没有找到联系人\"{}\"", _name) 244 | } 245 | } 246 | 247 | fn main() { 248 | let mut contacts = ContactsData::new(); 249 | contacts.add("刘祺", "156********"); 250 | contacts.add("张三", "130********"); 251 | println!("{}", contacts.get_query_result_string("刘祺")); 252 | } 253 | ``` 254 | 255 | 我们最先注意到底就是我们都使用 `#[derive(Clone)]` 为两个函数自动实现了一个新的特征 `Clone`。这个特征和 Rust 中的所有权系统有关。对于初学者来说，Rust 语言中的所有权系统简直就是最臭名昭著的东西。以至于很多没有学习过 Rust 语言的人都知道它的污名。（笔者猜测有一部分没有使用 C 语言在实际工作项目中的人可能感觉不到这种污名）实际上它是一个好用不好学的概念。（当然也只是对像笔者这样反应有些迟钝的人不太好学）一旦学会就会非常好用。这里我们采用一种简单途径来学习所有权系统——即笔者先不介绍所有权系统的概念，而是先讲解一些使用上的经验和投机取巧的办法。来让大家体会一下所有权，等到我们已经能够熟练的使用这种编程套路之后，再来系统的讲解它的概念。所有权系统是为了更科学的维护和管理内存而提出的。它的主要思想就是不让一个变量到处乱用，造成内存的难以维护。在 Rust 中我们一个变量如果直接扔给一个函数，那么这个变量就整体被这个函数拿走了（函数获得了变量的所有权）。也就是说您相当于把变量送给了一个函数，这样这个变量就再也不是您的了，您不能把它在送给另一个函数。这是一直常见的错误叫做“use of moved value”。在 Rust 中这是被禁止的。那么当您想给一个函数传递一个值的时候，最好就是您不要主动把变量送给函数啦，最好是让函数来借。这就产生了借用和引用。当然主要就表现为引用。当函数的某一个参数前出现了 `&` 符号，那么就说明这个参数函数要管别人去借。俗话说“好借好还，再借不难”。也就是说函数并不持有这个变量的所有权，只是借一下。用完了以后这个参数会还回去。那么这个参数当然就可以随便借给多个函数啦。不过有的时候借东西也会对东西本事造成改变。譬如说您和别人借钱肯定要如数奉还，不过有的时候我们还有利息的问题。（笑）那么函数也是这样，这就产生了可变引用。也就是对变量产生了改变的情况。不过还有的时候如果用引用实在是不方便，或者借出去的东西不用还，譬如说生活中我们经常会借纸巾。那么这种东西是不用还的，不过您是想保留这个变量，那么就产生了克隆（`clone`）。克隆是指实现了 `Clone` 特征的类型调用 `clone` 函数的过程。这里需要特别注意，虽然克隆的特征和函数调用的拼写是一样的。不过它们的大小写是不一致的。而 Rust 又是区分大小写的语言。这里就用到了我们之前说的技巧，所以我们可以判断出开头大写的是特征，完全小写的是函数。因为特征是一个独立的项，所以用开头大写的驼峰式写法，而函数是用全小写的蛇形写法。对于一个引用值的类型也是引用。所以有的时候您需要通过 `*` 来解引用。 256 | 257 | 除此之外我们还遇到了 `Option` 类型的数据。这是一个有意思的类型，在 Rust 中会考虑值为空的情况。所以就有了 `Option` 类型。它是 Rust 中的枚举，不过它相当于别的语言里面的共用体和枚举的组合形式。它的值是 `Some`(值) 或 `None`。前者表示存在一个值，后者表示值为空。这里我们用了两种方法来匹配 `Option` 类型。比较常规的是用 `match`，譬如说这样写： 258 | 259 | ```rust 260 | match self.index.get(&name.into()) { 261 | Some(query_index) => Some(self.list[*query_index].clone()), 262 | _ => None, 263 | } 264 | ``` 265 | 266 | Rust 的编程哲学是要穷举所有情况。用 `_` 来表示未考虑的其它情况。对于枚举类型您也可以穷举它的所有情况啦。截止到笔者写作的时候，Rust 对数值类型进行穷举上还存在着一定的缺陷。所以建议您总是要写 `_` 来表示未明确考虑的情况。您可以参考官方 GitHub 的讨论页面中的 issue #12483 和 issue #30578。类似的讨论还有 issue #45590。 267 | 268 | 另外一种就是比较简明，而且是比较推荐的高手做法。即使用 `if let` 的语法糖： 269 | 270 | ```rust 271 | if let Some(query_result) = self.query(_name.clone()) { 272 | return format!("{:?}", query_result); 273 | } 274 | ``` 275 | 276 | 它实际上就是 `match` 的意思，不过它允许不写 `else`。就显得更为清爽了。这是 Rust 高手更喜欢的做法。不过这个例子实际上有一个丑陋的地方，实际上它写成 `match` 也不会混乱到什么地方去。因为它使用 `return` 提前返回。而我们如果不使用 `return` 就必须给 `if let` 加上一个 `else`。这里需要注意 `if let` 是可以加上 `else` 的。不过这可能导致让代码更加混乱、有一点儿像是画蛇添足的做法： 277 | 278 | ```rust 279 | if let Some(query_result) = self.query(_name.clone()) { 280 | format!("{:?}", query_result) 281 | } else { 282 | format!("没有找到联系人\"{}\"", _name) 283 | } 284 | ``` 285 | 286 | 这样写实在不是很好看呢。它使用 `match` 的写法都要比使用 `if let` 与 `else` 配合的这种写法整洁一些: 287 | 288 | ```rust 289 | match self.query(_name.clone()) { 290 | Some(query_result) => format!("{:?}", query_result), 291 | _ => format!("没有找到联系人\"{}\"", _name), 292 | } 293 | ``` 294 | 295 | 这里有一个典型的示范，证明连最开始的例子中的 `if let` 的用法也是不太美观的。笔者认为那种写法更像是从 C 语言的避免多层分支语句嵌套留下来的后遗症。让我们来看看标准库中的 `unwrap` 函数（方法）是怎么写的： 296 | 297 | ```rust 298 | pub fn unwrap(self) -> T { 299 | match self { 300 | Some(val) => val, 301 | None => panic!("called `Option::unwrap()` on a `None` value"), 302 | } 303 | } 304 | ``` 305 | 306 | 这里的泛型 `T` 我们暂时不去管它，这里就是 `Some` 里面包裹的值的类型的意思。您可以把它简单理解为随便一个类型。如果我们硬是要改写成 `if let` 也是可以做到的，只是比较丑陋： 307 | 308 | ```rust 309 | pub fn unwrap(self) -> T { 310 | if let Some(val) = self { 311 | return val; 312 | } 313 | panic!("called `Option::unwrap()` on a `None` value"); 314 | } 315 | ``` 316 | 317 | 说来说去，`if let` 似乎只有当您的另外的匹配什么都不需要做的时候用起来比较方便，譬如： 318 | 319 | ```rust 320 | fn foo>>(bar: T) -> i16 { 321 | let mut result = -1; 322 | if let Some(x) = bar.into() { 323 | result = x as i16; 324 | } 325 | 326 | // 这里可能还有若干条涉及 result 的语句 327 | 328 | result 329 | } 330 | 331 | fn main() { 332 | println!("值为 {{0}} 的时候的结果: {}", foo(0)); 333 | println!("值为 {{None}} 的时候的结果: {}", foo(None)); 334 | } 335 | ``` 336 | 337 | 这里我们先来讲一下新鲜的事物：`Into>`。这里实际上是对泛型 `T` 的一个约束。也就是说泛型 `T` 是一个需要实现了 `Into>` 特征的类型。这个约束保证了它是可选的。当然了您也可以直接把参数 `bar` 的类型定义为 `Option`。不过这有一个问题就是您每次调用函数的时候都要写 `Some(值)` 或者 `None`。当然了如果您没有“这里可能还有若干条涉及 `result` 的语句”的时候，笔者希望您能够这样写： 338 | 339 | ```rust 340 | fn foo>>(bar: T) -> i16 { 341 | match bar.into() { 342 | Some(x) => x as i16, 343 | None => -1, // 这里把 None 写成 _ 也是可以的 344 | } 345 | } 346 | ``` 347 | 348 | 不过当您仅需要在函数中设置一个可选参数。那么您使用 `if let` 也不是非常优美的做法，因为存在更加简单明了的做法： 349 | 350 | ```rust 351 | fn hoge(piyo: T) -> u8 352 | where T: Into> { 353 | let mut result = piyo.into().unwrap_or(0); 354 | 355 | // 这里可能还有若干条涉及 result 的语句 356 | 357 | result 358 | } 359 | ``` 360 | 361 | 这里我们又涉及了一个新的关键字 `where` 这个关键字的常规用途实际上是用于描述多个泛型之间的较复杂的约束关系。不过这里我们单纯的是把它用于单个泛型约束。有的时候泛型过多或过长的时候我们也会用到这个关键字。这里只是为了各位读者对这个关键字的含义能够有一个初步的了解，以至于我们后面写到较复杂的关系的时候您不会感到陌生。一种典型的错误理解就是 `where` 是避免前面泛型写得过长而加上的语法糖。即使，我们经常是这样使用 `where` 的。不过它的常规用法（也就是只能使用 `where` 关键字的场合）实际上是描述两个或更多泛型之间存在一种依赖譬如： `where T:Into, U:Into` 这种情况。 362 | 363 | 此外，如果您拿不准什么时候使用 `if let` 可以安装 Clippy，当您的代码适合做出这样的调整的时候它会以警告的形式给出提示。 364 | 365 | 实际上我们通讯录的程序仍然是不完善的，因为我们没有考虑重名的联系人和一个人用多个电话的这两种情况。于是我们把程序作出一些简单的调整，让其支持这两个新功能： 366 | 367 | ```rust 368 | use std::fmt; 369 | use std::collections::HashMap; 370 | 371 | #[derive(Clone)] 372 | struct Contact { 373 | name: String, 374 | phone: Vec, 375 | } 376 | 377 | impl Contact { 378 | fn new>(new_name: T, new_phone: Vec) -> Self { 379 | Contact { 380 | name: new_name.into(), 381 | phone: new_phone, 382 | } 383 | } 384 | } 385 | 386 | impl fmt::Debug for Contact { 387 | fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> { 388 | let mut result = format!("联系人: {}", self.name); 389 | 390 | // 注意此处 for 循环的使用 391 | for (num, phone) in self.phone.iter().enumerate() { 392 | result = format!("{}\n电话{}: {}", result, num + 1, phone); 393 | } 394 | write!(f, "{}", result) 395 | } 396 | } 397 | 398 | #[derive(Clone)] 399 | struct ContactsData { 400 | list: Vec, 401 | index: HashMap>, 402 | } 403 | 404 | impl ContactsData { 405 | fn new() -> Self { 406 | ContactsData { 407 | list: Vec::new(), 408 | index: HashMap::new(), 409 | } 410 | } 411 | 412 | fn add>(&mut self, new_name: T, new_phone: Vec) { 413 | let name = new_name.into(); 414 | self.list.push(Contact::new(name.clone(), new_phone)); 415 | 416 | // 请注意这里的修改 417 | let person = self.index.entry(name.clone()).or_insert(Vec::new()); 418 | person.push(self.list.len() - 1); 419 | } 420 | 421 | fn query>(&self, name: T) -> Vec { 422 | let mut result: Vec = Vec::new(); 423 | if let Some(query_index) = self.index.get(&name.into()) { 424 | for i in query_index { 425 | result.push(self.list[*i].clone()); 426 | } 427 | } 428 | result 429 | } 430 | 431 | fn get_query_result_string>(&self, name: T) -> String { 432 | let _name = name.into(); 433 | if self.query(_name.clone()).is_empty() { 434 | return format!("没有找到联系人\"{}\"", _name); 435 | } 436 | 437 | let mut result = format!( 438 | "根据姓名\"{}\"找到了{}位联系人", 439 | _name.clone(), 440 | self.query(_name.clone()).len() 441 | ); 442 | for query_result in self.query(_name.clone()) { 443 | result = format!("{}\n----------\n{:?}", result, query_result); 444 | } 445 | result 446 | } 447 | } 448 | 449 | fn main() { 450 | let mut contacts = ContactsData::new(); 451 | contacts.add("刘祺", vec!["156********".to_string(), "130********".to_string()]); 452 | contacts.add("张三", vec!["130********".to_string()]); 453 | contacts.add("张三", vec!["156********".to_string()]); 454 | println!("{}", contacts.get_query_result_string("刘祺")); 455 | println!(); 456 | println!("{}", contacts.get_query_result_string("张三")); 457 | println!(); 458 | println!("{}", contacts.get_query_result_string("王五")); 459 | } 460 | ``` 461 | 462 | 笔者这里又引入了不少新东西。老规矩，我们从主函数看起。主函数里面的新东西还算比较少的。一个是 `vec!` 宏。这个宏用于创建一个可变数组并为其填充若干个初值。其次 `"130********".to_string()` 也是一个新东西。我们知道用双引号包裹的值的类型是 `&str` 而不是 `String`。那么 `to_string` 函数就可以把其转换为一个 `String` 类型的值。 463 | 464 | 465 | 接下来我们来看比较简单的 `add` 函数中的新内容： 466 | 467 | ```rust 468 | let person = self.index.entry(name.clone()).or_insert(Vec::new()); 469 | person.push(self.list.len() - 1); 470 | ``` 471 | 472 | 这是为了接受重名的联系人而准备的。这里比较需要讲的就是 `entry` 函数。它的一个使用技巧是统计某个字符串里面包含的各个字母分别有多少个。这也是标准库中给出的例子。不过它有一个比这种用法更为常规的用法，就是直接把哈希表中的一个元素拿出来直接修改。这里有一个模板，如果您懒得翻标准库去了解它具体是怎么写的可以参考它： `哈希表.entry(键).or_insert(如果键不存在插入的东西)`。 473 | 474 | 由于 Rust 的标准库是非常语义化的，以至于很多函数都不需要翻看标准库也能知道是做什么用的。譬如 `is_empty` 函数是返回值是否为空的。那么如果遇到了陌生的函数您可以翻阅标准库的文档。其文档的在线版本的网址是 [https://doc.rust-lang.org/std](https://doc.rust-lang.org/std)。标准库中的内容十分丰富，我们不可能一一赘述，所以这里笔者更愿意与您分享的是一种编程的方法，而不是逐句的把程序解释给您听。那是编译器和解释器干的事情。 475 | -------------------------------------------------------------------------------- /chapter2.md: -------------------------------------------------------------------------------- 1 | # 第2章 从零开始创建 Rust 库 2 | 3 | 在[快速入门](https://3442853561.gitbooks.io/rustcasestudymanual/content/chapter1.html)中我们学习了 Rust 的基础语法，特别是对于那些本来是学习别的语言的读者来说我们搞清楚了诸多语法细节。而从这一章开始我们就要真正的学习 Rust 语言了。由于我们学习的过程是由简及难的，所以整个过程中代码进行了反复的改动和重构。为了使这部分更加清晰，笔者给各部分增加了小标题。 4 | 5 | ## 创建库以及最开始的工作 6 | 7 | 我们可以通过 Rust 强大的包管理器—— Cargo 来创建一个库。您只需要在终端输入以下命令。 8 | 9 | ```shell 10 | cargo new --lib <库名称> 11 | ``` 12 | 13 | 这里我们用来做示范的库名称叫做 ```my_crate``` ,您会发现它的名称是使用蛇底写法的。然而这并不是一个好的库名称，好的库名称尽可能在库名上体现出您库的功能。就我们的示例库来说这是一个用于科学计算的基础库，当然我们只做了非常简单的矩阵运算的部分。您可以通过以下命令进入库目录。 14 | 15 | ```shell 16 | cd my_crate 17 | ``` 18 | 19 | 您可以通过 ```cargo build``` 来编译这个项目。具体的内容我们在[上一章](https://3442853561.gitbooks.io/rustcasestudymanual/content/chapter1.html)已经讲解过了，这里不再赘余。 20 | 21 | 现在请打开项目根目录下的 ```src``` 文件夹，会发现里面有一个名为 ```lib.rs``` 的文件。这个文件中包含了一个测试，以至于您一开始就可以通过 ```cargo test``` 来测试它是否可以正常运转。 22 | 23 | ```rust 24 | #[cfg(test)] 25 | mod tests { 26 | #[test] 27 | fn it_works() { 28 | assert_eq!(2 + 2, 4); 29 | } 30 | } 31 | ``` 32 | 33 | 不过暂时这是和我们工作无关的东西，我们直接删掉它就好了。不过这提醒了我们开发 Rust 程序的时候请务必注意测试驱动开发（TTD）这件事儿。 34 | 35 | ## 创建 ```Matrix``` 结构体 36 | 37 | ```rust 38 | struct Matrix { 39 | size: (usize, usize), 40 | data: Vec, 41 | default: T, 42 | } 43 | ``` 44 | 45 | 当然为了我们后期方便，现在为其实现 ```Clone``` 这个特征： 46 | 47 | ```rust 48 | #[derive(Clone)] 49 | struct Matrix { 50 | size: (usize, usize), 51 | data: Vec, 52 | default: T, 53 | } 54 | ``` 55 | 56 | 并且实现 ```new``` 方法和 ```Debug``` 特征： 57 | 58 | ```rust 59 | impl Matrix { 60 | // 这里的 new_height 和 new_width 的顺序是颠倒的 61 | // 理由是线性代数中习惯把纵向信息放在前面 62 | fn new(new_height: usize, new_width: usize, new_default: T) -> Self { 63 | Matrix { 64 | size: (new_width, new_height), 65 | data: vec![new_default.clone(); new_width * new_height], 66 | default: new_default, 67 | } 68 | } 69 | } 70 | 71 | use std::fmt; 72 | impl fmt::Debug for Matrix { 73 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 74 | // 这里将 size 类型分解为宽和高 75 | let (width, height) = self.size; 76 | let mut debug_string = "".to_string(); 77 | for h in 0..height { 78 | for w in 0..width { 79 | // format 宏的返回值总是 String 类型的 80 | debug_string += &*format!("{:?}, ", self.data[h*width+w]); 81 | } 82 | // 输入完一行之后需要增加一个换行符 83 | debug_string.push('\n'); 84 | } 85 | write!(f, "{}", debug_string) 86 | } 87 | } 88 | ``` 89 | 90 | 不要忘记测试驱动开发这件事儿，我们给这段程序写一个测试： 91 | 92 | ```rust 93 | #[test] 94 | fn test_new_matrix() { 95 | let my_matrix = Matrix::new(2, 5, 0); 96 | println!("{:?}", my_matrix); 97 | } 98 | ``` 99 | 100 | 在终端输入下面的命令就可以看测试结果了。如果您只写 ```cargo test``` 实际上是看不到输出的。 101 | 102 | ```shell 103 | cargo test -- --nocapture 104 | ``` 105 | 106 | 这里我们总是在 ```debug``` 里面写似乎不是一个好的解决方案，所以我们为其实现 ```ToString``` 特征： 107 | 108 | ```rust 109 | use std::fmt; 110 | impl fmt::Debug for Matrix { 111 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 112 | write!(f, "{}", self.to_string()) 113 | } 114 | } 115 | ``` 116 | 117 | 阅读下面的代码您会发现我们不仅仅是把代码转移了位置，并且增加了在矩阵过长时显示其转置矩阵的功能： 118 | 119 | ```rust 120 | impl ToString for Matrix 121 | where T: Clone + fmt::Debug{ 122 | fn to_string(&self) -> String { 123 | let mut result = "".to_string(); 124 | let (width, height) = self.size; 125 | 126 | if height == 1 { 127 | result += "[ "; 128 | for w in 0..width { 129 | result += &*format!("{:?} ", self.data[w]); 130 | } 131 | result += "]"; 132 | return result; 133 | } 134 | 135 | // 这一部分是获取输出的最大对齐 136 | let mut max_len_value = 0; 137 | for x in &self.data { 138 | let len = format!("{:?}", x).len(); 139 | if len > max_len_value { 140 | max_len_value = len; 141 | } 142 | } 143 | 144 | if height > width { 145 | // 这里有一个逻辑漏洞，我们以后再说 146 | result += "┌ "; 147 | for _ in 0..(max_len_value + 1)*height { 148 | result += " "; 149 | } 150 | result += "┐T\n"; 151 | for w in 0..width { 152 | result += "│ "; 153 | for h in 0..height { 154 | result += &*format!("{:?}", self.data[w*height+h]); 155 | for _ in format!("{:?}",self.data[w*height+h]).len()..max_len_value + 1{ 156 | result += " "; 157 | } 158 | } 159 | result += "│\n"; 160 | } 161 | result += "└ "; 162 | for _ in 0..(max_len_value + 1)*height { 163 | result += " "; 164 | } 165 | result += "┘"; 166 | } else { 167 | result += "┌ "; 168 | for _ in 0..(max_len_value + 1)*width { 169 | result += " "; 170 | } 171 | result += "┐\n"; 172 | for h in 0..height { 173 | result += "│ "; 174 | for w in 0..width { 175 | result += &*format!("{:?}", self.data[h*width+w]); 176 | for _ in format!("{:?}",self.data[h*width+w]).len()..max_len_value + 1{ 177 | result += " "; 178 | } 179 | } 180 | result += "│\n"; 181 | } 182 | result += "└ "; 183 | for _ in 0..(max_len_value + 1)*width { 184 | result += " "; 185 | } 186 | result += "┘"; 187 | } 188 | result 189 | } 190 | } 191 | ``` 192 | 193 | 增加完这部分代码后我们发现原本的 ```lib.rs``` 文件已经非常长了，这对于我们日后维护是一个极大的障碍。所以我们现在就对其进行分文件处理，在 ```lib.rs``` 只保留： 194 | 195 | ```rust 196 | pub mod matrix; 197 | ``` 198 | 199 | 目前的其他内容全选，并复制到名为 ```matrix.rs``` 的文件内，并对需要对外部暴露的自定义方法和类型进行 ```pub```: 200 | 201 | ```rust 202 | #[derive(Clone)] 203 | pub struct Matrix { 204 | size: (usize, usize), 205 | data: Vec, 206 | default: T, 207 | } 208 | 209 | impl Matrix { 210 | // 这里的 new_height 和 new_width 的顺序是颠倒的 211 | // 理由是线性代数中习惯把纵向信息放在前面 212 | pub fn new(new_height: usize, new_width: usize, new_default: T) -> Self { 213 | Matrix { 214 | size: (new_width, new_height), 215 | data: vec![new_default.clone(); new_width * new_height], 216 | default: new_default, 217 | } 218 | } 219 | } 220 | 221 | impl ToString for Matrix 222 | where T: Clone + fmt::Debug{ 223 | fn to_string(&self) -> String { 224 | let mut result = "".to_string(); 225 | let (width, height) = self.size; 226 | 227 | if height == 1 { 228 | result += "[ "; 229 | for w in 0..width { 230 | result += &*format!("{:?} ", self.data[w]); 231 | } 232 | result += "]"; 233 | return result; 234 | } 235 | 236 | // 这一部分是获取输出的最大对齐 237 | let mut max_len_value = 0; 238 | for x in &self.data { 239 | let len = format!("{:?}", x).len(); 240 | if len > max_len_value { 241 | max_len_value = len; 242 | } 243 | } 244 | 245 | if height > width { 246 | // 这里有一个逻辑漏洞，我们以后再说 247 | result += "┌ "; 248 | for _ in 0..(max_len_value + 1)*height { 249 | result += " "; 250 | } 251 | result += "┐T\n"; 252 | for w in 0..width { 253 | result += "│ "; 254 | for h in 0..height { 255 | result += &*format!("{:?}", self.data[w*height+h]); 256 | for _ in format!("{:?}",self.data[w*height+h]).len()..max_len_value + 1{ 257 | result += " "; 258 | } 259 | } 260 | result += "│\n"; 261 | } 262 | result += "└ "; 263 | for _ in 0..(max_len_value + 1)*height { 264 | result += " "; 265 | } 266 | result += "┘"; 267 | } else { 268 | result += "┌ "; 269 | for _ in 0..(max_len_value + 1)*width { 270 | result += " "; 271 | } 272 | result += "┐\n"; 273 | for h in 0..height { 274 | result += "│ "; 275 | for w in 0..width { 276 | result += &*format!("{:?}", self.data[h*width+w]); 277 | for _ in format!("{:?}",self.data[h*width+w]).len()..max_len_value + 1{ 278 | result += " "; 279 | } 280 | } 281 | result += "│\n"; 282 | } 283 | result += "└ "; 284 | for _ in 0..(max_len_value + 1)*width { 285 | result += " "; 286 | } 287 | result += "┘"; 288 | } 289 | result 290 | } 291 | } 292 | 293 | use std::fmt; 294 | impl fmt::Debug for Matrix { 295 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 296 | write!(f, "{}", self.to_string()) 297 | } 298 | } 299 | 300 | #[test] 301 | fn test_new_matrix() { 302 | let my_matrix = Matrix::new(5, 2, 0); 303 | println!("{:?}", my_matrix); 304 | let another_matrix = Matrix::new(2, 5, 1); 305 | println!("{:?}", another_matrix); 306 | let yet_another_matrix = Matrix::new(1, 10, 2); 307 | println!("{:?}", yet_another_matrix); 308 | } 309 | ``` 310 | 311 | 接下来我们发现每次访问矩阵中的元素都不太方便，所以我们为其添加方便访问的一些特征。主要就是下面的 ```Index``` 和 ```IndexMut``` 这两个特征： 312 | 313 | ```rust 314 | use std::ops::{Index, IndexMut}; 315 | 316 | impl Index<(usize, usize)> for Matrix { 317 | type Output = T; 318 | fn index(&self, ind: (usize, usize)) -> &T { 319 | let (i, j) = ind; 320 | let (width, _) = self.size; 321 | &self.data[i*width+j] 322 | } 323 | } 324 | 325 | impl IndexMut<(usize, usize)> for Matrix { 326 | fn index_mut(&mut self, ind: (usize, usize)) -> &mut T { 327 | let (i, j) = ind; 328 | let (width, _) = self.size; 329 | &mut self.data[i*width+j] 330 | } 331 | } 332 | 333 | #[test] 334 | fn test_matrix_can_get_set() { 335 | let mut my_matrix = Matrix::new(2, 5, 0); 336 | my_matrix[(0, 1)] = 1; 337 | println!("{:?}", my_matrix); 338 | } 339 | ``` 340 | 341 | 写到这里您就会发现我们之前说的逻辑漏洞在什么地方，这里我们顺便把我们之前写的内容重构一下。 342 | 343 | 344 | --------------------------------------------------------------------------------