NanoPB: Как обрабатывать вложенные сообщения в C

NanoPB — это оптимизированная по размеру кода реализация Protocol Buffers для встраиваемых систем. В этом посте показано, как обрабатывать вложенные сообщения в C с помощью NanoPB.

Определение Proto

Сначала создайте файл .proto с вложенными сообщениями:

nested.proto

syntax = "proto3";

package example;

message Address {
  string street = 1;
  string city = 2;
  string country = 3;
}

message Person {
  string name = 1;
  uint32 age = 2;
  Address address = 3;
}

syntax = "proto3";

package example;

message Address {
  string street = 1;
  string city = 2;
  string country = 3;
}

message Person {
  string name = 1;
  uint32 age = 2;
  Address address = 3;
}

Генерация кода NanoPB

Сгенерируйте код NanoPB с помощью файла .options для указания размеров строковых буферов:

Создайте nested.options:

nested.options

example.Address.street max_size:64
example.Address.city max_size:32
example.Address.country max_size:32
example.Person.name max_size:64

example.Address.street max_size:64
example.Address.city max_size:32
example.Address.country max_size:32
example.Person.name max_size:64

Затем сгенерируйте:

generate_nanopb_nested.sh

protoc --nanopb_out=. nested.proto

protoc --nanopb_out=. nested.proto

Это создаст nested.pb.h и nested.pb.c.

Пример на C

Вот полный пример на C для обработки вложенных сообщений:

nested_example.c

#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include "nested.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

