C++オブジェクトの直列化 (シリアライズ)

(2009.5.11 新規作成。2011.8 加筆、新規公開。)

C++オブジェクトをネットワーク経由などでやり取りしたりするための、直列化 (シリアライズ) について。

概要

Windows向けにC++で開発する場合、MFC (Microsoft Foundation Classes) にはシリアライズ機能が含まれます。

boostにもポータブルなシリアリゼーション機能があり、MFCが利用できない場合、これが使えます。

クラス定義

直列化したいオブジェクトのクラスで、次のようにします。

C++
[RAW]
  1. #include <list>
  2. #include <string>
  3. // #include <boost/serialization/list.hpp>
  4. // #include <boost/serialization/string.hpp>
  5. #include <boost/serialization/version.hpp>
  6. #include <boost/serialization/split_member.hpp>
  8. class BusStop;
  10. class BusRoute {
  11. // おまじない
  12. friend class boost::serialization::access;
  13. BOOST_SERIALIZATION_SPLIT_MEMBER()
  15. std::list<BusStop*> stops;
  16. std::string driver_name;
  18. // 必ずprivate.
  19. template <class Archive>
  20. void save(Archive& ar, unsigned int version) const {
  21. ar & driver_name;
  22. ar & stops;
  23. }
  25. // 必ずprivate.
  26. template <class Archive>
  27. void load(Archive& ar, unsigned int version) {
  28. if (version > 0)
  29. ar & driver_name;
  30. ar & stops;
  31. }
  32. };
  34. BOOST_CLASS_VERSION(BusRoute, 1)

何か特定のクラスのサブクラスにする必要はありません。save(), load() を定義するのと、いくつかのおまじないを書きます。

save(), load() では、最初の引数としてアーカイブなどが渡されます。& 演算子で追記、または読み込みを行います。

また、version も引数として渡されるため、それによって保存、再生する内容を変えることもできます。

オブジェクトの保存

オブジェクトを保存するには、boost::archive::binary_oarchive などのアーカイブクラスを通じて、ストリームに書き込みます。

例えば、シリアライズ可能な型Typのオブジェクトobjを受け取って、シリアライズし、MPIで送信するコードは、次のようになります。

C++
[RAW]
  1. template <typename Typ>
  2. void isend_obj( int dest_node, int tag, const Typ& obj,
  3. std::vector<MPI_Request>* reqs )
  4. {
  5. std::ostringstream oss;
  6. boost::archive::binary_oarchive oa(oss);
  8. oa << obj;
  10. int32_t len = oss.str().size();
  11. printf("len = %d\n", len); // DEBUG
  12. MPI_Request req;
  13. mMPI_CHECK_RESULT( MPI_Isend(&len, 1, MPI_INT32_T, dest_node, tag,
  14. MPI_COMM_WORLD, &req) );
  15. reqs->push_back(req);
  16. mMPI_CHECK_RESULT( MPI_Isend((void*) oss.str().data(), len, MPI_BYTE,
  17. dest_node, tag + 1, MPI_COMM_WORLD, &req) );
  18. reqs->push_back(req);
  19. }

アーカイブクラスは仲立ちをし、シリアライズされたデータはストリームに書き込まれます。

ライブラリとのリンク

boostのシリアライズ機能は、それだけで一つのライブラリとのリンクが必要です。リンカに -lboost_serialization オプションを加えます。

外部リンク