Глобальный контекст.ПолучитьБуферДвоичныхДанныхИзСтроки

Методы · GetBinaryDataBufferFromString

Преобразует строку в буфер двоичных данных.

Синтаксис

ПолучитьБуферДвоичныхДанныхИзСтроки(<Строка>, <КодировкаТекста>, <ЗаписатьBOM>)
Полное описание, параметры и ограничения

Глобальный контекст.ПолучитьБуферДвоичныхДанныхИзСтроки (Global context.GetBinaryDataBufferFromString)

Глобальный контекст (Global context)

ПолучитьБуферДвоичныхДанныхИзСтроки (GetBinaryDataBufferFromString)

Доступен, начиная с версии 8.3.10.

Синтаксис:
ПолучитьБуферДвоичныхДанныхИзСтроки(<Строка>, <КодировкаТекста>, <ЗаписатьBOM>)
Параметры:

<Строка> (обязательный)
Тип: Строка.
Строка, которую требуется преобразовать в буфер двоичных данных.

<КодировкаТекста> (необязательный)
Тип: КодировкаТекста, Строка.
Кодировка текста может быть задана как в виде значения перечисления КодировкаТекста, так и в виде строки с указанием названия кодировки.
Поддерживаемые названия кодировок:
UTF-8

UTF-16

UTF-16BE

UTF-16LE

ISO-8859-1

US-ASCII

gb18030

iso-8859-2

iso-8859-3

iso-8859-4

iso-8859-5

iso-8859-6

iso-8859-7

iso-8859-8

iso-8859-9

iso-8859-13

iso-8859-15

Shift_JIS

EUC-JP

Big5

Big5-HKSCS

GBK

GB2312

GB_2312-80

EUC-KR

KSC_5601

windows-949

windows-874

cp866

KOI8-R

KOI8-U

windows-1250

windows-1251

windows-1252

windows-1253

windows-1254

windows-1255

windows-1256

windows-1257

windows-1258

macintosh

x-mac-cyrillic

ISO-2022-JP

ISO-2022-KR

ISO-2022-CN

ISO-2022-CN-EXT

HZ-GB-2312

Значение по умолчанию: UTF8.

<ЗаписатьBOM> (необязательный)
Тип: Булево.
Определяет, будет ли добавлена метка порядка байт (BOM) кодировки текста в начало данных.
Значение по умолчанию: Ложь.
Возвращаемое значение:
Тип: БуферДвоичныхДанных.

Описание:

Преобразует строку в буфер двоичных данных.

Доступность:

Тонкий клиент, веб-клиент, мобильный клиент, сервер, толстый клиент, внешнее соединение, мобильное приложение (клиент), мобильное приложение (сервер), мобильный автономный сервер.

Использование в версии:

Доступен, начиная с версии 8.3.10.

Методическая информация

Практические примеры

Собрать пакет с версией, количеством и UTF-8 названием

Пакет имеет согласованную структуру: 1 байт версии, 2 байта количества, 4 байта длины названия, затем UTF-8. Проверяем поля до чтения тела.

Где и как запускать

Учебная база: создайте серверный общий модуль УчебныеЗадачи (флаг Сервер). Код без директив вставьте в тело процедуры ВыполнитьПример() Экспорт. Вызовите её из серверного обработчика команды учебной обработки. Не запускайте в рабочей базе.

Подготовка

  1. Серверный контекст, только память. Это учебный протокол, не формат какого-либо реального API.

  2. Название кодируется в UTF-8 без BOM; целые записываются в LittleEndian.

  3. В конструктор записи и чтения передаётся уже созданный поток: его закрываем отдельно после закрытия обоих объектов.

Название = ПолучитьБуферДвоичныхДанныхИзСтроки("Книга", КодировкаТекста.UTF8, Ложь);
Поток = Новый ПотокВПамяти;
Попытка
    Запись = Новый ЗаписьДанных(Поток, КодировкаТекста.UTF8, ПорядокБайтов.LittleEndian);
    Попытка
        Запись.ЗаписатьБайт(1);
        Запись.ЗаписатьЦелое16(3);
        Запись.ЗаписатьЦелое32(Название.Размер);
        Запись.ЗаписатьБуферДвоичныхДанных(Название);
    Исключение
        Запись.Закрыть();
        ВызватьИсключение;
    КонецПопытки;
    Запись.Закрыть();
    Сообщить(Поток.Размер());
    Поток.Перейти(0, ПозицияВПотоке.Начало);
    Чтение = Новый ЧтениеДанных(Поток, КодировкаТекста.UTF8, ПорядокБайтов.LittleEndian);
    Попытка
        Версия = Чтение.ПрочитатьБайт();
        Если Версия <> 1 Тогда
            ВызватьИсключение "Неподдерживаемая версия пакета";
        КонецЕсли;
        Количество = Чтение.ПрочитатьЦелое16();
        Длина = Чтение.ПрочитатьЦелое32();
        Если Количество = Неопределено Или Длина = Неопределено Тогда
            ВызватьИсключение "Заголовок пакета оборван";
        КонецЕсли;
        Если Длина < 0 Или Длина > 1024 Тогда
            ВызватьИсключение "Недопустимая длина названия";
        КонецЕсли;
        Результат = Чтение.Прочитать(Длина);
        Если Результат.Размер <> Длина Тогда
            ВызватьИсключение "Название получено не полностью";
        КонецЕсли;
        БуферНазвания = Результат.ПолучитьБуферДвоичныхДанных();
        Сообщить(ПолучитьСтрокуИзБуфераДвоичныхДанных(БуферНазвания, КодировкаТекста.UTF8));
        Сообщить(Количество);
        Сообщить(Результат.ПолучитьДвоичныеДанные().Размер());
    Исключение
        Чтение.Закрыть();
        ВызватьИсключение;
    КонецПопытки;
    Чтение.Закрыть();
