Как сделать динамически модульное приложение Spring Boot?

Question

[Stanyslav Glubyshev]

Добрый день.
Нужно сделать модульное приложение на Spring framework, т.е. есть приложение Spring-Boot, и есть например модули в виде jar файлов в директории сервера(например modules). При запуске приложения нужно забрать все jar файлы и импортировать их в приложение в виде компонентов(плагинов) которые будут расширять функциональность приложения.
Первым делом я сделал загрузку jar файлов используя java.net.URLClassLoader, но работать с классами я могу только через рефлексию, что не подходит так как я использую аннотация вместо xml файлов, а через рефлексию аннотации не работают.
Получается что в модулях я даже не могу внедрять зависимости например:

@PersistenceContext
private EntityManager em;

Я наткнулся на osgi framework но при его использовании нужно отказаться от использования Spring-Boot, плюс ко всему говорят, что там не работают все аннотации и придётся использовать xml, что не хотелось бы. Мы наоборот хотим избавится от всех xml файлов и сделать проект на аннотациях и java классах.
И что ещё пугает osgi так это его монструозность и заморочки в зависимости для которых придётся делать свои bundle это ещё куча потраченного времени и уверен что без проблем не обойдётся и плюс время на изучение.

Пример проекта на github: https://github.com/Stanyslav/spring-boot-multiple-...

Answer 1

[Victor Alenkov]

либо я не понял сути вашего вопроса, либо вам нужно посмотреть в сторону spring.factories

Comments

[Stanyslav Glubyshev]

Хорошо попробую объяснить по другому. Есть два jar файла первый core (приложение spring-boot) и migrate(должен запускаться для миграции со старой версии). Но migrate может и не быть, если новая установка приложения. Как сделать так что бы migrate.jar подключался автоматически если он есть?

[Victor Alenkov]

glubyshev: в модуле migrate.jar создаёте файл META-INF/spring.factories , который автоматически создаст объявленные в нём бины при загрузке SpringBoot приложения. Для простоты в нём можно сделать только ссылку на Configuration-класс

[Victor Alenkov]

вот ещё чтиво: docs.spring.io/spring-boot/docs/current/reference/...

формат в файле ещё можно так писать:
BEAN_NAME=FULL_PATH_BEAN_CLASS

[Stanyslav Glubyshev]

Victor Alenkov: Тут дело в том что spring-boot уже запущен и он ни чего не знает о migrate.jar. Загрузка migrate нужно сделать как то в runtime. Иначе придётся делать сборки под каждого пользователя приложения во своим набором модулей, тупо добавляя их в зависимости core, как не гибко.

[Victor Alenkov]

glubyshev: а в начале вопроса было написано "При запуске приложения..." - как-то не стыкуется

[Victor Alenkov]

и даже в этом случае, я бы модуль migrate.jar сделал бы с использованием spring.factories и посмотрел бы как работает загрузчик контекста, чтобы его дёрнуть.
ну, это если вы не хотите OSGi

[Stanyslav Glubyshev]

Ну да получается, сразу после запуска(spring-boot) нужно как то инициализировать модули(migrate), можно сказать что при запуске. Тут смотря от куда смотреть, инициализация модулей(моих) для меня это ещё запуск моего приложения просто перед ним запускается spring-boot.

[Victor Alenkov]

т.е. на этапе запуска вы знаете какие модули будут грузиться? т.е. они уже есть в classpath. Или их ещё нет и вы дополнительно будете их подгружать после запуска ядра?
Тогда может посмотреть на PropertiesLauncher и для каждого клиента просто делать свой параметр "loader.path"?

[Stanyslav Glubyshev]

На этапе у меня есть путь к папке с jar(никами). Просто приписывается в application.properties вот такая строка modules.path=/home/myuser/java/projects/billing/modules и в core просто @Value("${modules.path}") String path)

[Stanyslav Glubyshev]

loader.path - не работает потому как в core нет зависимости.

[Victor Alenkov]

glubyshev: замените modules.path на loader.path и используйте spring.factories. Это должно дать нужный вам функционал.
зависимости может и не быть в core. Тем более, что хранить application.properties внутри jar как-то не правильно что-ли. Его можно хранить в config-каталоге рядом с запускаемым jar, либо указывая до него путь в командной строке. Либо просто объявите переменную окружения LOADER_PATH.

Если вам уж очень надо хранить application.properties внутри jar, то возпользуйтесь профилями Spring и при запуске включайте например профиль "client", что вызовет загрузку файла application-client.properties и в нём уже указывайте какие модули грузить и прочие настройки, специфичные для клиента

[Stanyslav Glubyshev]

