文章详情

登录

短信预约-IT技能 免费直播动态提醒

选择考试省份

  • 北京
  • 上海
  • 天津
  • 重庆
  • 河北
  • 山东
  • 辽宁
  • 黑龙江
  • 吉林
  • 甘肃
  • 青海
  • 河南
  • 江苏
  • 湖北
  • 湖南
  • 江西
  • 浙江
  • 广东
  • 云南
  • 福建
  • 海南
  • 山西
  • 四川
  • 陕西
  • 贵州
  • 安徽
  • 广西
  • 内蒙
  • 西藏
  • 新疆
  • 宁夏
  • 兵团

请输入下面的图形验证码

提交验证

短信预约提醒成功

详尽的Spring Boot多模块开发与排坑指南

2024-12-24 19:00

关注

创建一个 SpringBoot 项目非常的简单，简单到这里根本不用再提。你可以在使用 IDEA 新建项目时直接选择 Spring Initlalize 创建一个 Spring Boot 项目，也可以使用 Spring 官方提供的 Spring Boot 项目生成页面得到一个项目。

下面介绍一下使用 Spring 官方生成的方式，如果你已经有了一个 Spring Boot 项目，这部分可以直接跳过。

 1.  打开 https://start.spring.io/ 

 2.  填写 group 和 Artifact 信息，选择依赖（我选择了 Spring Web 和 Lombok ）。   

spring 官网创建初始项目

  点击 Generate 按钮下载项目。

  打开下载的项目，删除无用的 .mvn 文件夹，mvnw 、 mvnw.cmd 、HELP.md 文件。

到这里已经得到了一个 Spring Boot 初始项目了，我们直接导入到 IDEA 中，看一眼 pom.xml 的内容。 

  1. xml version="1.0" encoding="UTF-8"?>  
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  3.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">  
  4.     <modelVersion>4.0.0modelVersion>  
  5.     <parent>  
  6.         <groupId>org.springframework.bootgroupId>  
  7.         <artifactId>spring-boot-starter-parentartifactId>  
  8.         <version>2.2.5.RELEASEversion>  
  9.         <relativePath/>   
  10.     parent>  
  11.     <groupId>com.wdbytegroupId>  
  12.     <artifactId>springboot-module-demoartifactId>  
  13.     <version>0.0.1-SNAPSHOTversion>  
  14.     <name>springboot-module-demoname>  
  15.     <description>Demo project for Spring Bootdescription>  
  16.     <properties>  
  17.         <java.version>1.8java.version>  
  18.     properties> 
  19.     <dependencies>  
  20.         <dependency>  
  21.             <groupId>org.springframework.bootgroupId>  
  22.             <artifactId>spring-boot-starter-webartifactId>  
  23.         dependency>  
  24.         <dependency>  
  25.             <groupId>org.projectlombokgroupId>  
  26.             <artifactId>lombokartifactId>  
  27.             <optional>trueoptional>  
  28.         dependency>  
  29.         <dependency>  
  30.             <groupId>org.springframework.bootgroupId>  
  31.             <artifactId>spring-boot-starter-testartifactId>  
  32.             <scope>testscope>  
  33.             <exclusions>  
  34.                 <exclusion>  
  35.                     <groupId>org.junit.vintagegroupId>  
  36.                     <artifactId>junit-vintage-engineartifactId>  
  37.                 exclusion>  
  38.             exclusions>  
  39.         dependency>  
  40.     dependencies>  
  41.     <build>  
  42.         <plugins>  
  43.             <plugin>  
  44.                 <groupId>org.springframework.bootgroupId>  
  45.                 <artifactId>spring-boot-maven-pluginartifactId>  
  46.             plugin>  
  47.         plugins>  
  48.     build>  
  49. project> 

把目录结构调整成自己想要的结构，然后添加 controller 和 entity 用于测试。

项目目录结构

ProductController 类源代码。 

  1. @RestController  
  2. @RequestMapping("/product")  
  3. public class ProductController {  
  4.       
  5.     @GetMapping("/list")  
  6.     public Map list() {  
  7.         // 模拟查询商品逻辑  
  8.         Product product = new Product();  
  9.         product.setProductName("小米粥");  
  10.         product.setProductPrice(new BigDecimal(2.0));  
  11.         product.setProductStock(100);  
  12.         Map<String, Object> resultMap = new HashMap<>();  
  13.         resultMap.put("code", 000);  
  14.         resultMap.put("message", "成功");  
  15.         resultMap.put("data", Arrays.asList(product));  
  16.         return resultMap;  
  17.     }  
  18. } 

