NanoPB: Umgang mit String-Typen in C
Siehe auch: C++-Version: Umgang mit String-Typen in C++
NanoPB ist eine codegrößenoptimierte Protocol-Buffers-Implementierung für Embedded-Systeme. Dieser Beitrag zeigt, wie man mit String-Typen in C mit NanoPB umgeht.
Proto-Definition
Erstellen Sie zunächst eine .proto-Datei mit String-Feldern:
syntax = "proto3";
package example;
message StringMessage {
string name = 1;
string description = 2;
}NanoPB-Code generieren
Generieren Sie den NanoPB-Code mit einer .options-Datei, um die String-Puffergrößen festzulegen:
Erstellen Sie strings.options:
example.StringMessage.name max_size:64
example.StringMessage.description max_size:256Dann generieren:
protoc --nanopb_out=. strings.protoDies generiert strings.pb.h und strings.pb.c.
C-Beispiel mit Puffern fester Größe
Hier ist ein vollständiges C-Beispiel mit Puffern fester Größe:
#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include "strings.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"
int main() {
// Buffer for encoded message
uint8_t buffer[256];
size_t message_length;
// --- ENCODING ---
example_StringMessage message = example_StringMessage_init_zero;
// Set string values (must fit in buffer size)
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);
// Create stream for encoding
pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
// Encode the message
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);
// Print hex dump of encoded data
printf("Encoded data: ");
for (size_t i = 0; i < message_length; i++) {
printf("%02x ", buffer[i]);
}
printf("\n");
// --- DECODING ---
example_StringMessage decoded = example_StringMessage_init_zero;
// Create stream for decoding
pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
// Decode the message
if (!pb_decode(&istream, example_StringMessage_fields, &decoded)) {
printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
return 1;
}
// Print decoded values
printf("Decoded values:\n");
printf(" name: %s\n", decoded.name);
printf(" description: %s\n", decoded.description);
return 0;
}Kompilierbefehl
Kompilieren Sie das Beispiel mit nanopb. NanoPB wird typischerweise verwendet, indem die Quelldateien direkt in Ihr Projekt eingebunden werden:
gcc -o strings_example strings_example.c strings.pb.c pb_common.c pb_encode.c pb_decode.c -I.Hinweis: NanoPB-Quelldateien (pb_common.c, pb_encode.c, pb_decode.c) müssen direkt mit Ihrem Projekt kompiliert werden. Sie erhalten diese aus dem NanoPB GitHub-Repository.
Python-Testskript
Um die Kodierung zu überprüfen, können Sie die Python-Protobuf-Bibliothek verwenden:
import strings_pb2
# Read the binary data
with open('encoded.bin', 'rb') as f:
data = f.read()
# Decode
msg = strings_pb2.StringMessage()
msg.ParseFromString(data)
print("Python decoded values:")
print(f" name: {msg.name}")
print(f" description: {msg.description}")Kompilieren Sie zunächst die Python-Protobuf-Definitionen:
protoc --python_out=. strings.protoModifizieren Sie dann das C-Beispiel, um die kodierten Daten in eine Datei zu speichern:
// After encoding, add this:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);Alternative: Callback-basierte Strings
Für dynamische String-Verarbeitung können Sie Callbacks verwenden. Erstellen Sie strings_callback.options:
# Use callback for dynamic strings
msg.StringMessage.name callback
msg.StringMessage.description callbackGenerieren Sie dann neu und verwenden Sie diesen Ansatz:
#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;
// Encoder callback for strings
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);
}
// Decoder callback for strings
bool string_decode_callback(pb_istream_t *stream, const pb_field_t *field, void **arg) {
dynamic_string_t* str = (dynamic_string_t*)*arg;
// Allocate buffer
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-terminate
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};
// --- ENCODING ---
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);
// --- DECODING ---
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);
// Free allocated memory
free(decoded_name.data);
free(decoded_description.data);
return 0;
}Wichtige Punkte
- Puffer fester Größe: Verwenden Sie
max_sizein der .options-Datei für einfache, statische Speicherzuweisung - Callback-basiert: Verwenden Sie
callbackin .options für dynamische String-Verarbeitung - Feste Größe: Verwenden Sie
strncpyzum Kopieren von Strings, stellen Sie Null-Terminierung sicher - Callback-basiert: Implementieren Sie Encode/Decode-Callbacks mit manueller Speicherverwaltung
- Überprüfen Sie immer Puffergrößen, um Überläufe zu verhindern
- Denken Sie daran, zugewiesenen Speicher im Callback-basierten Ansatz freizugeben
- C erfordert manuelle Speicherverwaltung (malloc/free) für dynamische Strings
Wann welcher Ansatz verwendet werden sollte
- Puffer fester Größe: Wenn Sie maximale String-Größen kennen und einfachen Code wünschen
- Callback-basiert: Wenn String-Größen variabel sind oder Sie dynamische Speicherzuweisung benötigen
Erwartete Ausgabe
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 systemsUnterschiede zu C++
Die C-Version ist nahezu identisch mit der C++-Version, mit folgenden Hauptunterschieden:
- Verwenden Sie
malloc/freestattnew/deletefür dynamischen Speicher - Manuelle Speicherverwaltung erforderlich (keine Destruktoren)
- Verwenden Sie struct als Wrapper für dynamische Strings statt std::string
- Denken Sie daran, Strings bei Bedarf manuell zu null-terminieren
Weitere NanoPB-Beiträge
- Basic scalar types in C++
- Basic scalar types in C
- String types in C++
- Bytes types in C++
- Bytes types in C
- Optional fields in C++
- Optional fields in C
- Repeated fields/arrays in C++
- Repeated fields/arrays in C
- Enums in C++
- Enums in C
- Nested messages in C++
- Nested messages in C
- Oneof/union types in C++
- Oneof/union types in C
- Custom array converters in C++
- Custom array converters in C