Rust是一門系統(tǒng)級(jí)編程語(yǔ)言，因其安全性、高性能和并發(fā)性而備受歡迎。在Rust應(yīng)用程序中，日志記錄是一項(xiàng)非常重要的任務(wù)，因?yàn)樗梢詭椭_(kāi)發(fā)人員了解應(yīng)用程序的運(yùn)行情況并解決問(wèn)題。Rust的Log庫(kù)提供了一種簡(jiǎn)單的方法來(lái)實(shí)現(xiàn)日志記錄，本文將介紹如何使用Rust的Log庫(kù)作為日志門面，并結(jié)合env_logger和log4rs兩個(gè)日志庫(kù)的實(shí)戰(zhàn)用例進(jìn)行深入探討。

Rust的Log庫(kù)

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

類似于Java語(yǔ)言中的Slf4j日志庫(kù)，可以零開(kāi)銷的幫助開(kāi)發(fā)者切換底層依賴的日志庫(kù)實(shí)現(xiàn)。

引入Log庫(kù)依賴

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

[dependencies]
log = "0.4.0"
##    引入env_logger庫(kù)
env_logger = "0.9.0"

使用Log庫(kù)

在使用Rust的Log庫(kù)之前，您需要初始化日志記錄系統(tǒng)。這可以通過(guò)調(diào)用 log::set_logger() 函數(shù)來(lái)完成，該函數(shù)將日志記錄器注冊(cè)到全局日志記錄器中。 下面是通過(guò)簡(jiǎn)單的示例：

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

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

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

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

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

日志級(jí)別

Rust的Log庫(kù)提供了五個(gè)日志級(jí)別，從最高到最低分別是：

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

默認(rèn)情況下，Log庫(kù)將記錄所有級(jí)別的日志消息。您可以通過(guò)調(diào)用 log::set_max_level() 函數(shù)來(lái)設(shè)置日志級(jí)別的閾值。例如，如果您只想記錄 warn 級(jí)別及以上的日志消息，可以使用以下代碼：

log::set_max_level(LevelFilter::Warn);

日志過(guò)濾器

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

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

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

日志格式化

Rust的Log庫(kù)允許您自定義日志消息的格式。默認(rèn)情況下，Log庫(kù)將使用 {level} {message} 格式化日志消息。您可以通過(guò)調(diào)用 log::set_logger() 函數(shù)時(shí)傳遞一個(gè)自定義的格式字符串來(lái)自定義日志消息的格式。例如，以下代碼將使用自定義的格式字符串來(lái)格式化日志消息：

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

在這個(gè)示例中，我們使用了 log::FormatBuilder 來(lái)創(chuàng)建一個(gè)自定義的格式化程序，該程序?qū)⒃谌罩鞠⒅邪瑫r(shí)間戳。我們將自定義的格式化程序傳遞給 log::set_logger() 函數(shù)，以便在記錄日志消息時(shí)使用它。

log4rs庫(kù)

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

ps：假如你曾經(jīng)接觸過(guò)log4j, 那么你會(huì)發(fā)現(xiàn)log4rs很多概念和設(shè)計(jì)都和log4j相似。

引入log4rs依賴

要使用log4rs庫(kù)，您需要在Cargo.toml文件中添加以下依賴項(xiàng)：

[dependencies]
log4rs = "1.2.0"

配置yaml

log4rs庫(kù)使用YAML或JSON格式的配置文件來(lái)配置日志記錄器。以下是一個(gè)簡(jiǎn)單的log4rs配置文件示例：

refresh_rate: 30 seconds

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

root:
  level: info
  appenders:
    - stdout
    - file

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

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

使用log4rs庫(kù)

要使用log4rs庫(kù)，您需要在應(yīng)用程序中初始化日志記錄器。以下是一個(gè)簡(jiǎn)單的示例：

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

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

log4rs日志過(guò)濾器

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

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

root:
  level: info
  appenders:
    - stdout
    - file

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

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

log4rs日志格式化

log4rs庫(kù)允許您自定義日志消息的格式。您可以通過(guò)在配置文件中設(shè)置輸出目標(biāo)的 encoder.pattern 屬性來(lái)自定義日志消息的格式。例如，以下配置將使用自定義的格式字符串來(lái)格式化日志消息：

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

在這個(gè)示例中，我們?cè)谳敵瞿繕?biāo)的 encoder.pattern 屬性中使用了自定義的格式字符串。

擴(kuò)展閱讀 - tracing

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

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

總結(jié)

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

使用Rust的Log庫(kù)和log4rs庫(kù)可以幫助您更好地了解應(yīng)用程序的運(yùn)行情況，更快地解決問(wèn)題，并提高應(yīng)用程序的可靠性和可維護(hù)性。