Rust是一門系統(tǒng)級編程語言，因其安全性、高性能和并發(fā)性而備受歡迎。在Rust應用程序中，日志記錄是一項非常重要的任務，因為它可以幫助開發(fā)人員了解應用程序的運行情況并解決問題。Rust的Log庫提供了一種簡單的方法來實現日志記錄，本文將介紹如何使用Rust的Log庫作為日志門面，并結合env_logger和log4rs兩個日志庫的實戰(zhàn)用例進行深入探討。

Rust的Log庫

Rust的Log庫是一個輕量級的日志記錄框架，它提供了一個簡單的API，可以方便地記錄日志。Log庫允許您將日志消息發(fā)送到控制臺、文件或任何其他自定義目標。Log庫還提供了一些有用的功能，如日志級別、日志過濾器和日志格式化。

類似于Java語言中的Slf4j日志庫，可以零開銷的幫助開發(fā)者切換底層依賴的日志庫實現。

引入Log庫依賴

在本系列教程的Cargo篇，我們提到了管理依賴，我們就引入過log庫，這里回顧一下。在Cargo.toml文件中添加以下依賴項, 引入Rust的Log庫依賴，具體配置如下：

[dependencies]
log = "0.4.0"
##    引入env_logger庫
env_logger = "0.9.0"

使用Log庫

在使用Rust的Log庫之前，您需要初始化日志記錄系統(tǒng)。這可以通過調用 log::set_logger() 函數來完成，該函數將日志記錄器注冊到全局日志記錄器中。 下面是通過簡單的示例：

use log::{info, LevelFilter};
use std::io::Write;

fn main() {
    //    使用env_logger日志庫，詳細的時候后續(xù)會深入講解
    env_logger::init();

    log::set_logger(&LOGGER).unwrap();
    log::set_max_level(LevelFilter::Info);

    info!("Hello, world!");
}

在這個示例中，我們使用了 env_logger 庫來初始化日志記錄系統(tǒng)。 env_logger 庫是一個流行的Rust日志記錄庫，它提供了一個簡單的方法來配置日志記錄器。在這個示例中，我們將日志記錄器注冊到全局日志記錄器中，并設置日志級別為 info 。最后，我們使用 info!() 宏來記錄日志消息。

日志級別

Rust的Log庫提供了五個日志級別，從最高到最低分別是：

• ? Error
• ? Warn
• ? Info
• ? Debug
• ? Trace

默認情況下，Log庫將記錄所有級別的日志消息。您可以通過調用 log::set_max_level() 函數來設置日志級別的閾值。例如，如果您只想記錄 warn 級別及以上的日志消息，可以使用以下代碼：

log::set_max_level(LevelFilter::Warn);

日志過濾器

Rust的Log庫還提供了一種過濾器機制，可以根據日志記錄器的名稱和日志級別來過濾日志消息。過濾器可以通過調用 log::set_logger() 函數時傳遞給日志記錄器。例如，如果您只想記錄名為 myapp::database 的記錄器的 info 級別及以上的日志消息，可以使用以下代碼：

use log::{info, LevelFilter};
use std::io::Write;

fn main() {
    env_logger::init();

    let filter = log::FilterBuilder::new()
        .target("myapp::database")
        .level(LevelFilter::Info)
        .build();

    log::set_logger(&LOGGER).unwrap();
    log::set_max_level(LevelFilter::Info);

    info!("Hello, world!");
}

在這個示例中，我們使用了 log::FilterBuilder 來創(chuàng)建一個過濾器，該過濾器將僅記錄名為 myapp::database 的記錄器的 info 級別及以上的日志消息。

日志格式化

Rust的Log庫允許您自定義日志消息的格式。默認情況下，Log庫將使用 {level} {message} 格式化日志消息。您可以通過調用 log::set_logger() 函數時傳遞一個自定義的格式字符串來自定義日志消息的格式。例如，以下代碼將使用自定義的格式字符串來格式化日志消息：

use log::{info, LevelFilter};
use std::io::Write;

fn main() {
    env_logger::init();

    let format = log::FormatBuilder::new()
        .format(|buf, record| {
            writeln!(buf, "{} [{}] - {}", chrono::Local::now().format("%Y-%m-%d %H:%M:%S"), record.level(), record.args())
        })
        .build();

    log::set_logger(&LOGGER).unwrap();
    log::set_max_level(LevelFilter::Info);

    info!("Hello, world!");
}

在這個示例中，我們使用了 log::FormatBuilder 來創(chuàng)建一個自定義的格式化程序，該程序將在日志消息中包含時間戳。我們將自定義的格式化程序傳遞給 log::set_logger() 函數，以便在記錄日志消息時使用它。

log4rs庫

log4rs是一個強大的日志記錄庫，它提供了許多高級功能，如多個日志記錄器、多個輸出目標和靈活的日志過濾器。log4rs庫是基于Rust的Log庫構建的，因此您可以使用Rust的Log庫的所有功能以及l(fā)og4rs庫的高級功能。

