NanoPB: Як обробляти строкові типи в C

Див. також: C++ version: How to handle string types in C++

NanoPB — це оптимізована за розміром коду реалізація Protocol Buffers для вбудованих систем. Ця публікація показує, як обробляти строкові типи в C за допомогою NanoPB.

Визначення Proto

Спочатку створіть файл .proto з строковими полями:

strings.proto
syntax = "proto3";

package example;

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

Генерація коду NanoPB

Згенеруйте код NanoPB за допомогою файлу .options, щоб указати розміри строкових буферів:

Створіть strings.options:

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

Потім згенеруйте:

generate_nanopb_strings.sh
protoc --nanopb_out=. strings.proto

Це згенерує strings.pb.h та strings.pb.c.

Приклад на C з буферами фіксованого розміру

Ось повний приклад на C з використанням буферів фіксованого розміру:

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() {
    // Буфер для закодованого повідомлення
    uint8_t buffer[256];
    size_t message_length;
    
    // --- КОДУВАННЯ ---
    example_StringMessage message = example_StringMessage_init_zero;
    
    // Встановлення строкових значень (мають вміститися в розмір буфера)
    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);
    
    // Створення потоку для кодування
    pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
    
    // Кодування повідомлення
    if (!pb_encode(&ostream, example_StringMessage_fields, &message)) {
        printf("Помилка кодування: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Закодовано %zu байтів\n", message_length);
    
    // Друк шістнадцяткового дампу закодованих даних
    printf("Закодовані дані: ");
    for (size_t i = 0; i < message_length; i++) {
        printf("%02x ", buffer[i]);
    }
    printf("\n");
    
    // --- ДЕКОДУВАННЯ ---
    example_StringMessage decoded = example_StringMessage_init_zero;
    
    // Створення потоку для декодування
    pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
    
    // Декодування повідомлення
    if (!pb_decode(&istream, example_StringMessage_fields, &decoded)) {
        printf("Помилка декодування: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    // Друк декодованих значень
    printf("Декодовані значення:\n");
    printf("  name: %s\n", decoded.name);
    printf("  description: %s\n", decoded.description);
    
    return 0;
}

Команда компіляції

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

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

Примітка: Вихідні файли NanoPB (pb_common.c, pb_encode.c, pb_decode.c) потрібно компілювати разом із вашим проєктом. Їх можна отримати з NanoPB GitHub repository.

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

Щоб перевірити кодування, ви можете використати бібліотеку protobuf для Python:

test_strings.py
import strings_pb2

# Читання двійкових даних
with open('encoded.bin', 'rb') as f:
    data = f.read()

# Декодування
msg = strings_pb2.StringMessage()
msg.ParseFromString(data)

print("Декодовані Python значення:")
print(f"  name: {msg.name}")
print(f"  description: {msg.description}")

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

compile_python_strings.sh
protoc --python_out=. strings.proto

Потім змініть приклад на C, щоб зберегти закодовані дані у файл:

save_encoded_strings.c
// Після кодування додайте це:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);

Альтернатива: Рядки на основі зворотних викликів

Для динамічної обробки рядків ви можете використовувати зворотні виклики. Створіть strings_callback.options:

strings_callback.options
# Використання зворотного виклику для динамічних рядків
msg.StringMessage.name callback
msg.StringMessage.description callback

Потім згенеруйте заново та використовуйте цей підхід:

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;

// Зворотний виклик кодувальника для рядків
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);
}

// Зворотний виклик декодера для рядків
bool string_decode_callback(pb_istream_t *stream, const pb_field_t *field, void **arg) {
    dynamic_string_t* str = (dynamic_string_t*)*arg;
    
    // Виділення буфера
    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'; // Нуль-термінування
    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};
    
    // --- КОДУВАННЯ ---
    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("Помилка кодування: %s\n", PB_GET_ERROR(&ostream));
        return 1;
    }
    
    message_length = ostream.bytes_written;
    printf("Закодовано %zu байтів\n", message_length);
    
    // --- ДЕКОДУВАННЯ ---
    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("Помилка декодування: %s\n", PB_GET_ERROR(&istream));
        return 1;
    }
    
    printf("Декодовані значення:\n");
    printf("  name: %s\n", decoded_name.data);
    printf("  description: %s\n", decoded_description.data);
    
    // Звільнення виділеної пам'яті
    free(decoded_name.data);
    free(decoded_description.data);
    
    return 0;
}

Ключові моменти

Коли використовувати який підхід

Очікуваний вивід

strings_expected_output.txt
Закодовано 38 байтів
Закодовані дані: 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 
Декодовані значення:
  name: NanoPB
  description: Protocol Buffers for embedded systems

Відмінності від C++

Версія на C майже ідентична версії на C++, з ключовими відмінностями:

More NanoPB posts


Дивіться схожі статті за категоріями: Embedded, C/C++, Protocol Buffers