Rust 日志库完全指南：从入门到精通

GitHub 仓库: https://github.com/zhouByte-hub/rust-study ⭐ 如果这个项目对您有帮助，请给我一个 star！

在 Rust 生态系统中，日志处理是一个至关重要的环节。无论是开发小型应用还是大型系统，良好的日志记录都能帮助我们追踪问题、监控应用状态以及优化性能。本文将深入探讨 Rust 中几种流行的日志库，从基础概念到实际应用，帮助您选择最适合自己项目的日志解决方案。

1. log：Rust 日志门面

log crate 是 Rust 生态系统中日志记录的核心组件。它提供了一个统一的日志 API，但本身并不实现日志输出功能，而是作为一个门面（facade），允许开发者选择最适合其需求的日志实现。

基本用法

use log::{info, trace};#[test]
fn test_1() {log::info!("info"); // 没有输出log::trace!("trace"); // 没有输出
}

优点

统一接口：为所有日志实现提供了一致的 API
解耦设计：库可以使用 log crate 的 API，而应用程序可以选择具体的日志实现
标准化：定义了标准的日志级别（trace、debug、info、warn、error）

缺点

无输出实现：本身不提供日志输出功能，需要配合其他日志库使用
配置复杂：需要额外配置才能看到日志输出

适用场景

作为库的开发者，希望提供日志功能但不强制用户使用特定日志实现
需要在不同环境中灵活切换日志实现的应用程序

兼容的日志实现

env_logger
pretty_env_logger
flexi_logger
simple-log

2. env_logger：环境变量配置的日志实现

env_logger 是一个通过环境变量配置的日志实现，是 Rust 中最常用的日志库之一。它与 log crate 完美配合，提供了灵活的配置选项。

基本用法

use log::{error, info};#[test]
fn env_test_1() {// env_logger::init() 的作用是把 env_logger 作为日志后端注册到 log crate 的全局系统中env_logger::init();info!("info"); // 不会输出error!("error"); // init()默认的日志级别是error
}#[test]
fn env_test_2() {// 初始化日志，设置日志级别env_logger::Builder::from_default_env().filter_level(log::LevelFilter::Info).init();info!("abc");
}#[test]
fn env_test_3() {env_logger::Builder::from_default_env().format(|buf, record| {writeln!(buf,"{} [{}] {}: {}","time",record.level(),record.target(),record.args())}).filter_level(log::LevelFilter::Info).init();info!("abc");
}

优点

环境变量配置：可以通过环境变量灵活配置日志行为
简单易用：基本用法非常简单，只需一行代码即可初始化
灵活格式化：支持自定义日志格式
模块级别过滤：可以为不同模块设置不同的日志级别

缺点

默认只输出到控制台：不直接支持输出到文件
配置复杂度：高级配置需要编写较多代码
依赖环境变量：在某些环境中可能不方便设置环境变量

适用场景

命令行工具和简单的应用程序
开发和测试环境
需要通过环境变量控制日志行为的场景

3. pretty_env_logger：美化的日志输出

pretty_env_logger 是 env_logger 的一个美化版本，提供了更美观、更易读的日志输出格式，特别适合在开发和调试时使用。

基本用法

use log::{error, info, warn};
extern crate pretty_env_logger;#[test]
fn test_1() {pretty_env_logger::init(); // init默认的日志级别也是errorinfo!("such information"); // 不打印warn!("o_O"); // 不打印error!("much error"); // 打印
}#[test]
fn test_2() {pretty_env_logger::formatted_builder().filter_level(log::LevelFilter::Info) // 全局日志级别.filter_module("reqwest", log::LevelFilter::Debug) // 模块日志级别.init();info!("info");
}

优点

美观输出：提供了比标准 env_logger 更美观的日志格式
颜色支持：支持彩色输出，使日志更易读
模块级别过滤：可以为不同模块设置不同的日志级别
易于调试：在开发环境中特别有用

缺点

性能开销：格式化和颜色处理会带来一些性能开销
不适合生产环境：美观的格式在生产环境中可能不是最佳选择
功能有限：相比其他日志库，功能相对简单

适用场景

开发和调试阶段
命令行工具和交互式应用
需要美观日志输出的演示程序

4. flexi_logger：灵活强大的日志解决方案

flexi_logger 是一个功能强大且高度可配置的日志库，支持将日志写入标准错误输出、文件或其他输出流，并允许在程序运行时进行动态配置。

基本用法

