QMessageLogger魔法是如何工作的?

时间:2016-10-31 22:11:20

标签: c++ qt logging

我正在研究QT应用程序的记录器框架。由于理解和学习目的,我没有直接使用QMessageLogger。关于一个QMessageLogger功能有一件事,我真的想在我的记录器中有,但我不知道它是如何工作的。让我们以qDebug宏:

为例
#define qDebug QMessageLogger(QT_MESSAGELOG_FILE, QT_MESSAGELOG_LINE, QT_MESSAGELOG_FUNC).debug

可以通过两种方式调用此函数: 第一种方式:

qDebug("abc = %u", abc);
第二种方式:

qDebug() << "abc = " << abc;

我正在查看库代码,但我不太明白如何通过使用QMessageLogger以及一些流对象来实现va_args。 我怎样才能达到这样的效果?我非常感谢所有人的帮助,非常感谢你的一个例子。

这是我的print方法正文。我需要用“流”方式实现类似的功能:

/*!
 * \brief Adds the log line to the print queue.
 * \param lvl: Log level of the line.
 * \param text: Formatted input for va_list.
 */
void CBcLogger::print(MLL::ELogLevel lvl, const char* text, ...)
{
    // check if logger initialized
    if (!m_loggerStarted)
        return;

    // check if log level sufficient
    if (lvl > m_setLogLvl)
        return;

    logLine_t logline;
    logline.loglvl = lvl;
    logline.datetime = QDateTime::currentDateTime();

    va_list argptr;
    va_start(argptr, text);

    char* output = NULL;
    if (vasprintf(&output, text, argptr))
    {
        logline.logstr = output;
        delete output;
    }

    va_end(argptr);
    emit addNewLogLine(logline);
}

1 个答案:

答案 0 :(得分:6)

首先,您需要了解以下内容

QMessageLogger(QT_MESSAGELOG_FILE, QT_MESSAGELOG_LINE, QT_MESSAGELOG_FUNC).debug

上面的行构造了一个QMessageLogger实例并立即访问其调试成员。因为它是一个宏,所以你在代码之后编写的内容也很重要。

如果您查看QMessageLogger::debug是什么,您会看到四个重载,其中前两个与您的问题相关:

void debug(const char *msg, ...) const Q_ATTRIBUTE_FORMAT_PRINTF(2, 3);
QDebug debug() const;
QDebug debug(const QLoggingCategory &cat) const;
QDebug debug(CategoryFunction catFunc) const;

现在问题应该很简单。如果您调用qDebug("abc = %u", abc),则调用第一个重载,扩展宏如下:

QMessageLogger(QT_MESSAGELOG_FILE, QT_MESSAGELOG_LINE, QT_MESSAGELOG_FUNC).debug("abc = %u", abc)

或多或少等于

QMessageLogger temp(QT_MESSAGELOG_FILE, QT_MESSAGELOG_LINE, QT_MESSAGELOG_FUNC);
temp.debug("abc = %u", abc);

在第二种情况下,您正在调用一个返回QDebug对象的重载。 QDebug已超载operator<<。扩展的宏如下:

QMessageLogger(QT_MESSAGELOG_FILE, QT_MESSAGELOG_LINE, QT_MESSAGELOG_FUNC).debug() << "abc = " << abc;

或多或少等于

QMessageLogger temp(QT_MESSAGELOG_FILE, QT_MESSAGELOG_LINE, QT_MESSAGELOG_FUNC);
QDebug anotherTemp = temp.debug();
anotherTemp << "abc = " << abc;

以下是此类记录器的简单实现:

void addNewLogLine(char const* ptr){
    cout << "addNewLogLine: " << ptr << endl;
}
struct LoggerHelper
{
    std::stringstream s;

    explicit LoggerHelper()=default;
    LoggerHelper(LoggerHelper&&) = default;

    ~LoggerHelper(){
        auto str = s.str();
        addNewLogLine(str.c_str());
    }

    template<typename T>
    LoggerHelper& operator<<(T const& val){
        s << val;
        return *this;
    }
};

struct Logger
{
    void operator()(char const* fmt, ...) const {
        char* buf;
        va_list args;
        va_start(args, fmt);
        vasprintf(&buf, fmt, args);
        va_end(args);
        addNewLogLine(buf);
        free(buf);
    }

    LoggerHelper operator()() const {
        return LoggerHelper{};
    }
};

demo

几点说明:

  • 我坚持你的界面,但就个人而言,我会使用可变参数模板而不是va_args
  • 你应该free vasprintf返回的缓冲区。 freedeletedelete[]
  • 不可互换
  • 我使用std::stringstream,但将其更改为QTextStream或其他任何内容都应该足够简单
  • 如果您可以使用log << "foo" << "bar"语法而不是log() << "foo" << "bar"
  • ,则无需将帮助器实现为单独的类