一个简单小巧的日志类

最新推荐文章于 2022-04-09 11:35:09 发布
最新推荐文章于 2022-04-09 11:35:09 发布
阅读量231 收藏
点赞数
分类专栏： C++ STL 文章标签： 日志 C++ Logger
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/kingfox/article/details/116369337
版权
C++ 同时被 2 个专栏收录
18 篇文章 2 订阅
订阅专栏
STL
2 篇文章 0 订阅
订阅专栏

其实网上可以找到很多日志库，不过大多太大、考虑得太细致，所以索性自己写个最适合自己用的。基本的需求是当程序在7*24运行时，每天能自动生成当日日志文件；能写入日志信息和操作代码；能按层级显示操作的从属等级。

类定义logger.h如下：

// logger.h
#ifndef __LOGGER_H
#define __LOGGER_H

#include <string>

/**
 * Logger 通用日志类。
 *       日志文本格式为：yyyy-MM-dd hh:mm:ss:sss - log-message-text, message-code, extension-code.
 *       根据不同的level设定，log-message-text前面会有3*N个"---"作为层级标识。
 *
 *       日志文件名格式为：prefix-yyyy-MM-dd.suffix。其中prefix是程序指定的文件名前缀，默认为"run"；suffix是程序指定的文件扩展名。
 *       默认为"log"。
 *       全局Logger实例runtimeLogger的默认文件名为"run-yyyy-MM-dd.log"。
 */
class Logger
{
   public:
      Logger();
      Logger(const char prefix[], const char suffix[]);
      Logger(const std::string& prefix, const  std::string& suffix);
      virtual ~Logger();

   public:
      /**
       * 写日志信息
       * @param msgText 字符数组，存放了日志消息正文
       * @param msgCode 整数，存放了日志消息代码，默认值为0
       * @param extCode 整数，存放了日志扩展代码，默认值为0
       * @param level   整数，指定日志层级，0是最高层级，默认值为0
       */
      virtual void write(const char msgText[], int msgCode = 0, int extCode = 0, int level = 0);

      /**
       * 写日志消息
       * @param msgText 字符串对象引用，存放了日志消息正文
       * @param msgCode 整数，存放了日志消息代码，默认值为0
       * @param extCode 整数，存放了日志扩展代码，默认值为0
       * @param level   整数，指定日志层级，0是最高层级，默认值为0
       */
      virtual void write(const std::string& msgText, int msgCode = 0, int extCode = 0, int level = 0);

      /**
       * 向日志文件中写入分隔行。分隔行由一系列相同的字符组成。
       * @param sepChar 字符类型常量，指定分隔行字符
       * @param length  整型常量，指定分隔行由多少个相同的字符组成
       */
      virtual void writeSeperatorLine(const char sepChar, const int length);

      /**
       * 根据前缀和后缀生成日志文件名
       * @param prefix  字符串常量对象引用，指定日志文件名前缀
       * @param suffix  字符串常量对象引用，指定日志文件名后缀
       * @return        形如prefix-yyyy-MM-dd.suffix的日志文件名字符串
       */
      static std::string generateFilename(const std::string& prefix, const std::string& suffix);

      /**
       * 根据指定的日期、前缀和后缀生成日志文件名
       * @param t       time_t类型，指定日志文件名的日期部分
       * @param prefix  字符串常量对象引用，指定日志文件名前缀
       * @param suffix  字符串常量对象引用，指定日志文件名后缀
       * @return        形如prefix-yyyy-MM-dd.suffix的日志文件名字符串
       */
      static std::string generateFilename(const time_t t, const std::string& prefix, const std::string& suffix);

      /**
       * 静态方法，向指定的日志文件中写入日志信息。
       * @param filename 字符串常量对象引用，指定日志文件名
       * @param msgText  字符串对象引用，存放了日志消息正文
       * @param msgCode  整数，存放了日志消息代码，默认值为0
       * @param extCode  整数，存放了日志扩展代码，默认值为0
       * @param level    整数，指定日志层级，0是最高层级，默认值为0
       */
      static void write(const std::string& filename, const std::string& msgText, int msgCode = 0, int extCode = 0, int level = 0);

      /**
       * 静态方法，向指定的日志文件中写入日志信息。
       * @param filename 字符串常量对象引用，指定日志文件名
       * @param msgText 字符数组，存放了日志消息正文
       * @param msgCode 整数，存放了日志消息代码，默认值为0
       * @param extCode 整数，存放了日志扩展代码，默认值为0
       * @param level   整数，指定日志层级，0是最高层级，默认值为0
       */
      static void write(const std::string& filename, const char msgText[], int msgCode = 0, int extCode = 0, int level = 0);

