Многомодульный проект с Spring Boot

1. Обзор

В этом кратком руководстве мы покажем, как создать многомодульный проект с помощью Spring Boot .

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

Для ознакомления со Spring Boot обратитесь к этой статье .

2. Настройка

Чтобы настроить наш многомодульный проект, давайте создадим простой модуль, используя упаковку pom для объединения нашей библиотеки и модулей приложений в нашей конфигурации Maven:

<groupId>com.foreach</groupId>
<artifactId>parent-multi-module</artifactId>
<packaging>pom</packaging>

Мы создадим два каталога внутри нашего проекта, которые будут отделять модуль приложения от модуля jar библиотеки .

Давайте объявим наши модули в pom.xml :

<modules>
    <module>library</module>
    <module>application</module>
</modules>

3. Библиотечная банка

Для нашего библиотечного модуля мы будем использовать упаковку jar :

<groupId>com.baledung.example</groupId>
<artifactId>library</artifactId>
<packaging>jar</packaging>

Поскольку мы хотим воспользоваться преимуществами управления зависимостями Spring Boot , мы будем использовать spring-boot-starter-parent в качестве родительского проекта, позаботившись о том, чтобы установить <relativePath/> пустое значение , чтобы Maven разрешил родительский pom. xml из репозиториев:

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.6.RELEASE</version>
    <relativePath/>
</parent>

Обратите внимание: если у нас есть собственный родительский проект, мы можем вместо этого импортировать управление зависимостями в виде спецификации (BOM) в разделе < dependencyManagement/> файла pom.xml :

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <type>pom</type>
            <version>2.4.0</version>
            <scope>import</scope>
        </dependency>
    </dependencies>
<dependencyManagement>

Наконец, исходные зависимости будут довольно простыми:

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
</dependencies>

В этом модуле плагин Spring Boot не нужен, потому что его основная функция — создать исполняемый файл über-jar , который нам не нужен и не нужен для библиотеки.

После этого мы готовы разработать сервисный компонент, который будет предоставляться библиотекой :

@Service
public class EvenOddService {

    public String isEvenOrOdd(Integer number) {
        return number % 2 == 0 ? "Even" : "Odd";
    }
}

4. Прикладной проект

Как и наш библиотечный модуль, наш прикладной модуль будет использовать упаковку jar :

<groupId>com.foreach.example</groupId>
<artifactId>application</artifactId>
<packaging>jar</packaging>

И мы воспользуемся преимуществами управления зависимостями Spring Boot , как и раньше:

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.6.RELEASE</version>
    <relativePath/>
</parent>

В дополнение к начальной зависимости Spring Boot мы включим нашу библиотеку jar, созданную в предыдущем разделе :

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.foreach.example</groupId>
        <artifactId>library</artifactId>
        <version>${project.version}</version>
    </dependency>
</dependencies>

Наконец, мы будем использовать плагин Spring Boot :

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

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

Во-первых, он предоставляет встроенный преобразователь зависимостей, который устанавливает номер версии в соответствии с зависимостями Spring Boot .

Во-вторых, он ищет метод main, чтобы пометить его как исполняемый класс.

Наконец, и, возможно, самое главное, он собирает все jar -файлы в пути к классам и создает единый исполняемый über-jar .

Теперь, когда все готово для написания нашего класса приложения и сразу к делу, давайте реализуем контроллер внутри основного класса приложения :

@SpringBootApplication(scanBasePackages = "com.foreach")
@RestController
public class EvenOddApplication {

    private EvenOddService evenOddService;

    // constructor

    @GetMapping("/validate/")
    public String isEvenOrOdd(
      @RequestParam("number") Integer number) {
        return evenOddService.isEvenOrOdd(number);
    }

    public static void main(String[] args) {
        SpringApplication.run(EvenOddApplication.class, args);
    }
}

5. Вывод

В этой статье мы рассмотрели, как реализовать и настроить многомодульный проект и самостоятельно создать jar -библиотеку с помощью Spring Boot .

Как всегда, образцы кода можно найти на GitHub .