Grantlee模板引擎中的泛型类型与容器支持详解

概述

Grantlee是一个强大的模板引擎，它提供了对泛型类型和容器的全面支持。本文将深入探讨如何在Grantlee中使用非QObject类型、各种容器类型以及智能指针，使开发者能够灵活地在模板中处理各种数据结构。

非QObject类型的支持

Grantlee允许开发者使用任何可以放入QVariant中的类型作为模板上下文(Context)的一部分。对于非QObject类型，需要遵循以下步骤：

1. 元类型声明：使用Q_DECLARE_METATYPE宏注册类型
2. 属性访问定义：使用GRANTLEE_BEGIN_LOOKUP和GRANTLEE_END_LOOKUP宏定义类型的属性访问方法
3. 类型注册：调用Grantlee::registerMetaType函数注册类型

// 示例：定义一个简单的Person类
class Person {
public:
    Person(const QString &name, int age) : m_name(name), m_age(age) {}
    QString name() const { return m_name; }
    int age() const { return m_age; }
private:
    QString m_name;
    int m_age;
};

// 1. 声明元类型
Q_DECLARE_METATYPE(Person)

// 2. 定义属性访问
GRANTLEE_BEGIN_LOOKUP(Person)
    if (property == "name") return object.name();
    else if (property == "age") return object.age();
GRANTLEE_END_LOOKUP

// 3. 注册类型
void initialize() {
    Grantlee::registerMetaType<Person>();
}

容器支持

Grantlee内置支持多种Qt和STL容器，只要容器中的元素类型是支持的。以下是主要的容器支持情况：

序列容器

• Qt: QList, QVector, QSet, QLinkedList, QStack, QQueue
• STL: std::vector, std::deque, std::list

关联容器

• Qt: QHash<K,T>, QMap<K,T> (K可以是QString或各种整数类型)
• STL: std::map<K,T> (K可以是QString或各种整数类型)

支持的元素类型

• 基本类型: bool, 各种整数类型, float, double
• Qt类型: QVariant, QString, QDateTime
• QObject派生类指针
• 任何通过Grantlee::registerMetaType注册的类型
• 任何支持的容器类型(支持嵌套容器)

注意：QSet需要元素类型定义了qHash函数，因此QSet不被支持。

第三方容器支持

对于非内置支持的容器，可以通过以下宏进行注册：

序列容器

使用Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE宏：

#include <boost/circular_buffer>

Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE(boost::circular_buffer)
Q_DECLARE_METATYPE(boost::circular_buffer<Person>)

关联容器

使用Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE宏。

智能指针支持

Grantlee对智能指针提供了良好的支持：

自定义类型的智能指针

需要像普通类型一样进行元类型声明和属性访问定义：

Q_DECLARE_METATYPE(QSharedPointer<Person>)
Grantlee::registerMetaType<QSharedPointer<Person>>();

GRANTLEE_BEGIN_LOOKUP(QSharedPointer<Person>)
    if (property == "name") return object->name();
GRANTLEE_END_LOOKUP

QObject派生类的智能指针

对于QObject派生类，智能指针会自动获得Q_PROPERTY的访问能力，无需额外定义：

// PersonObject继承自QObject并有Q_PROPERTY定义
auto p = QSharedPointer<PersonObject>::create();
context.insert("person", QVariant::fromValue(p));

第三方智能指针

对于第三方智能指针库，需要使用Q_DECLARE_SMART_POINTER_METATYPE宏：

Q_DECLARE_SMART_POINTER_METATYPE(boost::shared_ptr)

实际应用示例

以下是一个综合示例，展示如何在模板中使用复杂数据结构：

// 定义体育俱乐部类(QObject派生)
class SportsClub : public QObject {
    Q_OBJECT
    Q_PROPERTY(QString name READ name)
    Q_PROPERTY(QString sport READ sport)
    Q_PROPERTY(std::vector<QObject*> members READ members)
public:
    // ... 实现省略 ...
};

// 创建上下文
Grantlee::Context createContext() {
    Grantlee::Context c;
    
    QSet<QObject*> clubs;
    auto tennisClub = new SportsClub("Smithfield Tennis Club", "Tennis");
    
    std::vector<QObject*> members;
    members.push_back(new PersonObject("Alice", 21));
    members.push_back(new PersonObject("Bob", 22));
    tennisClub->setMembers(members);
    
    clubs.insert(tennisClub);
    c.insert("sportsClubs", QVariant::fromValue(clubs));
    
    return c;
}

// 模板示例
QString templateText = R"(
{% regroup sportsClubs by sport as groupedSports %}
{% for groupedClub in groupedSports %}
    <h1>{{ groupedClub.grouper }}</h1>
    {% for club in groupedClub.list %}
        <h2>{{ club.name }}</h2>
        <ul>
        {% for member in club.members %}
            <li>{{ member.name }}, {{ member.age }}</li>
        {% endfor %}
        </ul>
    {% endfor %}
{% endfor %}
)";

最佳实践

1. 优先使用QObject派生类和Q_PROPERTY，它们能自动获得属性访问支持
2. 对于简单值类型，使用非QObject类并通过宏注册
3. 对于复杂数据结构，合理选择容器类型
4. 考虑使用智能指针管理对象生命周期
5. 对于性能敏感场景，避免过度使用嵌套容器

通过合理利用Grantlee的泛型类型和容器支持，开发者可以构建灵活、强大的模板系统，处理各种复杂的数据结构需求。