      /**
       * 静态方法，向指定的日志文件中写入分隔行
       * @param filename 字符串常量对象引用，指定日志文件名
       * @param sepChar  字符类型常量，指定分隔行字符
       * @param length   整型常量，指定分隔行由多少个相同的字符组成
       */
      static void writeSeperatorLine(const std::string& filename, const char sepChar, const int length);

      /**
       * 模板函数，合成可供写入日志的文本
       * @tparam T      指定待写入数据类型。该类型必须实现 << 操作符
       * @param oper    操作说明字符串
       * @param result  操作结果数据
       * @return        合成的文本，形如：OPERATOR: xxxxxx. RESULT: yyyyyy
       */
      template<typename T> static std::string getLogText(const std::string& oper, const T& result)
      {
         std::stringstream msgTxt;
         msgTxt << "OPERATOR: " << oper << ", RESULT: " << result;
         return msgTxt.str();
      }

      /**
       * 获取日志文件名前缀
       * @return 日志文件名前缀字符串
       */
      const std::string& getPrefix() const;
      /**
       * 设置日志文件名前缀
       * @param prefix 指定日志文件名的新前缀
       */
      void setPrefix(const std::string &prefix);

      /**
       * 获取日志文件名扩展名
       * @return 日志文件名扩展名字符串
       */
      const std::string& getSuffix() const;
      /**
       * 设置日志文件名扩展名
       * @param suffix 指定日志文件名的新的扩展名
       */
      void setSuffix(const std::string &suffix);

   protected:
      /**
       * 将指定的时间转换成日期字符串
       * @param t  time_t类型常量，指定待转换的时间值
       * @param sc 字符类型常量，指定年月日之间的分隔字符，默认为'-'
       * @return   返回形如yyyy-MM-dd的日期字符串
       */
      static std::string getDateString(const time_t t, const char sc = '-');

      /**
       * 将指定的时间转换为时刻字符串
       * @param t  time_t类型常量，指定待转换的时间值
       * @param sc 字符类型常量，指定时分秒之间的分隔字符，默认为':'
       * @return   返回形如hh:mm:ss的时间字符串
       */
      static std::string getTimeString(const time_t t, const char sc = ':');

      /**
       * 将指定的时间值转换为日期和时间字符串
       * @param t    time_t类型常量，指定待转换的时间值
       * @param dsc  字符常量，指定年月日之间的分隔符，默认为'-'
       * @param tsc  字符常量，指定时分秒之间的分隔符，默认为':'
       * @return     返回形如yyyy-MM-dd hh:mm:ss的日期及时间字符串
       */
      static std::string getDatetimeString(const time_t t, const char dsc = '-', const char tsc = ':');

      /**
       * 将指定的时间值转换为日期和时间（含毫秒）字符串
       * @param t    time_t类型常量，指定待转换的时间值
       * @param dsc  字符常量，指定年月日之间的分隔符，默认为'-'
       * @param tsc  字符常量，指定时分秒之间的分隔符，默认为':'
       * @param msc  字符常量，指定秒与毫秒之间的分隔符，默认为'.'
       * @return     返回形如yyyy-MM-dd hh:mm:ss.sss的日期及时间（含毫秒）字符串
       */
      static std::string getDatetimeString(const timeb& t, const char dsc = '-', const char tsc = ':', const char msc = '.');

   private:
      std::string prefix;
      std::string suffix;
};

extern Logger runtimeLogger;

#endif // __LOGGER_H

类实现logger.cpp代码如下：

// logger.cpp
#include <sys\timeb.h>
#include <fstream>
#include <sstream>
#include <iomanip>
#include "logger.h"

using namespace std;

Logger runtimeLogger("run", "log");

Logger::Logger()
{
   this->prefix = "run";
   this->suffix = "log";
}

Logger::Logger(const char prefix[], const char suffix[])
{
   this->prefix.append(prefix);
   this->suffix.append(suffix);
}

Logger::Logger(const std::string &prefix, const std::string &suffix)
{
   this->prefix.assign(prefix);
   this->suffix.assign(suffix);
}

Logger::~Logger()
{
}

