Перейти к основному содержимому

Сценарий разработки сервиса бизнес-логики

к сведению

Этот сценарий рассматривает разработку сервиса бизнес-логики на языке C# в Visual Studio.

Предварительные требования​

На вашем компьютере установлен Visual Studio 2022 с рабочими нагрузками ASP.NET и разработка веб-приложений и Разработка классических приложений .NET.

Вы вошли в AdminTools.

Этапы​

Разработка сервиса бизнес-логики включает следующие этапы:

  1. Подготовка шаблона для разработки сервиса бизнес-логики

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

    По ссылке https://nexus.atomkod.ru/repository/platform-raw/template/<архив-шаблона>.zip вы скачиваете архивный файл, содержащий шаблон сервиса. Затем вы помещаете этот архивный файл в папку с шаблонами для Visual Studio %USERPROFILE%/Документы/Visual Studio 2022/Templates/ProjectTemplates/Visual C# и извлекаете файлы из архива.

    Доступ к данным по ссылке https://nexus.atomkod.ru/repository/platform-raw/template/<Platform_version>/<ServiceTemplate_CSharp>.zip возможен только для авторизованных пользователей. Если вы приобрели Платформу, в Службе технической поддержки вы можете запросить учетные данные для доступа. Вы можете обратиться в Службу технической поддержки по электронной почте по адресу MDSupport@rosatom.ru. В сообщении электронной почты вам необходимо указать название компании, которую вы представляете.

  2. Создание проекта в Visual Studio для разработки сервиса бизнес-логики

    Вы запускаете Visual Studio и создаете проект на основе шаблона сервиса бизнес-логики.

    Проект в Visual Studio, созданный на основе шаблона сервиса, имеет определенную структуру. Классы, описанные в проекте, позволяют изменять определенные параметры разрабатываемого сервиса бизнес-логики.

  3. Обновление пакетов NuGet в проекте для разработки сервиса бизнес-логики

    Поскольку разработчики Платформы периодически изменяют пакеты NuGet для управления регистрацией сервиса, вы обновляете пакеты NuGet в созданном в Visual Studio проекте.

  4. Разработка кода сервиса бизнес-логики

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

    При разработке сервиса бизнес-логики необходимо учитывать особенности разработки контроллера веб-API.

    Для написания кода вызовов сервисов Платформы и сервиса бизнес-логики вы можете использовать библиотеку ApiClient.

    Вы можете управлять генерацией файла Swagger с помощью свойств одного из классов в структуре проекта в Visual Studio, созданного на основе шаблона сервиса бизнес-логики.

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

  5. Разработка модульных тестов для сервиса бизнес-логики

    В Visual Studio вы создаете проект с модульными тестами для сервиса бизнес-логики и разрабатываете тесты.

  6. Настройка межсервисного взаимодействия для сервиса бизнес-логики

    Если сервис бизнес-логики должен взаимодействовать с другими сервисами Платформы, вы настраиваете межсервисную аутентификацию и авторизацию.

  7. Регистрация сервиса бизнес-логики в Платформе

    В AdminTools вы регистрируете новый сервис типа Product.

  8. Настройка сервиса бизнес-логики в Платформе

    В AdminTools в списке сервисов вы выбираете новый зарегистрированный сервис и указываете его параметры.

  9. Запуск и отладка сервиса бизнес-логики

    Вы отлаживаете разрабатываемый сервис на своем локальном компютере. В определенных сценариях отладки сервиса вам необходимо настроить дополнительные параметры.

  10. Доставка разработанного сервиса бизнес-логики в Платформу

    Разработанный сервис должен быть упакован в образ Docker-контейнера, который должен быть доставлен в Платформу согласно описанной процедуре.

Результаты​

Разработанный сервис бизнес-логики доступен на сервере Платформы. При разработке приложения в DevTools на этапе разработки интерфейса приложения вы можете использовать разработанный сервис бизнес-логики.