大厂Java项目如何进行Maven多模块管理 - 掘金

什么是多模块管理？

多模块管理简单地理解就是一个 Java 工程项目中不止有一个 pom.xml 文件，会在不同的目录中有多个这样的文件，进而实现 Maven 的多模块管理

为什么要使用多模块管理？

随着业务的增长，代码会出现以下问题：

  • 不同业务之间的代码互相耦合，难以区分且快速定位问题
  • 增加开发成本，入手难度增高
  • 开发界线模糊，不易定位到具体负责人
  • 对于有特殊需求的模块无法拆解，比如：上传 maven 仓库只需要部分代码即可，但由于只有 1 个模块，不得不全部上传

故而拆分模块之后，可以避免上述问题

模块拆分方案

一般有以下两种拆分方案

  • 按照结构进行拆分

    • project
      • project-service
      • project-controller
      • project-dao

  • 按照业务进行拆分

    • project
      • project-order
      • project-account
      • project-pay

实际项目结构

这里我们使用按照结构拆分的方法进行拆分

help-student-common：放一些所有模块都会用到的共用的部分 help-student-dao：放主要的dao层代码 help-student-entity：放实体类代码 help-student-service：放主要的业务逻辑代码 help-student-web：放web端的代码

image.png

需要注意的是父工程中pom.xml文件的配置，其决定了父子模块之间的依赖关系

1、help-student的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.0</modelVersion>
  5.     <packaging>pom</packaging>
  6.     <modules>
  7.         <module>help-student-web</module>
  8.         <module>help-student-entity</module>
  9.         <module>help-student-dao</module>
  10.         <module>help-student-service</module>
  11.         <module>help-student-common</module>
  12.     </modules>
  13.     <parent>
  14.         <groupId>org.springframework.boot</groupId>
  15.         <artifactId>spring-boot-starter-parent</artifactId>
  16.         <version>2.6.2</version>
  17.         <relativePath/> <!-- lookup parent from repository -->
  18.     </parent>
  19.     <groupId>com.ctguyxr</groupId>
  20.     <artifactId>help-student</artifactId>
  21.     <version>0.0.1-SNAPSHOT</version>
  22.     <name>help-student</name>
  23.     <description>help-student</description>
  24.     <properties>
  25.         <java.version>1.8</java.version>
  26.     </properties>
  27.     <dependencyManagement>
  28.         <dependencies>
  29.             <dependency>
  30.                 <groupId>org.springframework.boot</groupId>
  31.                 <artifactId>spring-boot-starter-data-jpa</artifactId>
  32.                 <version>2.6.2</version>
  33.             </dependency>
  34.             <dependency>
  35.                 <groupId>org.springframework.boot</groupId>
  36.                 <artifactId>spring-boot-starter-web</artifactId>
  37.                 <version>2.6.2</version>
  38.             </dependency>
  40.             <dependency>
  41.                 <groupId>mysql</groupId>
  42.                 <artifactId>mysql-connector-java</artifactId>
  43.                 <scope>runtime</scope>
  44.             </dependency>
  45.             <dependency>
  46.                 <groupId>org.projectlombok</groupId>
  47.                 <artifactId>lombok</artifactId>
  48.                 <optional>true</optional>
  49.             </dependency>
  50.             <dependency>
  51.                 <groupId>org.springframework.boot</groupId>
  52.                 <artifactId>spring-boot-starter-test</artifactId>
  53.                 <scope>test</scope>
  54.             </dependency>
  55.             <dependency>
  56.                 <groupId>com.ctguyxr</groupId>
  57.                 <artifactId>help-student-service</artifactId>
  58.                 <version>0.0.1-SNAPSHOT</version>
  59.             </dependency>
  60.             <dependency>
  61.                 <groupId>com.ctguyxr</groupId>
  62.                 <artifactId>help-student-common</artifactId>
  63.                 <version>0.0.1-SNAPSHOT</version>
  64.             </dependency>
  65.             <dependency>
  66.                 <groupId>com.ctguyxr</groupId>
  67.                 <artifactId>help-student-web</artifactId>
  68.                 <version>0.0.1-SNAPSHOT</version>
  69.             </dependency>
  70.         </dependencies>
  71.     </dependencyManagement>
  73.     <build>
  74.         <plugins>
  76.         </plugins>
  77.     </build>
  79. </project>

