从Millionaires例子学习Rust
首先,我们通过cargo package manager创建Millionaires项目:
cargo new rust_millionaires_problem # create a new project
cd rust_millionaires_problem # navigate to directory
cargo new
会自动创建一个可以打印Hello, world!的源代码:src/main.rs
。之后的逻辑都会在src/lib.rs
当中,在src/main.rs
里调用lib.rs
库里的函数。
Millionaires的逻辑十分简单,创建两个账户Bob, Alice,他们分别有对应的账户余额。逻辑中需要提供一个函数来判断谁的余额比较多。
首先我们定义实现逻辑的数据结构。这里使用Rust当中的结构体,因为其可以将一些变量整合成一个结构。我们在src/lib.rs
中首先定义Millionaire
结构:
pub struct Millionaire {
address: String,
net_worth: u64,
}
这里我们可以看到,每个Millionaire结构都有两个域:地址和对应的余额。在结构体的定义中,每个域均为一个域名和域类型的对:<field name>: <filed type>
。在Rust中,可以通过以下代码实例化结构体:
let alice = Millionaire {
address: String::from('Alice'),
net_worth: 2000000,
}
上述代码中,我们可以看到,Rust使用let
关键字定义变量,需要注意,Rust的变量默认为immutable,意味不可变。如需使用可变变量,则需要在let
后面加上mut
。这里定义了alice
变量,其中address
域设置为Alice
的字符串,net_worth
被设置为2000000。在实例化结构体时,通过设置key: value
来对每个域进行初始化。
为了存储多个Millionaire结构体,我们需要定义另外一个结构体:
pub struct MillionairesProblem {
millionaires: Vec<Millionare>,
}
这里我们在MillionaireProblem
中定义了类型为Vec<Millionare>
的millionaires
域。Rust中的Vec
可以存储一些列相同类型的变量,并且可以进行添加和删除。
下面我们定义与结构体对应的函数。和面向对象程序设计一样,类可以定义对应的实例方法和类方法。实例方法用于实例化的变量中,类方法可以直接通过类名进行调用,一般为工具函数。在Rust中,我们使用impl
块来定义结构体对应的函数。
impl MillionairesProblem {
//
}
初始化一个MillionaresProblem
我们将以下函数添加到impl MillionairesProblem
块中:
pub fn new () -> MillionairesProblem {
MillionairesProblem {
millionaires: Vec::new(),
}
}
这里:
- 函数定义使用
fn
关键字,如有返回值,使用->
加返回值类型 - 函数体可以包含表达式(expressions)或者陈述(statements)。表达式是没有分好做结尾的,可以将表达式的值作为返回值。陈述是以分号做结尾的,没有返回值。这里我们可以看到我们使用表达式定义了
MillionairesProblem
这样一个变量(结尾没有分号),所以其被作为函数的返回值。 -
MillionairesProblem
结构体实例的初始化时使用key: value
对来初始化对应的域。这里对millionaires
域使用Vec::new()
进行初始化,Vec::new()
是Vec初始化的函数。
添加一个Millionaire
同样将以下函数添加到impl MillionairesProblem
块中
pub fn add_millionaire(&mut self, address: String, net_worth: u64) {
let millionaire = Millionaire {
address,
net_worth,
};
self.millionaires.push(millionaire);
}
注意:
- 此函数没有返回值。
- 函数的参数使用:
param_1: <type>, param_2: <type>, …, param_n: <type>
- 作为实例方法,首个参数应为
self
,指代实例本身。这里用到&mut self
因为MillionairesProblem
需要有写入操作,所以设置为可变。&
操作符意思是函数不会改变参数的属主(属主为Rust特有的特性 ownership) - 使用
push
函数增加元素到Vec中。
计算谁更富有
将以下函数添加到impl
块中
pub fn compute_richest(&self) -> &str {
match self.millionaires.iter().max_by_key(|m| m.net_worth) {
Some(millionaire) => &millionaire.address[..],
None => "None"
}
}
- 由于在计算谁更富有的时候不需要写操作,所以使用
&self
,而没有加mut
。 - 这里使用了
match
关键字,其中包含多个分支。如果分支条件成立,则执行分支后的代码。我们是基于net_worth
来判断谁更富有。所以self.millionaires.iter().max_by_key(|m| m.net_worth)
尤为关键。它会根据net_worth
来判断,并返回Option
类型的enum。Option
含有两种情况:Some
和None
。如果执行的值为有效,则会使用Some
,并且可以提取出其中的值millionaire
。如果值为无效,则使用None
。
总结以上内容,src/lib.rs
的内容如下:
pub struct Millionaire {
address: String,
net_worth: u64,
}
pub struct MillionairesProblem {
millionaires: Vec<Millionaire>,
}
impl MillionairesProblem {
pub fn new() -> MillionairesProblem {
MillionairesProblem {
millionaires: Vec::new(),
}
}
pub fn add_millionaire(&mut self, address: String, net_worth: u64) {
let millionaire = Millionaire {
address,
net_worth,
};
self.millionaires.push(millionaire);
}
pub fn compute_richest(&self) -> &str {
match self.millionaires.iter().max_by_key(|m| m.net_worth) {
Some(millionaire) => &millionaire.address[..],
None => "None"
}
}
}
有了library之后,如何和library进行交互呢?
我们需要使用src/main.rs
来调用library。
在main.rs
中添加以下内容:
extern crate rust_millionaires_problem;
use rust_millionaires_problem::MillionairesProblem;
fn main() {
let mut millionaires_problem = MillionairesProblem::new();
millionaires_problem.add_millionaire(String::from("Bob"), 1000000);
millionaires_problem.add_millionaire(String::from("Alice"), 2000000);
let richest = millionaires_problem.compute_richest();
println!("Richest millionaire = {}", richest);
}
- 前两行是讲library库的内容引入到此文件中,同时声明会使用
MillionairesProblem
这个结构体。 - 在
main
当中,我们首先定义了可变化的millionaires_problem
变量。然后使用add_millionaire
函数添加两个账户Alice, Bob。最后使用compute_richest()
来计算谁更富有。计算后打印出richest
。
使用cargo run
执行:
$ cargo run
Compiling rust_millionaires_problem v0.1.0 (<path>/rust_millionaires_problem)
Finished dev [unoptimized + debuginfo] target(s) in 0.69s
Running `target/debug/rust_millionaires_problem`
Richest millionaire = Alice