腳本之家服務器常用軟件

快捷導航

idea創(chuàng)建Springboot多模塊項目（聚合項目）

更新時間：2024年11月16日 16:57:43 作者：清風凌雪

文章詳細介紹了如何在idea創(chuàng)建Springboot多模塊項目（聚合項目）,包括創(chuàng)建父工程和子工程、編輯pom.xml文件、編寫代碼和測試,還介紹了如何處理Maven視圖中的層級關系,并展示了如何同時啟動多個子項目

1. 創(chuàng)建父工程

1.1 創(chuàng)建一個新項目

1.1.1 方式一

打開 New Project --> Maven Archetype

1.1.2 方式二

或者 New Project -->New project

新版本idea是 New Project -->Java

1.2 編輯父項目pom.xml文件信息

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

  <!-- 項目基本信息:這里作為聚合工程的父工程 -->
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.qfx</groupId>
  <artifactId>springboot-parentProject</artifactId>
  <!-- packaging要設置為pom -->
  <packaging>pom</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>springboot-parentProject</name>
  <description>這是一個基于Maven的SpringBoot聚合項目父工程示例</description>

  <!-- 繼承說明:設置父類,整合第三方常用框架依賴信息(各種依賴信息),這里繼承SpringBoot提供的父工程 -->
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.5.4</version>
    <relativePath /> <!-- lookup parent from repository -->
  </parent>

  <!-- 設置公共參數(shù) -->
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
    <!-- Maven install 時,測試環(huán)境@Test中如果有中文輸出是亂碼，加上這句話試試 -->
    <argLine>-Dfile.encoding=UTF-8</argLine>
  </properties>

  <dependencies>
    <!-- 1.引入springboot核心包,整合SpringMVC Web組件,包含了spring-boot-starter -->
    <!-- 實現(xiàn)原理：Maven依賴繼承關系,相當于把第三方常用Maven依賴信息,在parent項目中已經(jīng)封裝好了 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- 2.引入SpringBoot測試場景啟動器 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <!-- 指定war包或jar包名稱,以此處為準,否則會帶上版本號 -->
    <finalName>${project.name}</finalName>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>

</project>

1.3 刪除多余文件

刪除多余的文件，僅保留.idea、.gitignore和pom.xml文件即可

項目結(jié)構(gòu)如下：

2. 創(chuàng)建子工程

2.1 創(chuàng)建一個新項目

選中父項目,右鍵 --> New -->Module...

2.1.1 方式一

選擇Maven Archetype

2.1.1 方式二

選擇 New Module

新版idea選擇New Module下面的Java

項目結(jié)構(gòu)如下：

2.2 查看父項目的pom.xml

可以看到父項目的pom.xml文件中新增了一個<modules></modules>模塊,里面已經(jīng)引用了剛剛創(chuàng)建的子項目

2.3 編寫子項目pom.xml文件信息

<"1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <!-- 項目基本信息:這里作為聚合工程的子工程 -->
    <modelVersion>4.0.0</modelVersion>
    <artifactId>springboot-child01</artifactId>
    <!-- 打包方式設置為jar,默認jar(可不設置) -->
    <packaging>jar</packaging>
    <description>這是一個基于Maven的SpringBoot聚合項目子工程示例</description>

    <!-- 設置父類,,這里繼承springboot-parentProject父工程 -->
    <parent>
        <groupId>com.qfx</groupId>
        <artifactId>springboot-parentProject</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    
</project>

2.4 Maven視圖展示

如果右側(cè)的Maven部分出現(xiàn)父項目和子項目同級的情況，如下圖：

選中父項目 --> 右鍵 --> Unlink Maven Projects

--> Remove

--> Load Maven Project

可以看到層級可以正常顯示了

3. 測試

3.1 創(chuàng)建子項目啟動類

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

3.2 創(chuàng)建子項目測試類

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("test01")
public class TestController {

    @RequestMapping("hello")
    public String hello() {
        return "Hello world!";
    }
}