Rivalry2

HTML Diff

0 added 0 removed

Original 2026-01-01

Modified 2026-03-10

1 Современный Spring, а если быть точнее - специальный фреймворк Spring Boot, позволяют с минимальными усилиями подключать ту или иную технологию. Необходимость создавать десятки служебных бинов ушла в прошлое.

2 Для этого имеются всевозможные starter-ы - специальные Maven/Gradle зависимости, которые необходимо только подключить в проект.

3 Например, подключив в проект всего одну зависимость:

4 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</artifactId> </dependency>мы имеем уже созданный в контексте DataSource, созданный по свойствам в application.properties и другими классами, вроде NamedParameterJdbcTemplate.

5 Подобные starter основаны на двух специальных функциональностях Spring Boot - AutoConfigurations и Conditional. Покажем, как использовать данные функциональности на примересоздания собственного Spring Boot Starter.

6 Для начала представим, что мы работаем в компании “Марсианская Почта” (com.martianpost). В нашей компании написано множество приложений, для простоты, ровно два - консольное app-example и веб-приложение web-app-example.

7 Создадим эти приложения с помощью<a>Spring Initializr</a>.

8 Исходные коды их можно найти вот<a>здесь</a>.

9 Т. к. мы “Марсианская Почта”, то нам очень важно в каждом приложении знать точное марсианское время (а точнее MSD - Mars Sol Date) для всех приложений.

10 Выпустим Spring Boot Starter, решающий эту задачу. В соответствии с<a>документацией</a>выдадим следующие Maven-координаты:

11 <project ...> <groupId>com.martianpost</groupId> <artifactId>martian-time-spring-boot-starter</artifactId> <version>1.0.0</version> ... </project>Для больших проектов и технологий, можно вынести отдельно, как саму технологию - martian-time, так и автоконфигурацию - martian-time-autoconfigure и сам стартер - martian-time-spring-boot-starter. Но для педагогических целей мы просто всё напишем в starter-е.

12 Из зависимостей мы оставим нам необходим только spring-boot-starter, правда, добавим его с optional-параметром - наш starter не является starter-ом уровнем всего приложения (как, например, spring-boot-starter-web), поэтому spring-boot-starter starter уже будет добавлен в приложение.

13 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> <optional>true</optional> </dependency>Ну и реализуем наш сервис:

14 package com.martianpost.martiantime.service; import org.springframework.stereotype.Service; import java.time.Duration; import java.time.ZonedDateTime; @Service public class MartianTimeService { private static final ZonedDateTime MID_DAY = ZonedDateTime.parse("2000-01-06T00:00:00Z"); public double toMarsSolDate(ZonedDateTime zonedDateTime) { double secondsFromMidDay = (double) Duration.between(MID_DAY, zonedDateTime).getSeconds(); return secondsFromMidDay / 88775.244 + 44795.9998; } }Не забудем про тест:

15 package com.martianpost.martiantime.service; ... @DisplayName("Сервис MartianTimeService") class MartianTimeServiceTest { private final MartianTimeService service = new MartianTimeService(); @DisplayName("должен конвертировать совпадение полночей в 06.01.2000") @Test void shouldConvertZeroDay() { ZonedDateTime zeroDayUtc = ZonedDateTime.parse("2000-01-06T00:00:00Z"); double result = service.toMarsSolDate(zeroDayUtc); assertEquals(44_795.9998, result, 1e-3); } @DisplayName("Должен конвертировать пример с http://jtauber.github.io/mars-clock/") @Test void shouldConvertExampleFromGithub() { ZonedDateTime time = ZonedDateTime.parse("2020-05-01T09:44:43Z"); double result = service.toMarsSolDate(time); assertEquals(52_018.84093, result, 1e-3); } }Обратим внимание, что если мы подключим данную библиотеку, то сервис не создастcя автоматически (хотя аннотация @Service) - для этого как раз и нужны автоконфигурации.

16 Создадим автоконфигурацию для нашего модуля:

17 package com.martianpost.martiantime; ... @Configuration @ComponentScan public class MartianTimeAutoConfiguration { }Данный класс ничем не отличается от обычного класса конфигурации. Его главная задача - найти класс, помеченный @Service и создать его бин.

18 Но кто найдёт этот класс автоконфигурации? Никто, и нужно дополнительно указать эту автоконфигурацию, чтобы Spring Boot нашёл её:

19 # resources/META_INF/spring.factories org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ com.martianpost.martiantime.MartianTimeAutoConfigurationДа, теперь можно попробовать подключить данный модуль в наше консольное приложение:

20 <dependency> <groupId>com.martianpost</groupId> <artifactId>martian-time-spring-boot-starter</artifactId> <version>1.0.0</version> </dependency>и больше ничего!

21 @Autowired private MartianTimeService martianTimeService; @PostConstruct public void printCurrentTime() { double currentMarsSolDate = martianTimeService.toMarsSolDate(ZonedDateTime.now()); System.out.println("MSD: " + currentMarsSolDate); }И получаем:

22 Допустим, нам в каждом веб-приложении необходимо сделать, чтобы это время возвращалось RestController-ом. Но проблема в том, что наш стартер может использоваться как в консольных приложениях, так и в веб-приложениях.

23 ОК, мы это можем сделать с помощью @Conditional. Сначала изменим зависимости нашего starter-а:

24 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <optional>true</optional> </dependency>Добавим контроллер, который будет создаваться только в веб-приложениях:

25 package com.martianpost.martiantime.rest; ... import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication; @ConditionalOnWebApplication @RestController public class MartianTimeController { private final MartianTimeService martianTimeService; public MartianTimeController(MartianTimeService martianTimeService) { this.martianTimeService = martianTimeService; } @GetMapping("/mds/current") public double getMds() { return martianTimeService.toMarsSolDate(ZonedDateTime.now()); } }Обратите внимание, что за магию включения/выключения бина отвечает аннотация @ConditionalOnWebApplication. Помимо неё существует множество других @Conditional аннотаций -<a>ссылка</a>.

26 Проверим, что наше консольное приложение работает:

27 Если вывести список зависимостей консольного приложения, то увидим, что spring-mvc там и не присутствует.

28 А вот подключив в веб-приложение:

29 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>com.martianpost</groupId> <artifactId>martian-time-spring-boot-starter</artifactId> <version>1.0.0</version> </dependency>И запустив, мы получим:

30 GET http://localhost:8080/msd/current 52018.90259483771Магия :-) Но доступная каждому :-)

31 Целиком пример Вы можете посмотреть на<a>GitHub</a>.