跳转至

C++中跟踪执行方法的一种简便日志记录方法(补充参数记录)

本文是对《C++中跟踪执行方法的一种简便日志记录方法》一文的补充,描述了对于想要记录方法参数的日志的简便写法。

0. 接上文

本文是对《C++中跟踪执行方法的一种简便日志记录方法》一文的补充。

1. 具体代码

上面文章叙述的方法,对于不带参数的方法已经比较方便,但是对于带参数的方法,想要记录其参数,也可以构建另外一种构造方法来记录参数,如下所示。 头文件:

#ifndef FUNCTIONTRACKERLOGGER_H
#define FUNCTIONTRACKERLOGGER_H

#include <QString>
#include <QMap>

class FunctionTrackerLogger
{
public:
    FunctionTrackerLogger(QString functionName);
    FunctionTrackerLogger(QString functionName, QMap<QString, QString> params);
    ~FunctionTrackerLogger();

private:
    QString functionName;
};

#endif // FUNCTIONTRACKERLOGGER_H
源文件如下:
#include "FunctionTrackerLogger.h"

#include "Log.h"

FunctionTrackerLogger::FunctionTrackerLogger(QString functionName)
{
    this->functionName = functionName;
    LOG(LL_INFO, functionName, "Enter funtion.");
}

FunctionTrackerLogger::FunctionTrackerLogger(QString functionName, QMap<QString, QString> params)
{
    this->functionName = functionName;

    QString paramsStr;
    if(params.size() >= 1)
    {
        for(auto& key : params.keys())
        {
            if(!paramsStr.isEmpty())
            {
                paramsStr.append(",");
            }
            else
            {
                paramsStr.append("with params {");
            }
            paramsStr.append(QString(" %1 = %2").arg(key).arg(params[key]));
        }

        paramsStr.append("}");
    }
    QString msg = QString("Enter funtion%1.").arg(paramsStr);

    LOG(LL_INFO, functionName, msg);
}

FunctionTrackerLogger::~FunctionTrackerLogger()
{
    LOG(LL_INFO, functionName, "Leave funtion.");
}

2. 相应的使用

2.1 简单使用

这里如果想要调用无参数的方法就使用

FunctionTrackerLogger::FunctionTrackerLogger(QString functionName)
对于有参数的则使用:
FunctionTrackerLogger::FunctionTrackerLogger(QString functionName, QMap<QString, QString> params)
将其参数当成QMap<QString, QString>放进来,然后展开记录。

2.2 与之前的差异

之前简单的如下代码就能记录:

FunctionTrackerLogger logger = "VideoPrecessThread::check";
现在需要明确构造函数的调用:
 FunctionTrackerLogger logger = QString("VideoPrecessThread::check");

3. 扩展

通过使用QSharedPointer自定义析构函数,来进行离开日志的记录,参见《使用C++利用对象的生命周期来记录离开方法的日志》一文。