NanoPB: Jak pracovat s opakovanými poli (pole) v C

Viz také: Verze v C++: Jak pracovat s opakovanými poli/poli v C++

NanoPB je implementace Protocol Buffers optimalizovaná na velikost kódu pro vestavěné systémy. Tento příspěvek ukazuje, jak pracovat s opakovanými poli (pole) v C s NanoPB.

Definice Proto

Nejprve vytvořte soubor .proto s opakovanými poli:

repeated.proto

syntax = "proto3";

package example;

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

Generování NanoPB kódu

Vygenerujte NanoPB kód se souborem .options pro určení velikostí polí:

Vytvořte repeated.options:

repeated.options

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

Poté vygenerujte:

generate_nanopb_repeated.sh

protoc --nanopb_out=. repeated.proto

Tím se vygenerují repeated.pb.h a repeated.pb.c.

Příklad v C s poli pevné velikosti

Zde je kompletní příklad v C používající pole pevné velikosti:

repeated_example.c

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

int main() {
    // Buffer pro kódovanou zprávu
    uint8_t buffer[256];
    size_t message_length;
    
    // --- KÓDOVÁNÍ ---
    example_RepeatedMessage message = example_RepeatedMessage_init_zero;
    
    // Nastavení hodnot opakovaných polí
    message.values[0] = 10;
    message.values[1] = 20;
    message.values[2] = 30;
    message.values_count = 3;  // Důležité: nastavit počet
    
    message.temperatures[0] = 20.5f;
    message.temperatures[1] = 21.0f;
    message.temperatures[2] = 21.5f;
    message.temperatures_count = 3;  // Důležité: nastavit počet
    
    // Vytvoření streamu pro kódování
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Kódování zprávy
    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);
    
    // Výpis hex dumpu kódovaných dat
    printf("Encoded data: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- DEKÓDOVÁNÍ ---
    example_RepeatedMessage decoded = example_RepeatedMessage_init_zero;
    
    // Vytvoření streamu pro dekódování
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Dekódování zprávy
    if (!pb_decode(&istream, example_RepeatedMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Výpis dekódovaných hodnot
    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;
}

Příkaz pro kompilaci

Zkompilujte příklad s nanopb. NanoPB se typicky používá tak, že se zdrojové soubory přímo vloží do vašeho projektu:

compile_repeated_example.sh

gcc -o repeated_example repeated_example.c repeated.pb.c pb_common.c pb_encode.c pb_decode.c -I.

Poznámka: Zdrojové soubory NanoPB (pb_common.c, pb_encode.c, pb_decode.c) je třeba kompilovat přímo s vaším projektem. Můžete je získat z NanoPB GitHub repozitáře.

Testovací skript v Pythonu

Pro ověření kódování můžete použít knihovnu protobuf v Pythonu:

test_repeated.py

import repeated_pb2

# Načtení binárních dat
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Dekódování
msg = repeated_pb2.RepeatedMessage()
msg.ParseFromString(data)

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

Nejprve zkompilujte definice protobuf pro Python:

compile_python_repeated.sh

protoc --python_out=. repeated.proto

Poté upravte příklad v C tak, aby ukládal kódovaná data do souboru:

save_encoded_repeated.c

// Po kódování přidejte toto:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

Alternativa: Opakovaná pole založená na callbackech

Pro dynamické zpracování polí můžete použít callbacky. Vytvořte repeated_callback.options:

repeated_callback.options

# Použití callbacku pro dynamická pole
msg.RepeatedMessage.values callback
msg.RepeatedMessage.temperatures callback

Poté znovu vygenerujte a použijte tento přístup:

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 kodéru pro pole 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 dekodéru pro pole 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;
    
    // Změna velikosti podle potřeby
    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 kodéru pro pole 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;
        
        // Kódování float jako 4 bajty
        union { float f; uint32_t u; } u;
        u.f = arr->data[i];
        if (!pb_encode_varint(stream, u.u))
            return false;
    }
    
    return true;
}

// Callback dekodéru pro pole 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;
    
    // Změna velikosti podle potřeby
    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};
    
    // --- KÓDOVÁNÍ ---
    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);
    
    // --- DEKÓDOVÁNÍ ---
    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");
    
    // Uvolnění alokované paměti
    free(decoded_values.data);
    free(decoded_temperatures.data);
    
    return 0;
}

Klíčové body

Pole pevné velikosti: Použijte max_count v souboru .options pro jednoduchou statickou alokaci
Založené na callbackech: Použijte callback v .options pro dynamické zpracování polí
Pevná velikost: Nastavte pole *_count pro určení počtu prvků
Založené na callbackech: Implementujte callbacky pro kódování/dekódování s ruční správou paměti
Pole jsou kódována jako opakované značky polí s hodnotami
Použijte malloc/realloc/free v C pro dynamické zpracování polí
Vždy kontrolujte počty prvků pro prevenci přetečení
Nezapomeňte uvolnit alokovanou paměť v přístupu založeném na callbackech

Kdy použít který přístup

Pole pevné velikosti: Pokud znáte maximální velikost pole a chcete jednoduchý kód
Založené na callbackech: Pokud je velikost pole proměnlivá nebo potřebujete dynamickou alokaci paměti

Očekávaný výstup

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 

Rozdíly oproti C++

Verze v C je téměř identická s verzí v C++, s klíčovými rozdíly:

Použijte malloc/realloc/free místo std::vector pro dynamická pole
Vyžadována ruční správa paměti (žádné destruktory)
Použijte strukturu pro obal dynamického pole místo std::vector
Nezapomeňte uvolnit alokovanou paměť po použití
Žádná automatická správa paměti v C