宏 - Rust 程序设计语言

宏

我们在本书中已经使用过像 println! 这样的宏，但还没有完全探讨宏是什么以及它是如何工作的。宏（macro）指的是 Rust 中的一系列特性——使用 macro_rules! 的声明宏（declarative macro），以及三种过程宏（procedural macro）：

自定义 #[derive] 宏，用于指定通过 derive 属性为结构体和枚举添加的代码
类属性宏，定义可用于任何条目的自定义属性
类函数宏，看起来像函数调用，但操作的是作为其参数指定的标记（token）

我们将依次讨论这些宏，但首先，让我们看看既然已经有了函数，为什么还需要宏。

宏与函数的区别

从根本上说，宏是一种编写生成其他代码的代码的方式，这被称为元编程（metaprogramming）。在附录 C 中，我们讨论了 derive 属性，它会为你生成各种 trait 的实现。我们在本书中还使用了 println! 和 vec! 宏。所有这些宏都会展开以生成比你手动编写的代码更多的代码。

元编程有助于减少你必须编写和维护的代码量，这也是函数的作用之一。然而，宏拥有一些函数所不具备的额外能力。

函数签名必须声明函数所拥有的参数数量和类型。而宏则可以接受可变数量的参数：我们可以用一个参数调用 println!("hello")，也可以用两个参数调用 println!("hello {}", name)。此外，宏在编译器解释代码含义之前就会展开，因此宏可以（例如）为给定类型实现 trait。而函数做不到这一点，因为函数在运行时才被调用，而 trait 需要在编译时实现。

实现宏而非函数的缺点在于宏定义比函数定义更复杂，因为你是在编写生成 Rust 代码的 Rust 代码。由于这种间接性，宏定义通常比函数定义更难阅读、理解和维护。

宏和函数之间的另一个重要区别是：在文件中调用宏之前，必须先定义宏或将宏引入作用域；而函数则可以在任何地方定义、在任何地方调用。

Rust 中使用最广泛的宏形式是声明宏（declarative macro）。它们有时也被称为“示例宏”（macros by example）、“macro_rules! 宏”，或者干脆就叫“宏”。声明宏的核心是允许你编写类似 Rust match 表达式的东西。如第 6 章所述，match 表达式是一种控制结构，它接收一个表达式，将表达式的结果值与模式进行比较，然后运行与匹配模式相关联的代码。宏也会将一个值与关联特定代码的模式进行比较：在这种情况下，值是传递给宏的字面 Rust 源代码；模式与该源代码的结构进行比较；而与每个模式相关联的代码在匹配时会替换传递给宏的代码。这一切都发生在编译期间。

要定义宏，需要使用 macro_rules! 构造。让我们通过查看 vec! 宏的定义来探索如何使用 macro_rules!。第 8 章介绍了如何使用 vec! 宏创建具有特定值的新 vector。例如，下面的宏创建了一个包含三个整数的新 vector：

#![allow(unused)]
fn main() {
let v: Vec<u32> = vec![1, 2, 3];
}

我们也可以使用 vec! 宏来创建包含两个整数的 vector，或者包含五个字符串切片的 vector。我们无法用函数做到同样的事情，因为我们无法预先知道值的数量或类型。

示例 20-35 展示了 vec! 宏的一个稍微简化的定义。

文件名：src/lib.rs

#[macro_export]
macro_rules! vec {
    ( $( $x:expr ),* ) => {
        {
            let mut temp_vec = Vec::new();
            $(
                temp_vec.push($x);
            )*
            temp_vec
        }
    };
}

示例 20-35：vec! 宏定义的简化版本

注意：标准库中 vec! 宏的实际定义包含预先分配正确数量内存的代码。该代码是一种优化，为了让示例更简单，我们此处没有包含它。

#[macro_export] 注解表明，只要定义该宏的 crate 被引入作用域，这个宏就应该可用。如果没有这个注解，宏就无法被引入作用域。

然后我们使用 macro_rules! 和要定义的宏的名称（不带感叹号）开始宏定义。名称（在这个例子中是 vec）后面跟着花括号，表示宏定义的主体。

vec! 主体中的结构类似于 match 表达式的结构。这里我们有一个分支，其模式为 ( $( $x:expr ),* )，后面跟着 => 和与此模式相关联的代码块。如果模式匹配，就会生成相关联的代码块。鉴于这是该宏中唯一的模式，因此只有一种有效的匹配方式；任何其他模式都会导致错误。更复杂的宏会有多个分支。

