Springboot多模塊項目搭建

目錄

• 新建項目，作為父模塊
• 創建子模塊
• 各個模塊建立關系
  • 父POM配置
  • Entity的POM配置
  • Dao的POM配置
  • Service的POM配置
  • Web的POM配置
• 代碼
• 驗證
• 注意事項
• 參考資料

新建項目，作為父模塊

刪除除pom.xml之外的所有文件

效果如下：

.gitignore和ReadMe.md是可選文件

創建子模塊

工程上右鍵 -> new -> model -> 選擇Spring Initializer -> 下一步

依此步驟分別建立 web、service、entity、dao,刪除每個模塊中無用的文件，只留下pom.xml

刪除除web模塊外其他模塊的Application啟動類和resources目錄下的application.properties配置文件

各個模塊建立關系

父POM配置

1. packaging改為pom
2. 聲明子模塊
3. properties/denpendencies下的配置都為公共配置
4. build模塊是打包用的，這里聲明了所有模塊都跳過單元測試

<?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 https://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.5.6</version>
        <relativePath/>
    </parent>

    <!--父POM-->
    <groupId>com.xxx</groupId>
    <artifactId>myblog</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>myblog</name>
    <packaging>pom</packaging>

    <!--聲明子模塊-->
    <modules>
        <module>entity</module>
        <module>dao</module>
        <module>service</module>
        <module>web</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>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <!--maven-surefire-plugin是執行測試用例的插件，這里聲明跳過TEST-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <configuration>
                    <skip>true</skip>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

Entity的POM配置

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--聲明父模塊-->
    <parent>
        <groupId>com.xxx</groupId>
        <artifactId>myblog</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <!--默認就是 ../pom.xml-->
        <relativePath>../pom.xml</relativePath>
    </parent>

    <!--當前模塊-->
    <groupId>com.xxx</groupId>
    <artifactId>entity</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>entity</name>
    <packaging>jar</packaging>

    <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
</project>

Dao的POM配置

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--聲明父模塊-->
    <parent>
        <groupId>com.xxx</groupId>
        <artifactId>myblog</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>

    <!--當前模塊-->
    <groupId>com.xxx</groupId>
    <artifactId>dao</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>dao</name>
    <packaging>jar</packaging>

    <!--依賴-->
    <dependencies>
        <!--數據庫連接-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

        <!--Mybatis-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.2.0</version>
        </dependency>

        <!--引入entity模塊-->
        <dependency>
            <groupId>com.xxx</groupId>
            <artifactId>entity</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

Service的POM配置

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <!--聲明父模塊-->
    <parent>
        <groupId>com.xxx</groupId>
        <artifactId>myblog</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>

    <!--當前模塊-->
    <groupId>com.xxx</groupId>
    <artifactId>service</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>service</name>
    <packaging>jar</packaging>

    <!--依賴-->
    <dependencies>
        <!--引入dao模塊-->
        <dependency>
            <groupId>com.xxx</groupId>
            <artifactId>dao</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

        <!--引入entity模塊-->
        <dependency>
            <groupId>com.xxx</groupId>
            <artifactId>entity</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

Web的POM配置

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <!--聲明父模塊-->
    <parent>
        <groupId>com.xxx</groupId>
        <artifactId>myblog</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>

    <!--當前模塊-->
    <groupId>com.xxx</groupId>
    <artifactId>web</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>web</name>
    <packaging>jar</packaging>

    <!--依賴-->
    <dependencies>
        <!--Web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--引入service模塊-->
        <dependency>
            <groupId>com.xxx</groupId>
            <artifactId>service</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

        <!--引入entity模塊-->
        <dependency>
            <groupId>com.xxx</groupId>
            <artifactId>entity</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

    </dependencies>

    <!--編譯打包相關-->
    <build>
        <plugins>
            <!--SpringBoot項目必須加入這個插件，才會將普通JAR打成SpringBoot的JAR-->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <!--指定Main Class為全局的唯一入口-->
                    <mainClass>com.xxx.blog.WebApplication</mainClass>
                </configuration>
            </plugin>

        </plugins>
    </build>
</project>

代碼

Entity

package com.xxx.blog;

import lombok.Data;

import java.util.Date;

/**
 * @author computer
 */
@Data
public class UmsMenu {
    private int id;

    private String title;

    private int level;

    private Date createTime;

    private int parentId;
}

Mapper

package com.xxx.blog;

import org.apache.ibatis.annotations.Param;

import java.util.List;

/**
 * @author computer
 */
public interface UmsMenuMapper {
    /**
     * 根據ID查找
     * @param id
     * @return
     */
    /*@Select("select * from ums_menu where id = #{id}")
    @Results({
            @Result(property = "createTime",column = "create_time",javaType = Date.class),
            @Result(property = "parentId",column = "parent_id",javaType = int.class)
    })*/
    UmsMenu findById(@Param("id") int id);

    /**
     * 查找所有
     * @return
     */
    /*@Select("select * from ums_menu")
    @Results({
            @Result(property = "createTime",column = "create_time",javaType = Date.class),
            @Result(property = "parentId",column = "parent_id",javaType = int.class)
    })*/
    List<UmsMenu> findAll();
}

Mapper.xml

<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.xxx.blog.UmsMenuMapper">
    <resultMap id="resultMap" type="com.xxx.blog.UmsMenu">
        <result column="id" property="id" javaType="java.lang.Integer"/>
        <result column="title" property="title" javaType="java.lang.String"/>
        <result column="level" property="level" javaType="java.lang.Integer"/>
        <result column="create_time" property="createTime" javaType="java.util.Date"/>
        <result column="parent_id" property="parentId" javaType="java.lang.Integer"/>
    </resultMap>

    <select id="findById" parameterType="java.lang.Integer" resultMap="resultMap">
        select * from ums_menu where id = #{id}
    </select>

    <select id="findAll" resultMap="resultMap">
        select * from ums_menu
    </select>
</mapper>

Service

package com.xxx.blog;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

/**
 * @author computer
 */
@Service
public class WebService {

    @Autowired
    UmsMenuMapper mapper;

    /**
     * 獲取所有Menu信息
     * @return
     */
    public List<UmsMenu> getAllMenu(){
        return mapper.findAll();
    }
}

Controller

package com.xxx.blog.controller;

import com.xxx.blog.WebService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author computer
 */
@RestController
@RequestMapping("/test")
public class WebTest {

    @Autowired
    WebService webService;

    /**
     * 獲取所有Menu信息
     * @return
     */
    @RequestMapping(value = "/getAllMenu",produces = "application/json")
    public String getAllMenu(){
        return webService.getAllMenu().toString();
    }
}

驗證

效果

注意事項

1.父pom.xml 打包方式，jar要更改為pom，build 需要更改

2.不需要打包的模塊pom.xml文件中不要寫<build>，全刪掉，例如有些工程中的common模塊，utils模塊，entity模塊，service模  塊都不需要打包

3.聲明父工程時，填寫父工程位置<relativePath>../pom.xml</relativePath>

4.關於applicatin.properties配置文件，只需要在啟動的模塊中配置就可以了，

5.關於打包為什么打包jar包，不打war包，打war包目的是war包可以運行在tomcat下，但是SpringBoot是內置tomcat，如果你打war包，前提是干掉內置的tomcat，然后才能打包，各種麻煩，直接打包可執行jar包，使用java -jar 命令就可以完美的運行起來很方便！
————————————————
版權聲明：本文為CSDN博主「凌雲冷海」的原創文章，遵循CC 4.0 BY-SA版權協議，轉載請附上原文出處鏈接及本聲明。
原文鏈接：https://blog.csdn.net/baidu_41885330/article/details/81875395

參考資料

SpringBoot+Maven多模塊項目（創建、依賴、打包可執行jar包部署測試）完整流程