Product 类源代码。 

  1. @Data  
  2. public class Product {  
  3.       
  4.     private String productName;  
  5.       
  6.     private BigDecimal productPrice;  
  7.       
  8.     private int productStock;  
  9. } 

模块化

借助 IDEA 工具可以快速的把项目改造成 maven 多模块，这里我们把准备测试 demo 拆分为 common 和 web 两个模块，common 模块存放实体类。web 模块存放 controller 层（这里项目虽小，拆分只是为了演示）。话不多说，直接开始。

    配置主 pom.xml 打包方式 为 pom   

  1. xml version="1.0" encoding="UTF-8"?>  
  2.    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  3.             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">  
  4.        <modelVersion>4.0.0modelVersion>  
  5.          
  6.        <packaging>pompackaging>  
  7.        ....  
  8.        .... 

  创建 common 模块

项目直接 new -> module。   

创建模块

选择 maven -> next，填写模块名称。   

填写模块名称 

继续 next 完成模块创建。

  创建 web 模块

    web 模块的创建和 common 模块如出一辙，不再赘述。完成两个模块的创建之后，你会发现你的主 pom.xml 文件里自动添加了 module 部分。   

  1. <modules>  
  2.         <module>product-commonmodule>  
  3.         <module>product-webmodule>  
  4.     modules> 

  移动代码到指定模块

移动 Product.java 到 product-common 模块，其他部分代码和 resource 部分直接移动到 product-web 模块，移动完后你的代码结构是这个样子。   

多模块目录结构

到这里，多模块已经拆分完成了， 但是 ProductController  代码里的红色警告让你发现事情还没有结束。

依赖管理

处理依赖问题

你发现了代码里的红色警告，不过你也瞬间想到了是因为把 Product  类移动到了 product-common 模块，导致这里引用不到了。

红色警告

然后你查看了下 product-common 模块的 pom.xml 里的内容。 

  1. xml version="1.0" encoding="UTF-8"?>  
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"  
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
  5.     <parent>  
  6.         <artifactId>springboot-module-demoartifactId>  
  7.         <groupId>com.wdbytegroupId>  
  8.         <version>0.0.1-SNAPSHOTversion>  
  9.     parent>  
  10.     <modelVersion>4.0.0modelVersion>  
  11.     <artifactId>product-commonartifactId>  
  12. project> 

机智的在 Product-web 模块的 pom.xml 里引入 product-common，手起键落，轻松搞定。 

  1. xml version="1.0" encoding="UTF-8"?>  
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"  
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
  5.     <parent>  
  6.         <artifactId>springboot-module-demoartifactId>  
  7.         <groupId>com.wdbytegroupId>  
  8.         <version>0.0.1-SNAPSHOTversion>  
  9.     parent>  
  10.     <modelVersion>4.0.0modelVersion>  
  11.     <artifactId>product-webartifactId>  
  12.     <dependencies>  
  13.         <dependency>  
  14.             <groupId>com.wdbytegroupId>  
  15.             <artifactId>product-commonartifactId>  
  16.         dependency>  
  17.     dependencies>  
  18. project> 

满心欢喜的你快速的点击 Build->  Build Project，得到的 Error 警告刺痛了顶着黑眼圈的你。

不过你还是迅速定位了问题，查看 maven 依赖，你发现是因为没有指定 product-common 依赖的版本号。

报错信息

原来如此，因为没有指定版本号，我们指定上不就完事了嘛。在最外层的主 pom.xml 中添加 添加上指定依赖和要指定的版本号。   

  1. <dependencyManagement>  
  2.        <dependencies>  
  3.            <dependency>  
  4.                <groupId>com.wdbytegroupId>  
  5.                <artifactId>product-commonartifactId>  
  6.                <version>0.0.1-SNAPSHOTversion>  
  7.            dependency>  
  8.        dependencies>  
  9.    dependencyManagement> 

刷新 maven ，发现项目已经不报错了，编译成功，运行启动类，熟悉的 Spring logo 又出现在眼前。

优化依赖