宏定义中有效的模式语法与第 19 章介绍的模式语法不同，因为宏模式匹配的是 Rust 代码结构而不是值。让我们逐步了解示例 20-29 中模式片段的含义；有关完整的宏模式语法，请参阅 Rust 参考手册。

首先，我们使用一组圆括号来包含整个模式。我们使用美元符号（$）在宏系统中声明一个变量，该变量将包含与模式匹配的 Rust 代码。美元符号清楚地表明这是一个宏变量，而不是普通的 Rust 变量。接下来是一组圆括号，它捕获与圆括号内模式匹配的值，以供替换代码使用。$() 内是 $x:expr，它匹配任何 Rust 表达式，并将该表达式命名为 $x。

$() 后面的逗号表示在每个匹配 $() 中代码的实例之间必须出现一个字面逗号分隔符。* 指定该模式匹配 * 之前内容的零次或多次出现。

当我们用 vec![1, 2, 3]; 调用这个宏时，$x 模式会与三个表达式 1、2 和 3 匹配三次。

现在让我们看看与此分支关联的主体代码中的模式：$()* 内的 temp_vec.push() 会根据模式匹配的次数，为模式中匹配 $() 的每个部分生成零次或多次。$x 会被替换为每个匹配的表达式。当我们用 vec![1, 2, 3]; 调用这个宏时，生成的用于替换此宏调用的代码如下：

{
    let mut temp_vec = Vec::new();
    temp_vec.push(1);
    temp_vec.push(2);
    temp_vec.push(3);
    temp_vec
}

我们定义了一个宏，它可以接受任意数量、任意类型的参数，并生成创建包含指定元素的 vector 的代码。

要进一步了解如何编写宏，请查阅在线文档或其他资源，例如由 Daniel Keep 发起、Lukas Wirth 继续维护的《The Little Book of Rust Macros》。

从属性生成代码的过程宏

第二种宏形式是过程宏，它更像函数（并且是一种过程）。过程宏（procedural macro）接受一些代码作为输入，对这些代码进行操作，然后生成一些代码作为输出，而不是像声明宏那样进行模式匹配并用其他代码替换原有代码。三种过程宏——自定义 derive、类属性和类函数——都以类似的方式工作。

创建过程宏时，其定义必须位于它们自己的 crate 中，并使用特殊的 crate 类型。这是出于复杂的技术原因，我们希望将来能够消除这些原因。在示例 20-36 中，我们展示了如何定义过程宏，其中 some_attribute 是使用特定宏种类的占位符。

文件名：src/lib.rs

use proc_macro::TokenStream;

#[some_attribute]
pub fn some_name(input: TokenStream) -> TokenStream {
}

示例 20-36：定义过程宏的示例

定义过程宏的函数接受 TokenStream 作为输入，并生成 TokenStream 作为输出。TokenStream 类型由 Rust 附带的 proc_macro crate 定义，表示一系列标记（token）。这是宏的核心：宏所操作的源代码构成输入 TokenStream，宏生成的代码是输出 TokenStream。函数还附加了一个属性，用于指定我们正在创建哪种过程宏。我们可以在同一个 crate 中拥有多种过程宏。

让我们看看不同种类的过程宏。我们将从自定义 derive 宏开始，然后解释使其他形式略有不同的小差异。

自定义 `derive` 宏

让我们创建一个名为 hello_macro 的 crate，它定义一个名为 HelloMacro 的 trait，其中有一个名为 hello_macro 的关联函数。我们不会让用户为他们的每个类型都实现 HelloMacro trait，而是提供一个过程宏，让用户可以用 #[derive(HelloMacro)] 注解他们的类型，从而获得 hello_macro 函数的默认实现。默认实现将打印 Hello, Macro! My name is TypeName!，其中 TypeName 是定义此 trait 的类型的名称。换句话说，我们将编写一个 crate，使另一位程序员能够使用我们的 crate 编写出如示例 20-37 所示的代码。

文件名：src/main.rs

use hello_macro::HelloMacro;
use hello_macro_derive::HelloMacro;

#[derive(HelloMacro)]
struct Pancakes;

