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

Handle removed variable from boost serialize

本文关键字:删除 变量 序列化 boost 处理      更新时间:2023-10-16

我查看了web上的示例,该示例通过增加版本号并在该变量的序列化周围添加"if"来向序列化函数添加成员变量。

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

如果我删除了一些在序列化函数中被"序列化"的类,这可能会变得更糟,我需要保留它们只是为了序列化代码还是有其他方法?

背景/存档格式兼容性

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> >

这些类型(不需要)存储类型信息,因此二进制流是兼容的,可交换的。

如果你想依赖于这种"偶然的"兼容性,你可能想写广泛的测试

我有一种感觉,您应该能够设计一个简单的归档实现,而不是序列化实际数据,而是创建所涉及的数据结构的"布局图"或"兼容性签名"。

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

案例研究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>取代。您可以找出要反序列化的等效字段。

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