2、help-student-web的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>help-student</artifactId>
  7.         <groupId>com.ctguyxr</groupId>
  8.         <version>0.0.1-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>help-student-web</artifactId>
  13.     <packaging>jar</packaging>
  14.     <properties>
  15.         <maven.compiler.source>8</maven.compiler.source>
  16.         <maven.compiler.target>8</maven.compiler.target>
  17.     </properties>
  19.     <dependencies>
  20.         <dependency>
  21.             <groupId>org.springframework.boot</groupId>
  22.             <artifactId>spring-boot-starter-web</artifactId>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <artifactId>spring-boot-starter-test</artifactId>
  27.             <version>2.6.2</version>
  28.             <scope>test</scope>
  29.         </dependency>
  30.         <dependency>
  31.             <groupId>com.ctguyxr</groupId>
  32.             <artifactId>help-student-entity</artifactId>
  33.             <version>0.0.1-SNAPSHOT</version>
  34.         </dependency>
  35.         <dependency>
  36.             <groupId>com.ctguyxr</groupId>
  37.             <artifactId>help-student-dao</artifactId>
  38.             <version>0.0.1-SNAPSHOT</version>
  39.         </dependency>
  40.         <dependency>
  41.             <groupId>com.ctguyxr</groupId>
  42.             <artifactId>help-student-service</artifactId>
  43.             <version>0.0.1-SNAPSHOT</version>
  44.         </dependency>
  45.     </dependencies>
  47.       <!--因为主启动类在这个包下，所以需要加上打包插件-->
  48.     <build>
  49.         <plugins>
  50.             <plugin>
  51.                 <groupId>org.springframework.boot</groupId>
  52.                 <artifactId>spring-boot-maven-plugin</artifactId>
  53.                 <version>2.6.2</version>
  55.             </plugin>
  56.         </plugins>
  57.     </build>
  58. </project>

3、模块之间的依赖关系

👏从零开始搭建SpringBoot+Jpa多模块项目 - 图2

4、help-student-dao的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>help-student</artifactId>
  7.         <groupId>com.ctguyxr</groupId>
  8.         <version>0.0.1-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  11.     <packaging>jar</packaging>
  12.     <artifactId>help-student-dao</artifactId>
  13.     <properties>
  14.         <maven.compiler.source>8</maven.compiler.source>
  15.         <maven.compiler.target>8</maven.compiler.target>
  16.     </properties>
  17.     <dependencies>
  18.         <dependency>
  19.             <groupId>com.ctguyxr</groupId>
  20.             <artifactId>help-student-entity</artifactId>
  21.             <version>0.0.1-SNAPSHOT</version>
  22.         </dependency>
  23.         <dependency>
  24.             <groupId>mysql</groupId>
  25.             <artifactId>mysql-connector-java</artifactId>
  26.             <version>8.0.27</version>
  27.         </dependency>
  28.         <dependency>
  29.             <groupId>org.springframework.boot</groupId>
  30.             <artifactId>spring-boot-starter-data-jpa</artifactId>
  31.         </dependency>
  32.     </dependencies>
  33.     <build>
  34.         <plugins>
  35.         </plugins>
  36.     </build>
  37. </project>