fn main() {
    Pancakes::hello_macro();
}

示例 20-37：使用我们的过程宏时，crate 用户能够编写的代码

完成后，这段代码将打印 Hello, Macro! My name is Pancakes!。第一步是创建一个新的库 crate，如下所示：

$ cargo new hello_macro --lib

接下来，在示例 20-38 中，我们将定义 HelloMacro trait 及其关联函数。

文件名：src/lib.rs

pub trait HelloMacro {
    fn hello_macro();
}

示例 20-38：我们将与 derive 宏一起使用的简单 trait

我们有了一个 trait 及其函数。此时，我们的 crate 用户可以实现该 trait 来实现所需的功能，如示例 20-39 所示。

文件名：src/main.rs

use hello_macro::HelloMacro;

struct Pancakes;

impl HelloMacro for Pancakes {
    fn hello_macro() {
        println!("Hello, Macro! My name is Pancakes!");
    }
}

fn main() {
    Pancakes::hello_macro();
}

示例 20-39：用户手动实现 HelloMacro trait 时的样子

然而，他们需要为每个想与 hello_macro 一起使用的类型编写实现块；我们希望免去他们做这项工作的麻烦。

此外，我们还无法为 hello_macro 函数提供默认实现来打印该 trait 所实现类型的名称：Rust 没有反射能力，因此无法在运行时查找类型的名称。我们需要一个宏在编译时生成代码。

下一步是定义过程宏。在撰写本文时，过程宏需要位于它们自己的 crate 中。最终，这一限制可能会被取消。组织 crate 和宏 crate 的约定如下：对于名为 foo 的 crate，自定义 derive 过程宏 crate 称为 foo_derive。让我们在 hello_macro 项目内启动一个名为 hello_macro_derive 的新 crate：

$ cargo new hello_macro_derive --lib

我们的两个 crate 紧密相关，所以我们在 hello_macro crate 的目录中创建过程宏 crate。如果我们更改 hello_macro 中的 trait 定义，也必须更改 hello_macro_derive 中过程宏的实现。这两个 crate 需要分别发布，使用这些 crate 的程序员需要将两者都添加为依赖并将它们都引入作用域。我们也可以让 hello_macro crate 将 hello_macro_derive 作为依赖，并重新导出过程宏代码。然而，我们组织项目的方式使得程序员即使不想要 derive 功能也可以使用 hello_macro。

我们需要将 hello_macro_derive crate 声明为过程宏 crate。我们还需要 syn 和 quote crate 的功能（稍后你会看到），因此需要将它们添加为依赖。将以下内容添加到 hello_macro_derive 的 Cargo.toml 文件中：

文件名：hello_macro_derive/Cargo.toml

[lib]
proc-macro = true

[dependencies]
syn = "2.0"
quote = "1.0"

要开始定义过程宏，请将示例 20-40 中的代码放入 hello_macro_derive crate 的 src/lib.rs 文件中。请注意，在我们为 impl_hello_macro 函数添加定义之前，这段代码无法编译。

文件名：hello_macro_derive/src/lib.rs

use proc_macro::TokenStream;
use quote::quote;

#[proc_macro_derive(HelloMacro)]
pub fn hello_macro_derive(input: TokenStream) -> TokenStream {
    // Construct a representation of Rust code as a syntax tree
    // that we can manipulate.
    let ast = syn::parse(input).unwrap();

    // Build the trait implementation.
    impl_hello_macro(&ast)
}

示例 20-40：大多数过程宏 crate 处理 Rust 代码时所需的代码

请注意，我们将代码拆分为 hello_macro_derive 函数（负责解析 TokenStream）和 impl_hello_macro 函数（负责转换语法树）：这使得编写过程宏更加方便。外部函数（在本例中为 hello_macro_derive）中的代码对于你看到或创建的几乎每个过程宏 crate 都是相同的。你在内部函数（在本例中为 impl_hello_macro）主体中指定的代码将根据过程宏的用途而有所不同。

我们引入了三个新 crate：proc_macro、syn 和 quote。proc_macro crate 随 Rust 一起提供，因此我们不需要将其添加到 Cargo.toml 的依赖中。proc_macro crate 是编译器的 API，允许我们从代码中读取和操作 Rust 代码。

