P11 如何写一个C++类 Log日志基础

01 前言

到目前为止，我们学了类 class，本期我们要尝试着从头开始写一个类。

本期不会讲的太深。我们不会写非常复杂的类，我们要会完成一个基本的 log 类

02 为什么使用 log

首先我们先分析一下我们的需求，这个 log 类到底是什么？具体要完成什么功能？

这个 log 类是我们管理日志信息的一种方式，换句话说我们想要我们的程序打印消息或信息到控制台。这个通常对调试代码非常有帮助。

比如，在游戏或应用中，如果我们想知道发生了什么，你只需将事务的状态打印到控制台，因为应用程序中的控制台就像一个展示信息的地方，我们可以用它来打印出发生了什么。这也是几乎可以保证代码在正确工作的东西。

控制台基本上是内置在操作系统中的东西，所以我们几乎可以保证它不会出问题。

我很喜欢用 log 类作为例子，

1. 因为日志系统可以根据您的需要从简单的或复杂的都行，——有些日志系统非常复杂，甚至有可能有几千行代码，而这些仅仅是为了把东西打印到控制台。但它们对调试和开发非常重要，所以花点时间在这上面是值得的。
2. log 日志系统不仅可以做简单将信息打印到控制台这样的事情，也可以用不同颜色打印或是通过网络输出日志消息到一个文件，你可以做很多事情，你最终完成的 log 类十行到一万行代码都行。就是这样。

这就是为什么我会说 log 是一个很好的例子的原因。

03 log 需要包括哪些参数

log 类开始的时候非常简单，它提供向控制台写入文本的能力并保持某种日志级别，也就是我们真正想要发送给控制台的日志信息的级别，开始我们有三个层次

• 错误 eror
• 警告 warning
• 信息 information

我们将来可能我们的日志系统级别设置为警告 warning。这意味着只会打印警告和错误而不会打印跟踪消息。这是非常有用的。如果你不想看到一堆信息，你只想知道哪里出了问题或者你的警告是什么，同样通过过滤实际发送和打印的内容。控制台也会很清爽

我们首先肯定是先实例化一个 log。然后，我们可能指定某种日志级别作为一个实际参数，暂且先跳过它。

log 肯定会设置一个 log 级别， SetLevel 方法的参数 WarnLevel就是指 warning 级别，这意味着只有警告或更重要的信息，比如警告或错误，才会被打印出来。但不跟踪消息。

然后我可能想要打印一个警告信号。

通过以上模拟操作，现在我知道了我的 log 类大概是什么样子了，我们可以直接回去类中开始填空。

这两个函数都是需要能够在外部访问的，所以我们设置它的可见性为 public。

首先是 SetLevel 函数，将 log 级别也就是 level 作为函数的整型参数，这样比较简单。然后这个函数会做一些事情。

然后还有一个 Warnint 函数，它有一个 const char 的参数，是我们的 message。const char 就是字符串的意思，后面我们会专门有一期介绍字符串的内容，现在先知道这些就可以了。

我们现在还有一个问题，这几个函数都已经存在了，可是 lWarningLevel 不存在，让我们开始声明 log 的级别变量。

我们创建一个私有的成员变量来保存我们的 log 级别的设定，它是一个整形，我把它叫做 M_Level，——按照惯例我使用了M_作为前缀，这样可以提示我们这是一个私有的类成员变量，通过这样的方式当我在函数内部写代码时，我就能知道在类代码中哪些是成员变量哪些只是局部变量，当然这样的写法约定不是必须的，但是它确实对整理你的代码并保持代码干净很有帮助。特别是当你处理大型代码库和复杂类这样的东西时。所以我建议大家遵循这样的惯例。

顺便，我们快速地将 SetLevel 函数设置完成。在它里面将参数值赋值给成员变量 M_Level。

让我们回到 main中，处理 LogLevelWarning 这个地方。

我们前面已经规划好了，设为 2 的意思是信息（或者跟踪），1的意思是警告，0的意思是错误，直接这样设置的话，代码读起来有点困难，如果我写的代码是那样的话，读代码的时候会有很多疑问，什么是1？1是个啥？我会不知道它是什么意思，只能靠记忆来记住它代表什么意思，我不想这样处理这个问题。因此我们要创建一些变量，当它的值是某些值的时候表示我们想要表示的东西。

我们在这里将它们设为公共 public 变量，你可以看到我在 log 类中用了两次 public，我喜欢把类中不同的部分分开来写，换句话说，public 方法可能在一个部分，然后 public 变量可以放在另一部分， public 静态变量可能会放在另一块中，这就是我的风格，你可以参考。

这些都是参数，所以我将它设置为 const int ，然后将 LogLevelWarning 设为1，我们还需要为错误写一个日志级别，LogLevelError 设置为零，然后我要为日志的信息跟踪再写一个 LogLevelInfo，让它等于2。

因此我们有三种类型的日志消息，我们有错误 Error、警告 warning、还有信息 information，默认情况下我会把我的日志级别设置为 LogLevelInfo，意思是把所有的东西都应该打印出来。

以上。

最后我们完善一下类里面的方法

我们现在有个问题。

我们当前的代码没有办法做到这个需求：如果日志级别设置成了 warning，就不要打印所有的 Info 消息。

我们可以通过添加 if 语句来搞定这个。

如果日志级别大于或等于这个特定的消息级别，那么就继续，Warn 和 Info方法也是一样的。然后我们将main函数中的 LogLevelWarning 调整为 log.LogLevelWarning。我们已经将 log 设置为警告级别。

04 运行log代码

运行我们的代码，看看具体的效果。我们试试打印 warning信息和 Error信息。

没有问题，就是我们想的那样。

后话

我们实现了所有的目标，创造了一个非常基本的 log 类。

但是我想说这绝对不是我自己写 log 类的方式，因为有一些问题需要解决，一个经验丰富的程序员是不会这样写的，这不是特别完整的代码，但它是比较基础的代码

#include  

class Log
{
public:
    const int LogLevelError = 0; //日志级别Error = 0
    const int LogLevelWarning = 1; //
    const int LogLevelInfo = 2; //

private:
    int m_level;  //私有的变量，用于类的内部

public:
    void setLevel(int level)   //设置日志级别
    {
        m_level = level;    //
    }
    void Error (const char* messge)   //打印警告级别的日志信息
    {
        if(m_level >= LogLevelError)
            std::cout << messge << std::endl;
    }

    void warning(const char* messge)   //打印警告级别的日志信息
    {
        if(m_level >= LogLevelWarning)
            std::cout << messge << std::endl;
    }

    void Info(const char* messge)   //打印警告级别的日志信息
    {
        if(m_level >= LogLevelInfo)
            std::cout << messge << std::endl;
    }

};


int main()
{
    Log log;
    log.setLevel(log.LogLevelWarning);   //日志级别设为warning 1
    log.warning("hello ,this is warning");
    log.Error("hello,this is Error"); //
    log.Info("this is Info"); //
    return  0;
}