Rust自定义Derive中如何获取结构体完整命名空间及Cargo库名？

嘿，这个问题我之前写proc宏的时候也踩过坑！默认拿到的ident确实只有本地名称，要拿到完整命名空间和库名得用点小技巧，我给你拆解一下：

一、获取结构体的完整限定路径 #

问题出在stringify!(#name)只会输出标识符的字面量，不会带上它所在的模块路径。要拿到完整路径，我们可以利用Rust提供的语法跨度（Span）来获取结构体定义所在的模块信息：

1. 首先，通过结构体标识符的span获取它的定义位置，然后调用module_path()拿到模块路径字符串；
2. 把模块路径和结构体名称拼接起来，就是完整的限定名了。

修改后的代码示例：

use proc_macro::Span;
use proc_macro2::Span as Span2;
use syn::DeriveInput;
use quote::quote;

#[proc_macro_derive(HelloWorld)]
pub fn hello_world(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let ast = syn::parse_macro_input!(input as DeriveInput);
    let gen = impl_hello_world(&ast);
    gen.into()
}

fn impl_hello_world(ast: &DeriveInput) -> proc_macro2::TokenStream {
    let name = &ast.ident;
    
    // 获取结构体定义所在的模块路径
    let struct_span: Span = name.span().into();
    let module_path = struct_span.module_path().unwrap_or_default();
    
    // 构建完整限定名
    let full_name = if module_path.is_empty() {
        name.to_string()
    } else {
        format!("{}::{}", module_path, name)
    };

    quote! {
        impl HelloWorld for #name {
            fn hello_world() {
                println!("Hello, World! My name is {}", #full_name);
            }
        }
    }
}

这样如果你的Pancakes在pancakes模块里，输出就会是pancakes::Pancakes啦。

二、获取使用Derive的Cargo库名称 #

要拿到当前Crate的名称，直接读取Cargo编译时设置的环境变量CARGO_PKG_NAME就行——这个变量会自动设置为当前被编译的库/二进制包的名称，完全符合你的需求。

把上面的代码再扩展一下：

fn impl_hello_world(ast: &DeriveInput) -> proc_macro2::TokenStream {
    let name = &ast.ident;
    
    // 获取结构体完整路径
    let struct_span: Span = name.span().into();
    let module_path = struct_span.module_path().unwrap_or_default();
    let full_name = if module_path.is_empty() {
        name.to_string()
    } else {
        format!("{}::{}", module_path, name)
    };

    // 获取当前Cargo库名称
    let crate_name = std::env::var("CARGO_PKG_NAME")
        .unwrap_or_else(|_| "unknown_crate".to_string());

    quote! {
        impl HelloWorld for #name {
            fn hello_world() {
                println!("Hello, World! My name is {} from crate {}", #full_name, #crate_name);
            }
        }
    }
}

一些额外提示 #

• 确保你的Cargo.toml里依赖版本正确，syn需要启用full或derive特性：

  [dependencies]
  syn = { version = "2.0", features = ["full"] }
  quote = "1.0"
  proc-macro2 = "1.0"
  

• 如果要处理更复杂的嵌套模块，建议用syn::Path来构建完整路径，而不是手动拼接字符串，这样生成的代码语法更严谨：

  use syn::Path;
  let full_path = Path::from_iter([
      syn::Ident::new(&module_path, name.span()),
      name.clone()
  ]);
  

  然后在quote!里直接用#full_path即可。

内容的提问来源于stack exchange，提问作者Peekmo