Шаблоны проектов для Maven (Архетипы)

Этот раздел перенесён из документации Camunda 7 и в дальнейшем будет доработан с учётом особенностей OpenBPM Engine

Мы предоставляем несколько шаблонов проектов для Maven, которые также называются архетипами (Archetypes). Они делают возможным быстрый старт для разработки готовых к продакшен процессных приложений, использующих Camunda 7. Мы привели в действие лучшие практики для различных типов приложений и применили их к шаблонам, чтобы помочь вам начать с прочной базы. Архетипы могут использоваться для генерации проектов, как описано в дальнейших разделах. Если самостоятельная генерация проекта из архетипа не является для вас реалистичным решением, мы также подготовили репозиторий шаблонов в GitHub для каждого архетипа.

Обзор имеющихся архетипов для Maven

Следующие архетипы предоставляются в настоящее время. Они распространаются через наш Maven репозиторий

Архетип	Описание
Плагин Camunda Cockpit	Плагин Camunda Cockpit, содержит REST-бэкенд, запросы к базе данных MyBatis, фронтенд на HTML и JavaScript, скрипт сборки на Ant для деплоймента в один клик.
Ппоцессное приложение (EJB, WAR)	Процессное приложение, которое использует разделенный движок Camunda 7 в контейнере Java EE, например, Wildfly. Содержит: Camunda EJB клиент, Camunda CDI интеграцию, BPMN процесс, Java Delegate как CDI бин, формы для старта и задач на HTML5- и JSF, конфигурацию для JPA (Hibernate), JUnit тест с in-memory движком и тестовым покрытием для визуальных процессов, Arquillian тесты для Wildfly, Maven плагины или скрипт сборки на Ant для деплоймента в Eclipse в один клик.
Процессное приложение(Servlet, WAR)	Процессное приложение, которое использует разделенный движок Camunda 7 в Servlet контейнере, например, Apache Tomcat. Содержит: процессное приложение на Servlet, BPMN процесс, Java Delegate, формы для старта и задач на HTML5, JUnit тест с in-memory движком, Maven плагины или скрипт сборки на Ant для деплоймента в Eclipse в один клик.
Camunda-приложение на Spring Boot	Приложение, использующее стартер Camunda Spring Boot. Содержит: Процессное приложение на Spring Boot, Camunda Webapps, BPMN процесс, Java Delegate, формы для старта и задач на HTML5, JUnit тест с in-memory движком, Maven плагины или скрипт сборки на Ant для деплоймента в Eclipse в один клик.
Camunda-приложение на Spring Boot с демо-пользователями	То же самое, что м архетип "Camunda-приложение на Spring Boot", но дополнительно создает демо-пользователей и групы для простого старта работы с Camunda Webapps (для входа используйте demo/demo).
Плагин движка обработки процессов	Пример для плагина движка обработки процессов. Содержит: плагин движка обработки процессов, слушатель парсинга BPMN, зарегитрированный через плагин, слушатель задач, добавляемый к каждой пользовательской задаче, JUnit тест с in-memory движком.

Архетип

Описание

Плагин Camunda Cockpit

Плагин Camunda Cockpit, содержит REST-бэкенд, запросы к базе данных MyBatis, фронтенд на HTML и JavaScript, скрипт сборки на Ant для деплоймента в один клик.

Ппоцессное приложение (EJB, WAR)

Процессное приложение, которое использует разделенный движок Camunda 7 в контейнере Java EE, например, Wildfly. Содержит: Camunda EJB клиент, Camunda CDI интеграцию, BPMN процесс, Java Delegate как CDI бин, формы для старта и задач на HTML5- и JSF, конфигурацию для JPA (Hibernate), JUnit тест с in-memory движком и тестовым покрытием для визуальных процессов, Arquillian тесты для Wildfly, Maven плагины или скрипт сборки на Ant для деплоймента в Eclipse в один клик.

Процессное приложение(Servlet, WAR)

Процессное приложение, которое использует разделенный движок Camunda 7 в Servlet контейнере, например, Apache Tomcat. Содержит: процессное приложение на Servlet, BPMN процесс, Java Delegate, формы для старта и задач на HTML5, JUnit тест с in-memory движком, Maven плагины или скрипт сборки на Ant для деплоймента в Eclipse в один клик.

Camunda-приложение на Spring Boot

Приложение, использующее стартер Camunda Spring Boot. Содержит: Процессное приложение на Spring Boot, Camunda Webapps, BPMN процесс, Java Delegate, формы для старта и задач на HTML5, JUnit тест с in-memory движком, Maven плагины или скрипт сборки на Ant для деплоймента в Eclipse в один клик.

Camunda-приложение на Spring Boot с демо-пользователями

