Rust宏处理服务器库 ra_ap_proc_macro_srv 使用指南

ra_ap_proc_macro_srv 是一个用于处理 Rust 过程宏的服务器库，它支持过程宏扩展和编译时代码生成，是 Rust 分析器 (rust-analyzer) 的一部分。

主要功能

• 提供过程宏扩展服务
• 支持编译时代码生成
• 可作为独立进程运行
• 与 IDE 工具集成

安装方法

在 Cargo.toml 中添加依赖：

[dependencies]
ra_ap_proc_macro_srv = "0.0"

基本使用方法

1. 创建宏服务器

use ra_ap_proc_macro_srv::ProcMacroSrv;

fn main() {
    let srv = ProcMacroSrv::default();
    // 现在可以使用srv处理宏请求
}

2. 处理宏扩展请求

use ra_ap_proc_macro_srv::{ProcMacroSrv, ExpandMacro};

let srv = ProcMacroSrv::default();
let request = ExpandMacro {
    macro_body: "println!(\"Hello, world!\")".to_string(),
    macro_name: "println".to_string(),
    attributes: None,
    lib: "proc_macro".to_string(),
    env: vec![],
};

let response = srv.expand(&request);
println!("Expanded code: {:?}", response);

3. 作为独立服务器运行

use ra_ap_proc_macro_srv::cli::run_server;

fn main() {
    run_server().expect("Failed to run proc macro server");
}

高级用法

自定义宏处理器

use ra_ap_proc_macro_srv::{ProcMacroSrv, ProcMacroKind, ProcMacro};

struct MyMacro;

impl ProcMacro for MyMacro {
    fn expand(&self, input: &str) -> Result<String, String> {
        Ok(format!("// Expanded by MyMacro\n{}", input))
    }
}

fn main() {
    let mut srv = ProcMacroSrv::default();
    srv.add_macro(
        "my_macro".to_string(),
        ProcMacroKind::Bang,
        Box::new(MyMacro),
    );
    
    // 现在可以使用my_macro!进行扩展
}

与 rust-analyzer 集成

use ra_ap_proc_macro_srv::server::ProcMacroServer;

fn main() {
    let server = ProcMacroServer::new();
    server.run();
}

实际应用示例

1. 创建自定义派生宏

use ra_ap_proc_macro_srv::{ProcMacroSrv, ProcMacroKind, ProcMacro};

#[derive(Debug)]
struct JsonDerive;

impl ProcMacro for JsonDerive {
    fn expand(&self, input: &str) -> Result<String, String> {
        // 简单的JSON派生宏实现
        Ok(format!(
            "impl Json for {} {{
                fn to_json(&self) -> String {{
                    serde_json::to_string(self).unwrap()
                }}
            }}",
            input
        ))
    }
}

fn main() {
    let mut srv = ProcMacroSrv::default();
    srv.add_macro(
        "Json".to_string(),
        ProcMacroKind::Derive,
        Box::new(JsonDerive),
    );
}

2. 属性宏示例

use ra_ap_proc_macro_srv::{ProcMacroSrv, ProcMacroKind, ProcMacro};

struct RouteMacro;

impl ProcMacro for RouteMacro {
    fn expand(&self, input: &str) -> Result<String, String> {
        // 简单的路由属性宏
        Ok(format!(
            "#[allow(unused)]
            fn generated_route() {{
                println!(\"Route registered for: {}\");
                {}
            }}",
            input, input
        ))
    }
}

fn main() {
    let mut srv = ProcMacroSrv::default();
    srv.add_macro(
        "route".to_string(),
        ProcMacroKind::Attr,
        Box::new(RouteMacro),
    );
}

完整示例

下面是一个完整的自定义派生宏示例，展示了如何创建一个简单的Debug派生宏：

use ra_ap_proc_macro_srv::{ProcMacroSrv, ProcMacroKind, ProcMacro};

// 自定义Debug派生宏实现
#[derive(Debug)]
struct SimpleDebugDerive;

impl ProcMacro for SimpleDebugDerive {
    fn expand(&self, input: &str) -> Result<String, String> {
        // 解析输入结构体名称
        let struct_name = input.split_whitespace()
            .next()
            .unwrap_or("MyStruct");
            
        // 生成Debug实现
        Ok(format!(
            "impl std::fmt::Debug for {} {{
                fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {{
                    write!(f, \"{} {{ }}\")
                }}
            }}",
            struct_name, struct_name
        ))
    }
}

fn main() {
    // 创建宏服务器
    let mut srv = ProcMacroSrv::default();
    
    // 添加自定义派生宏
    srv.add_macro(
        "SimpleDebug".to_string(),
        ProcMacroKind::Derive,
        Box::new(SimpleDebugDerive),
    );
    
    // 模拟宏扩展请求
    let request = ExpandMacro {
        macro_body: "struct Point { x: i32, y: i32 }".to_string(),
        macro_name: "SimpleDebug".to_string(),
        attributes: None,
        lib: "proc_macro".to_string(),
        env: vec![],
    };
    
    let response = srv.expand(&request);
    println!("Generated code:\n{}", response.unwrap());
}

注意事项

1. ra_ap_proc_macro_srv 主要用于开发工具链，不是常规应用程序开发的首选
2. 在生产环境中使用前应充分测试宏扩展行为
3. 性能敏感场景可能需要自定义优化
4. 与 rustc 版本兼容性需要注意

这个库特别适合开发需要深度集成 Rust 宏系统的工具，如 IDE 插件、自定义代码生成器等。