Rust宏之derive的设计及实战

Rust宏可以极大的简化编写的难度，学习好宏可以更好的减少冗余代码。
宏的基本概念

Rust中的宏可以分为两大类：声明宏（Declarative Macros）和过程宏（Procedural Macros）。

• 声明宏：也称为macro_rules!宏，使用macro_rules!关键字界说。它是一种基于模式匹配的文本替换宏，雷同于C语言中的宏界说。声明宏在编译期展开，用匹配的代码片段替换宏调用处的代码。
  
• 过程宏：是一种更为高级的宏，它通过编写Rust代码来处理输入的代码，并在编译期间生成新的代码。过程宏重要用于属性宏（Attribute Macros）、类函数宏（Function-Like Macros）和派生宏（Derive Macros）等场景。
  

宏的现实应用

• 声明宏在Rust中的应用，我们最常接触的宏界说vec！大概println!都是尺度库里提供的，他可以在编译阶段就进行宏展开，在一定水平上牺牲编译速率有错误实时发现从而保证步伐运行稳定。
  
• 过程宏在Rust中也是极为常见，就好比某个类，我们必要clone方法，但是声明的类并不支持clone，那么我们就可以在此类声明derive(Clone)如果必要默认的构造方法，那么同样可以声明derive(Default)
  

1. #[derive(Clone, Default)]
2. struct HcluaMacro {
3.     field: u32,
4. }

复制代码

此时我们就可以使用：

1. let obj = HcluaMacro::default();
2. let obj_clone = obj.clone();

复制代码

雷同的还要在序列化的宏等。
过程宏的实战

目录为Rust中的lua库hclua做对象的绑定，可以快速的实现Rust对象在Lua中的快速使用绑定。
新建库

由于过程宏只能在单独的库中使用，所以此时我们必要新建单独的一个项目cargo new hclua-macro，并在新项目的Cargo.toml中添加

1. [lib]
2. proc-macro = true

复制代码

声明该项目为过程宏项目。
界说宏ObjectMacro

起首我们得界说ObjectMacro宏，那么我们必要声明：

1. #[proc_macro_derive(ObjectMacro)]
2. pub fn object_macro_derive(input: TokenStream) -> TokenStream {
3.     TokenStream::new()
4. }

复制代码

此处我们就可以在这基础上实现额外的代码，他将在声明该宏文件中自动添加代码。
我们做以下测试：

1. #[proc_macro_derive(ObjectMacro)]
2. pub fn object_macro_derive(input: TokenStream) -> TokenStream {
3.     quote! {
4.         fn this_is_macro_auto() {
5.             println!("this_is_macro_auto auto func");
6.         }
7.     }.into()
8. }

复制代码

其中quote!可以快速的生成代码块。
展开宏cargo-expand

接下我们必要宏在这个过期中帮我们生成了什么，我们借助以下工具cargo-expand，通过cargo install cargo-expand进行安装。
此时用cargo expand可以发现宏展开后的代码如下：

1. #![feature(prelude_import)]
2. #[prelude_import]
3. use std::prelude::rust_2021::*;
4. #[macro_use]
5. extern crate std;
6. use hclua_macro::ObjectMacro;
7. struct HcluaMacro {
8.     field: u32,
9. }
10. fn this_is_macro_auto() {
11.     {
12.         ::std::io::_print(format_args!("this_is_macro_auto auto func\n"));
13.     };
14. }
15. fn main() {
16.     this_is_macro_auto();
17. }

复制代码

此时我们并没有处理跟类相关的任何东西，我们可以用parse_macro_input!将输入转成ItemStruct大概DeriveInput

