Rust/Cargo特定feature编译时提取字符串生成文件：选过程宏还是Build.rs？

推荐方案：build.rs 结合语法分析（可靠可控） #

这种方案能主动遍历所有源码文件，确保不遗漏任何 string_id! 宏调用，且无全局状态竞争问题，是最稳妥的选择。

核心步骤 #

1. Feature 触发判断：在 build.rs 中通过 cfg!(feature = "你的feature名称") 判断是否开启提取逻辑。
2. 遍历源码文件：用 walkdir 库遍历项目 src 目录下所有 .rs 文件。
3. 语法解析提取字符串：借助 syn 库解析每个文件的 AST（抽象语法树），定位 string_id! 宏调用，提取其中的字符串字面量。
4. 生成目标文件：将提取到的字符串去重后写入指定文件（如 src/generated_string_ids.rs），同时通过 cargo:rerun-if-changed=src/ 告诉 Cargo，当源码变动时重新执行 build.rs 更新文件。

示例代码 #

Cargo.toml 依赖

[build-dependencies]
syn = { version = "2.0", features = ["full"] }
walkdir = "2.4"

build.rs 实现

use std::fs;
use std::path::Path;
use walkdir::WalkDir;
use syn::{parse_file, Item, LitStr, Macro};

fn main() {
    // 仅在开启指定feature时执行提取逻辑
    if !cfg!(feature = "extract_string_ids") {
        return;
    }

    let mut string_ids = std::collections::BTreeSet::new();

    // 遍历src目录下所有.rs文件
    for entry in WalkDir::new("src")
        .into_iter()
        .filter_map(|e| e.ok())
        .filter(|e| e.path().extension().map(|ext| ext == "rs").unwrap_or(false))
    {
        let content = fs::read_to_string(entry.path()).unwrap();
        let ast = parse_file(&content).unwrap();

        // 遍历AST查找string_id宏调用
        for item in ast.items {
            if let Item::Macro(Macro { path, tokens, .. }) = item {
                if path.is_ident("string_id") {
                    // 解析宏参数，提取字符串字面量
                    let lit_str: LitStr = syn::parse2(tokens).unwrap();
                    string_ids.insert(lit_str.value());
                }
            }
        }
    }

    // 生成包含所有字符串的Rust代码文件
    let content = format!(
        "// 自动生成，请勿手动修改\npub const STRING_IDS: &[&str] = &[\n    {}\n];",
        string_ids.iter().map(|s| format!("\"{}\"", s)).collect::<Vec<_>>().join(",\n    ")
    );

    // 写入目标文件
    fs::write(Path::new("src").join("generated_string_ids.rs"), content).unwrap();

    // 监听src目录变动，自动重新执行build.rs
    println!("cargo:rerun-if-changed=src/");
}

项目中使用生成的文件

#[cfg(feature = "extract_string_ids")]
mod generated_string_ids;

#[cfg(feature = "extract_string_ids")]
use generated_string_ids::STRING_IDS;

// 你的宏定义，可保留原有逻辑
#[macro_export]
macro_rules! string_id {
    ($s:literal) => {
        $s
    };
}

fn main() {
    string_id!("MyString");
    string_id!("AnotherString");

    #[cfg(feature = "extract_string_ids")]
    {
        println!("提取到的字符串ID：{:?}", STRING_IDS);
    }
}

不推荐方案：过程宏 + 全局状态 #

过程宏虽然能直接关联代码，但存在诸多问题：

• Rust 过程宏的全局状态需要用静态锁（如 lazy_static + Mutex）维护，而 Cargo 并行编译时，多个编译单元的宏实例会竞争状态，容易出现字符串遗漏、重复的情况。
• 无法保证所有宏调用都被捕获，Cargo 的编译缓存机制可能跳过部分编译单元的宏处理。

内容的提问来源于stack exchange，提问作者Le-Dragon-Dev