最詳細的 Spring Boot 多模塊開發與排坑指南

2021-02-21 Java知音
創建項目

創建一個 SpringBoot 項目非常的簡單，簡單到這裡根本不用再提。你可以在使用 IDEA 新建項目時直接選擇 Spring Initlalize 創建一個 Spring Boot 項目，也可以使用 Spring 官方提供的 Spring Boot 項目生成頁面得到一個項目。

下面介紹一下使用 Spring 官方生成的方式，如果你已經有了一個 Spring Boot 項目，這部分可以直接跳過。

打開 https://start.spring.io/ 

填寫 group 和 Artifact 信息，選擇依賴（我選擇了 Spring Web 和 Lombok ）。

spring 官網創建初始項目

打開下載的項目，刪除無用的 .mvn 文件夾，mvnw 、 mvnw.cmd 、HELP.md 文件。

到這裡已經得到了一個 Spring Boot 初始項目了，我們直接導入到 IDEA 中，看一眼 pom.xml 的內容。

<?xml version="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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.2.5.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.wdbyte</groupId>
	<artifactId>springboot-module-demo</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>springboot-module-demo</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<java.version>1.8</java.version>
	</properties>

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

		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
			<exclusions>
				<exclusion>
					<groupId>org.junit.vintage</groupId>
					<artifactId>junit-vintage-engine</artifactId>
				</exclusion>
			</exclusions>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>
</project>
把目錄結構調整成自己想要的結構，然後添加 controller 和 entity 用於測試。
項目目錄結構
ProductController 類原始碼。
@RestController
@RequestMapping("/product")
public class ProductController {

    /**
     * 獲取商品列表
     *
     * @return
     */
    @GetMapping("/list")
    public Map list() {
        // 模擬查詢商品邏輯
        Product product = new Product();
        product.setProductName("小米粥");
        product.setProductPrice(new BigDecimal(2.0));
        product.setProductStock(100);

        Map<String, Object> resultMap = new HashMap<>();
        resultMap.put("code", 000);
        resultMap.put("message", "成功");
        resultMap.put("data", Arrays.asList(product));
        return resultMap;
    }
}

Product 類原始碼。
@Data
public class Product {
    /** 商品名稱. */
    private String productName;
    /** 商品價格. */
    private BigDecimal productPrice;
    /** 商品庫存。*/
    private int productStock;
}
模塊化
藉助 IDEA 工具可以快速的把項目改造成 maven 多模塊，這裡我們把準備測試 demo 拆分為 common 和 web 兩個模塊，common 模塊存放實體類。web 模塊存放 controller 層（這裡項目雖小，拆分只是為了演示）。話不多說，直接開始。
配置主 pom.xml 打包方式 為 pom
<?xml version="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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!-- 配置主 pom 打包方式為 pom -->
    <packaging>pom</packaging>
    ....
    ....
創建 common 模塊
項目直接 new -> module。
創建模塊
選擇 maven -> next，填寫模塊名稱。
填寫模塊名稱
繼續 next 完成模塊創建。
創建 web 模塊
web 模塊的創建和 common 模塊如出一轍，不再贅述。完成兩個模塊的創建之後，你會發現你的主 pom.xml 文件裡自動添加了 module 部分。
<modules>
    <module>product-common</module>
	<module>product-web</module>
</modules>
移動代碼到指定模塊
移動 Product.java 到 product-common 模塊，其他部分代碼和 resource 部分直接移動到 product-web 模塊，移動完後你的代碼結構是這個樣子。
多模塊目錄結構
到這裡，多模塊已經拆分完成了， 但是 ProductController  代碼裡的紅色警告讓你發現事情還沒有結束。
依賴管理處理依賴問題
你發現了代碼裡的紅色警告，不過你也瞬間想到了是因為把 Product  類移動到了 product-common 模塊，導致這裡引用不到了。
紅色警告
然後你查看了下 product-common 模塊的 pom.xml 裡的內容。
<?xml version="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">
    <parent>
        <artifactId>springboot-module-demo</artifactId>
        <groupId>com.wdbyte</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>product-common</artifactId>
</project>
機智的在 Product-web 模塊的 pom.xml 裡引入 product-common，手起鍵落，輕鬆搞定。
<?xml version="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">
    <parent>
        <artifactId>springboot-module-demo</artifactId>
        <groupId>com.wdbyte</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>product-web</artifactId>
    <dependencies>
        <dependency>
            <groupId>com.wdbyte</groupId>
            <artifactId>product-common</artifactId>
        </dependency>
    </dependencies>
