各编程语言的抽象语法树查看工具：https://astexplorer.net/

纲要

  • 设置过程宏
  • 通过解析 tokens 流获得结构体的名称
  • 生成硬编码输出
  • 在生成的代码中使用变量
  • 使用 cargo expand 检查生成的代码
  • 在没有 syn 和 quote 帮助的情况下编写宏
  • 理解 Rust 内部宏的特殊之处

使用过程宏的两种方式

  1. 方式一：创建普通的二进制应用程序，然后添加依赖库，最后在 main.rs 中使用宏
  2. 方式二：自己弄宏和配置
    1. 在项目目录下（如 hello-world）创建子文件夹（如 hello-world-macro）
    2. 在子文件夹下创建 lib，在 Cargo.toml 配置 [lib]，在 lib.rs 编写宏

过程宏：Derive macros - 图1

  1. use quote::quote;
  2. use proc_macro::TokenStream;
  4. #[proc_macro_derive(Hello)]
  5. pub fn hello(_item: TokenStream) -> TokenStream {
  6.     // 使用quote宏生成一个新的(当前为空)TokenStream
  7.     let add_hello_world = quote! {};
  8.     // 使用Into trait将此TokenStream更改为具有相同名称的普通/标准库TokenStream
  9.     add_hello_world.into()
  10. }

过程宏：Derive macros - 图2

  1. [package]
  2. name = "hello_world"
  3. version = "0.1.0"
  4. edition = "2021"
  6. [dependencies]
  7. hello-world-macro = { path = "./hello-world-macro" }
  1. #[macro_use]
  2. extern crate hello_world_macro;
  4. #[derive(Hello)]
  5. struct Example;
  7. fn main() {}
  9. // 或者
  10. use hello_world_macro::Hello;
  12. #[derive(Hello)]
  13. struct Example;
  15. fn main() {}

使用 syn 和 quote 的小示例

  1. use quote::quote;
  2. use proc_macro::TokenStream;
  3. use syn::{parse_macro_input, DeriveInput};
  5. #[proc_macro_derive(Hello)]
  6. pub fn hello(item: TokenStream) -> TokenStream {
  7.     let ast = parse_macro_input!(item as DeriveInput);
  8.     let name = ast.ident;
  10.     let add_hello_world = quote! {
  11.         impl #name {
  12.             fn hello_world(&self) {
  13.                 println!("Hello, world!");
  14.             }
  15.         }
  16.     };
  18.     add_hello_world.into()
  19. }
  1. #[macro_use]
  2. extern crate hello_world_macro;
  4. #[derive(Hello)]
  5. struct Example;
  7. fn main() {
  8.     let e = Example {};
  9.     e.hello_world();
  10. }

Cargo expand 的使用

过程宏：Derive macros - 图3

过程宏：Derive macros - 图4

不使用 syn 和 quote 小示例

  1. use proc_macro::{TokenStream, TokenTree};
  3. #[proc_macro_derive(Hello)]
  4. pub fn hello(item: TokenStream) -> TokenStream {
  5.     fn ident_name(item: TokenTree) -> String {
  6.         match item {
  7.             TokenTree::Ident(i) => i.to_string(),
  8.             _ => panic!("not an ident"),
  9.         }
  10.     }
  12.     let name = ident_name(item.into_iter().nth(1).unwrap());
  14.     format!("impl {} {{ fn hello_world(&self) {{ println!(\"Hello, world!\") }}}} ", name).parse().unwrap()
  15. }

有几个库试图提供一个轻量级的 syn 替代方案

过程宏：Derive macros - 图5