void Logger::write(const char msgText[], int msgCode, int extCode, int level)
{
   struct timeb tb;
   ftime(&tb);
   string fullLogFilename = generateFilename(tb.time, prefix, suffix);
   ofstream ofs(fullLogFilename, ios::app);
   ofs << getDatetimeString(tb, '-', ':', '.') << " - ";
   for(int count = 0; count < level; count ++)
   {
      ofs << "---";
   }
   ofs << msgText << ", CODE: " << msgCode << ", " << extCode << "." << endl;
   ofs.close();
}

void Logger::write(const string& msgText, int msgCode, int extCode, int level)
{
   write(msgText.c_str(), msgCode, extCode, level);
}

std::string Logger::generateFilename(const std::string &prefix, const std::string &suffix)
{
   string fullLogFilename = generateFilename(time(nullptr), prefix, suffix);
   return fullLogFilename;
}

std::string Logger::generateFilename(const time_t t, const std::string &prefix, const std::string &suffix)
{
   string filename = prefix + "-" + getDateString(t, '-') + "." + suffix;
   return filename;
}

void Logger::write(const std::string &filename, const std::string &msgText, int msgCode, int exCode, int level)
{
   write(filename, msgText.c_str(), msgCode, exCode, level);
}

void Logger::write(const std::string &filename, const char msgText[], int msgCode, int extCode, int level)
{
   ofstream ofs(filename, ios::app);
   timeb tb;
   ftime(&tb);
   ofs << getDatetimeString(tb, '-', ':', '.') << " - ";
   for(int count = 0; count < level; count ++)
   {
      ofs << "---";
   }
   ofs << msgText << ", CODE: " << msgCode << ", " << extCode << "." << endl;
   ofs.close();
}

void Logger::writeSeperatorLine(const char sepChar, const int length)
{
   string filename = generateFilename(prefix, suffix);
   writeSeperatorLine(filename, sepChar, length);
}

void Logger::writeSeperatorLine(const std::string &filename, const char sepChar, const int length)
{
   FILE *ofp = fopen(filename.c_str(), "a");
   for(int count = 0; count < length; count ++)
   {
      fprintf(ofp, "%c", sepChar);
   }
   fprintf(ofp, "\n");
   fclose(ofp);
}

std::string Logger::getDateString(const time_t t, const char sc)
{
   struct tm *tp = localtime(&t);
   ostringstream oss;
   oss << setw(4) << setfill('0') << (tp->tm_year + 1900) << sc << setw(2) << setfill('0') << (tp->tm_mon + 1) << sc << setw(2) << setfill('0') << tp->tm_mday;
   return oss.str();
}

std::string Logger::getTimeString(const time_t t, const char sc)
{
   struct tm *tp = localtime(&t);
   ostringstream oss;
   oss << setw(2) << setfill('0') << tp->tm_hour << sc << setw(2) << setfill('0') << tp->tm_min << sc << setw(2) << setfill('0') << tp->tm_sec;
   return oss.str();
}

std::string Logger::getDatetimeString(const timeb& t, const char dsc, const char tsc, const char msc)
{
   ostringstream oss;
   oss << getDatetimeString(t.time, dsc, tsc) << msc << setw(3) << setfill('0') << t.millitm;
   return oss.str();
}

std::string Logger::getDatetimeString(const time_t t, const char dsc, const char tsc)
{
   ostringstream oss;
   oss << getDateString(t, dsc) << " " << getTimeString(t, tsc);
   return oss.str();
}

const std::string& Logger::getPrefix() const
{
   return prefix;
}

void Logger::setPrefix(const std::string &prefix)
{
   this->prefix = prefix;
}

const std::string& Logger::getSuffix() const
{
   return suffix;
}

void Logger::setSuffix(const std::string &suffix)
{
   this->suffix = suffix;
}

代码里有足够的注释，所以不解释了。

测试代码如下：

   void testLogger()
   {
      Logger logger("tc", "log");
      logger.write("write a message to the log file with default code, ext code and level.");
      logger.write("write a message to the log file with specified code and ext code.", 1, 2);
      logger.write("write a message to the log file with specified code, ext code and level.", 1, 2, 1);

      logger.write(Logger::getLogText<string>("calling getLogText", "OK"), 1);
      logger.write(Logger::getLogText<double>("calling getLogText", 0.142857), 2, 0, 1);
      logger.write(Logger::getLogText<int>("calling getLogText", 1024), 3, 1, 2);
   }

运行上述代码，将创建日志文件tc-2021-05-03.log，内容如下所示：