Victor Alenkov: Я с Вами согласен что хранить настройки в jar не правильно. Сделал как вы посоветовали ни как не видит spring модуль migrate. Строку добавил application.properties в loader.path=lib/,/home/myuser/java/projects/billing/modules
Единственное не понял зачем spring.factories в модуле magrate? У него нет своего контекста spring и конфигураций тоже нет. Там несколько entity, repository и пару классов с алгоритмами миграции.

[Stanyslav Glubyshev]

Вот есть проект https://github.com/decebals/pf4j-spring, делает то что нужно, но с сожалению демо не работает(пока сомневаюсь использовать в боевом проекте). Только там он модули назвал плагинами. Но суть та же.

[Victor Alenkov]

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

Например я бы сделал так:
создаю модуль migrate.jar, в нём набор тех самых сущностей, репозиториев и бинов
но, следом я создаю класс MigrateAutoConfiguration, в котором:
1) использую @EntityScan для объявления пакетов, в которых лежат мои сущности (EMF их потом подцепит при загрузке)
2) использую @EnableJpaRepository, в котором укажу пакеты где лежат мои репозитарии (Spring Data их потом тоже использует при загрузке)
3) использую @ComponentScan в котором ничего не укажу, т.к. мой MigrateAutoConfiguration является "родительским" и аннотация будет сканировать в глубину от меня. Либо укажу, если это будет не так (но я так не люблю делать)
4) создам spring.factories, в который пропишу мой MigrateAutoConfiguration
всё! Теперь если подсунуть этот jar модуль, то он сам укажет какие сущности использовать, какие репозитарии для работы с ними будут и какие ещё бины надо поднять.

Если же потребуется что-то сделать в завершении поднятия приложения, то я воспользуюсь интерфейсом org.springframework.context.ApplicationListener, которому передам что-нить из пакета org.springframework.context.event, например org.springframework.context.event.ContextRefreshedEvent и там уже произведу необходимые мне действия

[Victor Alenkov]

проект по ссылке это не Spring Boot и потому это другая философия и другой подход к организации модульности Spring-приложения

[Stanyslav Glubyshev]

Victor Alenkov: Сделал всё как Вы сказали, но ни какого эффекта. Core ни как не видит migrate.
Бины не создаются - в конструкторах прописал вывод в лог сообщений о создании.

Я вот думаю может сделать простенький пример и загрузить на github?

По проекту да он не spring-boot это я так для примера привёл, что бы понятно чего хочется добиться от spring-boot'a.

[Victor Alenkov]

Stanyslav Glubyhev: сделайте.

[Stanyslav Glubyshev]

Ок. Завтра набросаю,а то уже утомился.
Спасибо за Ваши ответы...

[Stanyslav Glubyshev]

Victor Alenkov: Сделал репозиторий https://github.com/Stanyslav/spring-boot-multiple-...
В корне проекта нужно создать директорию module для jar файлов, или изменить путь в application.properties

[Victor Alenkov]

Stanyslav Glubyshev: добавь в Collaborators git-пользователя BorzdeG, чтоб я мог тебе туда push сделать рабочего примера - форкать не хочется.

P.S. был с loader.path неправ - он нифига не грузит как надо.

[Stanyslav Glubyshev]

Victor Alenkov: Добавил

[Victor Alenkov]

Stanyslav Glubyshev: лови коммит. демка запускается через файл demo.bash. Содержимое лежит в каталоге demo.
Это конечно несколько нарушает Spring Boot Way в плане "всё в одном файле, за исключением настроек", но зато работает модульность :)

Answer 2

[Дмитрий Зайцев]

Используйте SPI https://habrahabr.ru/post/118488/, это самый что ни на есть простой и стандартный способ регистрировать ваши модули в вашей глобальной системе. Также советую просто использовать gradle с его модульной системой и стандартным плагином application, который позволяет собирать ваши приложение с модулями (jar). Все jar модули будут находиться в папке lib и прекрасно работать в рамках Spring Boot.

Comments

[Victor Alenkov]

SPI для Spring Boot не очень-то и нужен - у него есть свой механизм загрузки модулей через spring.factories. Другое дело, что если использовать стандартный упаковщик Spring Boot, то фигня получается - он делает one-jar приложение и не хочет видеть внешние библиотеки

Answer 3

[T86]

https://github.com/DISID/disid-proofs/tree/master/...

Comments

[Victor Alenkov]

Это модульность в виде просто разбиения на модули проекта. Автору же надо были модули в виде плагинов к приложению

[T86]

nemerosa.ghost.io/2016/03/04/simple-plugin-system-...