Table of contents

1. Введение
2. Общая архитектура платформы
3. Основные принципы платформы
   1. Модульность
   2. Стратегии
   3. Принципы именования классов/интерфейсов/стратегий
4. Начало работы с платформой
5. Структура проектов платформы
6. Архитектура ядра
7. Архитектура системного слоя
8. Подробное описание модулей ядра и системных модулей
   1. Модуль base
      1. Интерфейсы

Введение

Данный документ представляет собой верхнеуровневое описание платформы SmartActors 0.6.0, реализующей принципы
акторной модели.

Общая архитектура платформы

Платформа Smartactors реализована на языке Java (поддерживается версия Java SE Version 8).

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

Развернутая платформа представляет собой каталог, содержащий файлы server.jar, configuration.json, а так же каталоги core, corefeatures и features.

Соответственно, основной модуль платформы - приложение server.jar - запускается посредством Java-машины.

Файл configuration.json содержит конфигурации базовых объектов и цепочек платформы.

Каталог core содержит все модули ядра платформы.

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

corefeatures может содержать только один файл features.json, вмещающий описания и ссылки на необходимые системные модули. В таком случае, эти системные модули будут автоматически загружены сервером платформы при старте из удаленных репозиториев, указанных в features.json.

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

Основные принципы платформы

Модульность

Каждый самостоятельный блок пользовательской функциональности должен быть реализован в виде отдельного модуля (feature). Модуль состоит из набора интерфейсов, акторов, плагинов и файла конфигурации config.json. В случае если интерфейсы предполагают более чем одну реализацию, они должны быть вынесены в отдельный модуль. Акторы реализуют собственно пользовательскую функциональность. Плагины проводят начальную инициализацию акторов при загрузке модуля и регистрацию необходимых компонент/стратегий. Плагины также могут быть вынесены в отдельный модуль в случае, если требуется отделить инициализацию и регистрацию компонент от собственно реализации. Файл конфигурации config.json содержит описания объектов модуля, цепочек модуля и др.

Стратегии

Любая единица функциональности (в том числе акторы, создание объектов, обработка объекта некоторым способом) регистрируется в системном сервис-локаторе (IOC) в виде стратегии под соответствующим именем. Для вызова этой функциональности производится запрос к IOC на выполнение соответствующией стратегии. Таким образом поведение кода может динамически меняться путем замены/перерегистрации стратегии без изменения самого кода.

Принципы именования классов/интерфейсов/стратегий

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

Имена интерфейсов должны начинаться с буквы “I” перед заглавной буквой первого слова имени.

Java-классы стратегий должны реализовывать интерфейс IStrategy.

Имя класса стратегии, реализующего только интерфейс IStrategy, должно быть осмысленной фразой на английском языке, означающей действие, (то есть содержащей глагол) с добавлением слова Strategy в конце имени. Например: CreateNewInstanceStrategy.

Имя класса стратегии, реализующего еще что-то помимо интерфейса IStrategy, должно соответствовать общим правилам именования классов платформы (см. выше). Например: StrategyStorageStrategy.

Имя стратегии, под которым она регистрируется в IOC, должно представлять из себя осмысленное описание выполняемого действия на английском языке. Все слова должны начинаться с маленькой буквы и быть разделенными пробелами. Например: “factor choice strategy” или “my main object creation”. Имя стратегии не должно состоять из более чем 4-6 слов.

Начало работы с платформой

Для начала работы со Smartactors требуется установить пакет das, позволяющий производить основные действия с платформой, такие как: создание сервера, установка ядра, создание/изменение/удаление пользовательских модулей/акторов/плагинов, и т.д.

Более подробную документацию по типовым действиям с платформой и das можно найти в разделе Quickstart guides.

Структура проектов платформы

Платформа Smartactors представляет собой несколько maven-проектов:

• Servers/Server2 содержит основное серверное приложение
• ServerDevelopmentTools содержит основной интерфейс серверного приложения
• СoreFeatures содержит все модули ядра и системные модули
• CommonFeatures содержит модули с дополнительной функциональностью общего назначения
• SystemActors содержит дополнительные системные модули
• ServerPack содержит конфигурационный файл со списком всех модулей, входящих в ядро

Архитектура ядра

Схема зависимостей модулей ядра платформы представлена следующей диаграммой:

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

Архитектура системного слоя

Схема зависимостей системного слоя платформы представлена следующей диаграммой:

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

Подробное описание модулей ядра и системных модулей

Модуль base

Модуль содержит базовые интерфейсы платформы.

Интерфейсы

| | Имя интерфейса | Описание | | —: | :— | — |