是的，Spring Boot 应用在改造成多模块后成功运行了起来，但是你貌似发现一个问题，模块 common 和模块 web 都继承了主 pom ，主 pom 中有 Lombok 、Spring Boot Web 和  Spring Boot Test 依赖，而 common 模块里只用到了 Lombok 啊，却一样继承了 Spring Boot 其他依赖，看来还是要改造一把。 

  只有 common 模块用到的依赖移动到 common 模块。   

  1. xml version="1.0" encoding="UTF-8"?>  
  2.    <project xmlns="http://maven.apache.org/POM/4.0.0"  
  3.             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  4.             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
  5.        <parent>  
  6.            <artifactId>springboot-module-demoartifactId>  
  7.            <groupId>com.wdbytegroupId>  
  8.            <version>0.0.1-SNAPSHOTversion>  
  9.        parent>  
  10.        <modelVersion>4.0.0modelVersion>  
  11.        <artifactId>product-commonartifactId>  
  12.        <dependencies>  
  13.            <dependency>  
  14.                <groupId>org.projectlombokgroupId>  
  15.                <artifactId>lombokartifactId>  
  16.                <optional>trueoptional>  
  17.            dependency>  
  18.        dependencies>  
  19.    project> 

  只有 web 模块用到的依赖移动到 web 模块。   

  1. xml version="1.0" encoding="UTF-8"?>  
  2.    <project xmlns="http://maven.apache.org/POM/4.0.0"  
  3.             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  4.             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
  5.        <parent>  
  6.            <artifactId>springboot-module-demoartifactId>  
  7.            <groupId>com.wdbytegroupId> 
  8.             <version>0.0.1-SNAPSHOTversion>  
  9.        parent>  
  10.        <modelVersion>4.0.0modelVersion>  
  11.        <artifactId>product-webartifactId>     
  12.        <dependencies>  
  13.            <dependency>  
  14.                <groupId>com.wdbytegroupId>  
  15.                <artifactId>product-commonartifactId>  
  16.            dependency>  
  17.            <dependency>  
  18.                <groupId>org.springframework.bootgroupId>  
  19.                <artifactId>spring-boot-starter-webartifactId>  
  20.            dependency>  
  21.            <dependency>  
  22.                <groupId>org.springframework.bootgroupId>  
  23.                <artifactId>spring-boot-starter-testartifactId>  
  24.                <scope>testscope>  
  25.                <exclusions>  
  26.                    <exclusion>  
  27.                        <groupId>org.junit.vintagegroupId>  
  28.                        <artifactId>junit-vintage-engineartifactId>  
  29.                    exclusion>  
  30.                exclusions>  
  31.            dependency>  
  32.        dependencies>  
  33.    project> 

  抽取用到的版本号到 ，这里抽取 common 模块的依赖版本。

    到这里最外层主 pom 的内容是这样的。   

  1. xml version="1.0" encoding="UTF-8"?>  
  2.     <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  3.              xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">  
  4.         <modelVersion>4.0.0modelVersion>  
  5.         <packaging>pompackaging>  
  6.         <modules>  
  7.             <module>product-commonmodule>  
  8.             <module>product-webmodule>  
  9.         modules>  
  10.         <parent>  
  11.             <groupId>org.springframework.bootgroupId> 
  12.              <artifactId>spring-boot-starter-parentartifactId>  
  13.             <version>2.2.5.RELEASEversion>  
  14.             <relativePath/>   
  15.         parent>  
  16.         <groupId>com.wdbytegroupId>  
  17.         <artifactId>springboot-module-demoartifactId>  
  18.         <version>0.0.1-SNAPSHOTversion>  
  19.         <name>springboot-module-demoname>  
  20.         <description>Demo project for Spring Bootdescription>  
  21.         <properties>  
  22.             <java.version>1.8java.version>  
  23.             <product-common.version>0.0.1-SNAPSHOTproduct-common.version>  
  24.         properties> 
  25.         <dependencyManagement>  
  26.             <dependencies>  
  27.                 <dependency>  
  28.                     <groupId>com.wdbytegroupId>  
  29.                     <artifactId>product-commonartifactId>  
  30.                     <version>${product-common.version}version>  
  31.                 dependency>  
  32.             dependencies> 
  33.          dependencyManagement>  
  34.         <build>  
  35.             <plugins>  
  36.                 <plugin>  
  37.                     <groupId>org.springframework.bootgroupId>  
  38.                     <artifactId>spring-boot-maven-pluginartifactId>  
  39.                 plugin>  
  40.             plugins>  
  41.         build>  
  42.     project> 

看似完美，重新  Build->  Build Project ，发现一切正常，运行发现一切正常，访问正常。

