ここで、オブジェクトビューからJSON / XMLに、またはその逆にデータをシリアル化するためのQtベースのライブラリプロジェクトについて説明してから数か月が経ちました。



そして、私が構築されたアーキテクチャをどれほど誇りに思っていても、認めなければなりません-実装は率直に言って、物議を醸しています。



これらすべてが大規模な処理をもたらしました。その結果については、この記事で説明します。詳細については-カットの下で！

QSerializerが死亡しました

QSerializerには欠点があり、その解決策はさらに大きな欠点になることがよくありました。そのいくつかを次に示します。

• 非常に高価です（シリアル化、プロパティキーパーをヒープに保持する、キーパーの寿命を制御するなど）
• QObjectベースのクラスのみを使用する
• ネストされた「複雑な」オブジェクトとそのコレクションもQObjectベースである必要があります
• デシリアライズ中にコレクションを補足できない
• 理論的には無限の入れ子のみ
• QObjectからのコピーが禁止されているため、重要なタイプの「複雑な」オブジェクトを処理できない
• Qtメタオブジェクトシステムでのタイプの必須登録の必要性
• プラットフォーム間のリンクや移植性の問題など、一般的な「ライブラリ」の問題

特に、QSerializer名前空間でメソッドの巨大なバインディングを使用する必要があるときに、「今ここで」任意のオブジェクトをシリアル化できるようにしたかったのです。

長生きするQSerializer！

QSerializerは完全ではありませんでした。ユーザーがQObjectに依存せず、値の型を低コストで操作できるソリューションを考え出す必要がありました。



でコメントへ前の記事、ユーザーmicrolaQ_GADGETの使用について考えることができることに気づきました。



利点Q_GADGET：

• コピーに制限はありません
• プロパティにアクセスするためのQMetaObjectの静的インスタンスがあります

Q_GADGETに 依存して、宣言されたクラスフィールドに基づいてJSONとXMLを作成する方法へのアプローチを再考する必要がありました。「高コスト」の問題は、主に次の理由で明らかになりました。

• 大容量のストレージクラスサイズ（少なくとも40バイト）
• 各プロパティの新しい保護者エンティティにヒープを割り当て、それらのTTLを制御する

コストを削減するために、次の要件を策定しました。

クラスのすべてのプロパティのシリアル化/逆シリアル化のためのワイヤーメソッドの各シリアル化可能なオブジェクト内の存在、およびこのプロパティに割り当てられた形式を使用して各プロパティの値を読み書きするためのメソッドの存在

マクロ

自動シリアル化を複雑にするC ++の強力な型指定を回避することは容易ではなく、以前の経験はこれを示しています。一方、マクロを使用すると、メソッドとプロパティのコード生成を実行できるため、マクロはこのような問題を解決するための優れたヘルプとして役立ちます（Qtメタオブジェクトシステム全体のほとんどはマクロ上に構築されます）。



はい、マクロは最も純粋な形で悪であることがよくあります-それらをデバッグすることはほとんど不可能です。コードを生成するマクロを書くことと、上司のかかとにクリスタルシューズを置くことを比較することはできますが、難しいということは不可能という意味ではありません。



マクロについての叙情的な逸脱

— , , «» (). .

QSerializerは現在、クラスをシリアル化可能として宣言する2つの方法を提供しています。QSerializerクラスから継承するか、QS_CLASSコード生成マクロを使用します。



まず、クラスの本体でQ_GADGETマクロを定義する必要があります。これにより、staticMetaObjectにアクセスできるようになり、マクロによって生成されたプロパティが保存されます。



QSerializerから継承すると、複数のシリアル化可能なオブジェクトを1つのタイプにキャストし、それらをまとめてシリアル化できます。



QSerializerクラスには、オブジェクトのプロパティを解析できる4つのエクスプローラーメソッドと、QMetaObjectのインスタンスを取得するための1つの仮想メソッドが含まれています。

QJsonValue toJson() const
void fromJson(const QJsonValue &)
QDomNode toXml() const
void fromXml(const QDomNode &)
virtual const QMetaObject * metaObject() const

Q_GADGETには、Q_OBJECTが提供するすべてのメタオブジェクトバインディングが含まれているわけではありません。



QSerializer内では、staticMetaObjectインスタンスはQSerializerクラスを表しますが、それから派生することはありません。したがって、QSerializerベースのクラスを作成するときは、metaObjectメソッドをオーバーライドする必要があります。QS_SERIALIZERマクロをクラス本体に追加すると、metaObjectメソッドがオーバーライドされます。



また、各オブジェクトにQMetaObjectインスタンスを格納する代わりにstaticMetaObjectを使用すると、クラスサイズから40バイト節約できます。



何らかの理由で継承したくない場合は、シリアル化されるクラスの本体でQS_CLASSマクロを定義できます。、QSerializerから継承する代わりに、必要なすべてのメソッドを生成します。

フィールドの宣言

