使用结构体的示例程序
为了理解何时可能需要使用结构体,让我们编写一个计算矩形面积的程序。我们将从使用单个变量开始,然后重构程序,直到使用结构体。
让我们使用 Cargo 创建一个名为 *rectangles* 的新二进制项目,该项目将获取以像素为单位指定的矩形的宽度和高度,并计算矩形的面积。清单 5-8 展示了一个简短的程序,该程序在我们项目的 *src/main.rs* 中以一种方式完成了这项工作。
文件名:src/main.rs
fn main() { let width1 = 30; let height1 = 50; println!( "The area of the rectangle is {} square pixels.", area(width1, height1) ); } fn area(width: u32, height: u32) -> u32 { width * height }
现在,使用 cargo run
运行此程序
$ cargo run
Compiling rectangles v0.1.0 (file:///projects/rectangles)
Finished dev [unoptimized + debuginfo] target(s) in 0.42s
Running `target/debug/rectangles`
The area of the rectangle is 1500 square pixels.
这段代码通过使用每个维度调用 area
函数成功计算出了矩形的面积,但我们可以做更多的事情来使这段代码更加清晰易读。
这段代码的问题在 area
的签名中很明显
fn main() {
let width1 = 30;
let height1 = 50;
println!(
"The area of the rectangle is {} square pixels.",
area(width1, height1)
);
}
fn area(width: u32, height: u32) -> u32 {
width * height
}
area
函数应该计算一个矩形的面积,但我们编写的函数有两个参数,并且在程序的任何地方都没有明确说明这两个参数是相关的。将宽度和高度组合在一起会更具可读性和可管理性。我们已经在第 3 章的 “元组类型” 部分讨论了一种可能的方法:使用元组。第 3 章:使用元组。
使用元组重构
清单 5-9 展示了我们程序的另一个版本,该版本使用了元组。
文件名:src/main.rs
fn main() { let rect1 = (30, 50); println!( "The area of the rectangle is {} square pixels.", area(rect1) ); } fn area(dimensions: (u32, u32)) -> u32 { dimensions.0 * dimensions.1 }
从某种程度上来说,这个程序更好。元组让我们可以添加一些结构,并且我们现在只传递一个参数。但从另一方面来说,这个版本不太清晰:元组没有为其元素命名,因此我们必须索引到元组的各个部分,这使得我们的计算不太明显。
混合宽度和高度对面积计算没有影响,但如果我们想在屏幕上绘制矩形,那就有影响了!我们必须记住 width
是元组索引 0
,而 height
是元组索引 1
。如果其他人要使用我们的代码,这将更难理解和记住。因为我们没有在代码中传达数据的含义,所以现在更容易引入错误。
使用结构体重构:添加更多含义
我们使用结构体通过标记数据来添加含义。我们可以将我们正在使用的元组转换为一个结构体,该结构体具有整体名称以及各个部分的名称,如清单 5-10 所示。
文件名:src/main.rs
struct Rectangle { width: u32, height: u32, } fn main() { let rect1 = Rectangle { width: 30, height: 50, }; println!( "The area of the rectangle is {} square pixels.", area(&rect1) ); } fn area(rectangle: &Rectangle) -> u32 { rectangle.width * rectangle.height }
在这里,我们定义了一个名为 Rectangle
的结构体。在大括号内,我们将字段定义为 width
和 height
,它们都具有 u32
类型。然后,在 main
中,我们创建了一个 Rectangle
的特定实例,其宽度为 30
,高度为 50
。
我们的 area
函数现在定义了一个参数,我们将其命名为 rectangle
,其类型是对结构体 Rectangle
实例的不可变借用。如第 4 章所述,我们希望借用结构体而不是获取其所有权。这样,main
保留其所有权并可以继续使用 rect1
,这就是我们在函数签名和调用函数的地方使用 &
的原因。
area
函数访问 Rectangle
实例的 width
和 height
字段(请注意,访问借用结构体实例的字段不会移动字段值,这就是为什么您经常看到结构体的借用)。我们现在对 area
的函数签名准确地表达了我们的意思:使用 Rectangle
的 width
和 height
字段计算其面积。这传达了宽度和高度是相互关联的,并且它为值提供了描述性名称,而不是使用元组索引值 0
和 1
。这对清晰度来说是一个胜利。
使用派生 trait 添加实用功能
在调试程序时,如果能够打印 Rectangle
的实例并查看其所有字段的值,那将会很有用。清单 5-11 尝试使用我们在前面章节中使用过的 println!
宏。但是,这行不通。
文件名:src/main.rs
struct Rectangle {
width: u32,
height: u32,
}
fn main() {
let rect1 = Rectangle {
width: 30,
height: 50,
};
println!("rect1 is {}", rect1);
}
当我们编译此代码时,我们会收到一条包含此核心消息的错误
error[E0277]: `Rectangle` doesn't implement `std::fmt::Display`
println!
宏可以进行多种格式化,默认情况下,花括号告诉 println!
使用称为 Display
的格式化:用于直接面向最终用户使用的输出。到目前为止,我们看到的原始类型默认实现了 Display
,因为您只想向用户显示 1
或任何其他原始类型的方式只有一种。但是对于结构体,println!
应该如何格式化输出就不那么清楚了,因为有更多显示的可能性:您是否需要逗号?您是否要打印花括号?是否应该显示所有字段?由于这种歧义,Rust 不会尝试猜测我们想要什么,并且结构体没有提供 Display
的实现以与 println!
和 {}
占位符一起使用。
如果我们继续阅读错误,我们会发现这条有用的提示
= help: the trait `std::fmt::Display` is not implemented for `Rectangle`
= note: in format strings you may be able to use `{:?}` (or {:#?} for pretty-print) instead
让我们试试吧!println!
宏调用现在看起来像 println!("rect1 is {:?}", rect1);
。将说明符 :?
放在花括号内告诉 println!
我们要使用一种称为 Debug
的输出格式。Debug
trait 使我们能够以对开发人员有用的方式打印我们的结构体,以便我们可以在调试代码时查看其值。
使用此更改编译代码。糟糕!我们仍然收到错误
error[E0277]: `Rectangle` doesn't implement `Debug`
但是,编译器再次给了我们一条有用的提示
= help: the trait `Debug` is not implemented for `Rectangle`
= note: add `#[derive(Debug)]` to `Rectangle` or manually `impl Debug for Rectangle`
Rust 确实 包含打印调试信息的函数,但我们必须明确选择加入才能使该函数可用于我们的结构体。为此,我们在结构体定义之前添加外部属性 #[derive(Debug)]
,如清单 5-12 所示。
文件名:src/main.rs
#[derive(Debug)] struct Rectangle { width: u32, height: u32, } fn main() { let rect1 = Rectangle { width: 30, height: 50, }; println!("rect1 is {rect1:?}"); }
现在,当我们运行程序时,我们将不会收到任何错误,并且我们将看到以下输出
$ cargo run
Compiling rectangles v0.1.0 (file:///projects/rectangles)
Finished dev [unoptimized + debuginfo] target(s) in 0.48s
Running `target/debug/rectangles`
rect1 is Rectangle { width: 30, height: 50 }
不错!这不是最漂亮的输出,但它显示了此实例的所有字段的值,这在调试期间肯定会有所帮助。当我们有更大的结构体时,拥有更易于阅读的输出会很有用;在这些情况下,我们可以在 println!
字符串中使用 {:#?}
而不是 {:?}
。在此示例中,使用 {:#?}
样式将输出以下内容
$ cargo run
Compiling rectangles v0.1.0 (file:///projects/rectangles)
Finished dev [unoptimized + debuginfo] target(s) in 0.48s
Running `target/debug/rectangles`
rect1 is Rectangle {
width: 30,
height: 50,
}
使用 Debug
格式打印值的另一种方法是使用 dbg!
宏,它获取表达式的所有权(与获取引用的 println!
相反),打印代码中 dbg!
宏调用所在的文件和行号以及该表达式的结果值,并返回该值的所有权。
注意:调用
dbg!
宏会打印到标准错误控制台流 (stderr
),而不是打印到标准输出控制台流 (stdout
) 的println!
。我们将在第 12 章的“将错误消息写入标准错误而不是标准输出”部分中详细讨论stderr
和stdout
.
这是一个示例,我们对分配给 width
字段的值以及 rect1
中整个结构体的值感兴趣
#[derive(Debug)] struct Rectangle { width: u32, height: u32, } fn main() { let scale = 2; let rect1 = Rectangle { width: dbg!(30 * scale), height: 50, }; dbg!(&rect1); }
我们可以将 dbg!
放在表达式 30 * scale
周围,并且由于 dbg!
返回表达式值的所有权,因此 width
字段将获得与我们没有 dbg!
调用时相同的值。我们不希望 dbg!
获取 rect1
的所有权,因此我们在下一次调用中使用对 rect1
的引用。以下是此示例的输出
$ cargo run
Compiling rectangles v0.1.0 (file:///projects/rectangles)
Finished dev [unoptimized + debuginfo] target(s) in 0.61s
Running `target/debug/rectangles`
[src/main.rs:10:16] 30 * scale = 60
[src/main.rs:14:5] &rect1 = Rectangle {
width: 60,
height: 50,
}
我们可以看到第一部分输出来自 src/main.rs 第 10 行,我们正在调试表达式 30 * scale
,其结果值为 60
(为整数实现的 Debug
格式是仅打印其值)。src/main.rs 第 14 行的 dbg!
调用输出 &rect1
的值,它是 Rectangle
结构体。此输出使用 Rectangle
类型的漂亮 Debug
格式。当您试图弄清楚您的代码在做什么时,dbg!
宏真的很有帮助!
除了 Debug
trait 之外,Rust 还提供了一些 trait 供我们与 derive
属性一起使用,这些 trait 可以为我们的自定义类型添加有用的行为。这些 trait 及其行为在附录 C中列出。我们将在第 10 章介绍如何使用自定义行为实现这些 trait 以及如何创建您自己的 trait。除了 derive
之外,还有许多其他属性;有关更多信息,请参阅Rust 参考的“属性”部分。
我们的 area
函数非常具体:它只计算矩形的面积。将此行为与我们的 Rectangle
结构体更紧密地联系起来会很有帮助,因为它不适用于任何其他类型。让我们看看如何通过将 area
函数转换为在我们的 Rectangle
类型上定义的 area
方法 来继续重构此代码。