使用Rust实现日志记录功能

更新时间：2024年04月02日 08:49:20 作者：二次元攻城狮

这篇文章主要为大家详细介绍了使用Rust实现日志记录功能的相关知识,文中的示例代码讲解详细,具有一定的借鉴价值,有需要的可以参考一下

log 日志库标准

log 是 Rust 的日志门面库，由官方积极维护可以放心使用。它是Rust的日志门面，相应的日志 API 已成为事实上的标准被其它日志框架所使用，有了日志门面开发者可以很方便切换自己的日志框架。

简单示例

创建一个名为 log_test 二进制项目：

cargo new log_test

执行以下命令，引入 log 依赖：

cargo add log

修改 main.rs 的代码如下：

use log::{info, warn,error,trace};

fn main() {
    // 记录日志
    info!("This is an info message");
    warn!("This is a warning message");
    error!("This is an error message");
    trace!("This is an trace message");
}

运行上面的示例，实际上看不到任何输出。因为 log 仅仅是日志门面库，它并不具备完整的日志库功能！

使用方法

因为 log 仅仅是日志门面库，对于库和应用的开发者来说使用方法是有区别的，这也是 log 包这么设计的优势所在。

库的开发者

作为库的开发者，你只要在库中使用门面库即可，将具体的日志库交给用户去选择和绑定：

use log::{info, trace, warn};
pub fn deal_with_something() {
    // 开始处理

    // 记录一些日志
    trace!("a trace log");
    info!("a info long: {}", "abc");
    warn!("a warning log: {}, retrying", err);

    // 结束处理
}

应用开发者

如果是应用开发者，就需要去选择一个具体的日志库了。

目前已经有了不少日志库实现，官方在 github 上也推荐了一些，主要分为以下几类：

简单的最小记录器，如 env_logger 等
复杂的可配置框架，如 log4rs 等
其他设施的适配器，如 syslog、db_logger 等
对于 WebAssembly 二进制文件：console_log
对于动态库：需要在日志上构造一个 FFI 安全包装器，以便在库中进行初始化。
实用程序，如 alterable_logger 等

log 还提供了 set_logger 函数用于设置日志库，set_max_level 用于设置最大日志级别。但是选用的具体日志库往往会提供更高级的 API，无需手动调用这两个函数。

日志库开发者

对于日志库开发者而言，自然要实现自己的 Log 特征:

use log::{Record, Level, Metadata};
struct SimpleLogger;
impl log::Log for SimpleLogger {
    fn enabled(&self, metadata: &Metadata) -> bool {
        metadata.level() <= Level::Info
    }
    fn log(&self, record: &Record) {
        if self.enabled(record.metadata()) {
            println!("{} - {}", record.level(), record.args());
        }
    }
    fn flush(&self) {}
}

除此之外，还需要包装下 set_logger 和 set_max_level:

use log::{SetLoggerError, LevelFilter};
static LOGGER: SimpleLogger = SimpleLogger;
pub fn init() -> Result<(), SetLoggerError> {
    log::set_logger(&LOGGER)
        .map(|()| log::set_max_level(LevelFilter::Info))
}

然后再main函数里面设置全局记录器：

use log::{info, warn,error,trace};

fn main() {
    //设置日志
    init();
    // 记录日志
    info!("This is an info message");
    warn!("This is a warning message");
    error!("This is an error message");
    trace!("This is an trace message");
}

运行后终端输出如下，因为设置日志等级为Info，所以没有输出Trace等级日志：

INFO - This is an info message
WARN - This is a warning message
ERROR - This is an error message

使用 log4rs

log4rs 是一个高度可配置的日志框架，以 Java 的 Logback 和 log4j 库为模型。

添加依赖

为项目添加 log4rs 依赖：

cargo add log4rs

配置文件

在项目根目录下，创建一个 log4rs.yaml 配置文件，并添加以下内容：

refresh_rate: 30 seconds

appenders:
  stdout:
    kind: console
    encoder:
      pattern: "{d(%Y-%m-%d %H:%M:%S.%f)} [{l}] {t} - {m}{n}"
  
  rolling_file:
    kind: rolling_file
    path: logs/test.log
    append: true 
    encoder:
      pattern: "{d(%Y-%m-%d %H:%M:%S.%f)} [{l}] {t} - {m}{n}"
    policy:
      kind: compound
      trigger:
        kind: size
        limit: 10 mb
      roller:        
        kind: fixed_window
        pattern: logs/test.{}.log
        base: 1
        count: 5
        