</project>
滿心歡喜的你快速的點擊 Build->  Build Project，得到的 Error 警告刺痛了頂著黑眼圈的你。
不過你還是迅速定位了問題，查看 maven 依賴，你發現是因為沒有指定 product-common 依賴的版本號。
報錯信息
原來如此，因為沒有指定版本號，我們指定上不就完事了嘛。在最外層的主 pom.xml 中添加 <dependencyManagement> 添加上指定依賴和要指定的版本號。
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.wdbyte</groupId>
                <artifactId>product-common</artifactId>
                <version>0.0.1-SNAPSHOT</version><!-- maven 打包默認 0.0.1-SNAPSHOT 版本 -->
            </dependency>
        </dependencies>
    </dependencyManagement>
刷新 maven ，發現項目已經不報錯了，編譯成功，運行啟動類，熟悉的 Spring logo 又出現在眼前。
優化依賴
是的，Spring Boot 應用在改造成多模塊後成功運行了起來，但是你貌似發現一個問題，模塊 common 和模塊 web 都繼承了主 pom ，主 pom 中有 Lombok 、Spring Boot Web 和  Spring Boot Test 依賴，而 common 模塊裡只用到了 Lombok 啊，卻一樣繼承了 Spring Boot 其他依賴，看來還是要改造一把。
只有 common 模塊用到的依賴移動到 common 模塊。
<?xml version="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">
    <parent>
        <artifactId>springboot-module-demo</artifactId>
        <groupId>com.wdbyte</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>product-common</artifactId>
    <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>
</project>
只有 web 模塊用到的依賴移動到 web 模塊。
<?xml version="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">
    <parent>
        <artifactId>springboot-module-demo</artifactId>
        <groupId>com.wdbyte</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>product-web</artifactId>
    
    <dependencies>
        <dependency>
            <groupId>com.wdbyte</groupId>
            <artifactId>product-common</artifactId>
        </dependency>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>
</project>
抽取用到的版本號到 <properties>，這裡抽取 common 模塊的依賴版本。
到這裡最外層主 pom 的內容是這樣的。
<?xml version="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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <packaging>pom</packaging>
    <modules>
        <module>product-common</module>
        <module>product-web</module>
    </modules>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.5.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.wdbyte</groupId>
    <artifactId>springboot-module-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-module-demo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <product-common.version>0.0.1-SNAPSHOT</product-common.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.wdbyte</groupId>
                <artifactId>product-common</artifactId>
                <version>${product-common.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>
看似完美，重新  Build->  Build Project ，發現一切正常，運行發現一切正常，訪問正常。
訪問接口打包編譯
好了，終於到了最後一步了，你感覺到勝利的曙光已經照到了頭頂，反射出耀眼的光芒。接著就是 mvn package。
[INFO] springboot-module-demo .... SUCCESS [  2.653 s]
[INFO] product-common .. FAILURE [  2.718 s]
[INFO] product-web  SKIPPED
[INFO] --
[INFO] BUILD FAILURE
[INFO] --
[INFO] Total time: 6.084 s
[INFO] Finished at: 2020-03-19T08:15:52+08:00
[INFO] Final Memory: 22M/87M
[INFO] --
[ERROR] Failed to execute goal org.springframework.boot:spring-boot-maven-plugin:2.2.5.RELEASE:repackage (repackage) on project product-common: Execution repackage of goal org.springframework.boot:spring-boot-m
aven-plugin:2.2.5.RELEASE:repackage failed: Unable to find main class -> [Help 1]
[ERROR]
ERROR 讓你傷心了，但是你還是從報錯中尋找到了一些蛛絲馬跡，你看到是  spring-boot-maven-plugin 報出的錯誤。重新審視你的主 pom 發現 <build> 編譯插件用到了 spring-boot-maven-plugin。
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
略加思索後將這段移動到 web 模塊的 pom，因為這是 Spring Boot 的打包方式，現在放在主 pom 中所有的模塊都會繼承到，那麼對於 common 模塊來說是肯定不需要的。
移動後重新打包，不管你是運行命令 mvn package 還是雙擊 IDEA 中的 maven 管理中的 package ，想必這時候你都已經打包成功了
IDEA 打包
在 web 模塊下的目錄 target 裡也可以看到打包後的 jar 文件 product-web-0.0.1-SNAPSHOT.jar。可以使用 java 命令直接運行。
$ \springboot-module-demo\product-web\target>java -jar product-web-0.0.1-SNAPSHOT.jar

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.2.5.RELEASE)

