Spring Boot 多模块项目实践（附打包方法）

刺骨的言语ヽ痛彻心扉 2021-08-19 13:11 327阅读 0赞

点击上方 [Java后端][Java]，选择 设为星标

优质文章，及时送达

![format_png][]

作者 | yizhiwazi

链接 | www.jianshu.com/p/59ceea4f029d

## **序言：** ##

比起传统复杂的单体工程，使用Maven的多模块配置，可以帮助项目划分模块，鼓励重用，防止POM变得过于庞大，方便某个模块的构建，而不用每次都构建整个项目，并且使得针对某个模块的特殊控制更为方便。

接下来，本文将重点阐述SpringBoot在Maven环境的多模块构建过程。

本项目传送门：

> https://github.com/yizhiwazi/springboot-socks/tree/master/springboot-integration

## **一、创建聚合父工程** ##

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

![format_png 1][]

2.然后在 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 构建，然后复制去进去父工程根目录即可。

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

![format_png 2][]

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

![format_png 3][]

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

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

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

![format_png 4][]

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

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

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

![format_png 5][]

R.java 作为统一返回的Bean对象

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 工程。

![format_png 6][]

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

![format_png 7][]

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

![format_png 8][]

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

### **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 进行打包。如图：

![format_png 9][]

打包效果如下：

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

![format_png 10][]

### **3.启动项目** ###

通过命令行启动项目：

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

启动效果如下：

![format_png 11][]

--------------------

【END】

如果看到这里，说明你喜欢这篇文章，请**转发****、点赞**。微信搜索「web\_resource」，关注后回复「进群」或者扫描下方二维码即可进入无广告交流群。

**↓扫描二维码进群↓**

![format_png 12][]

--------------------

**推****荐****阅****读 **

***1.*** [你在公司项目里面看过哪些操蛋的代码？][Link 1]

***2.*** [你知道 Spring Batch 吗？][Spring Batch]

***3.*** [面试题：Lucene、Solr、ElasticSearch][Lucene_Solr_ElasticSearch]

***4. ***[3 分钟带你彻底搞懂 Java 泛型背后的秘密][3 _ Java]

***5.***  [团队开发中 Git 最佳实践][Git]

![format_png 13][]

**喜****欢****文****章****，****点****个****在看 **![format_png 14][]

[Java]: https://blog.csdn.net/qq_37217713/article/details/101445094
[format_png]: /images/20210731/1b12d6240eec4cb9804a4067606fd2ff.png
[format_png 1]: /images/20210731/b566fa49116449ea918cc9e78b0a1353.png
[format_png 2]: /images/20210731/08fe9a428f814e53b04f3b951658ed79.png
[format_png 3]: /images/20210731/ca09ed5f28984704a245f12d5b2e9e52.png
[format_png 4]: /images/20210731/c3dec532dea14406a263b3413009b4de.png
[format_png 5]: /images/20210731/b43707773c3a4b5ba689400e2cd47448.png
[format_png 6]: /images/20210731/83561711b9b4410ca731b0724ead9c84.png
[format_png 7]: /images/20210731/6d073716da644610b26c877fd4366c80.png
[format_png 8]: /images/20210731/61ae45f218ec433c88360ac30a5051ec.png
[format_png 9]: /images/20210731/ff5c0c137de541aebc39479004bcf8f9.png
[format_png 10]: /images/20210731/957d8fc89d7f4a1083dcfb3ed1881c95.png
[format_png 11]: /images/20210731/2d96329895e2465db09c2606cb4de06d.png
[format_png 12]: /images/20210731/db0798b70b8a4e1a86126dc5051a0490.png
[Link 1]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0dab1bf97a220da927bb5120fbcf13d1dac380266fcf33af926fdfd6d3fcaed4c44d6c1d8b&idx=1&mid=2247490712&scene=21&sn=601de4d1e3e00360763e3978ecb3549c#wechat_redirect
[Spring Batch]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0dab1bf97a220dfce5bdf424b75ba73e5a7aaac7c3556f3af69bb25e4e7c5fce8f6526a05b&idx=2&mid=2247490712&scene=21&sn=cf30d4ea72a8f1d41bb739cbd9cf7cfc#wechat_redirect
[Lucene_Solr_ElasticSearch]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0dab1bf97a220d3175e0b5d75ff5886d6e6a7a556db8d53849e237c377f15b43d2744ac3ec&idx=3&mid=2247490712&scene=21&sn=43d1e0cc83c5206de631af27f711146f#wechat_redirect
[3 _ Java]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0dabeef97a22f8a54eb5fc998512e1491e425831d4b2c98f63063603edb1aa03081264fe54&idx=3&mid=2247490669&scene=21&sn=134edfa708a8498eac2eccae2c09e441#wechat_redirect
[Git]: https://blog.csdn.net/qq_37217713/article/details/102481709
[format_png 13]: /images/20210731/5b5fc449e73047338ff071d28ee67792.png
[format_png 14]: /images/20210731/ea6f73fc4fcd4c1f96760710875fcaa0.png