访问接口

打包编译

好了，终于到了最后一步了，你感觉到胜利的曙光已经照到了头顶，反射出耀眼的光芒。接着就是 mvn package。 

  1. [INFO] springboot-module-demo ............................. SUCCESS [  2.653 s]  
  2. [INFO] product-common ..................................... FAILURE [  2.718 s] 
  3.  [INFO] product-web ........................................ SKIPPED  
  4. [INFO] ------------------------------------------------------------------------  
  5. [INFO] BUILD FAILURE  
  6. [INFO] ------------------------------------------------------------------------  
  7. [INFO] Total time: 6.084 s  
  8. [INFO] Finished at: 2020-03-19T08:15:52+08:00  
  9. [INFO] Final Memory: 22M/87M  
  10. [INFO] ------------------------------------------------------------------------  
  11. [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-m 
  12. aven-plugin:2.2.5.RELEASE:repackage failed: Unable to find main class -> [Help 1]  
  13. [ERROR] 

ERROR 让你伤心了，但是你还是从报错中寻找到了一些蛛丝马迹，你看到是  spring-boot-maven-plugin 报出的错误。重新审视你的主 pom 发现 编译插件用到了 spring-boot-maven-plugin。   

  1. <build>  
  2.         <plugins>  
  3.             <plugin>  
  4.                 <groupId>org.springframework.bootgroupId>  
  5.                 <artifactId>spring-boot-maven-pluginartifactId>  
  6.             plugin>  
  7.         plugins>  
  8.     build> 

略加思索后将这段移动到 web 模块的 pom，因为这是 Spring Boot 的打包方式，现在放在主 pom 中所有的模块都会继承到，那么对于 common 模块来说是肯定不需要的。

移动后重新打包，不管你是运行命令 mvn package 还是双击 IDEA 中的 maven 管理中的 package ，想必这时候你都已经打包成功了

IDEA 打包

在 web 模块下的目录 target 里也可以看到打包后的 jar 文件 product-web-0.0.1-SNAPSHOT.jar。可以使用 java 命令直接运行。 

  1. $ \springboot-module-demo\product-web\target>java -jar product-web-0.0.1-SNAPSHOT.jar  
  2.   .   ____          _            __ _ _  
  3.  /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \  
  4. ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \  
  5.  \\/  ___)| |_)| | | | | || (_| |  ) ) ) )  
  6.   '  |____| .__|_| |_|_| |_\__, | / / / /  
  7.  =========|_|==============|___/=/_/_/_/  
  8.  :: Spring Boot ::        (v2.2.5.RELEASE)  
  9. 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-mod 
  10. ule-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) 
  11. 2020-03-19 08:33:03.340  INFO 15324 --- [           main] com.wdbyte.Application                   : No active profile set, falling back to default profiles: default 
  12. 2020-03-19 08:33:04.410  INFO 15324 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http) 
  13. 2020-03-19 08:33:04.432  INFO 15324 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat] 
  14. 2020-03-19 08:33:04.432  INFO 15324 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.31] 
  15. 2020-03-19 08:33:04.493  INFO 15324 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext 
  16. 2020-03-19 08:33:04.493  INFO 15324 --- [           main] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 1107 ms 
  17. 2020-03-19 08:33:04.636  INFO 15324 --- [           main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor' 
  18. 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 '' 
  19. 2020-03-19 08:33:04.772  INFO 15324 --- [           main] com.wdbyte.Application                   : Started Application in 1.924 seconds (JVM running for 2.649) 
  20. 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 命令。 

  1. # -Dmaven.test.skip=true 跳过测试  
  2. # -U 强制刷新  
  3. # clean 清理缓存  
  4. # install 安装到本地仓库 
  5.  
  6. $ \springboot-module-demo> mvn -Dmaven.test.skip=true -U clean install 

重新引入发现没有问题了。 

 

来源：Java知音内容投诉

免责声明：

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的，并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据，供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题

  • 2024年上半年信息系统项目管理师第二批次真题及答案解析（完整版）

    难度     813人已做
    查看

  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看

  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看

  • 2024年上半年软考高项第一、二批次真题考点汇总（完整版）

    难度     435人已做
    查看

  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机

详尽的Spring Boot多模块开发与排坑指南

后端开发SpringBoot2024-12-24
位置：首页-资讯-后端开发
咦！没有更多了？去看看其它编程学习网 内容吧
首页课程
资料下载问答资讯