2020-03-19 08:33:03.337  INFO 15324 --- [           main] com.wdbyte.Application                   : Starting Application v0.0.1-SNAPSHOT on DESKTOP-8SCFV4M with PID 15324 (C:\Users\83981\Desktop\springboot-mod
ule-demo\product-web\target\product-web-0.0.1-SNAPSHOT.jar started by 83981 in C:\Users\83981\Desktop\springboot-module-demo\product-web\target)
2020-03-19 08:33:03.340  INFO 15324 --- [           main] com.wdbyte.Application                   : No active profile set, falling back to default profiles: default
2020-03-19 08:33:04.410  INFO 15324 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
2020-03-19 08:33:04.432  INFO 15324 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2020-03-19 08:33:04.432  INFO 15324 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.31]
2020-03-19 08:33:04.493  INFO 15324 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2020-03-19 08:33:04.493  INFO 15324 --- [           main] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 1107 ms
2020-03-19 08:33:04.636  INFO 15324 --- [           main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor'
2020-03-19 08:33:04.769  INFO 15324 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2020-03-19 08:33:04.772  INFO 15324 --- [           main] com.wdbyte.Application                   : Started Application in 1.924 seconds (JVM running for 2.649)
2020-03-19 08:33:07.087  INFO 15324 --- [extShutdownHook] o.s.s.concurrent.ThreadPoolTaskExecutor  : Shutting down ExecutorService 'applicationTaskExecutor'
想必少了點什麼，多模塊不僅為了結構清晰，更是為了其他項目可以復用模塊（如 common 模塊），現在這個時候如果你新打開了一個項目，依賴 common  發現是引用不到的，因為你需要把模塊安裝到本地倉庫。可以點擊 IDEA -> Maven -> install，也可以通過 maven 命令。
# -Dmaven.test.skip=true 跳過測試
# -U 強制刷新
# clean 清理緩存
# install 安裝到本地倉庫
$ \springboot-module-demo> mvn -Dmaven.test.skip=true -U clean install
重新引入發現沒有問題了。
文中代碼已經上傳到 Github：niumoo/springboot

相關焦點

  • Spring 和 Spring Boot 最核心的 3 大區別,詳解!
    它包含一些很好的功能，如依賴注入和開箱即用的模塊，如：Spring JDBC 、Spring MVC 、Spring Security、 Spring AOP 、Spring ORM 、Spring Test，這些模塊縮短應用程式的開發時間，提高了應用開發的效率例如，在Java Web開發的早期階段，我們需要編寫大量的代碼來將記錄插入到資料庫中。
  • Spring Boot 和 Spring 到底有啥區別?
    它包含一些很好的功能，如依賴注入和開箱即用的模塊，如：Spring JDBC 、Spring MVC 、Spring Security、 Spring AOP 、Spring ORM 、Spring Test這些模塊縮短應用程式的開發時間，提高了應用開發的效率例如，在Java Web開發的早期階段，我們需要編寫大量的代碼來將記錄插入到資料庫中。
  • Spring Boot 開發 Web 應用
    （點擊上方公眾號，可快速關注）來源：翟永超，blog.didispace.com/springbootweb/
  • Spring Boot 整合 Web 開發
    ;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.boot.web.servlet.ServletComponentScan;@SpringBootApplication@ServletComponentScanpublic class App {
  • Spring Boot Web 開發註解篇
    Spring MVC 是 Spring Web 重要的模塊。內容包括 MVC 模式的實現和 RESTful 服務的支持。2.1 Spring MVC 體系溫故知新spring-webmvc 模塊裡面包：- org.springframework.web.servlet 提供與應用程式上下文基礎結構集成的 Servlet，以及 Spring web MVC 框架的核心接口和類。
  • Spring Boot 與 OAuth2 官方最詳細教程
    /tutorials/spring-boot-oauth2/)譯者：[nycgym] (https://github.com/nycgym)校對：本指南將向你展示如何使用[OAuth2] (https://tools.ietf.org/html/rfc6749)和[Spring Boot] (https://projects.spring.io/spring-boot
  • 面試題:說一下Spring 和 Spring Boot 的區別
    它包含一些很好的功能，如依賴注入和開箱即用的模塊，如：SpringJDBC、SpringMVC、SpringSecurity、SpringAOP、SpringORM、SpringTest，這些模塊縮短應用程式的開發時間，提高了應用開發的效率例如，在 JavaWeb開發的早期階段
  • Spring、Spring MVC、Spring Boot三者的關係還傻傻分不清楚?
    Spring Framework最重要的特性是依賴注入所有Spring模塊的核心是依賴注入或IOC控制反轉為什麼這很重要？因為，當正確使用DI或IOC時，我們可以開發鬆耦合的應用程式。鬆耦合的應用程式可以很方便進行單元測試。舉個簡單的例子。
  • Spring Boot WebFlux Quick Start
    Spring Boot 2.0 包括一個新的 spring-webflux 模塊。該模塊包含對響應式 HTTP 和 WebSocket 客戶端的支持，以及對 REST，HTML 和 WebSocket 交互等程序的支持。一般來說，Spring MVC 用於同步處理，Spring Webflux 用於異步處理。
  • Spring Boot 2.0 的快速入門(圖文教程)
    前面模塊會在本文中一一介紹，後面這些模塊本文不會涉及，如需自行請參看 Spring Boot 官方文檔。在上述技術選型中，需要為公司業務的要求和團隊技能選擇最有效最合適的設計方案、架構和編程模型。1.1.3 Spring Boot 應用場景Spring Boot 模塊眾多，代表著應用場景也非常廣泛，包括 Web 應用、SOA 及微服務等。
  • Spring Boot (十九):使用 Spring Boot Actuator 監控應用
    微服務的特點決定了功能模塊的部署是分布式的，大部分功能模塊都是運行在不同的機器上，彼此通過服務調用進行交互，前後臺的業務流會經過很多個微服務的處理和傳遞，出現了異常如何快速定位是哪個環節出現了問題？在這種框架下，微服務的監控顯得尤為重要。
  • Spring Boot項目打包部署最佳實踐
    </project><dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-tomcat</artifactId> <scope&
  • Spring Boot 中文文檔(二)(官方文檔翻譯 基於1.5.2.RELEASE)
    spring-boot-antlib「AntLib」模塊也可用於幫助Ant創建可執行文件。要聲明依賴關係，典型的ivy.xml文件將如下所示：spring-boot-devtools模塊還支持快速重新啟動應用程式。有關詳細信息，請參閱第20章「開發人員工具」部分和熱插拔「操作方法」。Spring Boot包括一組額外的工具，可以使應用程式開發體驗更加愉快。 spring-boot-devtools模塊可以包含在任何項目中，以提供額外的開發時功能。
  • Spring Boot(十七):使用 Spring Boot 上傳文件
    <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.0.RELEASE<
  • Spring Boot 2.0正式發布,新特性解讀
    在這段時間裡，雖然 Spring 社區推出了那麼多的輪子項目，但是真正在國內得到廣泛應用的並不多，很多開發團隊依然只是使用最核心的 IOC 和 AOP，並根據自己團隊的技術棧情況整合出更適合自身的腳手架來進行系統開發。2014 年 4 月 1 日，Spring Boot 發布了第一個正式版本。
  • Spring boot項目搭建(前端到資料庫,超詳細),大神勿進!
    實際開發中會有其他什麼O之類的，比如說：DTO/VO/BO。有的項目使用的是DTO，有的可能使用的是BO等。進入項目組了，按照項目組的開發規範來就行了，實在不理解的話，建議你先學會模仿別人是怎麼做的。廢話不多說，直接開幹！
  • 使用Spring Boot Operator將Spring Boot部署到Kubernetes
    Java項目打包鏡像用Maven/Gradle插件比較多，我的另一篇文章構建Spring Boot的Docker鏡像[2]有介紹，這裡再介紹一個新的Google開源的插件Jib，該插件使用起來比較方便。
  • Java程式設計師學習Spring Boot,先看看這16條實踐總結吧~
    Spring Boot是最流行的用於開發微服務的Java框架。在本文主要分享的是在專業開發中使用Spring Boot所採用的最佳實踐。這些內容是基於個人經驗和一些熟知的Spring Boot專家的文章。
  • Spring Boot 如何自定義Starter,你知道嗎?
    helloworld-spring-boot-starter-autoconfigure（以下簡稱autoconfigure）：該模塊用來實現 Helloworld 的自動配置功能，它的打包方式為 jar；helloworld-spring-boot-starter
  • Spring Boot 永遠滴神!10分鐘快速入門
    WEB 應用，Spring Boot 是啟動 Spring 項目最快最流行的方式了。命令行界面：這個可以讓我們無須構建項目只寫代碼就可以完成完整的應用程式；Actuator：應用監測和監控；搞清楚了 Spring Boot 其實就是一種開發 Spring 應用程式的快捷方式，那接下來，讓我們一起來感受疾風吧，看看它到底有多便捷。