SpringBoot多模块项目实践（Multi-Module）

Bertha 。 2022-03-09 05:35 433阅读 0赞

> 序言：  
> 比起传统复杂的单体工程，使用Maven的多模块配置，可以帮助项目划分模块，鼓励重用，防止POM变得过于庞大，方便某个模块的构建，而不用每次都构建整个项目，并且使得针对某个模块的特殊控制更为方便。接下来，本文将重点阐述SpringBoot在Maven环境的多模块构建过程。本项目传送门： [SpringBoot-Integration][]

# 一、创建聚合父工程 #

*  1.首先使用 [Spring Initializr ][Spring Initializr]来快速创建好一个Maven工程。然后**删除无关的文件，只需保留pom.xml 文件。 **
 *                                                       ![20190312145715333.png][]

![聚合父工程][1460000011367496]

*  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>
    
        
        <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 ][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 需要改造成这样：

# 三、编写子模块代码 #

*  # 1. 控制层（mm-web） #

![结构图][1460000011367497]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEyNzcxMjM_size_16_color_FFFFFF_t_70][]

*启动类 ：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） #

![结构图][1460000011367498]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEyNzcxMjM_size_16_color_FFFFFF_t_70 1][]

*实现类：UserServiceImpl.java （mm-service）*

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

*  # 3. 数据层（mm-repo） #

![结构图][1460000011367499]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEyNzcxMjM_size_16_color_FFFFFF_t_70 2][]

*数据层代码：UserRepository.java （mm-repo）*

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

*  # 4. mm-entity (实体模型层) #

![结构图][1460000011367500]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEyNzcxMjM_size_16_color_FFFFFF_t_70 3][]

*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 工程。
 *  ![20190312150009136.png][]

![image.png][]

*  2.安装Mysql数据库，然后创建数据库socks，并添加表t\_user，插入数据如图：
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEyNzcxMjM_size_16_color_FFFFFF_t_70 4][]

![sock.t\_user.PNG][sock.t_user.PNG]

*  1.  配置好整个项目之后，这里只需要运行mm-web模块下的MmWebApplication的启动类就可以了，如正常启动后，访问[http://localhost][http_localhost]:8080 可查询到用户列表信息。如下图：
    2.  ![20190312150041140.png][]

![image.png][image.png 1]

# 四、运维部署（多模块打包） #

## 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）:

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

## 2. 打包工程 ##

首先在IDE打开Maven插件，然后在聚合父工程spring-boot-integration中点击 clean ，然后点击 package 进行打包。如图：

![1460000011934079_w_237_h_238][]![20190312150100296.png][]

打包效果如下：

[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目录：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEyNzcxMjM_size_16_color_FFFFFF_t_70 5][]

![1460000011934080_w_444_h_211][]

## 3. 启动项目 ##

通过命令行启动项目：

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

启动效果如下：

![1460000011934081_w_550_h_426][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEyNzcxMjM_size_16_color_FFFFFF_t_70 6][]

全文到此，想获取更多关于SpringBoot 有趣的案例 请戳 [SpringBoot-从入门到上瘾][SpringBoot-] .

Github源码： [SpringBoot-Integration][]

[SpringBoot-Integration]: https://github.com/yizhiwazi/springboot-socks/tree/master/springboot-integration
[Spring Initializr]: http://www.jianshu.com/p/d2b08a671e27
[20190312145715333.png]: /images/20220309/2aeaa55727a74a8ea5c9c69acebeea07.png
[1460000011367496]: /images/20220309/7e3cf9f9b16642adb712ee532432be59.png
[1460000011367497]: /images/20220309/ba66e5ccf6b149e6b61290721f8208bd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEyNzcxMjM_size_16_color_FFFFFF_t_70]: /images/20220309/2811d5105c5048cdae70cc2d9af6c87c.png
[1460000011367498]: /images/20220309/1ea0094a41e044b0a58bf798598f3f63.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEyNzcxMjM_size_16_color_FFFFFF_t_70 1]: /images/20220309/96a7e1a5d4d74697ba4680da63fe0490.png
[1460000011367499]: https://segmentfault.com/img/remote/1460000011367499
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEyNzcxMjM_size_16_color_FFFFFF_t_70 2]: /images/20220309/6787927585c5415283e6d877806ee582.png
[1460000011367500]: https://segmentfault.com/img/remote/1460000011367500
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEyNzcxMjM_size_16_color_FFFFFF_t_70 3]: /images/20220309/311c0de68b9945bea15a00eabaeea317.png
[springboot-socks]: https://github.com/yizhiwazi/springboot-socks
[20190312150009136.png]: /images/20220309/16b2d23096c845bcbfc244da44439554.png
[image.png]: /images/20220309/5533c85a59ea42728fe611bfd68c7634.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEyNzcxMjM_size_16_color_FFFFFF_t_70 4]: /images/20220309/f59a0d9fed36475abb936dc49c3d5ab0.png
[sock.t_user.PNG]: /images/20220309/c12b3fda01c14ac7bbddc72490631377.png
[http_localhost]: http://localhost/
[20190312150041140.png]: /images/20220309/50954e14b93b420b94dbdafa62be4da0.png
[image.png 1]: /images/20220309/d211fa1d321f46a9b7ffee583d189958.png
[1460000011934079_w_237_h_238]: https://segmentfault.com/img/remote/1460000011934079?w=237&h=238
[20190312150100296.png]: /images/20220309/3dca3aefa349480692d80b7fc46b5586.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEyNzcxMjM_size_16_color_FFFFFF_t_70 5]: /images/20220309/f1b625c4a891460da48adaac0993b129.png
[1460000011934080_w_444_h_211]: /images/20220309/559b031d5be24a22a945cfd4189c837f.png
[1460000011934081_w_550_h_426]: https://segmentfault.com/img/remote/1460000011934081?w=550&h=426
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEyNzcxMjM_size_16_color_FFFFFF_t_70 6]: /images/20220309/77ba9350ddba425d895c1afc2abf02b7.png
[SpringBoot-]: http://www.jianshu.com/u/590460954c1d