syn crate 将 Rust 代码从字符串解析为我们可以对其执行操作的数据结构。quote crate 将 syn 数据结构转换回 Rust 代码。这些 crate 使解析我们可能要处理的任何类型的 Rust 代码变得更加简单：为 Rust 代码编写完整的解析器绝非易事。

当我们的库用户在类型上指定 #[derive(HelloMacro)] 时，hello_macro_derive 函数将被调用。这是可能的，因为我们在这里用 proc_macro_derive 注解了 hello_macro_derive 函数，并指定了与 trait 名称匹配的 HelloMacro 名称；这是大多数过程宏遵循的约定。

hello_macro_derive 函数首先将 input 从 TokenStream 转换为我们可以解释并执行操作的数据结构。这就是 syn 发挥作用的地方。syn 中的 parse 函数接受 TokenStream 并返回表示已解析 Rust 代码的 DeriveInput 结构体。示例 20-41 展示了我们从解析 struct Pancakes; 字符串获得的 DeriveInput 结构体的相关部分。

DeriveInput {
    // --snip--

    ident: Ident {
        ident: "Pancakes",
        span: #0 bytes(95..103)
    },
    data: Struct(
        DataStruct {
            struct_token: Struct,
            fields: Unit,
            semi_token: Some(
                Semi
            )
        }
    )
}

示例 20-41：解析示例 20-37 中带有宏属性的代码时获得的 DeriveInput 实例

这个结构体的字段表明，我们解析的 Rust 代码是一个单元结构体，其 ident（标识符，即名称）为 Pancakes。这个结构体上有更多字段用于描述各种 Rust 代码；查看 DeriveInput 的 syn 文档以获取更多信息。

很快我们将定义 impl_hello_macro 函数，我们将在那里构建要包含的新 Rust 代码。但在此之前，请注意我们的 derive 宏的输出也是一个 TokenStream。返回的 TokenStream 会被添加到 crate 用户编写的代码中，因此当他们编译自己的 crate 时，将获得我们在修改后的 TokenStream 中提供的额外功能。

你可能已经注意到，我们调用 unwrap 使 hello_macro_derive 函数在 syn::parse 函数调用失败时 panic。过程宏在出错时必须 panic，因为 proc_macro_derive 函数必须返回 TokenStream 而不是 Result，以符合过程宏 API。我们在这里使用 unwrap 简化了这个示例；在生产代码中，你应该使用 panic! 或 expect 提供关于出了什么问题的更具体的错误信息。

现在我们有了将带注解的 Rust 代码从 TokenStream 转换为 DeriveInput 实例的代码，让我们生成在带注解类型上实现 HelloMacro trait 的代码，如示例 20-42 所示。

文件名：hello_macro_derive/src/lib.rs

use proc_macro::TokenStream;
use quote::quote;

#[proc_macro_derive(HelloMacro)]
pub fn hello_macro_derive(input: TokenStream) -> TokenStream {
    // Construct a representation of Rust code as a syntax tree
    // that we can manipulate
    let ast = syn::parse(input).unwrap();

    // Build the trait implementation
    impl_hello_macro(&ast)
}

