シリアライズ

データの保存、ネットワーク通信でのデータの送受信といった場面において、任意の型の特定のフォーマットへのシリアライズ、デシリアライズが必要になることがある。Boost Serialization Libraryは、標準ライブラリやBoostライブラリのあらゆる型へのシリアライズとデシリアライズと、ユーザー定義型のシリアライズ方法を提供するライブラリである。

インデックス

• サポートされているフォーマット
• ユーザー定義型をシリアライズする
• 非侵入型のシリアライズ関数を定義する
• 非侵入型のシリアライズ関数で保存と読み込みで違う動作をさせる

サポートされているフォーマット

Boost.Serializationでは、以下のフォーマットへのシリアライズ、デシリアライズをサポートしている。

ユーザー定義型をシリアライズする

Boost.Serializationでは、ユーザー定義型に、

• boost::serialization::accessへのfriend指定を行い、
• serialize()メンバ関数を持たせ、Archiveにシリアライズするメンバ変数を登録

することで、ユーザー定義型をシリアライズとデシリアライズが可能な型にすることができる。

次に、各フォーマットのアーカイブ型は、コンストラクタでstd::istreamもしくはstd::ostreamを取る。

std::fstreamを渡すことでファイルに出力、std::stringstreamを渡すことで文字列に出力することができる。

アーカイブに対してシリアライズ可能な型をストリームで渡すことにより、ユーザー定義型をシリアライズ、デシリアライズすることができる。

ここでは、Data型をテキスト形式でシリアライズ、デシリアライズしている。

#include <iostream>
#include <fstream>
#include <string>
#include <boost/archive/text_oarchive.hpp>
#include <boost/archive/text_iarchive.hpp>
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/string.hpp>

class Data {
    int value;
    std::string str;
public:
    Data() {}
    Data(int value, const std::string& str)
        : value(value), str(str) {}

    void print()
    {
        std::cout << value << std::endl;
        std::cout << str << std::endl;
    }

private:
    friend class boost::serialization::access;
    template <class Archive>
    void serialize(Archive& ar, unsigned int /*version*/)
    {
        ar & boost::serialization::make_nvp("value", value);
        ar & boost::serialization::make_nvp("str", str);
    }
};

int main()
{
    {
        std::ofstream file("a.txt");
        boost::archive::text_oarchive ar(file);

        Data data(3, "abc");
        ar << boost::serialization::make_nvp("Data", data);
    }
    {
        std::ifstream file("a.txt");

        boost::archive::text_iarchive ar(file);

        Data data;
        ar >> boost::serialization::make_nvp("Data", data);

        data.print();
    }
}

出力ファイル a.txt：

22 serialization::archive 9 0 0 3 3 abc

実行結果(出力ファイルの読込結果)：

3
abc

boost::serialization::make_nvpのnvpはName Value Pairの略で、値に対して名前を関連付けている。

これは、XML形式のようなアーカイブを使用する際に、要素名として使用される。

ここではboost::archive::text_oarchiveを使用してテキスト形式にシリアライズしているが、これをboost::archive::xml_oarchiveに変えるだけでXML形式にシリアライズされる。

非侵入型のシリアライズ関数を定義する

すでに作成されたクラス、またはサードパーティで用意されているクラスをシリアライズしたい場合がある。

その場合は非侵入型のシリアライズを定義するのが良いだろう。

非侵入型シリアライズは boost::serialization 名前空間にシリアライズしたい型を受け取る serialize() 関数を定義することで実現できる。

#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>

struct Data {
    int number;
    double real;
};

namespace boost { namespace serialization {

template<class Archive>
void serialize(Archive & ar, Data & d, unsigned int /* version */) {
    ar & make_nvp("number", d.number);
    ar & make_nvp("real", d.real);
}

} } // namespace boost::serialization

当然ながら、非侵入型シリアライズが正しく動作するのは、クラス外部からアクセスできるデータでインスタンスが再構成可能なクラスに限られる。

非侵入型のシリアライズ関数で保存と読み込みで違う動作をさせる

サードパーティで用意されているクラスをシリアライズする場合、専用の関数などをつかって構築する場合など、serialize() 関数だけでは実装しにくい場合がある。

そのため、非侵入型でも save()/load() 関数に分解して保存時と読み込み時の動作を分ける方法が用意されている。使用するには split_free() 関数を用いる。

#include <boost/serialization/serialization.hpp>
#include <boost/serialization/split_free.hpp>

struct Data {
    int value;
};

namespace boost { namespace serialization {

template<class Archive>
void serialize(Archive & ar, Data & d, unsigned int version) {
    split_free(ar, d, version);
}

template<class Archive>
void save(Archive & ar, Data const& d, unsigned int /* version */) {
    const int v = d.value ^ 0xFFFFFFFF;
    ar & v;
}

template<class Archive>
void load(Archive & ar, Data & d, unsigned int /* version */) {
    int v;
    ar & v;
    d.value = v ^ 0xFFFFFF;
}

} } // namespace boost::serialization