これとは別に、JSONとXMLには4種類のシリアル化可能なデータがあり、これらの形式へのシリアル化は完了しません。この表は、以下を説明する方法として、データのタイプと対応するマクロを示しています。



これらのマクロを生成するコードは記述と呼ばれ、それを生成するマクロは記述と呼ばれると想定します。



説明を生成するための唯一の原則があります-特定のフィールドに対して、JSONおよびXMLプロパティを生成し、値を読み書きするためのメソッドを定義します。



プリミティブデータタイプフィールドの例を使用して、JSON記述の生成を分析してみましょう。

/* Create JSON property and methods for primitive type field*/
#define QS_JSON_FIELD(type, name)                                                           
    Q_PROPERTY(QJsonValue name READ get_json_##name WRITE set_json_##name)                  
    private:                                                                                
        QJsonValue get_json_##name() const {                                                
            QJsonValue val = QJsonValue::fromVariant(QVariant(name));                       
            return val;                                                                     
        }                                                                                   
        void set_json_##name(const QJsonValue & varname){                                   
            name = varname.toVariant().value<type>();                                       
        }   
...
int digit;
QS_JSON_FIELD(int, digit)  

int桁フィールドの場合、QJsonValueタイプのプロパティ桁が生成され、プライベート書き込みおよび読み取りメソッド（get_json_digitおよびset_json_digitが定義されます）が定義され、JSONを使用して桁フィールドをシリアル化/逆シリアル化するためのコンダクターになります。





そして、これが複雑な構造のJSON記述の生成です。

/* Generate JSON-property and methods for some custom class */
/* Custom type must be provide methods fromJson and toJson */
#define QS_JSON_OBJECT(type, name)
    Q_PROPERTY(QJsonValue name READ get_json_##name WRITE set_json_##name)
    private:
    QJsonValue get_json_##name() const {
        QJsonObject val = name.toJson();
        return QJsonValue(val);
    }
    void set_json_##name(const QJsonValue & varname) {
        if(!varname.isObject())
        return;
        name.fromJson(varname);
    } 
...
SomeClass object;
QS_JSON_OBJECT(SomeClass, object)

複雑なオブジェクトは、外部クラスの1つの「大きな」プロパティとして機能するネストされたプロパティのセットです。このようなオブジェクトにはワイヤメソッドも含まれるためです。これを行うために必要なのは、複雑な構造の読み取りメソッドと書き込みメソッドで適切なガイドメソッドを呼び出すことだけです。

クラスの作成

したがって、シリアル化可能なクラスを作成するための非常に単純なインフラストラクチャがあります。



したがって、たとえば、QSerializerから継承することで、クラスをシリアル化可能にすることができます。

class SerializableClass : public QSerializer {
Q_GADGET
QS_SERIALIZER
QS_FIELD(int, digit)
QS_COLLECTION(QList, QString, strings)
};

または、このように、QS_CLASSマクロを使用します。

class SerializableClass {
Q_GADGET
QS_CLASS
QS_FIELD(int, digit)
QS_COLLECTION(QList, QString, strings)
};

制限事項

単一フィールド



ユーザー定義またはプリミティブタイプは、デフォルトのコンストラクターを提供する必要があります。



コレクション



コレクションクラスはテンプレート化され、clear、at、size、appendメソッドを提供する必要があります。条件に応じて、独自のコレクションを使用できます。次の条件を満たすQtコレクション：QVector、QStack、QList、QQueue。



Qtバージョン



最小バージョンQt5.5.0

最小テストバージョンQt5.9.0

最大テストバージョンQt5.15.0

注：以前のバージョンのQtでQSerializerのテストに参加してテストできます。

結果

QSerializerを作り直すとき、私はそれを大幅に減らすという仕事を自分自身に絶対に設定しませんでした。ただし、サイズは9ファイルから1ファイルに減少し、複雑さも軽減されました。 QSerializerは、通常の形式のライブラリではなくなりました。プロジェクトに含めて、快適なシリアル化/逆シリアル化のためのすべての機能を取得するために必要なヘッダーファイルになりました。開発は3月に始まり、トリッキーなアーキテクチャが発明され、プロジェクトは依存関係、クラッチ、0から数回書き直されて大きくなりすぎました。そして、すべてを最終的に小さなファイルに変えるために。



「それに費やした努力の価値はあったのか」と自問し、「はい、そうだった」と答えます。私はすでに戦闘プロジェクトでそれを試しました、そして結果は私を喜ばせました。



リンク

GitHub：リンク

最新リリース：v1.1

前の記事：QSerializer：単純なJSON / XMLシリアル化のソリューション



将来のリスト

• 大幅なコスト削減（さらに安くできる）
• コンパクトさ
• 重要なタイプの操作
• シリアル化可能なデータの基本的な説明
• clear、at、size、およびappendメソッドを提供するテンプレートコレクションのサポート。自分でも
• デシリアライズに関する完全に変更可能なコレクション
• すべての一般的なプリミティブタイプのサポート
• QSerializerを使用して記述されたカスタムタイプのサポート
• カスタムタイプを登録する必要はありません