WebSocket Клиент / Сервер. Внешний компонент

Реализация протокола WebSocket. Клиентская часть для взаимодействия с внешними сервисами. Серверная часть для организации собственного сервера, принимающего клиентские соединения в многопоточном режиме.
Возможно взаимодействие RabbitMQ Slack Asterisk и другие

Актуальная документация здесь 1c-websocket.readthedocs.io

WebSocket — протокол связи поверх TCP-соединения, предназначенный для обмена сообщениями между приложениями в режиме реального времени.

Основной смысл протокола — держать постоянное соединение между сервером и клиентом для обмена данными.

Данная разработка содержит в себе как Клиент так и Сервер websocket.

Для реализации сервера можно использовать такой алгоритм:

Регламентное задание с расписанием повторять каждую 1 секунду запускается на сервере, прослушивает порт и принимает соединения.

Если обработка входящих сообщений занимает продолжительное время — запускаем фоновое задание обработки и с ИД клиента. Затем возвращаем результат клиенту, если это требуется.

Позволяет подключаться и принимать подключения в роли сервера как в режиме без шифровки (ws://), так и используя протокол шифрования (wss://) (сертификат .pem (для примера в приложении))

RabbitMQ

Пример SLACK

 // Пример SLACK
Процедура SlackBot()

ПутьККомпоненте = "c:/websocket.dll";
ИДКанала = "C23535436TR";
ТокенСлак = "xora-3234234324....";

Заголовки = Новый Соответствие;
Заголовки.Вставить("Authorization", "Bearer " + ТокенСлак);

Запрос = Новый HTTPЗапрос("api/rtm.connect", Заголовки);

Соединение = Новый HTTPСоединение("slack.com",,,,,, Новый ЗащищенноеСоединениеOpenSSL);

Ответ = Соединение.Получить(Запрос);

Если НЕ Ответ.КодСостояния = 200 Тогда
ВызватьИсключение "Не верный ответ";
КонецЕсли;

Данные =  ПолучитьЗначениеИзОтветаJSON(Ответ.ПолучитьТелоКакСтроку());

урл = Данные.Получить("url");

Если НЕ ЗначениеЗаполнено(урл) Тогда
ВызватьИсключение "Нет адреса подключения";
КонецЕсли;

Если НЕ ПодключитьВнешнююКомпоненту(ПутьККомпоненте, "WebSocket", ТипВнешнейКомпоненты.Native) Тогда
СисИнфо = Новый СистемнаяИнформация;
ОписаниеОшибки = НСтр("ru='Ошибка подключения компоненты ('") + СисИнфо.ТипПлатформы + "):
|" + ОписаниеОшибки();

ВызватьИсключение ОписаниеОшибки;
КонецЕсли;

Клиент = Новый("AddIn.WebSocket.Client");

ТекстСообщения = ПолучитьСтрокуJSON(Новый Структура("type, channel, text", "message", ИДКанала, "Listen for 1C Enterprise"));

Попытка
Клиент.Подключиться(урл);
Исключение

Описание = ОписаниеОшибки();
ТекстОшибки =  Клиент.ОписаниеОшибки();

ТекстОписания = Описание + ": " + ТекстОшибки;

ВызватьИсключение ТекстОписания;

КонецПопытки;

Данные = "";

ГотовПринимать = Ложь;

Пока Клиент.Принять(0, Данные) Цикл

Значение = ПолучитьЗначениеИзОтветаJSON(Данные);

Текст = Значение.Получить("text");

Если Значение.Получить("type") = "hello" Тогда
Клиент.Отправить(ТекстСообщения);
ГотовПринимать = Истина;
КонецЕсли;

Если Текст = Неопределено ИЛИ НЕ Значение.Получить("reply_to") = Неопределено ИЛИ НЕ ГотовПринимать Тогда
Продолжить;
КонецЕсли;

Если НРег(Текст) = НРег("go away!") ИЛИ НРег(Текст) = НРег("11") Тогда

ТекстСообщения = ПолучитьСтрокуJSON(Новый Структура("type, channel, text", "message", ИДКанала, "ok. bye-bye )))"));
Клиент.Отправить(ТекстСообщения);

Сообщить("Меня отключили");
Прервать;

КонецЕсли;

Сообщить(Текст);

ТекстСообщения = ПолучитьСтрокуJSON(Новый Структура("type, channel, text", "message", ИДКанала, "Получил: "+ Текст));
Клиент.Отправить(ТекстСообщения);

КонецЦикла;

Клиент.Отключиться();

//Клиент = Неопределено;


КонецПроцедуры


Функция ПолучитьЗначениеИзОтветаJSON(ТекстJSON) Экспорт

ЧтениеJSON      = Новый ЧтениеJSON;

ЧтениеJSON.УстановитьСтроку(ТекстJSON);

Значение        = ПрочитатьJSON(ЧтениеJSON, Истина);

Возврат Значение;

КонецФункции

Функция ПолучитьСтрокуJSON(Значение) Экспорт

ЗаписьJSON = Новый ЗаписьJSON;
ЗаписьJSON.УстановитьСтроку();
ЗаписатьJSON(ЗаписьJSON, Значение);

Возврат ЗаписьJSON.Закрыть();

КонецФункции

Собрать в архив файлы компонента поможет обработка

По теме:

Тестировалось на платформе 8.3.11.

30 Comments

informa1555 16.11.2018 at 15:00

А чего так мало описания? Я правильно понял что для того чтобы 1Ска приняла сообщение на своей стороне , она должна постоянно по расписанию опрашивать порт т.е. обращаться к компоненте чтобы она это сделала?

Reply ↓
nomadon 16.11.2018 at 15:05

(1) решил не набивать статью примерами или кейсами, а дополнять по вопросам для оценки интересности данных технологий, а по интерфейсу взаимодействия ссылка вначале.

да, конечно, для того что бы принять соединение необходимо постоянно слушать порт. Как вариант, можно подвесить на регламентное задание которое будет постоянно висеть и перезапускаться в случае падения.

Reply ↓
dyas 17.02.2019 at 18:22

(2) (2) (1)

Reply ↓
dyas 19.02.2019 at 02:34

Вопрос. Можно ли принимать/отправлять фалы с сервера на клиент и наоборот. Если да то какого максимального размера ?

Reply ↓
nomadon 19.02.2019 at 06:04

(4) можно двоичные данные кодировать в base64 и передавать как строку, максимальный размер не тестировался, думаю зависит от архитектуры и памями клиента и сервера

Reply ↓
Masich 14.03.2019 at 14:17

Добрый день.

А как сделать для клиента ожидание сообщения от сервера в фоновом режиме?

Я вижу, что во «ВнешнееСобытие» компонента не сообщает.

Reply ↓
nomadon 14.03.2019 at 17:38

Да, внешних событий нет.

Варианта 2:

1. Блокировать исполнение кода до получения сообщения (или наступления таймаута)

2. Оставить объект компонента в памяти, не блокируя исполнение и периодически возвращаясь к проверке наличия сообщений, при долгих серверных обработках например, или обработчиком ожидания/действием пользователя на клиенте

Если не секрет, какую задачу хотите решить ?

Reply ↓
Masich 15.03.2019 at 10:21

(7)

>> Если не секрет, какую задачу хотите решить ?

Интеграция с WEB-CRM через REST.

Хочется подвесить соединение и ждать сообщений от CRM.

Я запихнул в обработку ожидания, но не вариант, т.к. «Получить()» получает за раз одно сообщение, а сообщений много, и очередь накапливается.

Было бы хорошо, чтоб компонента во ВнешнееСобытие передавала все поступающие сообщения.

Еще было бы хорошо, чтоб компонента имела фильтрацию сообщений по вхождению текста. Т.к. если от сервера их много, что часто бывает, то 1с может ощутимо тормозить на их фильтрации.

Reply ↓
nomadon 15.03.2019 at 13:47

(8)

вот так тормозит?

Пока Получить(Сообщение, таймаут) Цикл

получите все доступные сообщения, компонент хранит в себе пришедшие сообщения, если их не получать они будут накапливаться в памяти.

Reply ↓
Masich 15.03.2019 at 18:18

(9)

Я про цикл как-то не подумал.

Спасибо.

Reply ↓
nomadon 15.03.2019 at 18:19

(10) посмотрите примеры в документации, может еще что найдете

Reply ↓
1739712 16.03.2019 at 11:45

добрый день

а какой заголовок отправляется на сервер при подключении?

Reply ↓
1739712 16.03.2019 at 12:04

меня интересует значение origin

GET /chat HTTP/1.1

Host: server.example.com

Upgrade: websocket

Connection: Upgrade

Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==

Origin: example.com

Sec-WebSocket-Protocol: chat, superchat

Sec-WebSocket-Version: 13

Reply ↓
popovm 25.03.2019 at 14:57

Как подключиться к ws-серверу, если клиент закрыт прокси?

Какие настройки inetcfg указать?

Reply ↓
nomadon 25.03.2019 at 16:01

(14) прокси а данном компоненте не поддерживается

Reply ↓
user598551_vaa 31.05.2019 at 08:05

Подскажите, а для Linux бинарников нету?

Reply ↓
nomadon 31.05.2019 at 08:23

(16) нет, требуется доработка кода, пока не занимался

Reply ↓
lagerfield 31.05.2019 at 16:24

Добрый день, мы работаем на платформе 1С:Предприятие 8.1 (8.1.15.14), сможем ли мы подключить эти DLL?

Reply ↓
Steelvan 23.09.2019 at 12:00

Про «поднимать веб-гнезда на сервере сложно» согласен. Через костыли.

Что бы экземпляр компоненты жил в потоке на сервере этот самый поток надо создать.

Как вариант, написать фоновое задание, которое будет создавать поток.

Этот поток передать во внешнюю компоненту вызовом метода и удерживать его там, передавая управление 1С только при получении сообщения.

Пока Истина Цикл

Сообщение = ВнешняяКомпонента.ПолучитьСообщение() // Здесь поток замирает до получения сообщения

ОбработкаСообщения(Сообщение);

КонецЦикла

Reply ↓
karpik666 06.11.2019 at 10:04

Здравствуйте, скачал компоненту, и сразу встал вопрос, ваша компонента умеет передавать заголовки при подключении или нет? Мне нужно реализовать аналог такой функции

websocket.DefaultDialer.Dial(*addr, http.Header{«Authorization»: {«Bearer » + *token}})

По факту это аналог вашей, но с передачей заголовков.

Пример с сайта со slack также не подходит, так как в нем вначале вызывается http метод авторизации, а затем уже полученный url передается для соединения без заголовков.

Reply ↓
nomadon 06.11.2019 at 10:16

Добрый, заголовки вроде не делал, slack и так работал, может что-то поменялось

Reply ↓
karpik666 06.11.2019 at 10:59

(21) получается, если разработчики api дополнительно не предусмотрели, что перед работой через websocket необходимо дополнительно авторизоваться через http, то здесь ваша компонента не поможет? Но это же частный случай.

Reply ↓
nomadon 06.11.2019 at 11:03

Частый да, но такой потребности не было, заголовок это всего лишь первые строки в tcp пакете, сообщение всеравно целиком приходит, по суди заголовок от сырых данных передаваемых первым сообщением мало чем отличается, поэтому слак раньше первым сообщением просил авторизацию и разрывал соединение, если не нравилось, как сейчас — не знаю. Да и уже существенно поменялся интерфейс используемой библиотеки c++, За полчаса заголовки у меня добавить не получится

Reply ↓
karpik666 06.11.2019 at 11:06

(23) смотрите в описании написано

Позволяет подключаться и принимать подключения в роли сервера как в режиме без шифровки (ws://), так и используя протокол шифрования (wss://)

У меня есть wss ссылка и токен для нее, я могу использовать вашу компоненту для работы или нет?

Reply ↓
nomadon 06.11.2019 at 11:08

Токен это прикладной объект конкретного сервера, по wss подключение поддерживается

Reply ↓
karpik666 06.11.2019 at 11:12

(25) wss подключение, это подключение с авторизацией, с таким же успехом могло потребоваться передавать логин и пароль, либо id сессии, и в том и другом случае ваша компонента предполагает, что должна быть предварительная http авторизация, при этом должна быть сформирован специальный url, который и будет означать, что вы авторизовались.

Вы когда к сайту подключаетесь по обычному http часто с таким сталкиваетесь? Все обычно передается в заголовках.

Reply ↓
karpik666 06.11.2019 at 11:25

(25) будет ли выпущена новая версия с учетом текущих замечаний?

Reply ↓
lazovit 21.11.2019 at 17:29

С сервисом Мои звонки будет работать?

Reply ↓
lectorkoba 03.12.2019 at 14:26

Скачал компоненты и для 32 и для 64. Все в целом удобно, пока не столкнулся с тем что нужно заполнение заголовка «origin». Было бы замечательно конечно если бы параметром можно было его устанавливать. Обновите пожалуйста, без этого не получится ее использовать.

Reply ↓
lectorkoba 03.12.2019 at 15:28

Заметил ошибку

ВебСокетКлиент.Подключиться(АдресСервера);

ВебСокетКлиент.Отключиться();

ВебСокетКлиент.Подключиться(АдресСервера);

Зависает до перезагрузки 1С.

Reply ↓

WebSocket Клиент / Сервер. Внешний компонент

Related Posts

30 Comments

Leave a Comment Отменить ответ