Rust 使用env_logger

在本章中，我们将探讨如何在 Rust 项目中使用 env_logger 库来记录日志。这将帮助我们更好地跟踪程序的运行状态、调试错误以及理解应用程序的行为。

环境搭建

首先，我们需要创建一个新的 Rust 项目。可以使用以下命令：

cargo new log_example
cd log_example

接下来，在 Cargo.toml 文件中添加 env_logger 依赖：

[dependencies]
env_logger = "0.9"
log = "0.4"

确保你的 Cargo.toml 文件看起来像这样：

// www.javascriptcn.com code example
[package]
name = "log_example"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
env_logger = "0.9"
log = "0.4"

初始化日志系统

env_logger 是一个灵活的日志库，它允许我们通过环境变量配置日志输出。首先，我们需要在 main.rs 文件中初始化日志系统。

引入必要的包

打开 src/main.rs 文件，并引入所需的包：

use log::{info, warn, error};
use env_logger::Builder;
use std::env;

配置日志系统

在 main 函数之前，我们需要配置 env_logger，以便它可以读取环境变量并设置适当的日志级别和格式：

fn configure_logger() {
    Builder::from_default_env()
        .format(|buf, record| {
            writeln!(buf, "{} {} {}", record.level(), record.target(), record.args())
        })
        .init();
}

主函数

现在，我们可以在主函数中调用 configure_logger 函数，并开始记录日志：

// www.javascriptcn.com code example
fn main() {
    configure_logger();

    info!("应用程序已启动");
    warn!("这是一个警告消息");
    error!("这是一条错误消息");

    // 模拟一些业务逻辑
    let result = do_something();

    if let Err(e) = result {
        error!("执行失败: {}", e);
    }
}

fn do_something() -> Result<(), String> {
    // 模拟一个可能失败的操作
    Err("模拟的错误".to_string())
}

设置日志级别

我们可以根据需要调整日志级别。默认情况下，env_logger 会从环境变量 RUST_LOG 获取日志级别。可以通过以下方式设置不同的日志级别：

• RUST_LOG=info：仅显示 info 及以上级别的日志。
• RUST_LOG=warn：仅显示 warn 及以上级别的日志。
• RUST_LOG=error：仅显示 error 及以上级别的日志。

例如，你可以通过在终端中设置环境变量来测试不同级别的日志：

RUST_LOG=info cargo run

或者在代码中动态设置日志级别：

fn configure_logger(level: &str) {
    Builder::new()
        .filter(None, log::LevelFilter::from_str(level).unwrap())
        .init();
}

然后在 main 函数中调用：

fn main() {
    configure_logger("info");

    // 其余部分保持不变
}

使用过滤器

除了基本的日志级别外，env_logger 还支持更细粒度的过滤。我们可以根据模块或特定的日志记录器来过滤日志：

fn configure_logger() {
    Builder::from_default_env()
        .filter_module("my_module", log::LevelFilter::Info)
        .init();
}

在这个例子中，只有 my_module 模块中的 info 级别及以上的日志会被记录。

日志格式化

env_logger 允许我们自定义日志的输出格式。我们已经在前面的示例中展示了如何自定义格式。你可以根据需要进一步调整日志的格式，以适应不同的需求。

日志文件输出

默认情况下，env_logger 将日志输出到标准输出。如果你希望将日志写入文件，可以使用 std::fs::File 和 log 库提供的 Log trait 来实现。

例如：

// www.javascriptcn.com code example
use std::fs::File;

fn configure_logger() {
    Builder::new()
        .format(|buf, record| {
            writeln!(buf, "{} {} {}", record.level(), record.target(), record.args())
        })
        .write_style(env_logger::WriteStyle::Always)
        .init();
    
    let file = File::create("app.log").expect("无法创建日志文件");
    let log_builder = env_logger::Builder::new();
    log_builder.format(|buf, record| {
        writeln!(buf, "{} {} {}", record.level(), record.target(), record.args())
    }).target(env_logger::Target::Pipe(Box::new(file))).init();
}

总结

通过本章的学习，你应该已经掌握了如何在 Rust 项目中使用 env_logger 来记录和管理日志。合理使用日志可以帮助我们更好地调试和维护应用程序，特别是在生产环境中。

在后续章节中，我们将继续深入探索 Rust 的其他高级功能和最佳实践。