Protocol Buffers - 列舉

概述

enum 資料型別是 Protobuf 的複合資料型別之一。它在使用的語言（例如 Java 等）中轉換為列舉。

繼續我們從 Protocol Buffers - 字串章節的劇院示例，以下是我們需要使用的語法，以指示 Protobuf 我們將建立一個列舉：

theater.proto

syntax = "proto3";
package theater;
option java_package = "com.tutorialspoint.theater";

message Theater {
   enum PAYMENT_SYSTEM{
      CASH = 0;
      CREDIT_CARD = 1;
      DEBIT_CARD = 2;
      APP = 3;  
   }
   PAYMENT_SYSTEM payment = 7;
}

現在我們的訊息類包含一個列舉屬性。它還有一個位置，這是 Protobuf 在序列化和反序列化時使用的。每個成員屬性都需要分配一個唯一的數字。

我們定義了列舉，並在下面將其用作資料型別以及“payment”屬性。請注意，儘管我們在訊息類內部定義了列舉，但它也可以位於訊息類外部。

從 Proto 檔案建立 Java 類

要使用 Protobuf，我們現在必須使用protoc二進位制檔案從這個“.proto”檔案建立所需的類。讓我們看看如何操作：

protoc  --java_out=. theater.proto

這將在當前目錄的com > tutorialspoint > theater資料夾中建立一個TheaterOuterClass.java類。我們在應用程式中使用此類，類似於Protocol Buffers - 基本應用章節中所做的。

使用從 Proto 檔案建立的 Java 類

TheaterWriter.java

package com.tutorialspoint.theater;

import java.io.FileOutputStream;
import java.io.IOException;
import com.tutorialspoint.theater.TheaterOuterClass.Theater;
import com.tutorialspoint.theater.TheaterOuterClass.Theater.PAYMENT_SYSTEM;

public class TheaterWriter{
   public static void main(String[] args) throws IOException {
      Theater theater = Theater.newBuilder()
         .setPayment(PAYMENT_SYSTEM.CREDIT_CARD)
         .build();
		
      String filename = "theater_protobuf_output";
      System.out.println("Saving theater information to file: " + filename);
		
      try(FileOutputStream output = new FileOutputStream(filename)){
         theater.writeTo(output);
      }
	    
      System.out.println("Saved theater information with following data to disk: \n" + theater);
   }
}

接下來，我們將有一個讀取器來讀取劇院資訊：

TheaterReader.java

package com.tutorialspoint.theater;

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import com.tutorialspoint.greeting.Greeting.Greet;
import com.tutorialspoint.theater.TheaterOuterClass.Theater;
import com.tutorialspoint.theater.TheaterOuterClass.Theater.Builder;

public class TheaterReader{
   public static void main(String[] args) throws IOException {
      Builder theaterBuilder = Theater.newBuilder();

      String filename = "theater_protobuf_output";
      System.out.println("Reading from file " + filename);
        
      try(FileInputStream input = new FileInputStream(filename)) {
         Theater theater = theaterBuilder.mergeFrom(input).build();
         System.out.println(theater.getPayment());
         System.out.println(theater);
      }
   }
}

編譯專案

現在我們已經設定了讀取器和寫入器，讓我們編譯專案。

mvn clean install

序列化 Java 物件

現在，編譯後，讓我們首先執行寫入器：

> java -cp .\target\protobuf-tutorial-1.0.jar com.tutorialspoint.theater.TheaterWriter

Saving theater information to file: theater_protobuf_output
Saved theater information with following data to disk:
payment: CREDIT_CARD

反序列化已序列化的物件

現在，讓我們執行讀取器以從同一檔案讀取：

java -cp .\target\protobuf-tutorial-1.0.jar com.tutorialspoint.theater.TheaterReader

Reading from file theater_protobuf_output
CREDIT_CARD
payment: CREDIT_CARD

因此，正如我們所看到的，我們能夠透過將二進位制資料反序列化為Theater物件來讀取序列化的列舉。在下一章Protocol Buffers - 重複欄位中，我們將瞭解重複欄位，這是一種複合型別。