Rust derive macro（Rust #[derive]）Rust派生宏

参考文章：附录 D：派生特征 trait

文章目录

Rust 中的派生宏 #[derive]
- 基础使用
- - 示例：派生 `Debug`
- 派生其他常用特征
- - 示例：派生 `Clone` 和 `Copy`
- 派生宏的限制和自定义派生
- - 自定义派生宏
  - - 上面代码运行时报错了，以下是解释
- 结论

Rust 中的派生宏 #[derive]

在 Rust 中，派生宏（derive macro）是一种自动实现特定特征（trait）的工具，极大地简化了代码的编写和维护过程。通过使用 #[derive] 属性，开发者可以轻松为自定义数据类型实现一系列的标准特征，例如 Debug、Clone、Copy、Hash、PartialEq 和 Eq 等。本文将深入探讨派生宏的工作原理、使用方式以及如何自定义派生宏。

基础使用

派生宏最常见的应用是自动实现标准库中的特征。例如，当你需要打印一个结构体的调试信息时，可以派生 Debug 特征。

示例：派生 `Debug`

#![allow(dead_code)] // 忽略全局dead code，放在模块开头！
#![allow(unused_variables)] // 忽略未使用变量，放在模块开头！

#[derive(Debug)]

struct Point {
    x: i32,
    y: i32,
}

fn main() {
    let point = Point { x: 10, y: 20 };
    println!("{:?}", point); // 使用 Debug 特征打印 point
}

在这里插入图片描述

在上述代码中，#[derive(Debug)] 使得 Point 结构体自动实现了 Debug 特征，允许我们通过 println! 宏以调试格式打印结构体的实例。

派生其他常用特征

除了 Debug，Rust 还允许自动派生其他一些重要的特征。

示例：派生 `Clone` 和 `Copy`

#![allow(dead_code)] // 忽略全局dead code，放在模块开头！
#![allow(unused_variables)] // 忽略未使用变量，放在模块开头！

#[derive(Debug, Clone, Copy)]

struct Point {
    x: i32,
    y: i32,
}

fn main() {
    let point1 = Point { x: 10, y: 20 };
    let point2 = point1; // Copy 特性允许这样的操作
    let point3 = point1.clone(); // Clone 特性的显式调用

    println!("{:?}", point2); // 使用 Debug 特征打印 point2
    println!("{:?}", point3); // 使用 Debug 特征打印 point3
}

在这里插入图片描述

在此示例中，Point 结构体通过 #[derive] 同时实现了 Debug、Clone 和 Copy 特征。Copy 是用于简单字段复制的轻量级特征，而 Clone 用于可能涉及到更复杂的数据克隆过程。

派生宏的限制和自定义派生

尽管派生宏非常有用，但它们并不适用于所有情况。例如，当结构体的某些字段不支持相应的特征时，直接使用派生宏可能会导致编译错误。

自定义派生宏

对于标准特征之外的特定用途，或当内置的派生无法满足需求时，Rust 允许创建自定义派生宏。自定义派生宏需要深入了解 Rust 的宏系统和特征实现。

use proc_macro::TokenStream;
use quote::quote;
use syn::{parse_macro_input, DeriveInput};

#[proc_macro_derive(MyTrait)]
pub fn my_trait_derive(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as DeriveInput);

    let name = &input.ident;
    let expanded = quote! {
        impl MyTrait for #name {
            fn my_trait_method(&self) -> String {
                format!("This is a MyTrait method implemented for {}", stringify!(#name))
            }
        }
    };

    TokenStream::from(expanded)
}

在上述示例中，定义了一个新的派生宏 MyTrait，它为指定的数据类型实现了 MyTrait 特征，包括一个方法 my_trait_method。使用 proc_macro 创建派生宏涉及解析类型定义、生成相应的代码，并将其输出为令牌流，这是 Rust 宏系统的核心。

上面代码运行时报错了，以下是解释

在 Rust 中，#[proc_macro_derive] 属性只能在 proc-macro 类型的 crate 中使用。这意味着你需要将你的代码放在一个特别设定为 proc-macro 类型的库中才能编译和运行。以下是设置步骤：

创建新的 proc-macro crate：
- 通常，你需要创建一个新的库专门用来编写 proc macro。你可以使用 cargo new --lib my_proc_macro 命令来创建一个新的库。确保你在创建时的目录不在其他项目中。
修改 Cargo.toml：
- 在你的 Cargo.toml 文件中，你需要指定库的类型为 proc-macro。这可以通过添加 proc-macro = true 到 [lib] 部分实现：
```
[lib]
proc-macro = true
```
将代码移动到新的 crate：
- 把你的 proc macro 代码复制到新创建的库的 src/lib.rs 文件中。
添加依赖：
- 你需要在 Cargo.toml 中添加 proc_macro, quote, 和 syn 作为依赖项。这样你的代码才能编译。
```
[dependencies]
quote = "1.0"
syn = { version = "1.0", features = ["full"] }
```
编译并使用你的 proc-macro crate：
- 在你的主项目中，添加对你刚创建的 proc-macro 库的依赖。这通常通过在主项目的 Cargo.toml 中添加路径依赖来实现：
```
[dependencies]
my_proc_macro = { path = "../path_to_my_proc_macro" }
```
使用 proc-macro：
- 现在，你可以在你的主项目中通过使用 #[derive(MyTrait)] 来使用你的 proc macro。