libnop 项目使用教程

libnop 项目使用教程

1. 项目目录结构及介绍

libnop 是一个 C++ 原生对象协议库，主要用于序列化和反序列化 C++ 数据类型。以下是项目的目录结构及其介绍：

libnop/
├── build/
│   └── 构建相关的文件和脚本
├── docs/
│   └── 项目文档，包括使用指南和 API 文档
├── examples/
│   └── 示例代码，展示了如何使用 libnop 进行序列化和反序列化
├── include/
│   └── nop/
│       └── libnop 的头文件，包含了库的核心功能
├── test/
│   └── 单元测试和集成测试代码
├── AUTHORS
│   └── 项目贡献者列表
├── CONTRIBUTING.md
│   └── 贡献指南，指导如何为项目贡献代码
├── LICENSE
│   └── 项目许可证，MIT 许可证
├── Makefile
│   └── 项目构建脚本
├── README.md
│   └── 项目介绍和使用说明

2. 项目启动文件介绍

libnop 是一个头文件库，没有传统的“启动文件”。用户只需包含相应的头文件即可使用库的功能。以下是一些关键头文件的介绍：

• include/nop/serializer.h: 序列化器头文件，包含了序列化 C++ 数据类型的功能。
• include/nop/deserializer.h: 反序列化器头文件，包含了反序列化 C++ 数据类型的功能。
• include/nop/structure.h: 结构体定义头文件，用于定义需要序列化的结构体。

3. 项目配置文件介绍

libnop 是一个头文件库，没有传统的配置文件。用户在使用时只需包含相应的头文件，并根据需要定义和序列化/反序列化 C++ 数据类型。

示例代码

以下是一个简单的示例，展示了如何使用 libnop 进行序列化和反序列化：

#include <iostream>
#include <sstream>
#include <string>
#include <vector>
#include <nop/serializer.h>
#include <nop/deserializer.h>
#include <nop/structure.h>
#include <nop/utility/stream_writer.h>
#include <nop/utility/stream_reader.h>

namespace example {
    struct Person {
        std::string name;
        std::uint32_t age_years;
        std::uint8_t height_inches;
        std::uint16_t weight_pounds;

        NOP_STRUCTURE(Person, name, age_years, height_inches, weight_pounds);
    };
}

int main() {
    using Writer = nop::StreamWriter<std::stringstream>;
    using Reader = nop::StreamReader<std::stringstream>;

    nop::Serializer<Writer> serializer;
    nop::Deserializer<Reader> deserializer;

    example::Person person = {"John Doe", 37, 72, 180};
    serializer.Write(person);

    std::string serialized_data = serializer.writer().stream().str();
    std::cout << "Serialized data size: " << serialized_data.size() << " bytes" << std::endl;

    deserializer.reader().SetStream(serialized_data);
    example::Person deserialized_person;
    deserializer.Read(&deserialized_person);

    std::cout << "Deserialized person: " << deserialized_person.name << ", "
              << deserialized_person.age_years << " years old, "
              << static_cast<int>(deserialized_person.height_inches) << " inches tall, "
              << deserialized_person.weight_pounds << " pounds" << std::endl;

    return 0;
}

以上代码展示了如何使用 libnop 对自定义结构体 Person 进行序列化和反序列化。