Qt 实战（7）元对象系统 | 7.5、QMetaProperty详解

前言：

在Qt框架中，QMetaProperty类扮演着举足轻重的角色，它是Qt反射机制的一个重要组成部分，用于描述对象的属性，并允许开发者在运行时动态地查询和操作这些属性。QMetaProperty通过Qt的元对象系统（Meta-Object System）实现了这一功能，使得Qt应用程序具备了高度的灵活性和可扩展性。

一、QMetaProperty详解

1、QMetaProperty的作用

• 属性描述： QMetaProperty主要用于描述Qt对象的属性。通过该类，开发者可以获取关于对象属性的各种信息，如属性的名称、类型、是否可读、是否可写、是否有通知信号等。这种机制使得开发者能够以一种通用的方式处理不同的对象属性，而无需硬编码属性名或类型。
• 动态属性访问： 利用QMetaProperty，开发者可以在运行时动态地读取和设置对象的属性值。这对于需要高度灵活性和可扩展性的应用程序来说尤为重要。例如，在编写一个通用的配置编辑器时，可以通过QMetaProperty来遍历和编辑对象的所有属性，而无需事先知道这些属性的具体名称和类型。

2、使用QMetaProperty

2.1、声明属性

要使用QMetaProperty，首先需要在类中声明属性。这通常通过Q_PROPERTY宏来完成。例如：

#include <QCoreApplication>  
#include <QMetaObject>  
#include <QMetaProperty>  
#include <QDebug>  
  
class MyClass : public QObject {  
    Q_OBJECT  
    Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged)  
    Q_PROPERTY(int age READ age WRITE setAge NOTIFY ageChanged)  
  
public:  
    explicit MyClass(QObject *parent = nullptr) : QObject(parent) {}  
  
    QString name() const { return m_name; }  
    void setName(const QString &name) {  
        if (m_name != name) {  
            m_name = name;  
            emit nameChanged();  
        }  
    }  
  
    int age() const { return m_age; }  
    void setAge(int age) {  
        if (m_age != age) {  
            m_age = age;  
            emit ageChanged();  
        }  
    }  
  
signals:  
    void nameChanged();  
    void ageChanged();  
  
private:  
    QString m_name;  
    int m_age;  
}; 

2.2、访问属性

下面是QMetaObject类提供的与QMetaProperty相关的方法，如下：

// QMetaObject类头文件qobjectdefs.h

// 获取当前类自定义属性的起始索引
int QMetaObject::propertyOffset() const;
int QMetaObject::propertyCount() const;	
int QMetaObject::indexOfProperty(const char *name) const;
QMetaProperty QMetaObject::property(int index) const;

在对象实例化后，可以通过QObject::metaObject()方法获取其元对象，进而使用QMetaObject::property()方法根据属性名获取QMetaProperty对象。之后，就可以使用QMetaProperty提供的各种方法来访问和操作属性了。

3、QMetaProperty成员方法

QMetaProperty提供了丰富的成员函数来支持属性的查询和操作，包括但不限于：

• isEnumType()：判断属性是否是枚举类型。
• isReadable()：属性是否可读。
• isWritable()：属性是否可写。
• hasNotifySignal()：属性更改时是否有通知信号。
• name()：获取属性名称。
• typeName()：获取属性类型名称。
• read()：从对象中读取属性值。
• write()：向对象中写入属性值。

下面是对应的方法声明，如下：

class Q_CORE_EXPORT QMetaProperty
{
public:
    QMetaProperty();
	
	const char *name() const;
    const char *typeName() const;
    QVariant::Type type() const;
    int userType() const;
    int propertyIndex() const;
	
	bool isReadable() const;
    bool isWritable() const;
	
	QVariant read(const QObject *obj) const;
    bool write(QObject *obj, const QVariant &value) const;
    bool reset(QObject *obj) const;
};

4、示例

4.1、通过名称获取指定属性

MyClass obj;  
const QMetaObject *metaObject = obj.metaObject();  
int index = metaObject->indexOfProperty("age");  
QMetaProperty property = metaObject->property(index);  
  
// 读取属性值  
QVariant value = property.read(&obj);  
int intValue = value.toInt();  
  
// 设置属性值  
bool success = property.write(&obj, QVariant(42));  
  
// 获取属性名称和类型  
QString propertyName = property.name();  
QByteArray propertyTypeName = property.typeName();

4.2、遍历全部属性（包含从基类继承下来的）

MyClass obj;  
const QMetaObject *metaObject = obj.metaObject();  

// 遍历所有属性  
for (int i = 0; i < metaObject->propertyCount(); ++i) {  
    QMetaProperty metaProperty = metaObject->property(i);  

    // 输出属性名称和类型  
    qDebug() << "Property Name:" << metaProperty.name() << "Type:" << metaProperty.typeName();  

    // 如果需要，你可以进一步查询或操作这个属性  
    if (metaProperty.isWritable()) {  
        qDebug() << "Writable";  
    }  
    if (metaProperty.isReadable()) {  
        qDebug() << "Readable";  
    }  
}  

4.3、遍历当前类的全部属性（不包含从基类继承下来的）

虽然propertyCount方法返回了类中定义的所有属性的数量（包括从基类继承的属性），但在某些情况下，开发者可能只对当前类定义的属性感兴趣。此时，可以结合使用propertyOffset方法来获取当前类自定义属性的起始索引，并据此调整遍历的范围，例如：

MyClass obj;  
const QMetaObject *metaObject = obj.metaObject();  

