Разработка

Дата последней модификации документа: 30 октября 2022.

1. API разработчика программных единиц платформы (обновлено: 15.02.2024)

API разработчика программных единиц платформы используется для разработки процедурного кода пользовательскийх агентов и шаблонов сообщений и содержит классы, сгруппированные в несколько аспектов: см. документацию.
Помимо методов API разработчика программных единиц платформы также допускается использование библиотеки MJSON (работа с Json) и Apache POI (работа с Microsoft Office документами).

Разработка описания и кода агентов и шаблонов сообщений может быть выполнена полностью online (на сайте платформы) - в соответствующих редакторах.
При необходимости выполнить локальную разработку кода (агента или шаблона сообщений) необходимо использовать следующие компоненты:

1.1. Библиотека методов API

Использование в нативных проектах Java IDE:
- файл: скачать jar (~130 Kib)
- подключение к проекту в IntelliJ IDEA:
  список шагов (может отличаться в разных версиях данной IDE)
  1. открыть окно структуры проекта
  2. выбрать "modules"
  3. выбрать разрабатываемый модуль (агента)
  4. выбрать таб "Dependencies"
  5. нажать "+"
  6. в диалоге выбора файла указать jar-файл библиотеки (iacpaas-api-1.0.jar) для добавления к проекту
  7. несколько раз нажать "OK" для закрытия всех диалоговых окон

Использование в maven-проекте:

описание зависимости

  <dependencies>
    <dependency>
      <groupId>ru.dvo.iacp.is.iacpaas</groupId>
      <artifactId>iacpaas-api</artifactId>
      <version>1.0</version>
    </dependency>
  </dependencies>
  <repositories>
    <repository>
      <id>central</id>
      <url>http://iacpaas-dev.dvo.ru/nexus/content/groups/public</url>
      <snapshots>
        <enabled>true</enabled>
      </snapshots>
      <releases>
        <enabled>true</enabled>
      </releases>
    </repository>
  </repositories>

1.2. Документация библиотеки методов API разработчика программных единиц п\латформы

Использование в нативных проектах Java IDE:
- файл: скачать jar (~1 Mib)
- подключение к проекту в IntelliJ IDEA:
  список шагов (может отличаться в разных версиях данной IDE)
  1. открыть окно структуры проекта
  2. выбрать "modules"
  3. выбрать разрабатываемый модуль (агента)
  4. выбрать таб "Dependencies"
  5. выделить в списке зависимостей подключенную ранее (см. выше) библиотеку iacpaas-api-1.0.jar
  6. нажать в её контекстном меню "Edit"
  7. в появившемся окне нажать "+" ("Add")
  8. в диалоге выбора файла выбрать jar-файл с документацией (iacpaas-api-1.0-javadoc.jar)
  9. несколько раз нажать "ОК" для закрытия всех диалоговых окон (при этом, если подключаемый тип файла не распознаётся - выбрать тип JavaDoc)

1.3. Байткод повторно-используемых шаблонов сообщений

(для шаблонов сообщений, не входящих в API разработчика программных единиц)

Использование в нативных проектах Java IDE:
- либо файлы с исходным кодом шаблонов скачиваются с помощью редактора шаблонов сообщений и помещаются в папку с исходными файлами проекта (с созданием иерархии каталогов, соответственно пакету ru.dvo.iacp.is.iacpaas.mas.messages)
- либо файлы с байт-кодом шаблонов скачиваются с помощью редактора шаблонов сообщений и помещаются в некоторую папку, после чего для каждого выполняется подключение к проекту, например, в IntelliJ IDEA:
  список шагов (может отличаться в разных версиях данной IDE)
  1. открыть окно структуры проекта
  2. выбрать "modules"
  3. выбрать разрабатываемый модуль (агента)
  4. выбрать таб "Dependencies"
  5. нажать "+"
  6. в диалоге выбора файла указать jar-файл(ы) шаблона(ов) для добавления к проекту
  7. несколько раз нажать "OK" для закрытия всех диалоговых окон
- либо единый файл с байт-кодом всех шаблонов скачивается с помощью редактора агентов и помещаются в некоторую папку, после чего выполняется подключение к проекту, например, в IntelliJ IDEA:
  список шагов (может отличаться в разных версиях данной IDE)
  1. открыть окно структуры проекта
  2. выбрать "modules"
  3. выбрать разрабатываемый модуль (агента)
  4. выбрать таб "Dependencies"
  5. нажать "+"
  6. в диалоге выбора файла указать jar-файл с шаблонами (agentName_reusedMessageTemapltes.jar) для добавления к проекту
  7. несколько раз нажать "OK" для закрытия всех диалоговых окон

1.4. Библиотека MJSON

Для использования некоторых методов API разработчика программных единиц платформы необходимо подключить к проекту библиотеку MJSON:

Использование в нативных проектах Java IDE:
- файл: скачать jar (~66 Kib)
- подключение к проекту в IntelliJ IDEA:
  список шагов (может отличаться в разных версиях данной IDE)
  1. открыть окно структуры проекта
  2. выбрать "modules"
  3. выбрать разрабатываемый модуль (агента)
  4. выбрать таб "Dependencies"
  5. нажать "+"
  6. в диалоге выбора файла указать jar-файл библиотеки (mjson-1.4.1.jar) для добавления к проекту
  7. несколько раз нажать "OK" для закрытия всех диалоговых окон

Использование в maven-проекте:

описание зависимости

  <dependency>
    <groupId>org.sharegov</groupId>
    <artifactId>mjson</artifactId>
    <version>1.4.1</version>
  </dependency>

1.5. Библиотека Apache POI

Для использования некоторых методов API разработчика программных единиц платформы необходимо подключить к проекту библиотеку Apache POI:

Использование в нативных проектах Java IDE:
- файл: скачать jar (~2.8 Mib)
- подключение к проекту в IntelliJ IDEA:
  список шагов (может отличаться в разных версиях данной IDE)
  1. открыть окно структуры проекта
  2. выбрать "modules"
  3. выбрать разрабатываемый модуль (агента)
  4. выбрать таб "Dependencies"
  5. нажать "+"
  6. в диалоге выбора файла указать jar-файл библиотеки (poi-5.2.2.jar) для добавления к проекту
  7. несколько раз нажать "OK" для закрытия всех диалоговых окон

Использование в maven-проекте:

описание зависимости

  <dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi</artifactId>
    <version>5.2.2</version>
  </dependency>

2. Технологии разработки

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