一個簡單的spdlog使用示例

来源:https://www.cnblogs.com/timefiles/archive/2023/08/26/17658766.html
-Advertisement-
Play Games

[TOC] spdlog是一個開源、跨平臺、無依賴、只有頭文件的C++11日誌庫,網上介紹的文章有很多這裡就不過多的介紹了,GitHub鏈接:[https://github.com/gabime/spdlog](https://github.com/gabime/spdlog)。 # 引用源碼 先下 ...


目錄
spdlog是一個開源、跨平臺、無依賴、只有頭文件的C++11日誌庫,網上介紹的文章有很多這裡就不過多的介紹了,GitHub鏈接:https://github.com/gabime/spdlog

引用源碼

先下載spdlog的源碼,將源碼的include文件夾複製到自己的項目文件夾下:
image

然後在項目屬性中包含include目錄,如下圖所示:
image

封裝Log頭文件

一般的項目對日誌要求都不高,主要是要求日誌線程安全、非同步寫入文件、每天生成新日誌、支持日誌回調顯示,spdlog稍微配置一下即可。
把spdlog相關的配置全放到Log.h文件中,封裝成Log頭文件有兩個好處:

  • 可以隨時替換後臺日誌實現
  • 對外只用暴露一個頭文件

Log頭文件的代碼如下:

#pragma once

#include "spdlog/spdlog.h"
#include "spdlog/async.h"
#include "spdlog/sinks/daily_file_sink.h"
#include "spdlog/stopwatch.h"
#include "spdlog/sinks/stdout_color_sinks.h"
#include "spdlog/sinks/callback_sink.h"
#include <iostream>

void init_spdlog()
{
    //非同步日誌,具有8k個項目和1個後臺線程的隊列
    spdlog::init_thread_pool(8192, 1);
    //標準控制台輸出
    auto stdout_sink = std::make_shared<spdlog::sinks::stdout_color_sink_mt >();
    stdout_sink->set_level(spdlog::level::debug);
    //日誌文件輸出,0點0分創建新日誌
    auto file_sink = std::make_shared<spdlog::sinks::daily_file_sink_mt>("logs/log.txt", 0, 0);
    file_sink->set_level(spdlog::level::info);
    //日誌回調
    auto callback_sink = std::make_shared<spdlog::sinks::callback_sink_mt>([](const spdlog::details::log_msg& msg)
        {
            //日誌記錄器名稱
            std::string name(msg.logger_name.data(), 0, msg.logger_name.size());
            //日誌消息
            std::string str(msg.payload.data(), 0, msg.payload.size());
            //日誌時間
            std::time_t now_c = std::chrono::system_clock::to_time_t(msg.time);

            //回調的處理邏輯自己根據項目情況定義,比如實時顯示到UI、保存到資料庫等等
            
            //.... 回調處理邏輯的示例
            //std::tm localTime;
            //localtime_s(&localTime, &now_c);
            //char timeStr[50];
            //std::strftime(timeStr, sizeof(timeStr), "%Y-%m-%d %H:%M:%S", &localTime);
            //// 獲取毫秒數
            //auto duration = msg.time.time_since_epoch();
            //auto milliseconds = std::chrono::duration_cast<std::chrono::milliseconds>(duration).count() % 1000;
            //std::cout << timeStr << "." << std::setfill('0') << std::setw(3) << milliseconds << " " ;
            //std::cout << to_string_view(msg.level).data() << " " << str << std::endl << std::endl << std::flush;

        });
    callback_sink->set_level(spdlog::level::info);

    std::vector<spdlog::sink_ptr> sinks{ stdout_sink, file_sink,callback_sink };
    auto log = std::make_shared<spdlog::async_logger>("logger", sinks.begin(), sinks.end(), spdlog::thread_pool(), spdlog::async_overflow_policy::block);

    //設置日誌記錄級別,您需要用 %^ 和 %$  括上想要彩色的部分
    log->set_level(spdlog::level::trace);
    //設置格式
    //參考 https://github.com/gabime/spdlog/wiki/3.-Custom-formatting
    //[%Y-%m-%d %H:%M:%S.%e] 時間
    //[%l] 日誌級別
    //[%t] 線程
    //[%s] 文件
    //[%#] 行號
    //[%!] 函數
    //[%v] 實際文本
    log->set_pattern("[%Y-%m-%d %H:%M:%S.%e] %^[%l]%$ [%t] [%s %!:%#] %v");
    //設置當出發 err 或更嚴重的錯誤時立刻刷新日誌到  disk
    log->flush_on(spdlog::level::err);
    //3秒刷新一次隊列
    spdlog::flush_every(std::chrono::seconds(3));
    spdlog::set_default_logger(log);
}

//單個日誌記錄器
std::shared_ptr<spdlog::logger>  get_async_file_logger(std::string name)
{
    auto log = spdlog::get(name);
    if (!log)
    {
        //指針為空,則創建日誌記錄器,
        log = spdlog::daily_logger_mt<spdlog::async_factory>(name, "logs/" + name + "/log.txt");
        log->set_level(spdlog::level::trace);
        log->flush_on(spdlog::level::err);
        log->set_pattern("[%Y-%m-%d %H:%M:%S.%e] %^[%l]%$ [%t] [%s %!:%#] %v");
        //記錄器是自動註冊的,不需要手動註冊  spdlog::register_logger(name);
    }
    return log;
}

#define INITLOG()     init_spdlog()


#define TRACE(...)     SPDLOG_TRACE(__VA_ARGS__)
#define DEBUG(...)     SPDLOG_DEBUG(__VA_ARGS__)
#define INFO(...)      SPDLOG_INFO(__VA_ARGS__)
#define WARN(...)      SPDLOG_WARN(__VA_ARGS__)
#define ERROR(...)     SPDLOG_ERROR(__VA_ARGS__)
#define CRITICAL(...)  SPDLOG_CRITICAL(__VA_ARGS__)

//單個日誌文件
#define GETLOG(LOG_NAME) get_async_file_logger(LOG_NAME)

#define LOGGER_TRACE(logger,...)     SPDLOG_LOGGER_TRACE(logger,__VA_ARGS__)
#define LOGGER_DEBUG(logger,...)     SPDLOG_LOGGER_DEBUG(logger,__VA_ARGS__)
#define LOGGER_INFO(logger,...)      SPDLOG_LOGGER_INFO(logger,__VA_ARGS__)
#define LOGGER_WARN(logger,...)      SPDLOG_LOGGER_WARN(logger,__VA_ARGS__)
#define LOGGER_ERROR(logger,...)     SPDLOG_LOGGER_ERROR(logger,__VA_ARGS__)
#define LOGGER_CRITICAL(logger,...)  SPDLOG_LOGGER_CRITICAL(logger,__VA_ARGS__)

//時間統計巨集
#define LOGSW() spdlog::stopwatch()

上面的代碼是用於初始化和配置spdlog庫的日誌記錄器的代碼。主要包括以下幾個部分:

  • init_spdlog()函數用於初始化spdlog庫的配置。該函數創建了一個包含控制台、文件和回調三種sink的日誌記錄器,並設置將其設置為預設記錄器。
  • get_async_file_logger()函數獲取一個單獨的非同步文件日誌記錄器,主要用於記錄多線程日誌,一般情況下用的比較少。
  • 用於簡化日誌記錄的操作一些巨集,spdlog自帶的有日誌巨集,這裡只是簡化一下並做隔離,實際上是對spdlog庫的相應函數進行了封裝。
  • 定義了一個LOGSW()巨集,用於方便地創建一個時間統計器,使用時不需要過多的關註統計類本身。

使用方法

使用方法如下:

#include "Log.h"
#include <thread>
#include <chrono>
#include <iostream>

int main()
{
    INITLOG("path");

    //單個日誌
    auto log1= GETLOG("Test1");
    auto log2= GETLOG("Test1");
    //原始調用方式
    //SPDLOG_LOGGER_INFO(log1, "123");
    LOGGER_INFO(log2, "123");

    auto sw = LOGSW();
    // 延時2秒
    std::this_thread::sleep_for(std::chrono::seconds(2)); 
    INFO("Elapsed {0} {1}","時間", sw);
    WARN("Elapsed {0} {1}", "時間", sw);
    //原始調用方式
    //SPDLOG_INFO("TEST");
    INFO("TEST");
}

最後生成的日誌文件如下:
image
image


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Go語言擁有三個用於輸出文本的函數: - Print() - Println() - Printf() Print() 函數以其預設格式列印其參數。 示例 列印 i 和 j 的值: ```Go package main import "fmt" func main() { var i, j stri ...
  • ### 1.Java是什麼呢? Java不僅是一門語言,而且是一個完整的平臺,有一個龐大的庫,其中包含了很多可重用的代碼和一個提供安全性、跨操作系統的可移植性以及自動垃圾收集等服務的執行環境。 更主要是JAVA已經具有強大的生態,使它具有了鮮活的生命力。 ### 2.JDK 和 JRE 是什麼? - ...
  • 前言 作為一名後端軟體工程師,工作中你肯定和 Redis 打過交道。但是Redis 為什麼快呢?很多人只能答出Redis 因為它是基於記憶體實現的,但是對於其它原因都是模棱兩可。 那麼今天就一起來看看是Redis 為什麼快吧: Redis 為什麼這麼快? 一、基於記憶體實現 Redis 是基於記憶體的數據 ...
  • 使用的依賴:Apache提供的poi包 首先導入依賴 <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi-ooxml</artifactId> <version>5.2.2</version> </dependency> 核心 ...
  • 問題代碼: 1 #include<windows.h> 2 #include<iostream> 3 #include<thread> 4 HANDLE h1; 5 HANDLE h2; 6 7 void CALLBACK test(PVOID a, BOOLEAN b) 8 { 9 std::co ...
  • ## IO 神器 Okio [官方](https://square.github.io/okio/) 是這麼介紹 Okio 的: > Okio is a library that complements java.io and java.nio to make it much easier to a ...
  • Python編程語言允許我們執行各種任務,所有這些都是在簡單模塊和短小精悍的代碼的幫助下完成的。在Python的幫助下進行屏幕截圖就是這樣一項任務。 Python為我們提供了許多模塊,使我們能夠執行不同的任務。有多種方法可以使用Python及其庫進行屏幕截圖。 ### 用Pyautogui模塊進行截 ...
  • 顧名思義,Python中的自動點擊器是一個簡單的Python應用程式,可以按照用戶的要求重覆點擊滑鼠。不同的參數,如速度、頻率和位置,可以根據用戶的要求進行改變。 Python有不同的模塊可用於控制鍵盤、滑鼠等設備。因此,我們可以使用這些模塊在Python中輕鬆創建一個自動點擊器。 本教程將展示在P ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...