int main() {
    // Буфер для закодированного сообщения
    uint8_t buffer[256];
    size_t message_length;
    
    // --- КОДИРОВАНИЕ ---
    example_Person person = example_Person_init_zero;
    
    // Установка значений вложенного сообщения
    strncpy(person.name, "John Doe", sizeof(person.name) - 1);
    person.has_address = true;
    strncpy(person.address.street, "123 Main St", sizeof(person.address.street) - 1);
    strncpy(person.address.city, "Springfield", sizeof(person.address.city) - 1);
    strncpy(person.address.country, "USA", sizeof(person.address.country) - 1);
    
    // Создание потока для кодирования
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Кодирование сообщения
    if (!pb_encode(&ostream, example_Person_fields, &person)) {
        printf("Encoding failed: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Encoded %zu bytes\n", message_length);
    
    // Вывод шестнадцатеричного дампa закодированных данных
    printf("Encoded data: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- ДЕКОДИРОВАНИЕ ---
    example_Person decoded = example_Person_init_zero;
    
    // Создание потока для декодирования
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Декодирование сообщения
    if (!pb_decode(&istream, example_Person_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Вывод декодированных значений
    printf("Decoded values:\n");
    printf("  name: %s\n", decoded.name);
    printf("  age: %u\n", (unsigned int)decoded.age);
    printf("  address:\n");
    printf("    street: %s\n", decoded.address.street);
    printf("    city: %s\n", decoded.address.city);
    printf("    country: %s\n", decoded.address.country);
    
    return 0;
}

#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include "nested.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

int main() {
    // Буфер для закодированного сообщения
    uint8_t buffer[256];
    size_t message_length;
    
    // --- КОДИРОВАНИЕ ---
    example_Person person = example_Person_init_zero;
    
    // Установка значений вложенного сообщения
    strncpy(person.name, "John Doe", sizeof(person.name) - 1);
    person.has_address = true;
    strncpy(person.address.street, "123 Main St", sizeof(person.address.street) - 1);
    strncpy(person.address.city, "Springfield", sizeof(person.address.city) - 1);
    strncpy(person.address.country, "USA", sizeof(person.address.country) - 1);
    
    // Создание потока для кодирования
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Кодирование сообщения
    if (!pb_encode(&ostream, example_Person_fields, &person)) {
        printf("Encoding failed: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Encoded %zu bytes\n", message_length);
    
    // Вывод шестнадцатеричного дампa закодированных данных
    printf("Encoded data: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- ДЕКОДИРОВАНИЕ ---
    example_Person decoded = example_Person_init_zero;
    
    // Создание потока для декодирования
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Декодирование сообщения
    if (!pb_decode(&istream, example_Person_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Вывод декодированных значений
    printf("Decoded values:\n");
    printf("  name: %s\n", decoded.name);
    printf("  age: %u\n", (unsigned int)decoded.age);
    printf("  address:\n");
    printf("    street: %s\n", decoded.address.street);
    printf("    city: %s\n", decoded.address.city);
    printf("    country: %s\n", decoded.address.country);
    
    return 0;
}

Команда компиляции

Скомпилируйте пример с помощью nanopb. NanoPB обычно используется путём прямого включения исходных файлов в ваш проект:

compile_nested_example.sh

gcc -o nested_example nested_example.c nested.pb.c pb_common.c pb_encode.c pb_decode.c -I.

gcc -o nested_example nested_example.c nested.pb.c pb_common.c pb_encode.c pb_decode.c -I.

Примечание: Исходные файлы NanoPB (pb_common.c, pb_encode.c, pb_decode.c) необходимо компилировать напрямую вместе с вашим проектом. Вы можете получить их из репозитория NanoPB на GitHub.

Скрипт тестирования на Python

Для проверки кодирования можно использовать библиотеку protobuf для Python:

test_nested.py

import nested_pb2

# Чтение бинарных данных
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Декодирование
msg = nested_pb2.Person()
msg.ParseFromString(data)

print("Python decoded values:")
print(f"  name: {msg.name}")
print(f"  age: {msg.age}")
print(f"  address:")
print(f"    street: {msg.address.street}")
print(f"    city: {msg.address.city}")
print(f"    country: {msg.address.country}")

import nested_pb2

# Чтение бинарных данных
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Декодирование
msg = nested_pb2.Person()
msg.ParseFromString(data)

print("Python decoded values:")
print(f"  name: {msg.name}")
print(f"  age: {msg.age}")
print(f"  address:")
print(f"    street: {msg.address.street}")
print(f"    city: {msg.address.city}")
print(f"    country: {msg.address.country}")

Сначала скомпилируйте определения protobuf для Python:

compile_python_nested.sh

protoc --python_out=. nested.proto

protoc --python_out=. nested.proto

Затем измените пример на C, чтобы сохранить закодированные данные в файл:

save_encoded_nested.c

// После кодирования добавьте это:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

// После кодирования добавьте это:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

Пример с опциональным вложенным сообщением

Вот пример с опциональным вложенным сообщением:

nested_optional.proto

syntax = "proto3";

package example;

message Address {
  string street = 1;
  string city = 2;
}

message Person {
  string name = 1;
  optional Address address = 2;
}

syntax = "proto3";

package example;

message Address {
  string street = 1;
  string city = 2;
}

message Person {
  string name = 1;
  optional Address address = 2;
}

Создайте nested_optional.options:

nested_optional.options

example.Address.street max_size:64
example.Address.city max_size:32
example.Person.name max_size:64

example.Address.street max_size:64
example.Address.city max_size:32
example.Person.name max_size:64

nested_optional_example.c

#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include "nested_optional.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

int main() {
    uint8_t buffer[256];
    size_t message_length;
    
    // --- КОДИРОВАНИЕ ---
    example_Person person = example_Person_init_zero;
    
    strncpy(person.name, "Jane Doe", sizeof(person.name) - 1);
    
    // Установка опционального вложенного сообщения
    strncpy(person.address.street, "456 Oak Ave", sizeof(person.address.street) - 1);
    strncpy(person.address.city, "Boston", sizeof(person.address.city) - 1);
    person.has_address = true;  // Важно: установите флаг has_*
    
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    if (!pb_encode(&ostream, example_Person_fields, &person)) {
        printf("Encoding failed: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Encoded %zu bytes\n", message_length);
    
    // --- ДЕКОДИРОВАНИЕ ---
    example_Person decoded = example_Person_init_zero;
    
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    if (!pb_decode(&istream, example_Person_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    printf("Decoded values:\n");
    printf("  name: %s\n", decoded.name);
    if (decoded.has_address) {
        printf("  address:\n");
        printf("    street: %s\n", decoded.address.street);
        printf("    city: %s\n", decoded.address.city);
    } else {
        printf("  address: (not set)\n");
    }
    
    return 0;
}

#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include "nested_optional.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

int main() {
    uint8_t buffer[256];
    size_t message_length;
    
    // --- КОДИРОВАНИЕ ---
    example_Person person = example_Person_init_zero;
    
    strncpy(person.name, "Jane Doe", sizeof(person.name) - 1);
    
    // Установка опционального вложенного сообщения
    strncpy(person.address.street, "456 Oak Ave", sizeof(person.address.street) - 1);
    strncpy(person.address.city, "Boston", sizeof(person.address.city) - 1);
    person.has_address = true;  // Важно: установите флаг has_*
    
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    if (!pb_encode(&ostream, example_Person_fields, &person)) {
        printf("Encoding failed: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Encoded %zu bytes\n", message_length);
    
    // --- ДЕКОДИРОВАНИЕ ---
    example_Person decoded = example_Person_init_zero;
    
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    if (!pb_decode(&istream, example_Person_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    printf("Decoded values:\n");
    printf("  name: %s\n", decoded.name);
    if (decoded.has_address) {
        printf("  address:\n");
        printf("    street: %s\n", decoded.address.street);
        printf("    city: %s\n", decoded.address.city);
    } else {
        printf("  address: (not set)\n");
    }
    
    return 0;
}

Ключевые моменты

Вложенные сообщения: Сообщения могут содержать другие сообщения в качестве полей
Инициализация: Используйте *_init_zero для инициализации как внешних, так и вложенных сообщений
Кодирование: Установите поля вложенного сообщения напрямую, затем закодируйте внешнее сообщение
Декодирование: Декодируйте внешнее сообщение, вложенные сообщения декодируются автоматически
Опциональные вложенные сообщения: Используйте ключевое слово optional и установите флаг has_*
Структура: Вложенные сообщения обеспечивают иерархическую организацию данных
Размеры буферов: Указывайте размеры буферов для всех строковых полей в файле .options

Когда использовать вложенные сообщения

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

Ожидаемый вывод

nested_expected_output.txt

Encoded 35 bytes
Encoded data: 0a 08 4a 6f 68 6e 20 44 6f 65 10 1e 1a 1b 0a 0b 31 32 33 20 4d 61 69 6e 20 53 74 12 08 4e 65 77 20 59 6f 72 6b 1a 03 55 53 41 
Decoded values:
  name: John Doe
  age: 30
  address:
    street: 123 Main St
    city: New York
    country: USA

Encoded 35 bytes
Encoded data: 0a 08 4a 6f 68 6e 20 44 6f 65 10 1e 1a 1b 0a 0b 31 32 33 20 4d 61 69 6e 20 53 74 12 08 4e 65 77 20 59 6f 72 6b 1a 03 55 53 41 
Decoded values:
  name: John Doe
  age: 30
  address:
    street: 123 Main St
    city: New York
    country: USA

Ожидаемый вывод (опциональное вложенное сообщение)

nested_optional_expected_output.txt

Encoded 27 bytes
Decoded values:
  name: Jane Doe
  address:
    street: 456 Oak Ave
    city: Boston

Encoded 27 bytes
Decoded values:
  name: Jane Doe
  address:
    street: 456 Oak Ave
    city: Boston

Отличия от C++

Версия на C почти идентична версии на C++, с ключевыми отличиями:

В C используется явное приведение типов для спецификаторов формата printf
Для обработки вложенных сообщений не требуются специфичные для C++ функции
Сгенерированный код идентичен для обоих языков
Управление памятью одинаково (статическое выделение в обоих случаях)