spring boot maven 多模块项目创建笔记

3,843 阅读3分钟

一、创建父项目(parent)

使用IDE创建功能

Intellij > File > New > Project > Spring Initializr

设置项目名称,使用默认选项,创建空的主项目

修改pom.xml

  1. 添加子模块
<!-- 模块说明:这里声明多个子模块 -->
    <modules>
        <module>btp-bean</module>
        <module>btp-common</module>
        <module>btp-dao</module>
        <module>btp-service</module>
        <module>btp-admin</module>
        <module>btp-user</module>
    </modules>
  1. 删除dependencies内容
  2. 添加pom 父项目打包不能是默认的jar,所以得改成pom
  3. 删除

最终的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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.boyuantang</groupId>
    <artifactId>btp-parent</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>btp-parent</name>
    <description>Demo project for Spring Boot</description>

    <packaging>pom</packaging>
    <!-- 模块说明:这里声明多个子模块 -->
    <modules>
        <module>btp-bean</module>
        <module>btp-common</module>
        <module>btp-dao</module>
        <module>btp-service</module>
        <module>btp-admin</module>
        <module>btp-user</module>
    </modules>


    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
    </dependencies>

</project>

父项目的作用

  • 父项目继承spring框架
  • 父项目定义版本号
  • 父项目让子模块之间可以相互引用

二、创建子模块

在IDE中点击父项目,右键

New > Module > Spring Initializr

设置项目名称,使用默认选项,创建空的子模块

修改pom.xml

  1. 添加父项目

取代默认的parent spring, 因为父项目已经继承了parent spring

<!-- 继承本项目的父工程 -->
    <parent>
        <groupId>com.boyuantang</groupId>
        <artifactId>btp-parent</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
  1. 删除dependencies内容 根据自己的需要添加依赖,如果是web模块,要添加spring的一整套依赖。如果是module模块,则按需要添加依赖。同时子模块之间也可以相互引用,如下
<dependency>
	<groupId>com.boyuantang</groupId>
	<artifactId>btp-dao</artifactId>
	<version>0.0.1-SNAPSHOT</version>
</dependency>
  1. 如果非web模块,则删除

非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>
    <!-- 继承本项目的父工程 -->
    <parent>
        <groupId>com.boyuantang</groupId>
        <artifactId>btp-parent</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <groupId>com.boyuantang</groupId>
    <artifactId>btp-dao</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>btp-dao</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
        	<groupId>com.boyuantang</groupId>
        	<artifactId>btp-service</artifactId>
        	<version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>

</project>

三、打包

子模块可以分开打包。生成的jar可运行。

四、配置问题

  1. 会遇到报错说 xxxDAO 不存在, 添加@MapperScan
@MapperScan("com.boyuantang.dao")
@SpringBootApplication
public class BtpAdminApplication {
    public static void main(String[] args) {
        SpringApplication.run(BtpAdminApplication.class, args);
    }
}
  1. 会遇到无法注册service模块的bean, 添加@ComponentScan
@ComponentScan("com.boyuantang")
@SpringBootApplication
public class BtpAdminApplication {

    public static void main(String[] args) {
        SpringApplication.run(BtpAdminApplication.class, args);
    }

}
  1. 无法扫描mybatis的xml文件,在application.properties中添加
mybatis.mapper-locations=classpath*:mapper/*.xml

五、项目之间的依赖关系

  1. 父项目导入全局依赖,这样子模块就不用再导入这些模块
    比如lombok,fastjson之类
  2. web模块导入service模块,不用导入entity, common这些,因为service已经包含了这些子模块