protolator - Protobuf <==> json

github.com/hyperledger/fabric-config/protolator 是 Hyperledger Fabric 中的一個 Go 包，用於將 Protocol Buffers（ProtoBuf）消息和 JSON 格式之間進行轉換。它提供了一種方便的方式來將 Fabric 配置文件（以 ProtoBuf 格式表示）與 JSON 配置文件之間進行相互轉換。這對於 Fabric 的配置管理和部署非常有用，使得用戶可以輕鬆地在不同的配置格式之間進行切換。

功能和用法

protolator 提供了一組功能，用於在 ProtoBuf 格式和 JSON 格式之間進行轉換：

DeepMarshalJSON

func DeepMarshalJSON(m proto.Message) ([]byte, error)

• 該方法用於將給定的 ProtoBuf 消息 m 轉換為 JSON 格式的位元組流。
• 它遞歸地將 ProtoBuf 的消息及其子消息轉換為 JSON 格式，返回表示 JSON 格式數據的位元組流。
• 註意：轉換後的 JSON 位元組流將具有縮進格式，易於閱讀。

DeepUnmarshalJSON

func DeepUnmarshalJSON(data []byte, m proto.Message) error

• 該方法用於將給定的 JSON 格式位元組流 data 轉換為指定的 ProtoBuf 消息 m。
• 它遞歸地將 JSON 格式的數據解析並填充到 m 中，返回 nil 或錯誤。
• 註意：JSON 位元組流必須是有效的，並且與目標消息 m 的結構相匹配。

Nested

type Nested struct{...}

• Nested 類型是用於 ProtoBuf 和 JSON 之間可嵌套轉換的通用轉換器。
• 它提供了 Marshal 和 Unmarshal 方法，用於將 ProtoBuf 格式的消息轉換為可嵌套的 JSON 格式，以及將可嵌套的 JSON 格式轉換為 ProtoBuf 格式。

使用示例

package main

import (
	"fmt"
	"github.com/golang/protobuf/proto"
	"github.com/hyperledger/fabric-config/protolator"
	"encoding/json"
)

// 使用 proto 文件定義的 message 結構
// 假設定義了 proto 文件如下：
// message MyData {
//     string name = 1;
//     int32 age = 2;
// }
type MyData struct {
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Age  int32  `protobuf:"varint,2,opt,name=age" json:"age,omitempty"`
}

func main() {
	// 創建一個 MyData 實例
	data := &MyData{
		Name: "John",
		Age:  30,
	}

	// 使用 DeepMarshalJSON 將 ProtoBuf 數據轉換為 JSON 位元組流
	jsonData, err := protolator.DeepMarshalJSON(data)
	if err != nil {
		fmt.Println("Error marshaling to JSON:", err)
		return
	}

	// 使用 DeepUnmarshalJSON 將 JSON 位元組流轉換為 ProtoBuf 數據
	newData := &MyData{}
	err = protolator.DeepUnmarshalJSON(jsonData, newData)
	if err != nil {
		fmt.Println("Error unmarshaling from JSON:", err)
		return
	}

	// 輸出結果
	fmt.Println("Original data:", data)
	fmt.Println("JSON data:", string(jsonData))
	fmt.Println("Unmarshaled data:", newData)
}

在上述示例中，我們使用 github.com/hyperledger/fabric-config/protolator 的 DeepMarshalJSON 方法將 MyData 結構體從 ProtoBuf 格式轉換為 JSON 格式的位元組流，並使用 DeepUnmarshalJSON 方法將 JSON 位元組流再轉換回 ProtoBuf 格式的數據。輸出結果顯示了原始數據、轉換後的 JSON 數據以及再次轉換回來後的數據。

聲明：本作品採用署名-非商業性使用-相同方式共用 4.0 國際 (CC BY-NC-SA 4.0)進行許可，使用時請註明出處。
Author: mengbin
blog: mengbin
Github: mengbin92
cnblogs: 戀水無意