QMessageLogger 魔法是如何工作的？

Question

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

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

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

qDebug("abc = %u", abc);

第二种方式：

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

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

这是我的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);
}

Answer 1

首先你要明白下面是什么

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
• 你应该freevasprintf返回的缓冲区。 free 不能与 delete 或 delete[] 互换
• 我使用了std::stringstream，但将其更改为QTextStream 或任何其他都应该足够简单
• 如果您同意允许log << "foo" << "bar" 语法而不是log() << "foo" << "bar"，则无需将帮助程序实现为单独的类