快捷導(dǎo)航

使用Rust實現(xiàn)日志記錄功能

更新時間：2024年04月02日 08:49:20 作者：二次元攻城獅

這篇文章主要為大家詳細介紹了使用Rust實現(xiàn)日志記錄功能的相關(guān)知識,文中的示例代碼講解詳細,具有一定的借鑒價值,有需要的可以參考一下

log 日志庫標(biāo)準(zhǔn)

log 是 Rust 的日志門面庫，由官方積極維護可以放心使用。它是Rust的日志門面，相應(yīng)的日志 API 已成為事實上的標(biāo)準(zhǔn)被其它日志框架所使用，有了日志門面開發(fā)者可以很方便切換自己的日志框架。

簡單示例

創(chuàng)建一個名為 log_test 二進制項目：

cargo new log_test

執(zhí)行以下命令，引入 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 僅僅是日志門面庫，對于庫和應(yīng)用的開發(fā)者來說使用方法是有區(qū)別的，這也是 log 包這么設(shè)計的優(yōu)勢所在。

庫的開發(fā)者

作為庫的開發(fā)者，你只要在庫中使用門面庫即可，將具體的日志庫交給用戶去選擇和綁定：

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);

    // 結(jié)束處理
}

應(yīng)用開發(fā)者

如果是應(yīng)用開發(fā)者，就需要去選擇一個具體的日志庫了。

目前已經(jīng)有了不少日志庫實現(xiàn)，官方在 github 上也推薦了一些，主要分為以下幾類：

簡單的最小記錄器，如 env_logger 等
復(fù)雜的可配置框架，如 log4rs 等
其他設(shè)施的適配器，如 syslog、db_logger 等
對于 WebAssembly 二進制文件：console_log
對于動態(tài)庫：需要在日志上構(gòu)造一個 FFI 安全包裝器，以便在庫中進行初始化。
實用程序，如 alterable_logger 等

log 還提供了 set_logger 函數(shù)用于設(shè)置日志庫，set_max_level 用于設(shè)置最大日志級別。但是選用的具體日志庫往往會提供更高級的 API，無需手動調(diào)用這兩個函數(shù)。

日志庫開發(fā)者

對于日志庫開發(fā)者而言，自然要實現(xiàn)自己的 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函數(shù)里面設(shè)置全局記錄器：

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

fn main() {
    //設(shè)置日志
    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");
}

運行后終端輸出如下，因為設(shè)置日志等級為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

配置文件

在項目根目錄下，創(chuàng)建一個 log4rs.yaml 配置文件，并添加以下內(nèi)容：

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

上面配置文件設(shè)定日志輸出到控制臺、文件，文件按10 mb大小滾動，只保留最近五個文件。各個配置字段的具體含義可以參考配置：

refresh_rate：用于確定 log4rs 掃描配置文件以查找更改的頻率，如果發(fā)現(xiàn)更改，記錄器將自動重新配置
appender：負責(zé)將日志收集到文件、控制臺或系統(tǒng)日志, 可配置多個
stdout、rolling_file：追加器的唯一標(biāo)識字符串，自己隨便定義，它的 kind 字段只支持console、file、rolling_file 三種實現(xiàn)
encoder：負責(zé)將 log 信息轉(zhuǎn)換為合適的格式, 如固定格式的平文本或json
pattern：編碼模板，格式可配置，具體格式詳見pattern
policy：策略字段，策略必須具有 kind 字段，默認（且僅受支持）策略為 kind: compound
trigger：觸發(fā)器字段用于指示何時滾動日志文件，支持 size 和 time 兩種類型，這里使用的是按大小

運行項目

修改main.rs內(nèi)容如下：

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);
    }
}

運行結(jié)果：