Protocol Buffers - map

概述

map 資料型別是 Protobuf 的複合資料型別之一。它在 Java 中轉換為 java.util.Map 介面。

繼續我們從 Protocol Buffers - 字串章節的 theater 示例，以下是我們需要使用的語法，以指示 Protobuf 我們將建立一個 repeated（重複）欄位：

theater.proto

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

message Theater {
   map<string, int32> movieTicketPrice = 9;
}

現在我們的 message 類包含一個電影及其票價的 map。請注意，雖然我們有 “string -> int” map，但我們也可以使用數字、布林值和自定義資料型別。但是，請注意我們不能巢狀 map。它還有一個 position 屬性，這是 Protobuf 在序列化和反序列化時使用的。每個成員屬性都需要分配一個唯一的數字。

從 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 java.util.HashMap;
import java.util.Map;

import com.tutorialspoint.theater.TheaterOuterClass.Theater;

public class TheaterWriter{
   public static void main(String[] args) throws IOException {
      Map<String, Integer> ticketPrice = new HashMap<>();
	    
      ticketPrice.put("Avengers Endgame", 700);
      ticketPrice.put("Captain America", 200);
      ticketPrice.put("Wonder Woman 1984", 400);
	    
      Theater theater = Theater.newBuilder()
         .putAllMovieTicketPrice(ticketPrice)
         .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);
   }
}

接下來，我們將有一個 reader 來讀取 theater 資訊：

TheaterReader.java

package com.tutorialspoint.theater;

import java.io.FileInputStream;
import java.io.IOException;

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);
      }
   }
}

編譯專案

現在我們已經設定了 reader 和 writer，讓我們編譯專案。

mvn clean install

序列化 Java 物件

現在，編譯後，讓我們首先執行 writer：

> 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:
movieTicketPrice {
   key: "Avengers Endgame"
   value: 700
}
movieTicketPrice {
   key: "Captain America"
   value: 200
}
movieTicketPrice {
   key: "Wonder Woman 1984"
   value: 400
}

反序列化已序列化的物件

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

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

Reading from file theater_protobuf_output
movieTicketPrice {
   key: "Avengers Endgame"
   value: 700
}
movieTicketPrice {
   key: "Captain America"
   value: 200
}
movieTicketPrice {
   key: "Wonder Woman 1984"
   value: 400
}

因此，正如我們所看到的，我們能夠透過將二進位制資料反序列化為 Theater 物件來讀取已序列化的 map。在下一章 Protocol Buffers - 巢狀類中，我們將瞭解巢狀類。