Разработка сервисов - История изменений

Oagapov: Исправление орфографии (ссылки и код не затронуты)

2026-10-27T21:21:59Z

Исправление орфографии (ссылки и код не затронуты)

Elena в 12:53, 17 марта 2025

2025-03-17T12:53:39Z

← Предыдущая версия		Версия от 12:53, 17 марта 2025
Строка 156:		Строка 156:

	Предыдущая статья курса: [[Задание 9. Пользовательские действия в карточке]]		Предыдущая статья курса: [[Задание 9. Пользовательские действия в карточке]]
	[[Категория:Курс "Разработка приложений"]]		[[Категория:Курс Разработка приложений]]

AZykov: /* Вызов сервисов */

2025-03-13T18:52:30Z

Вызов сервисов

← Предыдущая версия		Версия от 18:52, 13 марта 2025
Строка 138:		Строка 138:


	Пример вызова сервиса ~~из канала интеграции~~:		Пример вызова сервиса через REST API:<syntaxhighlight lang="http">
			POST /rest/v1/domain/nservices/demo01.ServerService
			{
			"method":"Demo_getUsers"
			}
			</syntaxhighlight>domain - имя домена Эра, в котором размещен сервис

	~~TODO//////~~		nservices - неизменяемый служебный путь для обращений к сервисам приложений.

	~~Пример вызова сервиса через REST API:~~

	~~TODO///~~

	~~Пример вызова сервиса из сценария:~~

	~~TODO////~~

	= Мониторинг сервисов =		= Мониторинг сервисов =

AZykov: /* Вызов сервисов */

2025-03-13T13:25:51Z

Вызов сервисов

← Предыдущая версия		Версия от 13:25, 13 марта 2025
Строка 135:		Строка 135:
	});		});
	</syntaxhighlight>		</syntaxhighlight>



Строка 141:		Строка 142:
	TODO//////		TODO//////

	Пример вызова сервиса ~~без использования Invoke~~:		Пример вызова сервиса через REST API:

			TODO///

			Пример вызова сервиса из сценария:

	TODO//////		TODO////

	= Мониторинг сервисов =		= Мониторинг сервисов =

AZykov: /* Работа в файловой системе */

2025-03-10T13:34:12Z

Работа в файловой системе

← Предыдущая версия		Версия от 13:34, 10 марта 2025
Строка 96:		Строка 96:
	Перенос изменений исходного кода сервиса в пакет на платформе Эра осуществляется полной заменой его исходного кода в редакторе сервиса в приложении Builder. Таким образом, после разработки и отладки сервиса на локальной машине, его код необходимо скопировать и вставить в редакторе сервиса на вкладке Code.		Перенос изменений исходного кода сервиса в пакет на платформе Эра осуществляется полной заменой его исходного кода в редакторе сервиса в приложении Builder. Таким образом, после разработки и отладки сервиса на локальной машине, его код необходимо скопировать и вставить в редакторе сервиса на вкладке Code.

	После повторной активации пакета, новый исходный код сервиса заместит предыдущий и логика работы сервиса будет обновлена.		После повторной активации пакета, новый исходный код сервиса заместит предыдущий и логика работы сервиса будет обновлена. <blockquote>'''Важно''': При модификации структуры классов, или других сервисов, необходимо заново загрузить обновленный архив из раздела сервисы для исключения ошибок при дальнейшей разработки. Рекомендуется регулярно обновлять исходные коды исключения ситуаций, когда версия какого либо класса-обёртки на локальном компьютере отличается от аналогичного класса в инстансе платформы. </blockquote>

	=== Работа в редакторе ===		=== Работа в редакторе ===

AZykov: /* Вызов сервисов */

2025-03-10T13:12:31Z

Вызов сервисов

