FlatBuffers : 메모리 효율적 직렬화 라이브러리

FlatBuffers : 메모리 효율적 직렬화 라이브러리

• https://github.com/google/flatbuffers

FlatBuffers 는 크로스 플랫폼 직렬화 라이브러리로 다음과 같은 목적으로 설계되었습니다.

최대 메모리 효율성. 이를 통해 먼저 파싱/언패킹하지 않고도 직렬화된 데이터에 직접 액세스할 수 있으며, 여전히 우수한 전방/후방 호환성을 유지합니다.

빠른 시작

1. 플랫버퍼를 위한 컴파일러(flatc)를 빌드합니다.

• cmake를 사용하여 플랫폼에 맞는 빌드 파일을 생성한 다음 컴파일을 수행합니다(Linux 예).

  cmake -G "Unix Makefiles"
  make -j
  

• 미리 빌드된 컴파일러는 https://github.com/google/flatbuffers/releases 에 존재합니다.

2. 플랫버퍼 스키마(.fbs)를 정의합니다.

• 직렬화하려는 데이터를 정의하려면 스키마를 작성합니다.

• 예제는 monster.fbs를 참조하세요.

  // Example IDL file for our monster's schema.
  namespace MyGame.Sample;
  
  enum Color:byte { Red = 0, Green, Blue = 2 }
  
  union Equipment { Weapon } // Optionally add more tables.
  
  struct Vec3 {
    x:float;
    y:float;
    z:float;
  }
  
  table Monster {
    pos:Vec3;
    mana:short = 150;
    hp:short = 100;
    name:string;
    friendly:bool = false (deprecated);
    inventory:[ubyte];
    color:Color = Blue;
    weapons:[Weapon];
    equipped:Equipment;
    path:[Vec3];
  }
  
  table Weapon {
    name:string;
    damage:short;
  }
  
  root_type Monster;
  

3. 언어에 대한 코드 생성

• flatc 컴파일러를 사용하여 스키마를 가져와 언어별 코드를 생성합니다. (예제는 C++와 Rust)

  ./flatc --cpp --rust monster.fbs
  

• monster_generated.h와 monster_generated.rs 파일을 생성합니다.

4. 데이터 직렬화

• 생성된 코드와 FlatBufferBuilder를 사용하여 직렬화된 버퍼를 구성합니다.
• C++ 예제)

// Build up a serialized buffer algorithmically:
flatbuffers::FlatBufferBuilder builder;

// First, lets serialize some weapons for the Monster: A 'sword' and an 'axe'.
auto weapon_one_name = builder.CreateString("Sword");
short weapon_one_damage = 3;

auto weapon_two_name = builder.CreateString("Axe");
short weapon_two_damage = 5;

// Use the `CreateWeapon` shortcut to create Weapons with all fields set.
auto sword = CreateWeapon(builder, weapon_one_name, weapon_one_damage);
auto axe = CreateWeapon(builder, weapon_two_name, weapon_two_damage);

// Create a FlatBuffer's `vector` from the `std::vector`.
std::vector<flatbuffers::Offset<Weapon>> weapons_vector;
weapons_vector.push_back(sword);
weapons_vector.push_back(axe);
auto weapons = builder.CreateVector(weapons_vector);

// Second, serialize the rest of the objects needed by the Monster.
auto position = Vec3(1.0f, 2.0f, 3.0f);

auto name = builder.CreateString("MyMonster");

unsigned char inv_data[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 };
auto inventory = builder.CreateVector(inv_data, 10);

// Shortcut for creating monster with all fields set:
auto orc = CreateMonster(builder, &position, 150, 80, name, inventory,
					   Color_Red, weapons, Equipment_Weapon, axe.Union());

builder.Finish(orc);  // Serialize the root of the object.

5. 전송/저장/버퍼 저장

• 직렬화된 버퍼를 원하는 대로 사용하세요. 누군가에게 보내거나, 나중에 저장하거나, 등등...

6. 데이터 읽기

• 생성된 접근자를 사용하여 직렬화된 버퍼에서 데이터를 읽습니다.

• 동일한 언어/스키마 버전일 필요는 없습니다. FlatBuffers는 데이터가 여러 언어와 스키마 버전에서 읽을 수 있도록 보장합니다.

• C++로 작성된 데이터를 읽는 Rust 예제를 참조하세요.

// We now have a FlatBuffer we can store on disk or send over a network.

// ** file/network code goes here :) **

// Instead, we're going to access it right away (as if we just received it).
// This must be called after `finish()`.
let buf = builder.finished_data(); // Of type `&[u8]`

// Get access to the root:
let monster = flatbuffers::root::<Monster>(buf).unwrap();

// Get and test some scalar types from the FlatBuffer.
let hp = monster.hp();
let mana = monster.mana();
let name = monster.name();

문서

문서를 탐색하려면 랜딩 페이지로 이동하세요.

지원되는 운영 체제

• 윈도우
• 맥 OS
• 리눅스
• 안드로이드
• 최신 C++ 컴파일러(C++ 11 이상)를 사용하는 다른 사용자

지원되는 프로그래밍 언어

다양한 인기 언어를 위한 코드 생성 및 런타임 라이브러리.

• C
• C++ - snapcraft.io
• C# - nuget.org
• Dart - pub.dev
• Go - go.dev
• Java - Maven
• JavaScript - NPM
• Kotlin
• Lobster
• Lua
• PHP
• Python - PyPI
• Rust - crates.io
• Swift - swiftpackageindex
• TypeScript - NPM
• Nim

버전 관리

FlatBuffers는 기존의 SemVer 버전 관리를 따르지 않습니다(근거 참조). 대신 출시 날짜 형식을 사용합니다.

기부금

• FlatBuffers 이슈 추적기를 사용하여 문제를 제출하세요.
• FlatBuffers에 관한 질문은 stackoverflow.com에 flatbuffers 태그를 사용하여 보내주세요.

이 프로젝트에 기여하려면 기여를 참조하세요.

지역 사회

• 디스코드 서버

보안

취약점 보고에 대해서는 보안 정책을 참조하세요.

라이센스

Flatbuffers는 Apache License, Version 2.0에 따라 라이센스됩니다. 전체 라이센스 텍스트는 LICENSE를 참조하세요.

view raw flatbuffer.ko.md hosted with ❤ by GitHub