NanoPB: Jak pracovat s řetězcovými typy v C

Viz také: Verze pro C++: Jak pracovat s řetězcovými typy 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 řetězcovými typy v C s NanoPB.

Definice Proto

Nejprve vytvořte soubor .proto s řetězcovými poli:

strings.proto

syntax = "proto3";

package example;

message StringMessage {
  string name = 1;
  string description = 2;
}

syntax = "proto3";

package example;

message StringMessage {
  string name = 1;
  string description = 2;
}

Generování NanoPB kódu

Vygenerujte kód NanoPB se souborem .options pro určení velikostí bufferu pro řetězce:

Vytvořte strings.options:

strings.options

example.StringMessage.name max_size:64
example.StringMessage.description max_size:256

example.StringMessage.name max_size:64
example.StringMessage.description max_size:256

Poté vygenerujte:

generate_nanopb_strings.sh

protoc --nanopb_out=. strings.proto

protoc --nanopb_out=. strings.proto

Tím se vygenerují soubory strings.pb.h a strings.pb.c.

Příklad v C s buffery pevné velikosti

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

strings_example.c

#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include "strings.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_StringMessage message = example_StringMessage_init_zero;
    
    // Nastavení řetězcových hodnot (musí se vejít do velikosti bufferu)
    const char* name = "NanoPB";
    const char* description = "Protocol Buffers for embedded systems";
    
    strncpy(message.name, name, sizeof(message.name) - 1);
    strncpy(message.description, description, sizeof(message.description) - 1);
    
    // 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_StringMessage_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_StringMessage decoded = example_StringMessage_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_StringMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Výpis dekódovaných hodnot
    printf("Decoded values:\n");
    printf("  name: %s\n", decoded.name);
    printf("  description: %s\n", decoded.description);
    
    return 0;
}

#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include "strings.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_StringMessage message = example_StringMessage_init_zero;
    
    // Nastavení řetězcových hodnot (musí se vejít do velikosti bufferu)
    const char* name = "NanoPB";
    const char* description = "Protocol Buffers for embedded systems";
    
    strncpy(message.name, name, sizeof(message.name) - 1);
    strncpy(message.description, description, sizeof(message.description) - 1);
    
    // 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_StringMessage_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_StringMessage decoded = example_StringMessage_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_StringMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Výpis dekódovaných hodnot
    printf("Decoded values:\n");
    printf("  name: %s\n", decoded.name);
    printf("  description: %s\n", decoded.description);
    
    return 0;
}

Příkaz pro kompilaci

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

compile_strings_example.sh

gcc -o strings_example strings_example.c strings.pb.c pb_common.c pb_encode.c pb_decode.c -I.

gcc -o strings_example strings_example.c strings.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_strings.py

import strings_pb2

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

# Dekódování
msg = strings_pb2.StringMessage()
msg.ParseFromString(data)

print("Python decoded values:")
print(f"  name: {msg.name}")
print(f"  description: {msg.description}")

import strings_pb2

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

# Dekódování
msg = strings_pb2.StringMessage()
msg.ParseFromString(data)

print("Python decoded values:")
print(f"  name: {msg.name}")
print(f"  description: {msg.description}")

Nejprve zkompilujte definice protobuf pro Python:

compile_python_strings.sh

protoc --python_out=. strings.proto

protoc --python_out=. strings.proto

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

save_encoded_strings.c

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

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

Alternativa: Řetězce založené na callbackech

Pro dynamické zpracování řetězců můžete použít callbacky. Vytvořte strings_callback.options:

strings_callback.options

# Použít callback pro dynamické řetězce
msg.StringMessage.name callback
msg.StringMessage.description callback

# Použít callback pro dynamické řetězce
msg.StringMessage.name callback
msg.StringMessage.description callback

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

strings_callback_example.c

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

typedef struct {
    char* data;
    size_t size;
} dynamic_string_t;

// Callback kodéru pro řetězce
bool string_encode_callback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) {
    const dynamic_string_t* str = (const dynamic_string_t*)*arg;
    
    if (!pb_encode_tag_for_field(stream, field))
        return false;
    
    return pb_encode_string(stream, (const pb_byte_t*)str->data, str->size);
}

// Callback dekodéru pro řetězce
bool string_decode_callback(pb_istream_t *stream, const pb_field_t *field, void **arg) {
    dynamic_string_t* str = (dynamic_string_t*)*arg;
    
    // Alokace bufferu
    size_t size = stream->bytes_left;
    str->data = (char*)malloc(size + 1);
    
    if (!pb_read(stream, (pb_byte_t*)str->data, size)) {
        free(str->data);
        str->data = NULL;
        return false;
    }
    
    str->data[size] = '\0'; // Null-terminace
    str->size = size;
    return true;
}