← Предыдущая версия		Версия от 13:12, 10 марта 2025
Строка 115:		Строка 115:
	Главный механизм вызова сервисов в рамках платформы - это Invocations.		Главный механизм вызова сервисов в рамках платформы - это Invocations.

	Механизм Invocations представляет собой единую точку вызова любых сервисов платформы. Все вызовы, выполненные через Invoke буферизуются средствами платформы, а сервисы получают эти вызовы ~~при помощи~~ протокола websocket. Таким образом, если некий сервис не обработал вызов, то запрос на этот вызов будет продолжать находиться в буфере до тех пор, пока сервис не примет его и не обработает, либо до тех пор как специализированный микросервис системы '''''watchdog''''' не исключит запрос из буфера по таймауту.		Механизм Invocations представляет собой единую точку вызова любых сервисов платформы. Все вызовы, выполненные через Invoke буферизуются средствами платформы, а сервисы получают эти вызовы с помощью протокола websocket. Таким образом, если некий сервис не обработал вызов, то запрос на этот вызов будет продолжать находиться в буфере до тех пор, пока сервис не примет его и не обработает, либо до тех пор как специализированный микросервис системы '''''watchdog''''' не исключит запрос из буфера по таймауту.

	Пример вызова микросервиса из серверного контекста: <syntaxhighlight lang="typescript">		Пример вызова микросервиса из серверного контекста: <syntaxhighlight lang="typescript">

AZykov: /* Мониторинг сервисов */

2025-03-10T13:10:39Z

Мониторинг сервисов

← Предыдущая версия		Версия от 13:10, 10 марта 2025
Строка 146:		Строка 146:

	= Мониторинг сервисов =		= Мониторинг сервисов =
			[[Файл:Мониторинг ServiceInstances.png\|мини\|Мониторинг ServiceInstances]]
			Мониторинг запущенных сервисов платформы можно проводить в приложении Builder, в разделе Monitoring.

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

	Следующая статья курса: [[Отладка и логирование]]		Следующая статья курса: [[Отладка и логирование]]

	Предыдущая статья курса: [[Задание 9. Пользовательские действия в карточке]]		Предыдущая статья курса: [[Задание 9. Пользовательские действия в карточке]]
	[[Категория:Курс "Разработка приложений"]]		[[Категория:Курс "Разработка приложений"]]

AZykov: /* Вызов сервисов */

2025-03-10T13:08:17Z

Вызов сервисов

@@ Строка 113: / Строка 113: @@
 = Вызов сервисов =
-Главный механизм вызова сервисов
+Главный механизм вызова сервисов в рамках платформы - это Invocations.
 = Мониторинг сервисов =

AZykov: /* Вызов сервисов */

2025-03-10T12:59:48Z

Вызов сервисов

← Предыдущая версия		Версия от 12:59, 10 марта 2025
Строка 113:		Строка 113:

	= Вызов сервисов =		= Вызов сервисов =
			Главный механизм вызова сервисов

	= Мониторинг сервисов =		= Мониторинг сервисов =

AZykov: /* Работа в редакторе */

2025-03-10T12:58:38Z

Работа в редакторе

