如何在Rust宏中返回格式化字符串并封装tracing日志功能

问题原因 #

你定义的宏展开后会生成两条独立的表达式，没有用代码块包裹，Rust 宏默认仅能返回单个语法元素，因此编译器会直接忽略error!之后的format!相关逻辑，抛出你遇到的报错。

修复方案 #

修改宏定义，将逻辑包裹在代码块中，用分号分隔两条语句，最后将格式化后的字符串作为代码块的返回值即可：

#[macro_export]
macro_rules! log_usr_err {
    ($($arg:tt)+) => {{
        // 先格式化错误字符串，避免重复执行format逻辑
        let err_msg = format!($($arg)+);
        // 打印日志，同时注入文件、行号信息，满足后续需求
        error!(
            err = %err_msg,
            file = file!(),
            line = line!(),
            "{}", err_msg
        );
        // 返回格式化好的错误消息
        err_msg
    }};
}

这里提前把错误消息存到临时变量，避免format!执行两次，提升性能的同时也能避免有副作用的参数执行多次导致逻辑异常。

调用方式修正 #

你原来的调用写法参数格式有误，直接和format!的传参方式对齐即可：

let var_a = 233;
let err = log_usr_err!("some custom error message, var_a: {}", var_a);
s_errs.append(err);

可选优化方案 #

如果你的项目中错误场景分类明确，可以结合thiserror库定义统一的错误枚举，给枚举实现日志打印的关联方法，比纯字符串错误的可维护性更高，也能避免重复的错误消息硬编码。不过如果你的需求就是仅需要返回字符串给终端用户，上面的宏实现已经完全够用，不需要额外引入其他依赖。

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