use flexi_logger::{DeferredNow, FileSpec, LogSpecification, Logger, WriteMode};
use log::{Record, info};#[test]
fn test_1() {// 初始化，日志级别是infoflexi_logger::init();log::info!("info");log::debug!("debug"); // 不会输出log::trace!("trace"); // 不会输出
}#[test]
fn test_2() {// 初始化，设置全局的Log Level为debugflexi_logger::Logger::try_with_str("debug").unwrap().start().unwrap();log::info!("info");log::trace!("trace"); // 不会输出log::debug!("debug");
}// 输出到文件
#[test]
fn log_to_file() {/*  WriteMode可以取值：1、Direct： 每条日志直接写入输出目标，无缓冲，实时输出，频繁IO操作。2、Buffer：使用缓冲区，默认8KB，缓冲区满后自动刷新，减少了IO操作，程序崩溃会丢失日志。3、BufferAndFlush：使用缓冲区，每次日志写入后都尝试刷新，比Direct性能好，比Buffer可靠。4、Never：从不主动刷新缓冲区，依赖操作系统自动刷新5、Auto：自动选择最佳模式*/let log_handle = Logger::try_with_str("info").unwrap().log_to_file(FileSpec::default().directory("src/logs").basename("app").suffix("log"),).write_mode(WriteMode::Direct).start().unwrap();info!("info");log_handle.flush(); //当WriteMode取值为BufferAndFlush时需要手动flush
}// 输出到控制台
#[test]
fn log_to_console() {Logger::try_with_str("info").unwrap().log_to_stdout().write_mode(WriteMode::Direct).start().unwrap();info!("info");
}// 同时将日志输出到文件和控制台
#[test]
fn log_to_file_and_console() {Logger::try_with_str("info").unwrap().log_to_file(FileSpec::default().directory("src/logs") // 日志文件所在的目录.discriminant("abc") // 日志文件名中包含的标识符，会拼接在baseName后面.basename("app") // 日志文件名前缀.suffix("log") // 日志文件名后缀.suppress_timestamp(), // 日志名不包含日期).duplicate_to_stdout(flexi_logger::Duplicate::All).write_mode(WriteMode::Direct).start().unwrap();info!("abc");
}// 设置日志格式进行输出
#[test]
fn format_log_to_console() {Logger::try_with_str("info").unwrap().log_to_stdout().write_mode(WriteMode::Direct).format(file_log_format).start().unwrap();log::info!("info");
}fn file_log_format(w: &mut dyn std::io::Write,now: &mut DeferredNow,record: &Record,
) -> std::io::Result<()> {write!(w,"[{}][{}][{}][{}:{}] - {}",now.now().format("%Y-%m-%d %H:%M:%S%.3f"), // 时间戳record.level(),                            // 日志级别record.module_path().unwrap_or("<unkonwn>"), // 模块路径record.file().unwrap_or("<unkonw>"),       // 文件名record.line().unwrap_or(0),                // 行号&record.args()                             // 日志内容)
}// 输出到文件中的日志和控制台中的日志格式不同
#[test]
fn file_format_and_console_format() {let log_specification = LogSpecification::builder().default(log::LevelFilter::Info).build();Logger::with(log_specification).format_for_files(file_log_format).format_for_stdout(console_log_format).log_to_file(FileSpec::default().directory("src/logs")).duplicate_to_stdout(flexi_logger::Duplicate::All).start().unwrap();info!("This is a test log message.");
}fn console_log_format(w: &mut dyn std::io::Write,_now: &mut DeferredNow,record: &Record,
) -> std::io::Result<()> {write!(w, "{}", &record.args())
}

优点

高度可配置：提供了丰富的配置选项，几乎可以满足所有日志需求
多种输出目标：支持同时输出到文件、控制台等多个目标
灵活的写入模式：提供了多种写入模式（Direct、Buffer、BufferAndFlush等）
自定义格式：可以为不同的输出目标设置不同的日志格式
运行时配置：支持在程序运行时动态修改日志配置

缺点

API 复杂：功能丰富导致 API 相对复杂，学习曲线较陡
依赖较多：相比简单的日志库，依赖更多
配置繁琐：高级功能需要编写较多配置代码

适用场景

需要复杂日志功能的大型应用程序
需要将日志输出到多个目标的应用
需要在运行时动态调整日志配置的系统
对日志格式有特殊要求的应用

5. simple-log：简单易用的日志库

simple-log 是一个设计简洁、易于使用的日志库，支持本地文件或标准输出写入，适合那些不需要复杂配置的简单应用。

基本用法

use simple_log::{LogConfigBuilder, debug, info};#[test]
fn test_1() {simple_log::quick!("info");info!("abc");
}#[test]
fn test_2() {let log_config = LogConfigBuilder::builder().path("src/logs/simple.log").size(10).roll_count(8).time_format("%Y-%m-%d %H:%M:%S.%f").level("debug").unwrap().output_console().output_file().build();simple_log::new(log_config).unwrap();info!("abc");debug!("debug");
}