IT заметки по программированию
IT заметки по программированию
IT заметки по программированию
IT заметки по программированию

Что такое oneof в Protobuf?

25.04.2024
Golang
Комментариев нет

oneof в Protobuf позволяет включать несколько типов данных в одно поле, но в один момент времени будет иметь значение только один из этих типов. Это полезно, когда нужно моделировать поле, которое может принимать разные типы данных, но не одновременно.

Основная идея oneof:

  • Одно поле в сообщении может содержать только одно значение из нескольких возможных типов.
  • Это сэкономит память, потому что Protobuf будет хранить только одно значение из множества вариантов.

Пример использования oneof

Пример схемы Protobuf с oneof:

Default
1
2
3
4
5
6
7
8
9
syntax = "proto3";
 
message Response {
  oneof result {
    string message = 1;  // Сообщение об успехе
    int32 error_code = 2; // Код ошибки
  }
}
 
🔹 Здесь у нас есть поле result, которое может либо содержать message (строку), либо error_code (целое число). Но не оба одновременно.

Как это работает?

Пример данных (json-like)

Допустим, мы создаём сообщение с message, которое обозначает успешный ответ:

JavaScript
1
2
3
4
5
6
{
  "result": {
    "message": "Success"
  }
}
 

Или создаём сообщение с error_code, если произошла ошибка:

JavaScript
1
2
3
4
5
6
{
  "result": {
    "error_code": 404
  }
}
 

Пример сгенерированного Go-кода для oneof:

После компиляции .proto файла с oneof, Protobuf создаст Go-структуру с методами для работы с этим полем. Пример сгенерированного кода:

Go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
package main
 
import (
"fmt"
"log"
 
"google.golang.org/protobuf/proto"
"example/responsepb"  // Импорт сгенерированного кода
)
 
func main() {
// Создаём успешный ответ
success := &responsepb.Response{
Result: &responsepb.Response_Message{
Message: "Success",
},
}
 
// Сериализация в Protobuf
data, err := proto.Marshal(success)
if err != nil {
log.Fatal("Ошибка сериализации:", err)
}
 
fmt.Println("Сериализованный ответ:", data)
 
// Десериализация из Protobuf
var parsed responsepb.Response
err = proto.Unmarshal(data, &parsed)
if err != nil {
log.Fatal("Ошибка десериализации:", err)
}
 
// Проверяем тип результата
switch result := parsed.Result.(type) {
case *responsepb.Response_Message:
fmt.Println("Успех:", result.Message)
case *responsepb.Response_ErrorCode:
fmt.Println("Ошибка:", result.ErrorCode)
default:
fmt.Println("Неизвестный тип результата")
}
}
 

Как работает oneof в Go?

  • При сериализации и десериализации внутри поля Result будет находиться только один из типов данных (либо Message, либо ErrorCode).
  • В Go сгенерирован код будет использовать встраиваемые типы (Response_Message, Response_ErrorCode), чтобы явно указать, какой тип был установлен.
  • Когда мы десериализуем данные, нужно проверить с помощью type assertion, какой тип в данный момент находится в поле.

Особенности работы с oneof:

  1. Только один тип в поле: Когда используешь oneof, Protobuf не позволяет одновременно хранить несколько значений в одном поле. То есть, если в одном пакете данных содержится message, в этот момент нельзя поставить значение для error_code и наоборот.
  2. Экономия памяти: Поскольку только одно значение из oneof сериализуется и хранится в данных, это экономит память, когда есть поля с возможными большими типами данных.
  3. Простота в использовании: Для потребителей сообщения (например, клиентов) легко использовать switch или другие проверки типа, чтобы работать с конкретным значением.

Когда использовать oneof?

  • Когда одно поле может быть разного типа. Например, ответ может быть либо успехом, либо ошибкой, но не обоими одновременно.
  • Когда экономия памяти важна и вам нужно обрабатывать различные типы данных в одном сообщении.
  • Когда есть несколько типов данных, которые могут быть заменены в определённых условиях, например, разные виды сообщений, ошибки или ответы от разных типов клиентов.

Итог:
oneof — это удобный инструмент для работы с полями, которые могут принимать разные значения, но только одно в конкретный момент времени. Это помогает создавать более гибкие и экономичные схемы сообщений в Protobuf!

Recommended Posts

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *