创建项目
创建一个 SpringBoot 项目非常的简单,简单到这里根本不用再提。你可以在使用 IDEA 新建项目时直接选择 Spring Initlalize
创建一个 Spring Boot 项目,也可以使用 Spring 官方提供的 Spring Boot 项目生成页面得到一个项目。
下面介绍一下使用 Spring 官方生成的方式,如果你已经有了一个 Spring Boot 项目,这部分可以直接跳过。
打开 https://start.spring.io/
-
填写
group
和Artifact
信息,选择依赖(我选择了 Spring Web 和 Lombok )。 点击
Generate
按钮下载项目。打开下载的项目,删除无用的
.mvn
文件夹,mvnw
、mvnw.cmd
、HELP.md
文件。
到这里已经得到了一个 Spring Boot 初始项目了,我们直接导入到 IDEA 中,看一眼 pom.xml
的内容。
4.0.0 org.springframework.boot spring-boot-starter-parent 2.2.5.RELEASE com.wdbyte springboot-module-demo 0.0.1-SNAPSHOT springboot-module-demo Demo project for Spring Boot 1.8 org.springframework.boot spring-boot-starter-web org.projectlombok lombok true org.springframework.boot spring-boot-starter-test test org.junit.vintage junit-vintage-engine org.springframework.boot spring-boot-maven-plugin
把目录结构调整成自己想要的结构,然后添加 controller
和 entity
用于测试。
ProductController 类源代码。
@RestController@RequestMapping("/product")publicclass ProductController { /** * 获取商品列表 * * @return */ @GetMapping("/list") public Map list() { // 模拟查询商品逻辑 Product product = new Product(); product.setProductName("小米粥"); product.setProductPrice(new BigDecimal(2.0)); product.setProductStock(100); Map resultMap = new HashMap<>(); resultMap.put("code", 000); resultMap.put("message", "成功"); resultMap.put("data", Arrays.asList(product)); return resultMap; }}
Product 类源代码。
@Datapublicclass Product { /** 商品名称. */ private String productName; /** 商品价格. */ private BigDecimal productPrice; /** 商品库存。*/ privateint productStock;}
模块化
借助 IDEA 工具可以快速的把项目改造成 maven 多模块,这里我们把准备测试 demo 拆分为 common 和 web 两个模块,common 模块存放实体类。web 模块存放 controller 层(这里项目虽小,拆分只是为了演示)。话不多说,直接开始。
-
配置主 pom.xml 打包方式 为 pom
4.0.0 pom .... .... -
创建 common 模块
项目直接 new -> module。
选择 maven -> next,填写模块名称。
继续 next 完成模块创建。
-
创建 web 模块
web 模块的创建和 common 模块如出一辙,不再赘述。完成两个模块的创建之后,你会发现你的主 pom.xml 文件里自动添加了 module 部分。
product-common product-web -
移动代码到指定模块
移动
Product.java
到product-common
模块,其他部分代码和 resource 部分直接移动到product-web
模块,移动完后你的代码结构是这个样子。
到这里,多模块已经拆分完成了, 但是 ProductController
代码里的红色警告让你发现事情还没有结束。
依赖管理
处理依赖问题
你发现了代码里的红色警告,不过你也瞬间想到了是因为把 Product
类移动到了 product-common
模块,导致这里引用不到了。
然后你查看了下 product-common
模块的 pom.xml 里的内容。
springboot-module-demo com.wdbyte 0.0.1-SNAPSHOT 4.0.0 product-common
机智的在 Product-web
模块的 pom.xml 里引入 product-common,手起键落,轻松搞定。
springboot-module-demo com.wdbyte 0.0.1-SNAPSHOT 4.0.0 product-web com.wdbyte product-common
满心欢喜的你快速的点击 Build-> Build Project,得到的 Error 警告刺痛了顶着黑眼圈的你。
不过你还是迅速定位了问题,查看 maven 依赖,你发现是因为没有指定 product-common
依赖的版本号。
原来如此,因为没有指定版本号,我们指定上不就完事了嘛。在最外层的主 pom.xml 中添加
添加上指定依赖和要指定的版本号。
com.wdbyte product-common 0.0.1-SNAPSHOT
刷新 maven ,发现项目已经不报错了,编译成功,运行启动类,熟悉的 Spring logo 又出现在眼前。
优化依赖
是的,Spring Boot 应用在改造成多模块后成功运行了起来,但是你貌似发现一个问题,模块 common
和模块 web
都继承了主 pom ,主 pom 中有 Lombok 、Spring Boot Web 和 Spring Boot Test 依赖,而 common
模块里只用到了 Lombok 啊,却一样继承了 Spring Boot 其他依赖,看来还是要改造一把。
-
只有
common
模块用到的依赖移动到common
模块。springboot-module-demo com.wdbyte 0.0.1-SNAPSHOT 4.0.0 product-common org.projectlombok lombok true -
只有
web
模块用到的依赖移动到web
模块。springboot-module-demo com.wdbyte 0.0.1-SNAPSHOT 4.0.0 product-web com.wdbyte product-common org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-test test org.junit.vintage junit-vintage-engine -
抽取用到的版本号到
,这里抽取common
模块的依赖版本。到这里最外层主 pom 的内容是这样的。
4.0.0 pom product-common product-web org.springframework.boot spring-boot-starter-parent 2.2.5.RELEASE com.wdbyte springboot-module-demo 0.0.1-SNAPSHOT springboot-module-demo Demo project for Spring Boot 1.8 0.0.1-SNAPSHOT com.wdbyte product-common ${product-common.version} org.springframework.boot spring-boot-maven-plugin
看似完美,重新 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-maven-plugin:2.2.5.RELEASE:repackage failed: Unable to find main class -> [Help 1][ERROR]
ERROR 让你伤心了,但是你还是从报错中寻找到了一些蛛丝马迹,你看到是 spring-boot-maven-plugin 报出的错误。重新审视你的主 pom 发现
编译插件用到了 spring-boot-maven-plugin。
org.springframework.boot spring-boot-maven-plugin
略加思索后将这段移动到 web
模块的 pom,因为这是 Spring Boot 的打包方式,现在放在主 pom 中所有的模块都会继承到,那么对于 common
模块来说是肯定不需要的。
移动后重新打包,不管你是运行命令 mvn package
还是双击 IDEA 中的 maven 管理中的 package ,想必这时候你都已经打包成功了
在 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-module-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: default2020-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 WebApplicationContext2020-03-19 08:33:04.493 INFO 15324 --- [ main] o.s.web.context.ContextLoader : Root WebApplicationContext: initialization completed in 1107 ms2020-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
重新引入发现没有问题了。