Исключение
    Поток.Закрыть();
    ВызватьИсключение;
КонецПопытки;
Поток.Закрыть();

Разбор по шагам

  1. Записываем поля заголовка в фиксированном порядке и длину тела в байтах.

  2. Закрыть объекта записи сбрасывает её буферы, не закрывая переданный извне поток.

  3. Возвращаем позицию в начало и читаем поля в том же порядке и с тем же порядком байтов.

  4. Ограничиваем длину, проверяем фактический размер прочитанного тела и лишь затем декодируем название.

Как проверить результат

  1. Размер пакета 17 байтов: 1 + 2 + 4 + 10; результат Книга и количество 3.

  2. Замените записанную версию 1 на 2: чтение должно завершиться текстом Неподдерживаемая версия пакета.

  3. Укажите при записи длину 100 вместо фактических 10: должна сработать проверка неполного названия.

Ожидаемый результат

Пакет прочитан с проверкой версии, ограничением размера и контролем неполного тела.

На что обратить внимание

  1. Для сетевого потока частичное чтение может быть нормальным: в реальном сетевом протоколе собирайте тело циклом до нужного размера или завершения потока.

  2. Нельзя доверять длине из внешнего пакета без верхнего ограничения: иначе можно выделить чрезмерную память.

Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.

Преобразовать русское название в UTF-8 и вернуть обратно

Размер строки в символах и размер передаваемых байтов различаются. Явно выбираем UTF-8 без BOM для обмена.

Где и как запускать

Учебная база: создайте серверный общий модуль УчебныеЗадачи (флаг Сервер). Код без директив вставьте в тело процедуры ВыполнитьПример() Экспорт. Вызовите её из серверного обработчика команды учебной обработки. Не запускайте в рабочей базе.

Подготовка

  1. Выполняйте на сервере; файл не создаётся, сеть не используется.

  2. В первом запуске оставьте название Книга и параметр ЗаписатьBOM равным Ложь.

Название = "Книга";
Данные = ПолучитьДвоичныеДанныеИзСтроки(Название, КодировкаТекста.UTF8, Ложь);
Буфер = ПолучитьБуферДвоичныхДанныхИзДвоичныхДанных(Данные);
Сообщить(СтрДлина(Название));
Сообщить(Данные.Размер());
Сообщить(Буфер.Размер);
НазваниеИзДанных = ПолучитьСтрокуИзДвоичныхДанных(Данные, КодировкаТекста.UTF8);
НазваниеИзБуфера = ПолучитьСтрокуИзБуфераДвоичныхДанных(Буфер, КодировкаТекста.UTF8);
Сообщить(НазваниеИзДанных = Название);
Сообщить(НазваниеИзБуфера = Название);
ДругойБуфер = ПолучитьБуферДвоичныхДанныхИзСтроки(Название, КодировкаТекста.UTF8, Ложь);
ДругиеДанные = ПолучитьДвоичныеДанныеИзБуфераДвоичныхДанных(ДругойБуфер);
Сообщить(ДругиеДанные.Размер() = Данные.Размер());

Разбор по шагам

  1. Кодируем строку в двоичные данные с явно заданной кодировкой.

  2. Преобразуем двоичные данные в изменяемый буфер и сравниваем размеры.

  3. Декодируем данные и буфер той же кодировкой и проверяем равенство исходному названию.

  4. Повторяем путь через создание буфера прямо из строки.

Как проверить результат

  1. В названии 5 символов, в UTF-8 без BOM 10 байтов.

  2. Оба обратных преобразования возвращают Книга; все сравнения равны Истина.

Ожидаемый результат

Название восстановлено без потери русских букв; различие байтов и символов показано явно.

На что обратить внимание

  1. Передавая длину в сетевой протокол, уточните, требуются байты или символы: СтрДлина не заменяет размер UTF-8.

  2. Декодирование другой кодировкой может дать испорченный текст. BOM добавляйте только если его ждёт принимающая сторона.

Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.

Не хотите разбираться сами?

Адаптируем это решение под вашу базу. Оценка бесплатно.

Оставить задачу

1С, 1С:Предприятие — товарные знаки ООО «1С». Сайт не является официальным представительством фирмы «1С» и не аффилирован с ней.