fn impl_hello_macro(ast: &syn::DeriveInput) -> TokenStream {
    let name = &ast.ident;
    let generated = quote! {
        impl HelloMacro for #name {
            fn hello_macro() {
                println!("Hello, Macro! My name is {}!", stringify!(#name));
            }
        }
    };
    generated.into()
}

示例 20-42：使用解析后的 Rust 代码实现 HelloMacro trait

我们使用 ast.ident 获取包含带注解类型名称（标识符）的 Ident 结构体实例。示例 20-41 中的结构体表明，当我们对示例 20-37 中的代码运行 impl_hello_macro 函数时，获得的 ident 的 ident 字段值将为 "Pancakes"。因此，示例 20-42 中的 name 变量将包含一个 Ident 结构体实例，打印时将是字符串 "Pancakes"，即示例 20-37 中结构体的名称。

quote! 宏让我们定义想要返回的 Rust 代码。编译器期望的结果与 quote! 宏执行的直接结果不同，因此我们需要将其转换为 TokenStream。我们通过调用 into 方法来实现这一点，该方法消耗这个中间表示并返回所需的 TokenStream 类型的值。

quote! 宏还提供了一些非常酷的模板机制：我们可以输入 #name，quote! 会用变量 name 中的值替换它。你甚至可以做一些类似普通宏工作方式的重复操作。查看 quote crate 的文档获取详尽的介绍。

我们希望过程宏为用户注解的类型生成 HelloMacro trait 的实现，这可以通过使用 #name 获得。trait 实现有一个函数 hello_macro，其主体包含我们想要提供的功能：打印 Hello, Macro! My name is 以及带注解类型的名称。

这里使用的 stringify! 宏是 Rust 内置的。它接受一个 Rust 表达式，例如 1 + 2，并在编译时将表达式转换为字符串字面量，例如 "1 + 2"。这与 format! 或 println! 不同，后者是对表达式求值然后将结果转换为 String。#name 输入可能是一个需要按字面打印的表达式，因此我们使用 stringify!。使用 stringify! 还通过在编译时将 #name 转换为字符串字面量来节省一次内存分配。

此时，cargo build 应该能在 hello_macro 和 hello_macro_derive 中都成功完成。让我们将这些 crate 连接到示例 20-37 中的代码，看看过程宏的实际效果！在 projects 目录中使用 cargo new pancakes 创建一个新的二进制项目。我们需要在 pancakes crate 的 Cargo.toml 中添加 hello_macro 和 hello_macro_derive 作为依赖。如果你将 hello_macro 和 hello_macro_derive 的版本发布到 crates.io，它们将是常规依赖；如果不是，你可以将它们指定为 path 依赖，如下所示：

[dependencies]
hello_macro = { path = "../hello_macro" }
hello_macro_derive = { path = "../hello_macro/hello_macro_derive" }

将示例 20-37 中的代码放入 src/main.rs，然后运行 cargo run：它应该打印 Hello, Macro! My name is Pancakes!。过程宏对 HelloMacro trait 的实现已包含在内，无需 pancakes crate 实现它；#[derive(HelloMacro)] 添加了该 trait 实现。

接下来，让我们探索其他类型的过程宏与自定义 derive 宏有何不同。

类属性宏

类属性宏与自定义 derive 宏类似，但不是为 derive 属性生成代码，而是允许你创建新属性。它们也更灵活：derive 仅适用于结构体和枚举；属性也可以应用于其他条目，例如函数。下面是使用类属性宏的示例。假设你有一个名为 route 的属性，在使用 Web 应用框架时为函数添加注解：

#[route(GET, "/")]
fn index() {

这个 #[route] 属性将由框架定义为过程宏。宏定义函数的签名如下所示：

#[proc_macro_attribute]
pub fn route(attr: TokenStream, item: TokenStream) -> TokenStream {

这里有两个 TokenStream 类型的参数。第一个用于属性内容：GET, "/" 部分。第二个是属性所附加条目的主体：在本例中是 fn index() {} 以及函数的其余主体。

除此之外，类属性宏的工作方式与自定义 derive 宏相同：创建一个 proc-macro crate 类型的 crate，并实现一个生成所需代码的函数！

类函数宏

类函数宏定义看起来像函数调用的宏。与 macro_rules! 宏类似，它们比函数更灵活；例如，它们可以接受未知数量的参数。然而，macro_rules! 宏只能使用我们在前面“用于通用元编程的声明宏”一节中讨论的类 match 语法来定义。类函数宏接受 TokenStream 参数，其定义像其他两种过程宏一样使用 Rust 代码操作该 TokenStream。类函数宏的一个示例是可能像这样调用的 sql! 宏：

let sql = sql!(SELECT * FROM posts WHERE id=1);

这个宏会解析其中的 SQL 语句并检查其语法是否正确，这比 macro_rules! 宏能做的处理要复杂得多。sql! 宏的定义如下所示：

#[proc_macro]
pub fn sql(input: TokenStream) -> TokenStream {

这个定义类似于自定义 derive 宏的签名：我们接收圆括号内的标记，并返回想要生成的代码。

总结

呼！现在你的工具箱里有了一些你可能不会经常使用、但知道在非常特定的情况下可用的 Rust 特性。我们介绍了几个复杂的主题，以便当你在错误信息建议中或其他人的代码中遇到它们时，能够识别这些概念和语法。将本章作为引导你找到解决方案的参考。

接下来，我们将把本书中讨论的所有内容付诸实践，再完成一个项目！

键盘快捷键

Rust 程序设计语言