有沒(méi)有同學(xué)記得我們一起挖了多少個(gè)坑竭望?嗯…其實(shí)我自己也不記得了邪码,今天我們?cè)賮?lái)挖一個(gè)特殊的坑,這個(gè)坑可以說(shuō)是挖到根源了——元編程咬清。
元編程是編程領(lǐng)域的一個(gè)重要概念闭专,它允許程序?qū)⒋a作為數(shù)據(jù),在運(yùn)行時(shí)對(duì)代碼進(jìn)行修改或替換旧烧。如果你熟悉Java影钉,此時(shí)是不是想到了Java的反射機(jī)制?沒(méi)錯(cuò)粪滤,它就是屬于元編程的一種斧拍。
反射
Rust也同樣支持反射,Rust的反射是由標(biāo)準(zhǔn)庫(kù)中的std::any::Any
包支持的杖小。
這個(gè)包中提供了以下幾個(gè)方法
TypeId是Rust中的一種類型肆汹,它被用來(lái)表示某個(gè)類型的唯一標(biāo)識(shí)。type_id(&self)
這個(gè)方法返回變量的TypeId予权。
is()
方法則用來(lái)判斷某個(gè)函數(shù)的類型昂勉。
可以看一下它的源碼實(shí)現(xiàn)
pub fn is<T: Any>(&self) -> bool {
let t = TypeId::of::<T>();
let concrete = self.type_id();
t == concrete
}
可以看到它的實(shí)現(xiàn)非常簡(jiǎn)單,就是對(duì)比TypeId扫腺。
downcast_ref()
和downcast_mut()
是一對(duì)用于將泛型T轉(zhuǎn)換為具體類型的方法岗照。其返回的類型是Option<&T>
和Option<&mut T>
,也就是說(shuō)downcast_ref()
將類型T轉(zhuǎn)換為不可變引用,而downcast_mut()
將T轉(zhuǎn)換為可變引用攒至。
最后我們通過(guò)一個(gè)例子來(lái)看一下這幾個(gè)函數(shù)的具體使用方法厚者。
use std::any::{Any, TypeId};
fn main() {
let v1 = "Jackey";
let mut a: &Any;
a = &v1;
println!("{:?}", a.type_id());
assert!(a.is::<&str>());
print_any(&v1);
let v2: u32 = 33;
print_any(&v2);
}
fn print_any(any: &Any) {
if let Some(v) = any.downcast_ref::<u32>() {
println!("u32 {:x}", v);
} else if let Some(v) = any.downcast_ref::<&str>() {
println!("str {:?}", v);
} else {
println!("else");
}
}
宏
Rust的反射機(jī)制提供的功能比較有限,但是Rust還提供了宏來(lái)支持元編程迫吐。
到目前為止库菲,宏對(duì)我們來(lái)說(shuō)是一個(gè)既熟悉又陌生的概念,熟悉是因?yàn)槲覀円恢痹谑褂?code>println!宏志膀,陌生則是因?yàn)槲覀儚臎](méi)有詳細(xì)介紹過(guò)它熙宇。
對(duì)于println!
宏,我們直觀上的使用感受是它和函數(shù)差不多溉浙。但兩者之間還是有一定的區(qū)別的烫止。
我們知道對(duì)于函數(shù),它接收參數(shù)的個(gè)數(shù)是固定的戳稽,并且在函數(shù)定義時(shí)就已經(jīng)固定了馆蠕。而宏接收的參數(shù)個(gè)數(shù)則是不固定的。
這里我們說(shuō)的宏都是類似函數(shù)的宏广鳍,此外荆几,Rust還有一種宏是類似于屬性的宏吓妆。它有點(diǎn)類似于Java中的注解赊时,通常作為一種標(biāo)記寫在函數(shù)名上方。
#[route(GET, "/")]
fn index() {
route在這里是用來(lái)指定接口方法的行拢,對(duì)于這個(gè)服務(wù)來(lái)講祖秒,根路徑的GET
請(qǐng)求都被路由到這個(gè)index函數(shù)上。這樣的宏是通過(guò)屬于過(guò)程宏舟奠,它的定義使用了#[proc_macro_attribute]
注解竭缝。而函數(shù)類似的過(guò)程宏在定義時(shí)使用的注解是#[proc_macro]
。
除了過(guò)程宏以外沼瘫,宏的另一大分類叫做聲明宏抬纸。聲明宏是通過(guò)macro_rules!
來(lái)聲明定義的宏,它比過(guò)程宏的應(yīng)用要更加廣泛耿戚。我們?cè)?jīng)接觸過(guò)的vec!
就是聲明宏的一種湿故。它的定義如下:
#[macro_export]
macro_rules! vec {
( $( $x:expr ),* ) => {
{
let mut temp_vec = Vec::new();
$(
temp_vec.push($x);
)*
temp_vec
}
};
}
下面我們來(lái)定義一個(gè)屬于自己的宏。
自定義宏需要使用derive
注解膜蛔。(例子來(lái)自the book)
我們先來(lái)創(chuàng)建一個(gè)叫做hello_macro的lib庫(kù)坛猪,只定義一個(gè)trait。
pub trait HelloMacro {
fn hello_macro();
}
接著再創(chuàng)建一個(gè)子目錄hello_macro_derive皂股,在hello_macro_derive/Cargo.toml文件中添加依賴
[lib]
proc-macro = true
[dependencies]
syn = "0.14.4"
quote = "0.6.3"
然后就可以在hello_macro_derive/lib.rs文件中定義我們自定義宏的功能實(shí)現(xiàn)了墅茉。
extern crate proc_macro;
use crate::proc_macro::TokenStream;
use quote::quote;
use syn;
#[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 gen = quote! {
impl HelloMacro for #name {
fn hello_macro() {
println!("Hello, Macro! My name is {}", stringify!(#name));
}
}
};
gen.into()
}
這里使用了兩個(gè)crate:syn和quote,其中syn是把Rust代碼轉(zhuǎn)換成一種特殊的可操作的數(shù)據(jù)結(jié)構(gòu),而quote的作用則與它剛好相反就斤。
可以看到悍募,我們自定義宏使用的注解是#[proc_macro_derive(HelloMacro)]
,其中HelloMacro是宏的名稱洋机,在使用時(shí)搜立,我們只需要使用注解#[derive(HelloMacro)]
即可。
在使用時(shí)我們應(yīng)該先引入這兩個(gè)依賴
hello_macro = { path = "../hello_macro" }
hello_macro_derive = { path = "../hello_macro/hello_macro_derive" }
然后再來(lái)使用
use hello_macro::HelloMacro;
use hello_macro_derive::HelloMacro;
#[derive(HelloMacro)]
struct Pancakes;
fn main() {
Pancakes::hello_macro();
}
運(yùn)行結(jié)果顯示槐秧,我們能夠成功在實(shí)現(xiàn)中捕獲到結(jié)構(gòu)體的名字啄踊。
總結(jié)
我們?cè)诒疚闹邢群蠼榻B了Rust的兩種元編程:反射和宏。其中反射提供的功能能力較弱刁标,但是宏提供的功能非常強(qiáng)大颠通。我們所介紹的宏的相關(guān)知識(shí)其實(shí)只是皮毛,要想真正理解宏膀懈,還需要花更多的時(shí)間學(xué)習(xí)顿锰。