int main() {
    uint8_t buffer[256];
    size_t message_length;
    
    dynamic_string_t name = {"NanoPB", 6};
    dynamic_string_t description = {"Protocol Buffers for embedded systems", 38};
    
    // --- KÓDOVÁNÍ ---
    example_StringMessage message = example_StringMessage_init_zero;
    
    message.name.funcs.encode = string_encode_callback;
    message.name.arg = &name;
    message.description.funcs.encode = string_encode_callback;
    message.description.arg = &description;
    
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    if (!pb_encode(&ostream, example_StringMessage_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_StringMessage decoded = example_StringMessage_init_zero;
    dynamic_string_t decoded_name = {NULL, 0};
    dynamic_string_t decoded_description = {NULL, 0};
    
    decoded.name.funcs.decode = string_decode_callback;
    decoded.name.arg = &decoded_name;
    decoded.description.funcs.decode = string_decode_callback;
    decoded.description.arg = &decoded_description;
    
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    if (!pb_decode(&istream, example_StringMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    printf("Decoded values:\n");
    printf("  name: %s\n", decoded_name.data);
    printf("  description: %s\n", decoded_description.data);
    
    // Uvolnění alokované paměti
    free(decoded_name.data);
    free(decoded_description.data);
    
    return 0;
}

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

typedef struct {
    char* data;
    size_t size;
} dynamic_string_t;

// Callback kodéru pro řetězce
bool string_encode_callback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) {
    const dynamic_string_t* str = (const dynamic_string_t*)*arg;
    
    if (!pb_encode_tag_for_field(stream, field))
        return false;
    
    return pb_encode_string(stream, (const pb_byte_t*)str->data, str->size);
}

// Callback dekodéru pro řetězce
bool string_decode_callback(pb_istream_t *stream, const pb_field_t *field, void **arg) {
    dynamic_string_t* str = (dynamic_string_t*)*arg;
    
    // Alokace bufferu
    size_t size = stream->bytes_left;
    str->data = (char*)malloc(size + 1);
    
    if (!pb_read(stream, (pb_byte_t*)str->data, size)) {
        free(str->data);
        str->data = NULL;
        return false;
    }
    
    str->data[size] = '\0'; // Null-terminace
    str->size = size;
    return true;
}

int main() {
    uint8_t buffer[256];
    size_t message_length;
    
    dynamic_string_t name = {"NanoPB", 6};
    dynamic_string_t description = {"Protocol Buffers for embedded systems", 38};
    
    // --- KÓDOVÁNÍ ---
    example_StringMessage message = example_StringMessage_init_zero;
    
    message.name.funcs.encode = string_encode_callback;
    message.name.arg = &name;
    message.description.funcs.encode = string_encode_callback;
    message.description.arg = &description;
    
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    if (!pb_encode(&ostream, example_StringMessage_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_StringMessage decoded = example_StringMessage_init_zero;
    dynamic_string_t decoded_name = {NULL, 0};
    dynamic_string_t decoded_description = {NULL, 0};
    
    decoded.name.funcs.decode = string_decode_callback;
    decoded.name.arg = &decoded_name;
    decoded.description.funcs.decode = string_decode_callback;
    decoded.description.arg = &decoded_description;
    
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    if (!pb_decode(&istream, example_StringMessage_fields, &decoded)) {
        printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    printf("Decoded values:\n");
    printf("  name: %s\n", decoded_name.data);
    printf("  description: %s\n", decoded_description.data);
    
    // Uvolnění alokované paměti
    free(decoded_name.data);
    free(decoded_description.data);
    
    return 0;
}

Klíčové body

Buffery pevné velikosti: Použijte max_size v souboru .options pro jednoduchou statickou alokaci
Založené na callbackech: Použijte callback v souboru .options pro dynamické zpracování řetězců
Pevná velikost: Použijte strncpy pro kopírování řetězců, zajistěte null-terminaci
Založené na callbackech: Implementujte callbacky pro kódování/dekódování s ruční správou paměti
Vždy kontrolujte velikosti bufferů, abyste předešli přetečení
Nezapomeňte uvolnit alokovanou paměť v přístupu založeném na callbackech
C vyžaduje ruční správu paměti (malloc/free) pro dynamické řetězce

Kdy použít který přístup

Buffery pevné velikosti: Pokud znáte maximální velikosti řetězců a chcete jednoduchý kód
Založené na callbackech: Pokud jsou velikosti řetězců proměnlivé nebo potřebujete dynamickou alokaci paměti

Očekávaný výstup

strings_expected_output.txt

Encoded 38 bytes
Encoded data: 0a 06 4e 61 6e 6f 50 42 12 1e 50 72 6f 74 6f 63 6f 6c 20 42 75 66 66 65 72 73 20 66 6f 72 20 65 6d 62 65 64 64 65 64 20 73 79 73 74 65 6d 73 
Decoded values:
  name: NanoPB
  description: Protocol Buffers for embedded systems

Encoded 38 bytes
Encoded data: 0a 06 4e 61 6e 6f 50 42 12 1e 50 72 6f 74 6f 63 6f 6c 20 42 75 66 66 65 72 73 20 66 6f 72 20 65 6d 62 65 64 64 65 64 20 73 79 73 74 65 6d 73 
Decoded values:
  name: NanoPB
  description: Protocol Buffers for embedded systems

Rozdíly oproti C++

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

Použijte malloc/free místo new/delete pro dynamickou paměť
Vyžadována ruční správa paměti (žádné destruktory)
Použijte strukturu pro obal dynamického řetězce místo std::string
Nezapomeňte ručně null-terminovat řetězce, když je to potřeba

Další příspěvky o NanoPB

Podívejte se na podobné články podle kategorie: Embedded, C/C++, Protocol Buffers

Pokud vám tento článek pomohl, zvažte, zda mi nekoupíte kávu nebo nepřispějete přes PayPal na podporu výzkumu a publikování nových článků na TechOverflow

Buy me a coffee