閱讀本文大概需要 3 分鐘

背景

日常開發過程中，避免不了對象序列化和反序列化，如果你使用 Qt 進行開發，那么有一種方法實現起來非常簡單和容易。

實現

我們知道 Qt 的元對象系統非常強大，基于此屬性我們可以實現對象的序列化和反序列化操作。

比如有一個學生類，包含以下幾個字段：學號、姓名、性別、出生日期等，定義如下類結構：

class DStudent : public QObject
{Q_OBJECTQ_PROPERTY(QString name READ name WRITE setName)Q_PROPERTY(QString number READ number WRITE setNumber)Q_PROPERTY(QString sex READ sex WRITE setSex)Q_PROPERTY(QDateTime birthday READ birthday WRITE setBirthda)
public:explicit DStudent(QObject *parent = nullptr);QString name() const;void setName(const QString &newName);QString number() const;void setNumber(const QString &newNumber);QString sex() const;void setSex(const QString &newSex);QDateTime birthday() const;void setBirthda(const QDateTime &newBirthday);//...

需要增加那些字段，只需要在上述屬性位置繼續追加即可，通過把需要反射的字段定義成屬性，我們就可以遍歷該類的元對象，進而獲取其中的屬性信息。

序列化 Json

QJsonObject DStudent::toJson()
{QJsonObject jsObj = KJsonHelp::object2Json(this);return jsObj;
}
bool DStudent::fromJson(const QJsonObject &jsObj)
{return KJsonHelp::json2Object(jsObj, this);
}

核心代碼封裝到工具類中，方便其它地方調用，詳細實現如下：

QJsonObject KJsonHelp::object2Json(QObject *object)
{QJsonObject jsObj;if(nullptr == object){return jsObj;}const QMetaObject *pMetaObj = object->metaObject();for(int i = 0; i < pMetaObj->propertyCount(); i++){auto proName = pMetaObj->property(i).name();jsObj.insert(proName, QJsonValue::fromVariant(object->property(proName)));}if(jsObj.contains("objectName")){jsObj.remove("objectName");}return jsObj;
}bool KJsonHelp::json2Object(const QJsonObject &jsObj, QObject *object)
{if (jsObj.isEmpty() || nullptr == object){return false;}QStringList list;const QMetaObject *pMetaObj = object->metaObject();for(int i = 0; i < pMetaObj->propertyCount(); i++){list << pMetaObj->property(i).name();}QStringList jsonKeys = jsObj.keys();foreach(const QString &proName ,list){if(!jsonKeys.contains(proName) || jsObj.value(proName).isNull()){continue;}object->setProperty(proName.toLocal8Bit().data(), jsObj.value(proName));}return true;
}

任意一個繼承 QObject的對象都可以獲取到它的元對象，接著可以獲取到屬性個數，然后挨個進行遍歷即可。

如果想序列化到其他格式的，比如XML，在上述方法中根據 XML 規則生成即可，這個不是本文的重點。

一些坑和注意點

當然了并不是所有的類型都支持這種方式自動生成字段的，一些特殊類型或者自定義的類需要自己特殊去實現。

我們可以在上述學生類中，繼續添加新的測試屬性字段，來看看輸出的結果：

    // custome typeQ_PROPERTY(DScore sScore READ sScore WRITE setSScore)// test other typeQ_PROPERTY(int testInt READ testInt WRITE setTestInt)Q_PROPERTY(bool testBool READ testBool WRITE setTestBool)Q_PROPERTY(double testDouble READ testDouble WRITE setTestDouble)Q_PROPERTY(char testChar READ testChar WRITE setTestChar)Q_PROPERTY(QUrl testUrl READ testUrl WRITE setTestUrl)Q_PROPERTY(QVariant testV READ testV WRITE setTestV)Q_PROPERTY(QStringList testStringList READ testStringList WRITE setTestStringList)Q_PROPERTY(QRect testRect READ testRect WRITE setTestRect)Q_PROPERTY(QSize testSize READ testSize WRITE setTestSize)Q_PROPERTY(QPoint testPoint READ testPoint WRITE setTestPoint)Q_PROPERTY(QList<int> testIntList READ testIntList WRITE setTestIntList)Q_PROPERTY(QList<QString> testListString READ testListString WRITE setTestListString)

打印輸出：

    qRegisterMetaType<DScore>("DScore");DStudent st;st.setName(QStringLiteral("法外狂徒張三"));st.setNumber("123456789");st.setSex(QStringLiteral("男"));st.setBirthda(QDateTime::currentDateTime());// test other typest.setTestInt(10);st.setTestBool(true);st.setTestV(12);st.setTestDouble(12.121212);st.setTestChar('k');        //->stringst.setTestUrl(QUrl("http://kevinlq.com/")); // -> stringst.setTestStringList(QStringList() << "stringList1" << "stringList2");st.setTestRect(QRect(10,10,10,10));             // nullst.setTestSize(QSize(10,10));                   // nullst.setTestPoint(QPoint(10, 10));                // nullst.setTestIntList({11, 12});                    // nullst.setTestListString({"kevinlq", "devstone"});  // nullDScore score;score.setName("computer");score.setNumber("001");st.setSScore(score);                            // nullqDebug() << "st:" << st.toJson();

st: QJsonObject({"birthday":"2023-08-05T19:33:14.815","name":"法外狂徒張三","number":"123456789","sScore":null,"sex":"男","testBool":true,"testChar":"k","testDouble":12.121212,"testInt":10,"testIntList":null,"testListString":null,"testPoint":null,"testRect":null,"testSize":null,"testStringList":["stringList1","stringList2"],"testUrl":"http://kevinlq.com/","testV":12})

可以看到很多字段的值是 null，出現這種問題表示這個類型目前無法直接自動生成，如果你缺失需要這種結構，那么需要自行在序列化函數中進行特殊處理，比如自定義的類型處理:

QJsonObject DStudent::toJson()
{QJsonObject jsObj = KJsonHelp::object2Json(this);jsObj.insert("sScore", m_sScore.toJson());return jsObj;
}

上述對定義的課程類，進行了特殊處理,再次編譯后，輸出的結果如下：

{"birthday": "2023-08-05T23:27:00.757","name": "法外狂徒張三","number": "123456789","sScore": {"name": "computer","number": "001"}
}

可以看到正常輸出了我們需要的類型，其他類型可以照葫蘆畫瓢。

進階

是不是發現問題了，隨著你的類屬性字段越來越多，手寫這么多字段肯定非常累，能否自動生成這些重復的代碼呢，答案是可以的，結合前面的文章，就可以編寫一份更加緊湊的代碼了，詳細見這里 http://kevinlq.com/2023/01/16/generateProperty/

總結

序列化其實有很應用場景，以下是工作站經常使用的小 case：

• 持久化保存類對象，及保存數據到本地磁盤；
• socket 傳輸數據，需要把 json/xml/other 類型轉為對象，用對象進行業務處理；
• 數據庫操作：從 db 中讀取出來的值序列化成對象，方便業務進行處理(使用 ORM 框架例外)
• 和界面交互，比如界面使用 QML 編寫，那么大部分超場景會使用到 JSON。
• 其他：待補充……

參考文檔

• c++自動生成get/set方法