摘要: 原创出处 http://www.iocoder.cn/Fight/Spring-Boot-multi-module-project-practice/ 「芋道源码」欢迎转载,保留摘要,谢谢!
序言:
比起传统复杂的单体工程,使用Maven的多模块配置,可以帮助项目划分模块,鼓励重用,防止POM变得过于庞大,方便某个模块的构建,而不用每次都构建整个项目,并且使得针对某个模块的特殊控制更为方便。接下来,本文将重点阐述SpringBoot在Maven环境的多模块构建过程。本项目传送门: SpringBoot-Integration
一、创建聚合父工程
聚合父工程
然后在 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 需要改造成这样:
<? 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 > <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 >
三、编写子模块代码
结构图
启动类 :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: username: root password: root driver-class -name : com.mysql.jdbc.Driver
结构图
实现类:UserServiceImpl.java (mm-service)
@Service public class UserServiceImpl implements UserService { @Autowired UserRepository userRepository; @Override public List<User> list () { return userRepository.findAll(); } }
结构图
数据层代码:UserRepository.java (mm-repo)
public interface UserRepository extends JpaRepository <User ,String > {}
结构图
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 = "" ; 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 ; } public R () { } }
@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; }
三、运行项目
为了更好的学习效果,建议先下载本项目,在IDE运行成功之后,然后再由自己手工敲一遍。
具体步骤:
2.安装Mysql数据库,然后创建数据库socks,并添加表t_user,插入数据如图:
sock.t_user.PNG
四、运维部署(多模块打包)
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 进行打包。如图:
打包效果如下:
[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
启动效果如下: