如何让include_str!在文件不存在时默认返回空字符串？

当然可以通过编译期过程宏实现这个需求，核心思路是在编译阶段检查目标文件是否存在，存在则读取内容嵌入代码，不存在则返回空字符串。以下是具体实现步骤：

1. 创建过程宏 crate #

首先新建一个过程宏项目（比如命名为maybe_include_str_macro），用于实现自定义宏逻辑：

Cargo.toml 配置 #

[package]
name = "maybe_include_str_macro"
version = "0.1.0"
edition = "2021"

[lib]
proc-macro = true

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

宏实现代码（lib.rs） #

use proc_macro::TokenStream;
use quote::quote;
use syn::{parse_macro_input, LitStr};
use std::fs;
use std::path::Path;

#[proc_macro]
pub fn maybe_include_str(input: TokenStream) -> TokenStream {
    // 解析宏输入的字符串路径
    let lit_str = parse_macro_input!(input as LitStr);
    let path = lit_str.value();

    // 获取调用宏的源文件所在目录，和include_str!的路径行为保持一致
    let source_file = lit_str.span().source_file();
    let source_dir = source_file.path().parent().unwrap_or_else(|| Path::new(""));
    let full_path = source_dir.join(path);

    // 读取文件内容，不存在则返回空字符串
    let contents = match fs::read_to_string(full_path) {
        Ok(content) => content,
        Err(_) => String::new(),
    };

    // 将内容转为字符串字面量嵌入编译后的代码
    quote!(#contents).into()
}

2. 在主项目中使用宏 #

回到你的主项目，在Cargo.toml中添加对过程宏 crate 的依赖：

[package]
name = "my_project"
version = "0.1.0"
edition = "2021"

[dependencies]
maybe_include_str_macro = { path = "../maybe_include_str_macro" }

然后在main.rs中调用宏：

use maybe_include_str_macro::maybe_include_str;

fn main() {
    let file_contents = maybe_include_str!("file.txt"); // 存在则返回文件内容，比如"hello world"
    let empty_contents = maybe_include_str!("nonexistent_file.txt"); // 返回空字符串""
    
    println!("文件内容: '{}'", file_contents);
    println!("不存在文件的内容: '{}'", empty_contents);
}

关键说明 #

• 该宏在编译阶段执行文件检查和读取，不会带来运行时开销，行为和include_str!保持一致，路径相对于调用宏的源文件所在目录。
• 无论文件是否存在，宏都会生成合法的字符串字面量，编译过程不会报错。

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