SpringBoot多模塊項目實踐（Multi-Module）

序言：
比起傳統復雜的單體工程，使用Maven的多模塊配置，可以幫助項目划分模塊，鼓勵重用，防止POM變得過於龐大，方便某個模塊的構建，而不用每次都構建整個項目，並且使得針對某個模塊的特殊控制更為方便。接下來，本文將重點闡述SpringBoot在Maven環境的多模塊構建過程。本項目傳送門： SpringBoot-Integration

https://segmentfault.com/a/1190000011367492

一、創建聚合父工程

• 1.首先使用 Spring Initializr 來快速創建好一個Maven工程。然后刪除無關的文件，只需保留pom.xml 文件。

• 1. 然后在 pom.xml 里面聲明該父工程包含的子模塊。（其它信息就不逐一講述了，諸如繼承SpringBoot官方父工程以及統一依賴管理 請查看下面的注釋說明）

<?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"> <!-- 基本信息 --> <description>SpringBoot 多模塊構建示例</description> <modelVersion>4.0.0</modelVersion> <name>springboot-integration</name> <packaging>pom</packaging> <!-- 項目說明：這里作為聚合工程的父工程 --> <groupId>com.hehe</groupId> <artifactId>springboot-integration</artifactId> <version>1.0.0.RELEASE</version> <!-- 繼承說明：這里繼承SpringBoot提供的父工程 --> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.7.RELEASE</version> <relativePath/> </parent> <!-- 模塊說明：這里聲明多個子模塊 --> <modules> <module>mm-web</module> <module>mm-service</module> <module>mm-repo</module> <module>mm-entity</module> </modules> <!-- 版本說明：這里統一管理依賴的版本號 --> <dependencyManagement> <dependencies> <dependency> <groupId>com.hehe</groupId> <artifactId>mm-web</artifactId> <version>0.0.1-SNAPSHOT</version> </dependency> <dependency> <groupId>com.hehe</groupId> <artifactId>mm-service</artifactId> <version>0.0.1-SNAPSHOT</version> </dependency> <dependency> <groupId>com.hehe</groupId> <artifactId>mm-repo</artifactId> <version>0.0.1-SNAPSHOT</version> </dependency> <dependency> <groupId>com.hehe</groupId> <artifactId>mm-entity</artifactId> <version>0.0.1-SNAPSHOT</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.42</version> </dependency> </dependencies> </dependencyManagement> </project> 

二、創建子模塊（module）

注：這里是使用IDEA來創建子模塊，使用Eclipse的小伙伴可通過 Spring Initializr 構建，然后復制去進去父工程根目錄即可。

• 1.對着父工程右鍵 - New - Module - > 輸入 mm-web

• 2.對着父工程右鍵 - New - Module - > 輸入 mm-service

• 3.對着父工程右鍵 - New - Module - > 輸入 mm-repo

• 4.對着父工程右鍵 - New - Module - > 輸入 mm-entity

• 1~4 步驟完成后，分別調整它們的pom.xml 以繼承上面的父工程。

例如mm-web模塊的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"> <modelVersion>4.0.0</modelVersion> <!-- 基本信息 --> <groupId>com.hehe</groupId> <artifactId>mm-web</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>mm-web</name> <!-- 繼承本項目的父工程 --> <parent> <groupId>com.hehe</groupId> <artifactId>springboot-integration</artifactId> <version>1.0.0.RELEASE</version> </parent> <!-- Web模塊相關依賴 --> <dependencies> <dependency> <groupId>com.hehe</groupId> <artifactId>mm-service</artifactId> </dependency> <dependency> <groupId>com.hehe</groupId> <artifactId>mm-entity</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> </project> 

三、編寫子模塊代碼

• 1. 控制層（mm-web）

啟動類 ：MmWebApplication.java （mm-web）

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

控制器：UserController.java （mm-web ）

@RestController @RequestMapping("/user/*") public class UserController { @Autowired UserService userService; @GetMapping("list") public R list() { try { return R.isOk().data(userService.list()); } catch (Exception e) { return R.isFail(e); } } }

