处理从 boost 序列化中删除的变量

Question

我查看了网络上关于通过增加版本号并在该变量的序列化周围添加“if”来向序列化函数添加成员变量的示例。

但是如果我删除了一个成员变量，我该怎么办？我应该把它从序列化函数中删除，然后 boost 会处理它吗？

如果我删除了一些在序列化函数中“序列化”的类，情况可能会变得更糟，我是否需要只为序列化代码保留它们还是有其他方法？

Answer 1

背景/存档格式兼容性

Boost 序列化在很多场景中都是相当轻量级的。

特别是，如果您不使用对象跟踪/动态多态性，则有惊人的余地可以使您的序列化流兼容。

在通过（智能）指针（到基）进行序列化时，跟踪和多态性都成为一个因素。

标准库以及现代 C++ 中的大多数东西都支持价值语义（例如所有标准容器），并且直接暗示，在这里可以很好地发挥作用。

作为一个具体的例子，我已经取得了很多成功的序列化

std::map<std::string, boost::uuids::uuid>

进入二进制存档，并将此存档反序列化为

boost::unordered_map<std::string, boost::uuids::uuid>
// or
boost::flat_map<std::string, boost::uuids::uuid>
// or
std::vector<std::pair<std::string, boost::uuids::uuid> >

这些类型都（不需要）存储类型信息，因此二进制流兼容可交换。

也许如果您想依靠这种“偶然”的兼容性，您可能需要编写广泛的测试。

我感觉您应该能够设计一个trivial archive implementation，而不是序列化实际数据，而是创建所涉及数据结构的“布局图”或“兼容性签名”。

这对于获得验证不同类型之间存档兼容性的信心大有帮助

案例研究 1：更改布局

这与原始问题非常吻合：“删除字段后如何反序列化旧版本”。

这里，关键是：serialize 只是一个函数。你可以做任何你需要的事情。以一个经历了两个版本的简单演示类为例：

struct MyType {
    MyType();
    MyType(std::string const& v);

  private:
    friend class boost::serialization::access;
    template <typename Ar> void serialize(Ar&, unsigned);

#if DEMO_VERSION == 0

    bool hasValue;
    std::string value;

#elif DEMO_VERSION == 1

    boost::optional<std::string> value;

#endif
};

显然，这些版本会有不同的实现。

诀窍是反序列化为临时变量，然后根据您的业务规则将旧语义映射到新语义上：

#if DEMO_VERSION == 0
MyType::MyType()                     : hasValue(false)          {}
MyType::MyType(std::string const &v) : hasValue(true), value(v) {}

template <typename Ar> void MyType::serialize(Ar& ar, unsigned /*file_version*/) {
    ar & hasValue & value; // life was simple in v0
}

#elif DEMO_VERSION == 1
MyType::MyType()                     : value(boost::none)       {}
MyType::MyType(std::string const &v) : value(v)                 {}

template <typename Ar> void MyType::serialize(Ar& ar, unsigned file_version) {
    switch (file_version) {
        case 0: {
            assert(Ar::is_loading::value); // should not be writing old formats
            //
            bool        old_hasValue;      // these fields no longer exist
            std::string oldValue;

            ar & old_hasValue & oldValue;

            // translate to new object semantics/layout
            value.reset();
            if (old_hasValue) value.reset(oldValue);

            break;
        }
        default: // v1+
            ar & value;
    }
}
#endif

您可以在 Coliru 上实时看到此过程，其中程序 v0 将对象写入 v0.dat，程序 v1 成功读取该对象（并以新格式序列化）：

Live On Coliru

BOOST_CLASS_VERSION(MyType, DEMO_VERSION)
#include <fstream>

namespace demo {
    template <typename T> void serialize(std::ostream& os, T const& obj) {
        {
            boost::archive::text_oarchive oa(os);
            oa << obj;
        }
        os.flush();
    }

    template <typename T> void save(std::string const& fname, T const& payload) {
        std::ofstream ofs(fname, std::ios::binary);
        serialize(ofs, payload);
    }

    MyType load(std::string const& fname) {
        std::ifstream ifs(fname, std::ios::binary);

        MyType obj;

        boost::archive::text_iarchive ia(ifs);
        ia >> obj;

        return obj;
    }
}

int main(int, char** cmd) {
    std::cout << "Running " << *cmd << " with DEMO_VERSION=" << DEMO_VERSION << "\n";
    using namespace demo;

#if DEMO_VERSION == 0

    MyType payload("Forty two");
    save     ("v0.dat", payload);  // uses v0 format
    serialize(std::cout, payload); // uses v0 format

#elif DEMO_VERSION == 1

    auto loaded = load("v0.dat");  // still reads the v0 format
    serialize(std::cout, loaded);  // uses v1 format now

#endif
}

打印：

for v in 0 1
do
    g++ -std=c++11 -Os -Wall -DDEMO_VERSION=$v main.cpp -o v$v -lboost_system -lboost_serialization
    ./v$v
done
Running ./v0 with DEMO_VERSION=0
22 serialization::archive 11 0 0 1 9 Forty two
Running ./v1 with DEMO_VERSION=1
22 serialization::archive 11 0 1 0 0 1 0 9 Forty two

案例研究 2：更改/删除的类型

就像你说的，可能最简单的做法是保留旧类型以进行间接反序列化。

请参阅上面的“背景/存档格式兼容性”部分，当然，只要您知道自己在做什么，还有另一种选择。

假设上面的示例（“案例研究 1”）略有不同，并使用了 PoorMansOptional<std::string> 替换为 boost::optional<std::string>。您可以找出反序列化的等效字段。

注意可能散布的额外项目版本字段。在上面提到的容器示例中，这些字段在项目之间很方便地不存在。