ps：假如你曾經接觸過log4j, 那么你會發(fā)現log4rs很多概念和設計都和log4j相似。

引入log4rs依賴

要使用log4rs庫，您需要在Cargo.toml文件中添加以下依賴項：

[dependencies]
log4rs = "1.2.0"

配置yaml

log4rs庫使用YAML或JSON格式的配置文件來配置日志記錄器。以下是一個簡單的log4rs配置文件示例：

refresh_rate: 30 seconds

appenders:
  stdout:
    kind: console
    encoder:
      pattern: "m5kw60s9xdeh [{l}] - {m}n"
  file:
    kind: file
    path: "logs/myapp.log"
    encoder:
      pattern: "m5kw60s9xdeh [{l}] - {m}n"

root:
  level: info
  appenders:
    - stdout
    - file

loggers:
  myapp::database:
    level: info
    appenders:
      - file

在這個示例中，我們定義了兩個輸出目標：一個是控制臺，另一個是文件。我們還定義了一個名為 myapp::database 的記錄器，它將日志消息發(fā)送到文件輸出目標。最后，我們將根記錄器配置為將日志消息發(fā)送到控制臺和文件輸出目標。

使用log4rs庫

要使用log4rs庫，您需要在應用程序中初始化日志記錄器。以下是一個簡單的示例：

use log::{info, LevelFilter};
use log4rs::config::{Config, ConfigHandle};

fn main() {
    let config: Config = log4rs::load_config_file("log4rs.yaml", Default::default()).unwrap();
    let handle: ConfigHandle = log4rs::init_config(config).unwrap();

    info!("Hello, world!");
}

在這個示例中，我們使用 log4rs::load_config_file() 函數從文件中加載配置文件。然后，我們使用 log4rs::init_config() 函數初始化日志記錄器。最后，我們使用 info!() 宏來記錄日志消息。

log4rs日志過濾器

log4rs庫提供了靈活的過濾器機制，可以根據記錄器的名稱、級別和其他屬性來過濾日志消息。以下是一個示例配置文件，其中定義了一個過濾器，該過濾器將僅記錄名為 myapp::database 的記錄器的 info 級別及以上的日志消息：

appenders:
  stdout:
    kind: console
    encoder:
      pattern: "m5kw60s9xdeh [{l}] - {m}n"
  file:
    kind: file
    path: "logs/myapp.log"
    encoder:
      pattern: "m5kw60s9xdeh [{l}] - {m}n"

root:
  level: info
  appenders:
    - stdout
    - file

loggers:
  myapp::database:
    level: info
    appenders:
      - file
    filters:
      - kind: threshold
        level: info

在這個示例中，我們定義了一個過濾器，該過濾器將僅記錄名為 myapp::database 的記錄器的 info 級別及以上的日志消息。

log4rs日志格式化

log4rs庫允許您自定義日志消息的格式。您可以通過在配置文件中設置輸出目標的 encoder.pattern 屬性來自定義日志消息的格式。例如，以下配置將使用自定義的格式字符串來格式化日志消息：

appenders:
  stdout:
    kind: console
    encoder:
      pattern: "m5kw60s9xdeh [{l}] - {m}n"
  file:
    kind: file
    path: "logs/myapp.log"
    encoder:
      pattern: "m5kw60s9xdeh [{l}] - {m}n"

在這個示例中，我們在輸出目標的 encoder.pattern 屬性中使用了自定義的格式字符串。

擴展閱讀 - tracing

一般來說，env_logger和log4rs已經能夠滿足絕大部門開發(fā)者的日志需求。但是在分布式應用，異步編程領域，log4rs輸出的日志由于沒有上下文環(huán)境信息，異步錯落的日志輸出，讓我們排查問題變得很痛苦，這種情況下，log4rs就顯得不太夠專業(yè)了，而tracing恰恰就有了用武之地。

不過鑒于tracing日志庫是一個非常龐雜的日志庫，要講透整個知識點需要先掌握分布式日志，鏈路追蹤等等一些列的基礎知識，所以博主先在這里提一句，挖個坑，后續(xù)針對tracing專門開一篇教程講解。

總結

Rust的Log庫和log4rs庫都是非常有用的日志記錄庫，它們提供了許多功能，可以幫助開發(fā)人員了解應用程序的運行情況并解決問題。Rust的Log庫是一個輕量級的日志記錄框架，它提供了一個簡單的API，可以方便地記錄日志。Log庫允許您將日志消息發(fā)送到控制臺、文件或任何其他自定義目標。Log庫還提供了一些有用的功能，如日志級別、日志過濾器和日志格式化。log4rs庫是一個強大的日志記錄庫，它提供了許多高級功能，如多個日志記錄器、多個輸出目標和靈活的日志過濾器。log4rs庫是基于Rust的Log庫構建的，因此您可以使用Rust的Log庫的所有功能以及l(fā)og4rs庫的高級功能。

使用Rust的Log庫和log4rs庫可以幫助您更好地了解應用程序的運行情況，更快地解決問題，并提高應用程序的可靠性和可維護性。