2021-05-03 09:18:33.244 - write a message to the log file with default code, ext code and level., CODE: 0, 0.
2021-05-03 09:18:33.244 - write a message to the log file with specified code and ext code., CODE: 1, 2.
2021-05-03 09:18:33.245 - ---write a message to the log file with specified code, ext code and level., CODE: 1, 2.
2021-05-03 09:18:33.245 - OPERATOR: calling getLogText, RESULT: OK, CODE: 1, 0.
2021-05-03 09:18:33.245 - ---OPERATOR: calling getLogText, RESULT: 0.142857, CODE: 2, 0.
2021-05-03 09:18:33.245 - ------OPERATOR: calling getLogText, RESULT: 1024, CODE: 3, 1.

以上日志文本中，每一行是一条日志，开头是动作发生的日期、时间（精确到毫秒），日志时间和日志正文之间用短横线分隔。日志正文前面没有三道短横线“---”的，表明这是顶级操作；前面有3*N个"---"的，表示这是上一条日志中所描述的动作的操作结果。这可以通过设置write(...)函数中的level的值来确定。

狐帝
关注
专栏目录
简易日志类
qlong_008的专栏
09-24 215
网络上目前开源日志类库包非常齐全，也用过LOG4之类的，做得都很好，但是有些时候可能只是为了简单记录日志辅助测试或部分维护，有些项目或者工具是非常轻量级的，而开源的日志库比如LOG4（很多语言和版本）却是一个比较重量的库包，我就特别不喜欢使用这些重量级的东西，编译、部署、安装包等都显得很是笨重，如果不是必要我一般都不用，也是基于此自己针对字符串、时间、文件、日志等常用编写一些简单的工具包，下面就是用C++写了一个超轻便的日志类，直接上源码： ////////////////////////////////
一个较为实用的日志类【Python】
最新发布
weixin_44545838的博客
12-01 432
在软件开发中，日志记录是一项重要的任务，它可以帮助我们跟踪应用程序的行为、故障排查和性能分析。为了简化日志记录的过程并提供更多的灵活性，下面介绍一个名为 LogUtil 的实用日志类。该日志类能够将信息输出到终端，同时存储到指定的log文件中。
一个简单的日志类
qq_34739614的博客
12-12 120
代码： class logger { /** * 记录日志 * @param string $level * @param string $message * @return bool */ public function logging($message = '', $level = 'info') { $filename = date(...
超简单的C++日志类
09-26
非常适合新手阅读, 代码量极少, 实现了日志最基本的需求, 有等级控制, 文件控制, 性能足够一般小型项目调试使用, 线程安全, 全局单例, 并有定义了几个宏, 可直接用宏, 使用方式类似于 printf, 支持不定参数
简单日志文件
weixin_30564901的博客
05-22 105
/********************************************************************** * 版权所有 (C)2015, 王茂春。 * * 文件名称：WriteLog.c * 文件标识：无 * 内容摘要：演示日志信息的打印方法 * 其它说明：无 第一，本文中对日志信息的写入采用的是直接在日志文件后面追加的方式，因此每次测试之前...
Simple Logging Library:一个简单的日志库-开源
04-25
标题中的“Simple Logging Library”指的是一个专为C++和Java开发者设计的日志库，它具有简单易用、体积小巧和可扩展的特点。日志库在软件开发中扮演着重要角色，帮助开发者记录程序运行时的信息，便于调试和问题...
Python-一个简单小巧可定制化轻量级的基于内存的Python缓存组件
08-10
标题中的“Python-一个简单小巧可定制化轻量级的基于内存的Python缓存组件”指的是一种Python库，它设计用于实现简单的内存缓存功能。这类组件在处理大量数据或者需要频繁读取已计算结果时特别有用，因为它可以减少...
SpringBoot日志系统，非常简单
m0_58039950的博客
04-09 2590
日志系统 SpringBoot为我们提供了丰富的日志系统，它几乎是开箱即用的。 日志门面和日志实现 我们首先要区分一下，什么是日志门面（Facade）什么是日志实现，我们之前学习的JUL实际上就是一种日志实现，我们可以直接使用JUL为我们提供的日志框架来规范化打印日志，而日志门面，如Slf4j，是把不同的日志系统的实现进行了具体的抽象化，只提供了统一的日志使用接口，使用时只需要按照其提供的接口方法进行调用即可，由于它只是一个接口，并不是一个具体的可以直接单独使用的日志框架，所以最终日志的格式、记录级别、输出
最简单方便小巧的FTP工具
09-07
例如，从提供的压缩包文件名`ftpserver.exe`可以推测，这可能是一个简单的FTP服务器程序，用户只需运行该程序，按照向导进行几步简单的设置，就能开启FTP服务。 2. 快速启动与关闭：在局域网内建立临时FTP服务器，...
一个简单的自定义程序日志小样例
01-02
代码如下: using System; using System.IO; using System.Text; public class LogInfo { private string ErrorInfo_User = “”; // 记录用户自定义错误信息 private string ErrorPosition = “”; // 记录错误的位置信息，可包括类、函数等 private string ErrorInfo_Sys = “”; // 记录系统产生的异常错误信息 // 记录日志信息 public void RecordErrorInfo(string Position, string
一个写log日志的类，简单高效
01-27
一个写Log日志的类，简单高效，多线程，有临界区保护，支持按日期，时间写日志
自己写的简易版Java日志类分享
09-03
主要介绍了自己写的简易版Java日志类分享,本文直接给出实现代码,需要的朋友可以参考下
Java自定义日志模块实现
06-18
自定义日志模块（接口及代理实现），而不直接使用第三方日志框架接口，避免在日志框架升级或者切换时，代码过多耦合。 这个举例说明一下： 比如，在某一项目开始时使用的是“log4j”框架，后面经过研究发现“sf4j”框架功能更强大，想切换到“sf4j”。常规的做法是，修改项目中每一处调用到“log4j”相关模块的代码。如果是项目比较大，所要花费的工作量也真不少，但如果使用了上面的方式，则只需要实现“LoggerAdapter”接口，使之与具体的日志（logger）进行适配，并且（如果必要）重写或者调整LoggerAdapterFacory类即可。 注意：代码使用的是utf-8编码
tiny-logger:轻巧的作曲家程序包，用于文件记录。 支持网页挂钩请求
04-19
轻巧的作曲家软件包，用于文件记录。 设定档案路径 要为所有日志文件全局设置路径，可以在引导文件中调用setPath方法。 use Serhii \ TinyLogger \ Logger ; Logger :: setPath ( 'logs/errors.log' ); // simple format Logger :: setPath ( 'logs/%s.log' , 'errors' ); // sprintf format 注意：如果要在cron脚本或WordPress钩之类的程序中使用记录器，则需要在脚本执行的第一步就调用setPath() ，这意味着您的项目可能有多个需要设置路径的地方为您的日志。 如果您不想调用setPath() ，则可以将路径作为第三个参数传递给tiny_log()函数。 请参阅“用法”部分中的示例。 用法 该软件包带有一个函数tiny_log()
templog:templog的镜像，Hendrik Schober的一个非常小巧，轻巧的C ++库
05-10
2. **创建日志记录器**：通过`templog::logger`类创建一个日志记录器实例，可以设置输出目的地，如标准输出、文件或网络。 3. **设置日志级别**：可以使用`setLogLevel`方法来设定记录哪些级别的日志。 4. **记录...
自定义简单日志记录类
Jia_ShengJie
11-24 1412
说明： 实在被log4net折磨的无语了，就自己写了一个简单的日志记录操作类。 源码如下(VS2015): /************************************************** * *命名空间： Common * 类名： FuncMyLog * 作者： 贾胜杰（2017/11/24/周五 9:22:34 ） *模块说明： 自定义日志类 *
最简单的日志管理方式
yyh_linux_note的博客
04-16 290
journal 1.journalctl 日志查看工具 -n 3 查看最新三条日志 -p err 查看错误日志 -o verbose 查看日志的详细参数 --since 查看从什么时间开始的日志 --until 查看到什么时间为止的日志 2.如何使用systemd-journald保存系统日志 默认system...
自定义日志类
weixin_30781775的博客
11-04 78
最近开发一个windows服务，需要各项操作和报错写入日志文件以备检查服务运行状态和错误，里面用到的方法其实也是个人在网上找的然后拼接在一起，其他不多说，代码如下： 1.默认日志存放在程序运行的目录，适合于windows服务和CS程序（其中DataAction为程序自定义的一个类,用的时候替换成自己实际程序里面随便一个类就行了） 1 public class MyLog 2 ...
简易SQLHelper：小巧实用的数据库操作类
"这是一个简单的SQLHelper类，适用于ASP.NET环境，主要提供基础的数据库操作，如增、删、查、改。该类包含三个核心方法，适合初学者学习和使用。可能需要根据实际项目调整命名空间以适应不同应用。" 在.NET开发中，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值