root:
  level: info 
  appenders:
    - stdout
    - rolling_file

上面配置文件设定日志输出到控制台、文件，文件按10 mb大小滚动，只保留最近五个文件。各个配置字段的具体含义可以参考配置：

refresh_rate：用于确定 log4rs 扫描配置文件以查找更改的频率，如果发现更改，记录器将自动重新配置
appender：负责将日志收集到文件、控制台或系统日志, 可配置多个
stdout、rolling_file：追加器的唯一标识字符串，自己随便定义，它的 kind 字段只支持console、file、rolling_file 三种实现
encoder：负责将 log 信息转换为合适的格式, 如固定格式的平文本或json
pattern：编码模板，格式可配置，具体格式详见pattern
policy：策略字段，策略必须具有 kind 字段，默认（且仅受支持）策略为 kind: compound
trigger：触发器字段用于指示何时滚动日志文件，支持 size 和 time 两种类型，这里使用的是按大小

运行项目

修改main.rs内容如下：

use log::*;
use log4rs;

fn main() {
    log4rs::init_file("log4rs.yaml", Default::default()).unwrap();

    for i in 1..=1000 {
        info!("This is loop iteration {}", i);
    }
}

运行结果：

2024-04-01 15:43:28.596832500 [INFO] hello_world - This is loop iteration 1

到此这篇关于使用Rust实现日志记录功能的文章就介绍到这了,更多相关Rust日志记录内容请搜索程序员之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持程序员之家！

您可能感兴趣的文章:

Rust
日志

Rust中引用的具体使用
在Rust语言中,引用机制是其所有权系统的重要组成部分,ust提供了两种类型的引用,不可变引用和可变引用,本文就来详细的介绍一下这两种的用法,感兴趣的可以了解一下
2024-03-03
聊聊Rust 运算符
运算符用于对数据执行一些操作。被运算符执行操作的数据我们称之为操作数。下面通过本文给大家介绍Rust 运算符的相关知识，感兴趣的朋友一起看看吧
2021-11-11
Rust语言之trait中的个方法可以重写吗
在Rust中,trait定义了一组方法,这些方法可以被一个或多个类型实现,当你为某个类型实现一个trait时,你可以为该trait中的每个方法提供自己的具体实现,本文将给大家介绍一下trait中的个方法是否可以重写,需要的朋友可以参考下
2023-10-10
Rust?中?Deref?Coercion讲解
Rust 的设计理念一向是显式比隐式好，也就是说所有的行为尽量在代码中表现出来，这篇文章主要介绍了Rust?中?Deref?Coercion?介绍,需要的朋友可以参考下
2022-10-10
Tauri?打开本地文件踩坑分析解决
这篇文章主要为大家介绍了Tauri?打开本地文件踩坑分析解决，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-04-04
rust声明式宏的实现
声明式宏使得你能够写出类似?match?表达式的东西,来操作你所提供的?Rust代码,它使用你提供的代码来生成用于替换宏调用的代码,感兴趣的可以了解一下
2023-12-12
Rust中使用Serde对json数据进行反序列化
JSON作为目前流行的数据格式之一,被大家广泛使用,在日常的开发实践中,将JSON数据反序列化为对应的类型具有重要的意义,在Rust中,Serde几乎成了JSON数据解析的事实标准,本文将给大家介绍Rust中使用Serde对json数据进行反序列化,需要的朋友可以参考下
2024-01-01
Rust多线程Web服务器搭建过程
这篇文章主要介绍了Rust多线程 Web 服务器搭建过程,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2023-04-04
Rust裸指针的安全性实例讲解
裸指针是一个不包含所有权和借用关系的原始指针，它们与常规指针相比没有任何限制和保护措施，这篇文章主要介绍了Rust裸指针的安全性实例,需要的朋友可以参考下
2023-05-05
libbpf和Rust开发ebpf程序实战示例
这篇文章主要为大家介绍了libbpf和Rust开发ebpf程序实战示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-12-12