配置文件：application.yml （mm-web）

spring: datasource: url: jdbc:mysql://localhost:3306/socks?useSSL=false username: root password: root driver-class-name: com.mysql.jdbc.Driver 

• 2. 業務層（mm-service）

實現類：UserServiceImpl.java （mm-service）

@Service public class UserServiceImpl implements UserService { @Autowired UserRepository userRepository; @Override public List<User> list() { return userRepository.findAll(); } }

• 3. 數據層（mm-repo）

數據層代碼：UserRepository.java （mm-repo）

public interface UserRepository extends JpaRepository<User,String> { } 

• 4. mm-entity (實體模型層)

R.java 作為統一返回的Bean對象

package com.hehe.integration.common; import java.io.Serializable; public class R<T> implements Serializable { private static final long serialVersionUID = -4577255781088498763L; private static final int OK = 0; private static final int FAIL = 1; private static final int UNAUTHORIZED = 2; private T data; //服務端數據 private int status = OK; //狀態碼 private String msg = ""; //描述信息 //APIS public static R isOk(){ return new R(); } public static R isFail(){ return new R().status(FAIL); } public static R isFail(Throwable e){ return isFail().msg(e); } public R msg(Throwable e){ this.setMsg(e.toString()); return this; } public R data(T data){ this.setData(data); return this; } public R status(int status){ this.setStatus(status); return this; } //Constructors public R() { } //Getter&Setters } 

@Entity @Table(name = "T_USER") public class User { @Id @Column(name = "USERID") private String userId; @Column(name = "USERNAME") private String username; @Column(name = "PASSWORD") private String password; //Getter&Setters }

三、運行項目

為了更好的學習效果，建議先下載本項目，在IDE運行成功之后，然后再由自己手工敲一遍。

具體步驟：

• 1.首先下載好 springboot-socks，然后打開springboot-integration 工程。

• 2.安裝Mysql數據庫，然后創建數據庫socks，並添加表t_user，插入數據如圖：

• 1. 配置好整個項目之后，這里只需要運行mm-web模塊下的MmWebApplication的啟動類就可以了，如正常啟動后，訪問http://localhost:8080 可查詢到用戶列表信息。如下圖：

四、運維部署（多模塊打包）

1. 添加打包插件

注意：多模塊項目僅僅需要在啟動類所在的模塊添加打包插件即可！！不要在父類添加打包插件，因為那樣會導致全部子模塊都使用spring-boot-maven-plugin的方式來打包（例如BOOT-INF/com/hehe/xx），而mm-web模塊引入mm-xx 的jar 需要的是裸露的類文件，即目錄格式為（/com/hehe/xx）。

本案例的啟動模塊是 mm-web ， 只需在它的pom.xml 添加打包插件（spring-boot-maven-plugin）:

  
    <!--多模塊打包：只需在啟動類所在模塊的POM文件：指定打包插件 --> <build> <plugins> <plugin> <!--該插件主要用途：構建可執行的JAR --> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build>

2. 打包工程

首先在IDE打開Maven插件，然后在聚合父工程spring-boot-integration中點擊 clean ，然后點擊 package 進行打包。如圖：

打包效果如下：

[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO] 
[INFO] spring-boot-integration ............................ SUCCESS [  0.000 s] [INFO] mm-entity .......................................... SUCCESS [ 1.915 s] [INFO] mm-repo ............................................ SUCCESS [ 0.235 s] [INFO] mm-service ......................................... SUCCESS [ 0.218 s] [INFO] mm-web ............................................. SUCCESS [ 0.891 s] [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 3.798 s [INFO] Finished at: 2017-10-18T17:17:02+08:00 [INFO] Final Memory: 35M/300M [INFO] ------------------------------------------------------------------------

打包地址默認在Target目錄：

3. 啟動項目

通過命令行啟動項目：

xx\mm-web\target>java -jar mm-web-0.0.1-SNAPSHOT.jar

啟動效果如下：

全文到此，想獲取更多關於SpringBoot 有趣的案例 請戳 SpringBoot-從入門到上癮 .

Github源碼： SpringBoot-Integration