文盤Rust -- 給程式加個日誌

日誌是應用程式的重要組成部分。無論是服務端程式還是客戶端程式都需要日誌做為錯誤輸出或者業務記錄。在這篇文章中，我們結合log4rs聊聊rust 程式中如何使用日誌。
log4rs類似java生態中的log4j,使用方式也很相似

log4rs中的基本概念

log4rs 的功能組件也由 appender 和 logger構成。

• appender
  負責向指定文件或控制台追加日誌

• logger
  包含多個 appender ，比如一條日誌既要輸出到控制台也要持久化到日誌文件中，就可以在logger中同時綁定 ConsoleAppender 和 FileAppender

log4rs 使用示例

• 示例描述
  我們需要在工程中記錄系統日誌和業務日誌，分別記錄在logs/sys.log 和 logs/business.log

• 定義 appender 和 logger 並初始化
  代碼位置 src/logger/logger.rs

  
    let sys_file = FileAppender::builder()
        .encoder(Box::new(PatternEncoder::new("{d} - {m}{n}")))
        .build("logs/sys.log")
        .unwrap();
    let business_file = FileAppender::builder()
        .encoder(Box::new(PatternEncoder::new("{d} - {m}{n}")))
        .build("logs/business.log")
        .unwrap();
  
    let stdout = ConsoleAppender::builder().build();
  
    let config = Config::builder()
        .appender(Appender::builder().build("stdout", Box::new(stdout)))
        .appender(Appender::builder().build("sys", Box::new(sys_file)))
        .appender(Appender::builder().build("business", Box::new(business_file)))
        .logger(
            Logger::builder()
                .appender("sys")
                .build("syslog", LevelFilter::Info),
        )
        .logger(
            Logger::builder()
                .appender("business")
                .build("businesslog", LevelFilter::Info),
        )
        .build(
            Root::builder()
                .appender("stdout")
                .appender("file_out")
                .build(LevelFilter::Info),
        )
        .unwrap();
  
    let _ = log4rs::init_config(config).unwrap();
  
  
  

代碼中定義了 sys_file 和 business_file 兩個FileAppender 分別用於像sys.log 和 business.log中追加日誌。

config 中定義了兩個logger 分別綁定 sys appender 和 business appender。
最後通過 init_config 初始化 log4rs。

• 在程式中輸出日誌

  • 定義 uselog 命令及兩個子命令，分別輸入sys 日誌和 business 日誌。
    代碼位置 src/cmd/cmdusedifflogger.rs

    pub fn new_use_log_cmd() -> Command<'static> {
        clap::Command::new("uselog")
            .about("use diffrent target log")
            .subcommand(new_use_sys_log_cmd())
            .subcommand(new_use_business_log_cmd())
    }
    
    pub fn new_use_sys_log_cmd() -> Command<'static> {
        clap::Command::new("syslog").about("append to syslog")
    }
    
    pub fn new_use_business_log_cmd() -> Command<'static> {
        clap::Command::new("businesslog").about("append to business log")
    }
    
    
    

  • 解析命令並輸出日誌
    代碼位置 src/cmd/rootcmd.rs

    if let Some(ref log) = matches.subcommand_matches("uselog") {
        println!("use log");
        if let Some(_) = log.subcommand_matches("syslog") {
            log::info!(target:"syslog","Input sys log");
        }  
        if let Some(_) = log.subcommand_matches("businesslog") {
            log::info!(target:"businesslog","Input business log");
        }
    }
    
    
    

輸出時，通過 target 來區分輸出到不同的logger。

本問代碼的github地址：https://github.com/jiashiwen/interactcli-rs

下期見

作者：京東科技 賈世聞

來源：京東雲開發者社區 轉載請註明來源