5、help-student-service的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>help-student</artifactId>
  7.         <groupId>com.ctguyxr</groupId>
  8.         <version>0.0.1-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  11.     <packaging>jar</packaging>
  12.     <artifactId>help-student-service</artifactId>
  14.     <properties>
  15.         <maven.compiler.source>8</maven.compiler.source>
  16.         <maven.compiler.target>8</maven.compiler.target>
  17.     </properties>
  18.     <dependencies>
  19.         <dependency>
  20.             <groupId>com.ctguyxr</groupId>
  21.             <artifactId>help-student-entity</artifactId>
  22.             <version>0.0.1-SNAPSHOT</version>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>com.ctguyxr</groupId>
  26.             <artifactId>help-student-dao</artifactId>
  27.             <version>0.0.1-SNAPSHOT</version>
  28.         </dependency>
  29.         <dependency>
  30.             <groupId>org.springframework.boot</groupId>
  31.             <artifactId>spring-boot-starter-data-jpa</artifactId>
  32.         </dependency>
  33.     </dependencies>
  34.     <build>
  35.         <plugins>
  36.         </plugins>
  37.     </build>
  38. </project>

6、help-student-entity的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>help-student</artifactId>
  7.         <groupId>com.ctguyxr</groupId>
  8.         <version>0.0.1-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  11.     <artifactId>help-student-entity</artifactId>
  12.     <packaging>jar</packaging>
  13.     <properties>
  14.         <maven.compiler.source>8</maven.compiler.source>
  15.         <maven.compiler.target>8</maven.compiler.target>
  16.     </properties>
  17.     <dependencies>
  18.         <dependency>
  19.             <groupId>org.projectlombok</groupId>
  20.             <artifactId>lombok</artifactId>
  21.             <version>1.18.22</version>
  22.             <optional>true</optional>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <artifactId>spring-boot-starter-data-jpa</artifactId>
  27.         </dependency>
  29.     </dependencies>
  30.     <build>
  31.         <plugins>
  32.         </plugins>
  33.     </build>
  34. </project>

项目如何启动

Springboot配置扫描其它模块路径的方法

http://www.javashuo.com/article/p-momaobrc-hc.html

springboot项目打包时提示“程序包xxx不存在，找不到符号” - 夏冬青 - 博客园
SpringBoot默认只会扫描当前包以及当前包下的所有组件，我们多模块的编写的时候就需要配置扫描包的路径，指明需要去哪些包下面扫描我们的组件
需要用到以下几个注解：

  • @EnableJpaRepositorie 用来扫描和发现指定包以及其子包中Repository组件的定义

Springboot应用中@EntityScan和@EnableJpaRepositories的用法 - 星朝 - 博客园

  • @EntityScan 配置实体类的扫描路径，扫描指定包和其子包中所有Entity的定义
  • @ComponentScan 配置组件的扫描路径

由于是多模块开发，启动类和我们的其他组件并不在一个模块中，所以需要进行配置

  1. package com.ctguyxr.web;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5. import org.springframework.boot.autoconfigure.domain.EntityScan;
  6. import org.springframework.context.annotation.ComponentScan;
  7. import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
  9. /**
  10.  * Created By Intellij IDEA
  11.  *
  12.  * @author Xinrui Yu
  13.  * @date 2021/12/23 20:03 星期四
  14.  */
  16. @EnableJpaRepositories(basePackages = {"com.ctguyxr.dao"})
  17. @EntityScan(basePackages = {"com.ctguyxr.entity"})
  18. @ComponentScan(basePackages = {"com.ctguyxr.service.impl","com.ctguyxr.web.controller"})
  19. @SpringBootApplication
  20. public class WebApplication {
  21.     public static void main(String[] args) {
  22.         SpringApplication.run(WebApplication.class,args);
  23.     }
  24. }

在启动类对应的模块下编写SpringBoot的配置文件application.properties，配置好数据库和JPA的相关配置信息。创建好测试用的controller
运行，测试：
image.png
测试接口，接口也能正常响应，说明多模块项目已经搭建成功！！
image.png

打包的时候需要指定启动主类，在pom.xml中配置我们的mainClass即可
maven打包，配置中指定主类 - lshan - 博客园

MyBatis+SpringBoot搭建流程

SpringBoot 多模块构建 - 掘金