То же самое, что м архетип "Camunda-приложение на Spring Boot", но дополнительно создает демо-пользователей и групы для простого старта работы с Camunda Webapps (для входа используйте demo/demo).

Плагин движка обработки процессов

Пример для плагина движка обработки процессов. Содержит: плагин движка обработки процессов, слушатель парсинга BPMN, зарегитрированный через плагин, слушатель задач, добавляемый к каждой пользовательской задаче, JUnit тест с in-memory движком.

Репозитории шаблонов

Мы предоставляем репозиторий шаблона для каждого архетипа от Camunda. Каждый репозиторий содержит проект, сгенерированный из одного конкретного шаблона. Полный список можно найти на GitHub.

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

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

Использование в Eclipse IDE

Краткий обзор

Добавьте каталог архетипа (Preferences → Maven → Archetypes → Add Remote Catalog): https://artifacts.camunda.com/artifactory/camunda-bpm/
Создайте проект на Maven из архетипа (File → New → Project… → Maven → Maven Project)

Подробная инструкция

Выберите в меню Preferences → Maven → Archetypes и нажмите на кнопку Add Remote Catalog
Введите следующие URL и описание, нажмите на Verify…, чтобы протестировать соединение и если оно работает, нажмите на OK, чтобы сохранить каталог.

Каталог: https://artifacts.camunda.com/artifactory/camunda-bpm/

Описание: Camunda 7

Теперь у вас должна появиться возможность использовать архетипы при создании нового проекта на Maven в Eclipse:

1.Выберите в меню File → New → Project… и затем выберите Maven → Maven Project Create new Maven project 2. Выберите местоположение проекта или просто сохраните настройку по умолчанию. Eclipse: Select Maven project location 3. Выберите архетип из каталога, который вы создали ранее. Eclipse: Select Maven archetype from catalog 4. Задайте координаты Mavenи версию Camunda, затем завершите создание проекта. Eclipse: Specify Maven coordinates and Camunda version

Получившийся в результате проект должен выглядеть вот так:

Generated Maven Project in Eclipse

Отладка

Иногда создание самого первого Maven-проекта в Eclipse заканчивается неудачей. Если такое случилось с вами, просто попробуйте сделать то же самое еще раз. В большинстве случаев вторая попытка работает. Если проблема созраняется, свяжитесь с нами.

Использование в IntelliJ IDEA

На экране "Welcome to IntelliJ IDEA", нажмите на "Configure" и выберите "Plugins" в выпадающем списке.
В диалоговом окне плагина нажмите на "Browse repositories…".
Сделайте поиск плагина "Maven Archetype Catalogs" и нажмите на "Install".
Перезапустите IntelliJ IDEA.
На экране "Welcome to IntelliJ IDEA" нажмите на "Configure" и выберите "Preferences" в выпадающем списке.
В окне предпочтений перейдите к: "Build, Execution, Deployment > Build Tools > Maven Archetype Catalogs".
В окне каталогов архетипов Maven Archetype Catalogs нажмите на кнопку "+", и в открывшемся модальном окне "Add Archetype Catalog URL" добавьте URL файла каталога: https://artifacts.camunda.com/artifactory/camunda-bpm/archetype-catalog.xml.
Чтобы создать Maven-проект из архетипа, на экране "Welcome to IntelliJ IDEA" нажмите на "Create New Project".
В диалоговом окне сздания проекта нажмите на "Maven", пометьте галочкой "Create from archetype" и выберите любое вхождение io.openbpm.bpm.archetype.

Использование в командной строке

Интерактивный режим

Выполните следующую команду в терминале, чтобы сгенерировать проект. Maven позволит вам выбрать архетип и запросит все параметры, необходимые для его создания:

mvn archetype:generate -Dfilter=io.openbpm.bpm.archetype:

Полная автоматизация

Следующая команда полностью автоматизирует генерацию проекта и может быть использована в Shell-скриптах или Ant-сборках:

mvn archetype:generate \
  -DinteractiveMode=false \
  -DarchetypeGroupId=io.openbpm.bpm.archetype \
  -DarchetypeArtifactId=camunda-archetype-ejb-war \
  -DarchetypeVersion=7.10.0 \
  -DgroupId=org.example.openbpm.bpm \
  -DartifactId=camunda-bpm-ejb-project \
  -Dversion=0.0.1-SNAPSHOT \
  -Dpackage=org.example.openbpm.bpm.ejb

Исходный код и кастомизация

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

Лицензия и атрибуция

Эта документация была создана на базе материала "Camunda 7 Docs" от Camunda, находится под лицензией Creative Commons Attribution-ShareAlike 3.0 Unported License .

Оригинал документации: https://docs.camunda.org