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

创建项目

成都创新互联专注于荣昌网站建设服务及定制,我们拥有丰富的企业做网站经验。 热诚为您提供荣昌营销型网站建设,荣昌网站制作、荣昌网页设计、荣昌网站官网定制、小程序制作服务,打造荣昌网络公司原创品牌,更为您提供荣昌网站排名全网营销落地服务。

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

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

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

 2.  填写 group 和 Artifact 信息,选择依赖(我选择了 Spring Web 和 Lombok )。 

spring 官网创建初始项目

3.  点击 Generate 按钮下载项目。

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

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

 
 
 
 
  1.   
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">  
  3.     4.0.0  
  4.       
  5.         org.springframework.boot  
  6.         spring-boot-starter-parent  
  7.         2.2.5.RELEASE  
  8.            
  9.       
  10.     com.wdbyte  
  11.     springboot-module-demo  
  12.     0.0.1-SNAPSHOT  
  13.     springboot-module-demo  
  14.     Demo project for Spring Boot  
  15.       
  16.         1.8  
  17.      
  18.       
  19.           
  20.             org.springframework.boot  
  21.             spring-boot-starter-web  
  22.           
  23.           
  24.             org.projectlombok  
  25.             lombok  
  26.             true  
  27.           
  28.           
  29.             org.springframework.boot  
  30.             spring-boot-starter-test  
  31.             test  
  32.               
  33.                   
  34.                     org.junit.vintage  
  35.                     junit-vintage-engine  
  36.                   
  37.               
  38.           
  39.       
  40.       
  41.           
  42.               
  43.                 org.springframework.boot  
  44.                 spring-boot-maven-plugin  
  45.               
  46.           
  47.       
  48.  

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

项目目录结构

ProductController 类源代码。

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

Product 类源代码。

 
 
 
 
  1. @Data  
  2. public class Product {  
  3.     /** 商品名称. */  
  4.     private String productName;  
  5.     /** 商品价格. */  
  6.     private BigDecimal productPrice;  
  7.     /** 商品库存。*/  
  8.     private int productStock;  

模块化

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

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

 
 
 
 
  1.   
  2.    
  3.             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">  
  4.        4.0.0  
  5.          
  6.        pom  
  7.        ....  
  8.        .... 

2.  创建 common 模块

项目直接 new -> module。 

创建模块

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

填写模块名称

继续 next 完成模块创建。

3.  创建 web 模块

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

 
 
 
 
  1.   
  2.         product-common  
  3.         product-web  
  4.      

4.  移动代码到指定模块

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

多模块目录结构

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

依赖管理

处理依赖问题

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

红色警告

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

 
 
 
 
  1.   
  2.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
  4.       
  5.         springboot-module-demo  
  6.         com.wdbyte  
  7.         0.0.1-SNAPSHOT  
  8.       
  9.     4.0.0  
  10.     product-common  
  11.  

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

 
 
 
 
  1.   
  2.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
  4.       
  5.         springboot-module-demo  
  6.         com.wdbyte  
  7.         0.0.1-SNAPSHOT  
  8.       
  9.     4.0.0  
  10.     product-web  
  11.       
  12.           
  13.             com.wdbyte  
  14.             product-common  
  15.           
  16.       
  17.  

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

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

报错信息

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

 
 
 
 
  1.   
  2.          
  3.              
  4.                com.wdbyte  
  5.                product-common  
  6.                0.0.1-SNAPSHOT  
  7.              
  8.          
  9.     

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

优化依赖

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

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

 
 
 
 
  1.   
  2.    
  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.          
  6.            springboot-module-demo  
  7.            com.wdbyte  
  8.            0.0.1-SNAPSHOT  
  9.          
  10.        4.0.0  
  11.        product-common  
  12.          
  13.              
  14.                org.projectlombok  
  15.                lombok  
  16.                true  
  17.              
  18.          
  19.     

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

 
 
 
 
  1.   
  2.    
  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.          
  6.            springboot-module-demo  
  7.            com.wdbyte 
  8.             0.0.1-SNAPSHOT  
  9.          
  10.        4.0.0  
  11.        product-web     
  12.          
  13.              
  14.                com.wdbyte  
  15.                product-common  
  16.              
  17.              
  18.                org.springframework.boot  
  19.                spring-boot-starter-web  
  20.              
  21.              
  22.                org.springframework.boot  
  23.                spring-boot-starter-test  
  24.                test  
  25.                  
  26.                      
  27.                        org.junit.vintage  
  28.                        junit-vintage-engine  
  29.                      
  30.                  
  31.              
  32.          
  33.     

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

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

 
 
 
 
  1.   
  2.     
  3.              xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">  
  4.         4.0.0  
  5.         pom  
  6.           
  7.             product-common  
  8.             product-web  
  9.           
  10.           
  11.             org.springframework.boot 
  12.              spring-boot-starter-parent  
  13.             2.2.5.RELEASE  
  14.                
  15.           
  16.         com.wdbyte  
  17.         springboot-module-demo  
  18.         0.0.1-SNAPSHOT  
  19.         springboot-module-demo  
  20.         Demo project for Spring Boot  
  21.           
  22.             1.8  
  23.             0.0.1-SNAPSHOT  
  24.          
  25.           
  26.               
  27.                   
  28.                     com.wdbyte  
  29.                     product-common  
  30.                     ${product-common.version}  
  31.                   
  32.              
  33.            
  34.           
  35.               
  36.                   
  37.                     org.springframework.boot  
  38.                     spring-boot-maven-plugin  
  39.                   
  40.               
  41.           
  42.      

看似完美,重新  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.   
  2.           
  3.               
  4.                 org.springframework.boot  
  5.                 spring-boot-maven-plugin  
  6.               
  7.           
  8.      

略加思索后将这段移动到 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 文章题目:详尽的Spring Boot多模块开发与排坑指南
    URL网址:http://www.shufengxianlan.com/qtweb/news18/403418.html

    网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

    广告

    声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联