TechOverflow Logo
TechOverflow
English Deutsch Français 简体中文 Español Українська Čeština Português Русский

NanoPB: Как обрабатывать повторяющиеся поля (массивы) в C

Uli Köhler 10 min read

Смотрите также: Версия для C++: Как обрабатывать повторяющиеся поля/массивы в C++

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

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

Сначала создайте файл .proto с повторяющимися полями:

repeated.proto
syntax = "proto3";

package example;

message RepeatedMessage {
  repeated uint32 values = 1;
  repeated float temperatures = 2;
}

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

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

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

repeated.options
example.RepeatedMessage.values max_count:20
example.RepeatedMessage.temperatures max_count:10

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

generate_nanopb_repeated.sh
protoc --nanopb_out=. repeated.proto

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

Пример на C с массивами фиксированного размера

Вот полный пример на C с использованием массивов фиксированного размера:

repeated_example.c
#include <stdio.h>
#include <stdint.h>
#include "repeated.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

int main() {
    // Буфер для закодированного сообщения
    uint8_t buffer[256];
    size_t message_length;
    
    // --- КОДИРОВАНИЕ ---
    example_RepeatedMessage message = example_RepeatedMessage_init_zero;
    
    // Установка значений повторяющегося поля
    message.values[0] = 10;
    message.values[1] = 20;
    message.values[2] = 30;
    message.values_count = 3;  // Важно: установить количество
    
    message.temperatures[0] = 20.5f;
    message.temperatures[1] = 21.0f;
    message.temperatures[2] = 21.5f;
    message.temperatures_count = 3;  // Важно: установить количество
    
    // Создание потока для кодирования
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Кодирование сообщения
    if (!pb_encode(&ostream, example_RepeatedMessage_fields, &message)) {
        printf("Encoding failed: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Encoded %zu bytes\n", message_length);
    
    // Вывод шестнадцатеричного дампа закодированных данных
    printf("Encoded data: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- ДЕКОДИРОВАНИЕ ---
    example_RepeatedMessage decoded = example_RepeatedMessage_init_zero;
    
    // Создание потока для декодирования
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Декодирование сообщения
    if (!pb_decode(&istream, example_RepeatedMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Вывод декодированных значений
    printf("Decoded values:\n");
    printf("  values (%zu items): ", decoded.values_count);
    for (size_t i = 0; i < decoded.values_count; i++) {
        printf("%u ", (unsigned int)decoded.values[i]);
    }
    printf("\n");
    
    printf("  temperatures (%zu items): ", decoded.temperatures_count);
    for (size_t i = 0; i < decoded.temperatures_count; i++) {
        printf("%.1f ", decoded.temperatures[i]);
    }
    printf("\n");
    
    return 0;
}

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

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

compile_repeated_example.sh
gcc -o repeated_example repeated_example.c repeated.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_repeated.py
import repeated_pb2

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

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

print("Python decoded values:")
print(f"  values: {list(msg.values)}")
print(f"  temperatures: {list(msg.temperatures)}")

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

compile_python_repeated.sh
protoc --python_out=. repeated.proto

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

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

Альтернатива: Повторяющиеся поля на основе callback-функций

Для динамической обработки массивов вы можете использовать callback-функции. Создайте repeated_callback.options:

repeated_callback.options
# Использовать callback для динамических массивов
msg.RepeatedMessage.values callback
msg.RepeatedMessage.temperatures callback

Затем перегенерируйте и используйте этот подход:

repeated_callback_example.c
#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include "repeated.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"

typedef struct {
    uint32_t* data;
    size_t size;
    size_t capacity;
} dynamic_uint32_array_t;

typedef struct {
    float* data;
    size_t size;
    size_t capacity;
} dynamic_float_array_t;

// Callback-функция кодирования для массива uint32
bool uint32_array_encode_callback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) {
    const dynamic_uint32_array_t* arr = (const dynamic_uint32_array_t*)*arg;
    
    for (size_t i = 0; i < arr->size; i++) {
        if (!pb_encode_tag_for_field(stream, field))
            return false;
        
        if (!pb_encode_varint(stream, arr->data[i]))
            return false;
    }
    
    return true;
}

// Callback-функция декодирования для массива uint32
bool uint32_array_decode_callback(pb_istream_t *stream, const pb_field_t *field, void **arg) {
    dynamic_uint32_array_t* arr = (dynamic_uint32_array_t*)*arg;
    
    uint64_t value;
    if (!pb_decode_varint(stream, &value))
        return false;
    
    // Изменение размера при необходимости
    if (arr->size >= arr->capacity) {
        size_t new_capacity = arr->capacity == 0 ? 4 : arr->capacity * 2;
        uint32_t* new_data = (uint32_t*)realloc(arr->data, new_capacity * sizeof(uint32_t));
        if (!new_data)
            return false;
        
        arr->data = new_data;
        arr->capacity = new_capacity;
    }
    
    arr->data[arr->size++] = (uint32_t)value;
    return true;
}

// Callback-функция кодирования для массива float
bool float_array_encode_callback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) {
    const dynamic_float_array_t* arr = (const dynamic_float_array_t*)*arg;
    
    for (size_t i = 0; i < arr->size; i++) {
        if (!pb_encode_tag_for_field(stream, field))
            return false;
        
        // Кодирование float как 4 байт
        union { float f; uint32_t u; } u;
        u.f = arr->data[i];
        if (!pb_encode_varint(stream, u.u))
            return false;
    }
    
    return true;
}

// Callback-функция декодирования для массива float
bool float_array_decode_callback(pb_istream_t *stream, const pb_field_t *field, void **arg) {
    dynamic_float_array_t* arr = (dynamic_float_array_t*)*arg;
    
    uint64_t value;
    if (!pb_decode_varint(stream, &value))
        return false;
    
    // Изменение размера при необходимости
    if (arr->size >= arr->capacity) {
        size_t new_capacity = arr->capacity == 0 ? 4 : arr->capacity * 2;
        float* new_data = (float*)realloc(arr->data, new_capacity * sizeof(float));
        if (!new_data)
            return false;
        
        arr->data = new_data;
        arr->capacity = new_capacity;
    }
    
    union { float f; uint32_t u; } u;
    u.u = (uint32_t)value;
    arr->data[arr->size++] = u.f;
    return true;
}

int main() {
    uint8_t buffer[256];
    size_t message_length;
    
    uint32_t values_data[] = {10, 20, 30};
    float temperatures_data[] = {20.5f, 21.0f, 21.5f};
    
    dynamic_uint32_array_t values = {values_data, 3, 3};
    dynamic_float_array_t temperatures = {temperatures_data, 3, 3};
    
    // --- КОДИРОВАНИЕ ---
    example_RepeatedMessage message = example_RepeatedMessage_init_zero;
    
    message.values.funcs.encode = uint32_array_encode_callback;
    message.values.arg = &values;
    
    message.temperatures.funcs.encode = float_array_encode_callback;
    message.temperatures.arg = &temperatures;
    
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    if (!pb_encode(&ostream, example_RepeatedMessage_fields, &message)) {
        printf("Encoding failed: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Encoded %zu bytes\n", message_length);
    
    // --- ДЕКОДИРОВАНИЕ ---
    example_RepeatedMessage decoded = example_RepeatedMessage_init_zero;
    dynamic_uint32_array_t decoded_values = {NULL, 0, 0};
    dynamic_float_array_t decoded_temperatures = {NULL, 0, 0};
    
    decoded.values.funcs.decode = uint32_array_decode_callback;
    decoded.values.arg = &decoded_values;
    
    decoded.temperatures.funcs.decode = float_array_decode_callback;
    decoded.temperatures.arg = &decoded_temperatures;
    
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    if (!pb_decode(&istream, example_RepeatedMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    printf("Decoded values:\n");
    printf("  values (%zu items): ", decoded_values.size);
    for (size_t i = 0; i < decoded_values.size; i++) {
        printf("%u ", decoded_values.data[i]);
    }
    printf("\n");
    
    printf("  temperatures (%zu items): ", decoded_temperatures.size);
    for (size_t i = 0; i < decoded_temperatures.size; i++) {
        printf("%.1f ", decoded_temperatures.data[i]);
    }
    printf("\n");
    
    // Освобождение выделенной памяти
    free(decoded_values.data);
    free(decoded_temperatures.data);
    
    return 0;
}

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

  • Массивы фиксированного размера: Используйте max_count в файле .options для простого статического распределения
  • На основе callback-функций: Используйте callback в .options для динамической обработки массивов
  • Фиксированный размер: Установите поле *_count для указания количества элементов
  • На основе callback-функций: Реализуйте callback-функции кодирования/декодирования с ручным управлением памятью
  • Массивы кодируются как повторяющиеся теги полей со значениями
  • Используйте malloc/realloc/free в C для динамической обработки массивов
  • Всегда проверяйте количество элементов массива для предотвращения переполнения
  • Не забывайте освобождать выделенную память в подходе на основе callback-функций

Когда использовать какой подход

  • Массивы фиксированного размера: Когда вы знаете максимальный размер массива и хотите простой код
  • На основе callback-функций: Когда размер массива переменный или вам нужно динамическое выделение памяти

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

repeated_expected_output.txt
Encoded 15 bytes
Encoded data: 08 0a 08 14 08 1e 15 00 00 a4 41 15 00 00 a8 41 15 00 00 ac 41 
Decoded values:
  values (3 items): 10 20 30 
  temperatures (3 items): 20.5 21.0 21.5

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

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

  • Используйте malloc/realloc/free вместо std::vector для динамических массивов
  • Требуется ручное управление памятью (нет деструкторов)
  • Используйте структуру (struct) для обёртки динамического массива вместо std::vector
  • Не забывайте освобождать выделенную память после использования
  • В C нет автоматического управления памятью

Другие посты о NanoPB

Check out similar posts by category: Embedded C/C++ Protocol Buffers