// 遍历所有属性  
for (int i = metaObject->propertyOffset(); i < metaObject->propertyCount(); ++i) {  
    QMetaProperty metaProperty = metaObject->property(i);  

    // 输出属性名称和类型  
    qDebug() << "Property Name:" << metaProperty.name() << "Type:" << metaProperty.typeName();  

    // 如果需要，你可以进一步查询或操作这个属性  
    if (metaProperty.isWritable()) {  
        qDebug() << "Writable";  
    }  
    if (metaProperty.isReadable()) {  
        qDebug() << "Readable";  
    }  
}  

注意：propertyOffset方法通常用于区分自定义属性和从基类继承的属性，但在Qt的当前版本中，它并不总是直接提供这样的功能。在某些情况下，开发者可能需要通过其他方式（如检查属性的名称或类型）来区分自定义属性和继承的属性。

5、动态属性

5.1、什么是动态属性？

运行时给对象新增加的属性叫做动态属性，动态属性的主要优势在于它的灵活性和可扩展性。通过使用动态属性，我们可以在不修改类定义的情况下，为类添加新的属性。这对于一些需要频繁修改或扩展的场景非常有用，比如插件系统、用户界面组件等。

在Qt中，动态属性是通过QObject类的property()函数和setProperty()函数来实现的。property()函数用于获取属性的值，而setProperty()函数用于设置属性的值。这两个函数都接受一个字符串参数，表示属性的名称。下面是一个简单的例子，演示了如何在Qt中使用动态属性：

int main(int argc, char *argv[])
{
    QCoreApplication a(argc, argv);

    MyClass obj;
    obj.setProperty("myProperty", 42); // 设置属性值
    int value = obj.property("myProperty").toInt(); // 获取属性值

    return a.exec();
}

5.2、访问动态添加的属性

通过QObject提供的方法，可以访问动态添加的属性吗，成员方法如下：

bool QObject::setProperty(const char *name, const QVariant &value);
QVariant QObject::property(const char *name) const;
QList<QByteArray> QObject::dynamicPropertyNames() const;

遍历动态添加的属性，如下：

MyClass obj(this);
obj.setAge(10);
obj.setName("Jack");
obj.setProperty("country", QVariant("China")); // 动态设置属性

// 获取所有静态属性名称
qDebug() << "===================== Static Properys =====================";
const QMetaObject *pMetaObject = obj.metaObject();
for (int i = 0; i < pMetaObject->propertyCount(); i ++)
{
    QMetaProperty metaProperty = pMetaObject->property(i);
    qDebug() << "Static Property Name:" << metaProperty.name() << "Type:" << metaProperty.typeName();
}

// 获取所有动态属性名称
qDebug() << "===================== Dynamic Properys =====================";
QList<QByteArray> propertyNames = obj.dynamicPropertyNames();
foreach(const QByteArray &propertyName, propertyNames) {
    qDebug() << "Dynamic Property Name:" << propertyName << "Value:" << obj.property(propertyName.data()).toString();
}

输出结果

===================== Static Properys =====================
Static Property Name: objectName Type: QString
Static Property Name: name Type: QString
Static Property Name: age Type: int
===================== Dynamic Properys =====================
Dynamic Property Name: "country" Value: "China"

5.3、与静态属性的区别

Qt中的静态属性与动态属性在定义方式、作用时机、使用场景以及特性上存在显著差异。以下是对两者区别的详细阐述：

1）定义方式

• 静态属性：在Qt中，静态属性是通过在QObject派生类的类定义中使用Q_PROPERTY宏来声明的。这种方式在编译时确定属性的存在，并将属性信息注册到Qt的元对象系统中。静态属性支持元信息，可以通过元对象系统查询和访问。
• 动态属性：动态属性并不是在类的定义中声明的，而是在运行时通过QObject::setProperty(const char* name, const QVariant &value)方法动态地添加到对象上的。这些属性不会出现在类的元对象信息中，因此不能通过元对象系统直接查询，但可以通过dynamicPropertyNames()方法和property()方法来访问。

2）作用时机

• 静态属性：静态属性的作用时机是在编译时。它们作为类定义的一部分，在编译过程中被处理，并注册到Qt的元对象系统中。
• 动态属性：动态属性的作用时机是在运行时。它们可以在程序的任何时刻被添加到对象上，为对象提供额外的数据或功能，而无需修改类的定义。

3）使用场景

• 静态属性：静态属性适用于那些需要在编译时就确定其存在和类型的属性。它们常用于Qt的UI设计中，如QWidget的geometry、windowTitle等属性。
• 动态属性：动态属性适用于那些需要在运行时动态添加的属性。它们为开发者提供了更大的灵活性，可以在不修改类定义的情况下为对象添加额外的数据或功能。例如，在开发一个通用的数据展示组件时，可以使用动态属性来存储不同数据源的连接信息。

4）特性

• 静态属性
  • 支持元信息，可以通过元对象系统查询和访问。
  • 其值在编译时确定，但可以在运行时修改（如果属性有相应的setter函数）。
  • 静态属性会注册到元对象系统中，可以通过元对象系统查询到已注册的属性信息。
• 动态属性
  • 不在类的元对象信息中注册，因此不能通过元对象系统直接查询。
  • 可以在运行时动态地添加和删除。
  • 使用setProperty()和property()方法设置和获取动态属性的值。

综上所述，Qt中的静态属性和动态属性在定义方式、作用时机、使用场景以及特性上存在明显的区别。开发者可以根据具体的需求和场景选择合适的属性类型来实现程序的功能。

6、总结

QMetaProperty是Qt反射机制中不可或缺的一部分，它使得Qt应用程序能够以动态和灵活的方式处理对象的属性。通过QMetaProperty，开发者可以在运行时获取属性的详细信息，读取和设置属性值，以及处理属性的更改通知。这一机制极大地增强了Qt应用程序的灵活性和可扩展性，为开发高效、可维护的应用程序提供了有力的支持。