← Предыдущая версия		Версия от 12:58, 10 марта 2025
Строка 96:		Строка 96:
	Перенос изменений исходного кода сервиса в пакет на платформе Эра осуществляется полной заменой его исходного кода в редакторе сервиса в приложении Builder. Таким образом, после разработки и отладки сервиса на локальной машине, его код необходимо скопировать и вставить в редакторе сервиса на вкладке Code.		Перенос изменений исходного кода сервиса в пакет на платформе Эра осуществляется полной заменой его исходного кода в редакторе сервиса в приложении Builder. Таким образом, после разработки и отладки сервиса на локальной машине, его код необходимо скопировать и вставить в редакторе сервиса на вкладке Code.

	После повторной активации пакета, новый исходный код сервиса заместит предыдущий и логика работы сервиса будет обновлена.		После повторной активации пакета, новый исходный код сервиса заместит предыдущий и логика работы сервиса будет обновлена.

	=== Работа в редакторе ===		=== Работа в редакторе ===
			[[Файл:Определение методов в редакторе сервиса.png\|мини\|Определение методов в редакторе сервиса]]
			В платформе присутствует возможность разрабатывать сервисы без применения файловой системы, из редактора сервиса. Такой подход является менее предпочтительным, так как не предлагает базовых удобств при работе с кодом, таких как подсветка и проверка синтаксиса, autocompletion, автоматический импорт зависимостей и т.д.

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

			Платформа предлагает '''два подхода''' к разработке такого простого сервиса.

			'''Первый подход''' - определение тела методов на вкладке Common, в этом случае система автоматически перенесет код из свойства в соответствующий ему метод (onInitCode -> onInit, onTimerCode -> onTimer и т.д.). Так же, присутствует возможность задать произвольные методы сервиса с помощью свойства functionsCode.
			[[Файл:Редактор кода сервиса в Builder'е.png\|мини\|Редактор кода на вкладке Code]]
			'''Второй подход''' - редактирование исходного кода всего сервиса на вкладке Code. В этом случае разработчику доступен весь код сервиса, с возможностью изменения и создания любого метода, включая конструктор.

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

	= Вызов сервисов =		= Вызов сервисов =

← Предыдущая версия		Версия от 21:21, 27 октября 2026
Строка 24:		Строка 24:
	Сервисы, исполняемые на клиенте, работают в браузере пользователя и могут, например, при запросе открывать пользователю определенную карточку с данными (пример - базовый микросервис callcenter.ShowCardService, который открывает карточку звонка при поступлении входящего вызова из очереди).		Сервисы, исполняемые на клиенте, работают в браузере пользователя и могут, например, при запросе открывать пользователю определенную карточку с данными (пример - базовый микросервис callcenter.ShowCardService, который открывает карточку звонка при поступлении входящего вызова из очереди).

	~~Так же,~~ сервисы могут отличаться по типу ('''ServiceType'''):		Также сервисы могут отличаться по типу ('''ServiceType'''):

	* '''default''' - Стандартный сервис (с таймером и вызовами invocations)		* '''default''' - Стандартный сервис (с таймером и вызовами invocations)
Строка 34:		Строка 34:
	Таким образом, стандартный сервис имеет наиболее широкий функционал, обеспечиваемый платформой. Два других варианта позволяют реализовывать более "легковесные" сервисы, например, для работы с большим объемом запросов, для которых нет необходимости накопления в случае неработоспособности сервиса (например это может быть поток websocket-запрсоов в реальном времени от сторонней системы).		Таким образом, стандартный сервис имеет наиболее широкий функционал, обеспечиваемый платформой. Два других варианта позволяют реализовывать более "легковесные" сервисы, например, для работы с большим объемом запросов, для которых нет необходимости накопления в случае неработоспособности сервиса (например это может быть поток websocket-запрсоов в реальном времени от сторонней системы).

	В ~~отличии~~ от Actions и Handlers, сервисы не привязаны к конкретным классам, и могут содержать набор методов для работы с различными данными, или вообще не быть привязанными ни к какой конкретной бизнес-логике системы и выполнять исключительно утилитарные функции.		В отличие от Actions и Handlers, сервисы не привязаны к конкретным классам, и могут содержать набор методов для работы с различными данными, или вообще не быть привязанными ни к какой конкретной бизнес-логике системы и выполнять исключительно утилитарные функции.

	= Структура сервиса =		= Структура сервиса =
Строка 43:		Строка 43:
	Сервис представляет собой TypeScript-класс, наследующий класс Service.		Сервис представляет собой TypeScript-класс, наследующий класс Service.

	По-умолчанию, каждый сервис содержит конструктор и два асинхронных метода:		По умолчанию, каждый сервис содержит конструктор и два асинхронных метода:

	* ''async'' '''onInit()'''		* ''async'' '''onInit()'''
Строка 62:		Строка 62:
	Любой сервис перед работой необходимо изначально создать в приложении Builder, разделе Services.		Любой сервис перед работой необходимо изначально создать в приложении Builder, разделе Services.

	Для того, чтобы платформа ~~сгененрировала~~ исходный код сервиса, необходимо задать ему имя (Name), контекст исполнения (ServiceKind) и тип (ServiceType). Другие свойства для генерации заполнять не требуется, они будут рассмотрены далее.		Для того, чтобы платформа сгенерировала исходный код сервиса, необходимо задать ему имя (Name), контекст исполнения (ServiceKind) и тип (ServiceType). Другие свойства для генерации заполнять не требуется, они будут рассмотрены далее.
	[[Файл:Деактивация пакета.png\|мини\|Деактивация пакета]]		[[Файл:Деактивация пакета.png\|мини\|Деактивация пакета]]
	Для того, чтобы платформа ~~сгененрировала~~ исходный код для сервиса, необходимо деактивировать пакет и затем активировать его заново.		Для того, чтобы платформа сгенерировала исходный код для сервиса, необходимо деактивировать пакет и затем активировать его заново.

	После того как платформа сгенерирует исходный код, сервис будет автоматически запущен, а так же будет доступна функция загрузки исходников для разработки и отладки в файловой системе, на компьютере разработчика.		После того как платформа сгенерирует исходный код, сервис будет автоматически запущен, а так же будет доступна функция загрузки исходников для разработки и отладки в файловой системе, на компьютере разработчика.
Строка 70:		Строка 70:
	=== Работа в файловой системе ===		=== Работа в файловой системе ===
	[[Файл:Исходные коды сервисов.png\|мини\|Исходные коды сервисов]]		[[Файл:Исходные коды сервисов.png\|мини\|Исходные коды сервисов]]
	После генерации платформой исходных кодов сервиса, они становятся доступными для загрузки в разделе Services, приложения Builder. Кнопки загрузки исходных кодов доступны в столбце sourceCode. Если эта колонка не отображается, её необходимо вывести через меню "Выбор столбцов" (на ~~скриношоте~~ выделено зеленой рамкой).		После генерации платформой исходных кодов сервиса, они становятся доступными для загрузки в разделе Services, приложения Builder. Кнопки загрузки исходных кодов доступны в столбце sourceCode. Если эта колонка не отображается, её необходимо вывести через меню "Выбор столбцов" (на скриншоте выделено зеленой рамкой).
	[[Файл:Справка раздела Services.png\|мини\|Справка раздела Services]]		[[Файл:Справка раздела Services.png\|мини\|Справка раздела Services]]
	Для обеспечения удобства дальнейшей разработки и отладки на локальной машине, необходимо произвести определенный набор действий по настройке сервиса и рабочей среды.		Для обеспечения удобства дальнейшей разработки и отладки на локальной машине, необходимо произвести определенный набор действий по настройке сервиса и рабочей среды.
Строка 76:		Строка 76:
	Алгоритм настройки всегда доступен в справке раздела Services (кнопка "?" около заголовка раздела), также его можно найти в статье [[Принципы разработки#Запуск TS-модулей и отладка\|Принципы разработки, в разделе "Запуск TS-модулей и отладка"]].		Алгоритм настройки всегда доступен в справке раздела Services (кнопка "?" около заголовка раздела), также его можно найти в статье [[Принципы разработки#Запуск TS-модулей и отладка\|Принципы разработки, в разделе "Запуск TS-модулей и отладка"]].

	Важным шагом при запуске локального сервиса является отключение экземпляра сервиса на стороне платформы. Так как по-умолчанию все сервисы являются [https://ru.wikipedia.org/wiki/%D0%9E%D0%B4%D0%B8%D0%BD%D0%BE%D1%87%D0%BA%D0%B0_(%D1%88%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD_%D0%BF%D1%80%D0%BE%D0%B5%D0%BA%D1%82%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F) ~~singletone~~'ами], попытка запустить второй экземпляр сервиса приведёт к ошибке.		Важным шагом при запуске локального сервиса является отключение экземпляра сервиса на стороне платформы. Так как по умолчанию все сервисы являются [https://ru.wikipedia.org/wiki/%D0%9E%D0%B4%D0%B8%D0%BD%D0%BE%D1%87%D0%BA%D0%B0_(%D1%88%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD_%D0%BF%D1%80%D0%BE%D0%B5%D0%BA%D1%82%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F) singleton'ами], попытка запустить второй экземпляр сервиса приведёт к ошибке.

	В составе архива содержится структура всех пакетов системы, включая целевой пакет, в котором ~~распологается~~ сервис. Наличие сторонних и базовых пакетов позволяет удобно разрабатывать сервисы, взаимодействующие с данными в других пакетах, а так же "подсматривать" примеры реализации той или иной функциональности в уже существующих сервисах.		В составе архива содержится структура всех пакетов системы, включая целевой пакет, в котором располагается сервис. Наличие сторонних и базовых пакетов позволяет удобно разрабатывать сервисы, взаимодействующие с данными в других пакетах, а так же "подсматривать" примеры реализации той или иной функциональности в уже существующих сервисах.
	[[Файл:Исходный код сервиса в VSCode.png\|мини\|Исходный код сервиса в VSCode]]		[[Файл:Исходный код сервиса в VSCode.png\|мини\|Исходный код сервиса в VSCode]]
	Структура файлов исходных кодов:		Структура файлов исходных кодов:
Строка 91:		Строка 91:
	Сервис может быть запущен при помощи команды ''npm start'', запущенный локально сервис будет автоматически перезапускаться при любых изменениях в исходном коде, что удобно для отладки.		Сервис может быть запущен при помощи команды ''npm start'', запущенный локально сервис будет автоматически перезапускаться при любых изменениях в исходном коде, что удобно для отладки.

	В рамках ~~разрботки~~ сервисов, '''основным объектом''' изменения является файл исходного кода сервиса. Изменения в этом файле в дальнейшем могут быть перенесены в платформу и использоваться в продуктиве. Изменения в других файлах, например в классах-обёртках, интерфейсах или других сервисах могут вноситься '''только для проведения отладки''' локально на компьютере разработчика, '''дальнейший перенос этих изменений невозможен'''.		В рамках разработки сервисов, '''основным объектом''' изменения является файл исходного кода сервиса. Изменения в этом файле в дальнейшем могут быть перенесены в платформу и использоваться в продуктиве. Изменения в других файлах, например в классах-обёртках, интерфейсах или других сервисах могут вноситься '''только для проведения отладки''' локально на компьютере разработчика, '''дальнейший перенос этих изменений невозможен'''.
	[[Файл:Редактор кода сервиса в Builder'е.png\|мини\|Редактор кода сервиса в Builder'е]]		[[Файл:Редактор кода сервиса в Builder'е.png\|мини\|Редактор кода сервиса в Builder'е]]

Строка 106:		Строка 106:
	Платформа предлагает '''два подхода''' к разработке такого простого сервиса.		Платформа предлагает '''два подхода''' к разработке такого простого сервиса.

	'''Первый подход''' - определение тела методов на вкладке Common, в этом случае система автоматически перенесет код из свойства в соответствующий ему метод (onInitCode -> onInit, onTimerCode -> onTimer и т.д.). ~~Так же,~~ присутствует возможность задать произвольные методы сервиса с помощью свойства functionsCode.		'''Первый подход''' - определение тела методов на вкладке Common, в этом случае система автоматически перенесет код из свойства в соответствующий ему метод (onInitCode -> onInit, onTimerCode -> onTimer и т.д.). Также присутствует возможность задать произвольные методы сервиса с помощью свойства functionsCode.
	[[Файл:Редактор кода сервиса в Builder'е.png\|мини\|Редактор кода на вкладке Code]]		[[Файл:Редактор кода сервиса в Builder'е.png\|мини\|Редактор кода на вкладке Code]]
	'''Второй подход''' - редактирование исходного кода всего сервиса на вкладке Code. В этом случае разработчику доступен весь код сервиса, с возможностью изменения и создания любого метода, включая конструктор.		'''Второй подход''' - редактирование исходного кода всего сервиса на вкладке Code. В этом случае разработчику доступен весь код сервиса, с возможностью изменения и создания любого метода, включая конструктор.