1. #[proc_macro_derive(ObjectMacro)]
2. pub fn object_macro_derive(input: TokenStream) -> TokenStream {
3.     let ItemStruct {
4.         ident,
5.         fields,
6.         attrs,
7.         ..
8.     } = parse_macro_input!(input);
10.     let name = ident.to_string();
11.     quote! {
12.         fn this_is_macro_auto() {
13.             println!("struct name {}", #name);
14.         }
15.     }.into()
16. }

复制代码

在quote中可以用#来序列化局数的变量数据。那么此时我们运行步伐，将会输出：

1. struct name HcluaMacro

复制代码

类名正确的被打印出来。
字段处理

界说

1. pub struct Field {
2.     pub attrs: Vec<Attribute>,
4.     pub vis: Visibility,
6.     pub mutability: FieldMutability,
8.     pub ident: Option<Ident>,
10.     pub colon_token: Option<Token![:]>,
12.     pub ty: Type,
13. }

复制代码

• vis表现是否公开，就是表现pub大概pub(super) or pub(crate) or pub(in some::module)大概不公开模式
  
• attrs表现在该字段上的各种属性
  
• mutability表现是否可编辑
  
• ident变量的名字，当enum时只有类型没著名字
  我们就可以通过处理变量的各种情况然后进行操纵，好比添加get_#ident大概set_#ident等方法。
  

属性处理

在此处我们界说了两种属性名称，hclua_field及 hclua_cfg，一种设置名称，一种设置是否可以在Lua中直接访问的字段名称，此时的宏界说：

1. #[proc_macro_derive(ObjectMacro, attributes(hclua_field, hclua_cfg))]
2. pub fn object_macro_derive(input: TokenStream) -> TokenStream {
3.    
4. }

复制代码

如果没有在此处界说的attrib，在类型里直接添加会报编译错误。
此处我们判断是否为hclua_field字段进行相应的加工。

1. let functions: Vec<_> = fields
2.     .iter()
3.     .map(|field| {
4.         let field_ident = field.ident.clone().unwrap();
5.         if field.attrs.iter().any(|attr| attr.path().is_ident("hclua_field")) {
6.             quote! {}
7.         } else {
8.             quote! {}
9.         }
10.     })
11.     .collect();

复制代码

接下来将自动实现get及set方法。此处functions为TokenStream的数组，我们将用

1. #(#functions)*

复制代码

将此部门内容做展开。
完整宏代码：

1. use proc_macro::TokenStream;
2. use quote::{format_ident, quote};
3. use syn::{self, ItemStruct};
5. use syn::parse_macro_input;
7. #[proc_macro_derive(ObjectMacro, attributes(hclua_field, hclua_cfg))]
8. pub fn object_macro_derive(input: TokenStream) -> TokenStream {
9.     let ItemStruct {
10.         ident,
11.         fields,
12.         attrs,
13.         ..
14.     } = parse_macro_input!(input);
16.     let functions: Vec<_> = fields
17.         .iter()
18.         .map(|field| {
19.             let field_ident = field.ident.clone().unwrap();
20.             if field.attrs.iter().any(|attr| attr.path().is_ident("hclua_field")) {
21.                 let get_name = format_ident!("get_{}", field_ident);
22.                 let set_name = format_ident!("set_{}", field_ident);
23.                 let ty = field.ty.clone();
24.                 quote! {
25.                     fn #get_name(&mut self) -> &#ty {
26.                         &self.#field_ident
27.                     }
29.                     fn #set_name(&mut self, val: #ty) {
30.                         self.#field_ident = val;
31.                     }
32.                 }
33.             } else {
34.                 quote! {}
35.             }
36.         })
37.         .collect();
39.     let name = ident.to_string();
40.     quote! {
41.         fn this_is_macro_auto() {
42.             println!("struct name {}", #name);
43.         }
45.         impl #ident {
46.             #(#functions)*
47.         }
48.     }.into()
49. }

复制代码

将示例代码进行如下书写：

1. use hclua_macro::ObjectMacro;
3. #[derive(ObjectMacro)]
4. struct HcluaMacro {
5.     #[hclua_field]
6.     field: u32,
8.     not_field: u32,
9. }
11. fn main() {
12.     this_is_macro_auto();
13. }

复制代码

通过cargo expand将得到如下的代码：

1. #![feature(prelude_import)]
2. #[prelude_import]
3. use std::prelude::rust_2021::*;
4. #[macro_use]
5. extern crate std;
6. use hclua_macro::ObjectMacro;
7. struct HcluaMacro {
8.     #[hclua_field]
9.     field: u32,
10.     not_field: u32,
11. }
12. fn this_is_macro_auto() {
13.     {
14.         ::std::io::_print(format_args!("struct name {0}\n", "HcluaMacro"));
15.     };
16. }
17. impl HcluaMacro {
18.     fn get_field(&mut self) -> &u32 {
19.         &self.field
20.     }
21.     fn set_field(&mut self, val: u32) {
22.         self.field = val;
23.     }
24. }
25. fn main() {
26.     this_is_macro_auto();
27. }

复制代码

自动实现了get及set方法，符合我们的要求。
注意事项

• 学习曲线：难度相对较高，必要理解block,expr, ident, item, literal, pat, path, stmt, tt, ty, vis等相关内容。
  
• 调试难度：由于宏是在编译时实行的，因此调试起来可能比力困难。对于严重依赖调试会相对吃力。
  
• 滥用风险：虽然宏提供了强大的代码生成能力，但滥用宏也可能导致代码难以理解和维护。因此，在使用宏时尽量的做好规划及说明。
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。