NanoPB: Как работать с типами bytes в C++
Смотрите также: Версия на C: Как работать с типами bytes в C
NanoPB — это оптимизированная по размеру кода реализация Protocol Buffers для встраиваемых систем. В этом посте показано, как работать с типами bytes в C++ с помощью NanoPB.
Определение proto
Сначала создайте файл .proto с полями типа bytes:
syntax = "proto3";
package example;
message BytesMessage {
bytes data = 1;
bytes signature = 2;
}Генерация кода NanoPB
Сгенерируйте код NanoPB с помощью файла .options для указания размеров буферов bytes:
Создайте bytes.options:
example.BytesMessage.data max_size:32
example.BytesMessage.signature max_size:16Затем сгенерируйте:
protoc --nanopb_out=. bytes.protoЭто создаст bytes.pb.h и bytes.pb.c.
Пример на C++ с буферами фиксированного размера
Вот полный пример на C++ с использованием буферов фиксированного размера:
#include <stdio.h>
#include <string.h>
#include "bytes.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"
int main() {
// Буфер для закодированного сообщения
uint8_t buffer[256];
size_t message_length;
// --- КОДИРОВАНИЕ ---
example_BytesMessage message = example_BytesMessage_init_zero;
// Установка данных bytes
const uint8_t data[] = {0x01, 0x02, 0x03, 0x04, 0x05};
const uint8_t signature[] = {0xAA, 0xBB, 0xCC, 0xDD};
message.data.size = sizeof(data);
memcpy(message.data.bytes, data, sizeof(data));
message.signature.size = sizeof(signature);
memcpy(message.signature.bytes, signature, sizeof(signature));
// Создание потока для кодирования
pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
// Кодирование сообщения
if (!pb_encode(&ostream, example_BytesMessage_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_BytesMessage decoded = example_BytesMessage_init_zero;
// Создание потока для декодирования
pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
// Декодирование сообщения
if (!pb_decode(&istream, example_BytesMessage_fields, &decoded)) {
printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
return 1;
}
// Вывод декодированных значений
printf("Decoded values:\n");
printf(" data: ");
for (size_t i = 0; i < decoded.data.size; i++) {
printf("%02x ", decoded.data.bytes[i]);
}
printf("\n");
printf(" signature: ");
for (size_t i = 0; i < decoded.signature.size; i++) {
printf("%02x ", decoded.signature.bytes[i]);
}
printf("\n");
return 0;
}Команда компиляции
Скомпилируйте пример с помощью nanopb. NanoPB обычно используется путём прямого включения исходных файлов в ваш проект:
g++ -o bytes_example bytes_example.cpp bytes.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:
import bytes_pb2
# Чтение бинарных данных
with open('encoded.bin', 'rb') as f:
data = f.read()
# Декодирование
msg = bytes_pb2.BytesMessage()
msg.ParseFromString(data)
print("Python decoded values:")
print(f" data: {msg.data.hex()}")
print(f" signature: {msg.signature.hex()}")Сначала скомпилируйте определения protobuf для Python:
protoc --python_out=. bytes.protoЗатем измените пример на C++, чтобы сохранить закодированные данные в файл:
// После кодирования добавьте это:
FILE *f = fopen("encoded.bin", "wb");
fwrite(buffer, 1, message_length, f);
fclose(f);Альтернатива: bytes на основе колбэков
Для динамической обработки bytes можно использовать колбэки. Создайте bytes_callback.options:
# Использовать колбэк для динамических bytes
msg.BytesMessage.data callback
msg.BytesMessage.signature callbackЗатем перегенерируйте код и используйте этот подход:
#include <stdio.h>
#include <vector>
#include "bytes.pb.h"
#include "pb_encode.h"
#include "pb_decode.h"
// Колбэк кодировщика для bytes
bool bytes_encode_callback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) {
const std::vector<uint8_t>* data = (const std::vector<uint8_t>*)*arg;
if (!pb_encode_tag_for_field(stream, field))
return false;
return pb_encode_string(stream, data->data(), data->size());
}
// Колбэк декодировщика для bytes
bool bytes_decode_callback(pb_istream_t *stream, const pb_field_t *field, void **arg) {
std::vector<uint8_t>* data = (std::vector<uint8_t>*)*arg;
// Изменение размера вектора для хранения данных
size_t size = stream->bytes_left;
data->resize(size);
// Чтение данных в вектор
return pb_read(stream, data->data(), size);
}
int main() {
uint8_t buffer[256];
size_t message_length;
std::vector<uint8_t> data = {0x01, 0x02, 0x03, 0x04, 0x05};
std::vector<uint8_t> signature = {0xAA, 0xBB, 0xCC, 0xDD};
// --- КОДИРОВАНИЕ ---
example_BytesMessage message = example_BytesMessage_init_zero;
message.data.funcs.encode = bytes_encode_callback;
message.data.arg = &data;
message.signature.funcs.encode = bytes_encode_callback;
message.signature.arg = &signature;
pb_ostream_t ostream = pb_ostream_from_buffer(buffer, sizeof(buffer));
if (!pb_encode(&ostream, example_BytesMessage_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_BytesMessage decoded = example_BytesMessage_init_zero;
std::vector<uint8_t> decoded_data, decoded_signature;
decoded.data.funcs.decode = bytes_decode_callback;
decoded.data.arg = &decoded_data;
decoded.signature.funcs.decode = bytes_decode_callback;
decoded.signature.arg = &decoded_signature;
pb_istream_t istream = pb_istream_from_buffer(buffer, message_length);
if (!pb_decode(&istream, example_BytesMessage_fields, &decoded)) {
printf("Decoding failed: %s\n", PB_GET_ERROR(&istream));
return 1;
}
printf("Decoded values:\n");
printf(" data: ");
for (uint8_t byte : decoded_data) {
printf("%02x ", byte);
}
printf("\n");
printf(" signature: ");
for (uint8_t byte : decoded_signature) {
printf("%02x ", byte);
}
printf("\n");
return 0;
}Ключевые моменты
- Буферы фиксированного размера: Используйте
max_sizeв файле .options для простого статического выделения памяти - На основе колбэков: Используйте
callbackв .options для динамической обработки bytes - Фиксированный размер: Установите поле
*_sizeи используйтеmemcpyдля копирования bytes - На основе колбэков: Реализуйте колбэки кодирования/декодирования для динамического выделения памяти
- Bytes похожи на строки, но содержат сырые бинарные данные (без нуль-терминатора)
- Используйте
std::vector<uint8_t>в C++ для динамической обработки bytes - Всегда проверяйте размеры буферов для предотвращения переполнения
Когда использовать какой подход
- Буферы фиксированного размера: Когда вы знаете максимальный размер bytes и хотите простой код
- На основе колбэков: Когда размер bytes переменный или вам нужно динамическое выделение памяти
Ожидаемый вывод
Encoded 14 bytes
Encoded data: 0a 05 01 02 03 04 05 12 04 aa bb cc dd
Decoded values:
data: 01 02 03 04 05
signature: aa bb cc dd Сценарии использования bytes
- Бинарные данные (изображения, аудио и т. д.)
- Криптографические подписи
- Сырые данные датчиков
- Пользовательские бинарные протоколы
- Любые данные, которые не должны интерпретироваться как текст
Другие посты о NanoPB
- Базовые скалярные типы в C++
- Базовые скалярные типы в C
- Типы string в C++
- Типы string в C
- Типы bytes в C
- Опциональные поля в C++
- Опциональные поля в C
- Повторяющиеся поля/массивы в C++
- Повторяющиеся поля/массивы в C
- Перечисления в C++
- Перечисления в C
- Вложенные сообщения в C++
- Вложенные сообщения в C
- Типы oneof/union в C++
- Типы oneof/union в C
- Пользовательские конвертеры массивов в C++
- Пользовательские конвертеры массивов в C