Flat Buffers - 枚举

概述

枚举数据类型是Flat Buffers的复合数据类型之一。它相当于我们使用的语言中的枚举，例如Java等。

继续使用Flat Buffers - 字符串一章中的Theater 示例，以下是我们需要用来指示 FlatBuffers 我们将创建枚举的语法 −

theater.fbs

namespace com.tutorialspoint.theater;

enum PAYMENT_SYSTEM: byte { CASH = 0, CREDIT_CARD = 1, DEBIT_CARD, APP = 3 }

table Theater {
   payment:PAYMENT_SYSTEM;
}
root_type Theater;

现在我们的表包含一个枚举属性。我们为每个枚举常量分配了一个值，除了一个 DEBIT_CARD，默认情况下，它采用增量值 2。

我们定义枚举并将其用作下面的数据类型以及"payment"属性。

从 fbs 文件创建 Java 类

要使用 FlatBuffers，我们现在必须使用flatc二进制文件从此".fbs"文件创建所需的类。让我们看看如何做到这一点 −

flatc --java theater.fbs

这将在当前目录的com > tutorialspoint > theater 文件夹中创建一个 Theater.java 和 PAYMENT_SYSTEM 类。我们在应用程序中使用此类的方式与Flat Buffers - Schema一章中的方式类似。

使用从 fbs 文件创建的 Java 类

TheaterWriter.java

package com.tutorialspoint.theater;

import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;

import com.google.flatbuffers.FlatBufferBuilder;

public class TheaterWriter {
   public static void main(String[] args) throws FileNotFoundException, IOException {
        // 创建一个Flat Buffers构建器
        // 它将用于创建Theater  FlatBuffer
        FlatBufferBuilder builder = new FlatBufferBuilder(1024);
        
        // 使用 startTheater() 方法创建Theater  FlatBuffers
        Theater.startTheater(builder);
        // 向Theater  FlatBuffer 添加详细信息
        Theater.addPayment(builder, PAYMENT_SYSTEM.DEBIT_CARD);
        
        // 标记在 Greet FlatBuffer 中输入的数据结束
        int theater = Theater.endTheater(builder);
        
        // 完成构建器
        builder.finish(theater);
        
        // 获取要存储的字节
        byte[] data = builder.sizedByteArray();
        
        String filename = "theater_flatbuffers_output";
        System.out.println("将Theater 保存到文件:" + filename);
        // 将构建器内容写入名为 theater_flatbuffers_output 的文件
        try(FileOutputStream output = new FileOutputStream(filename)){
         output.write(data);
      	}
      	System.out.println("Saved theater with following data to disk: 
" + theater);
   }
}	

接下来，我们将有一个阅读器来读取Theater 信息 −

TheaterReader.java

package com.tutorialspoint.theater;

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.nio.ByteBuffer;

public class TheaterReader {
   public static void main(String[] args) throws FileNotFoundException, IOException {

      String filename = "theater_flatbuffers_output";
      System.out.println("Reading from file " + filename);
      try(FileInputStream input = new FileInputStream(filename)) {
         // 获取序列化数据
         byte[] data = input.readAllBytes();
         ByteBuffer buf = ByteBuffer.wrap(data);
         // 读取序列化数据中的根对象
         Theater theater = Theater.getRootAsTheater(buf);
         // 打印 theater 剧场值
         System.out.println("Payment Method: " + theater.payment());
      }
   }
}

编译项目

现在我们已经设置了reader和writer，让我们编译项目。

mvn clean install

序列化 Java 对象

现在，编译后，让我们先执行writer −

> java -cp .	arget\flatbuffers-tutorial-1.0.jar com.tutorialspoint.theater.TheaterWriter

Saving theater information to file: theater_flatbuffers_output
Saved theater information with following data to disk:
8

反序列化序列化对象

现在，让我们执行读取器来读取同一个文件−

java -cp .	arget\flatbuffers-tutorial-1.0.jar com.tutorialspoint.theater.TheaterReader

Reading from file theater_flatbuffers_output
Payment Method: 2

因此，如我们所见，我们可以通过将二进制数据反序列化为 Theater 对象来读取序列化的 enum。在下一章 Flat Buffers - Vector 中，我们将研究复合类型 vector。