Springboot項(xiàng)目腳手架搭建全系列

學(xué)習(xí)路線

1.快速搭建Springboot多模塊項(xiàng)目&工程架構(gòu)

目標(biāo)

1.學(xué)習(xí)創(chuàng)建Springboot的多module項(xiàng)目

2.學(xué)習(xí)搭建前后端分離的項(xiàng)目工程結(jié)構(gòu)

內(nèi)容

創(chuàng)建多module項(xiàng)目

本文通過構(gòu)建一個(gè)包含5個(gè)子模塊的項(xiàng)目，來演示 SpringBoot 在 Maven 環(huán)境的多模塊構(gòu)建過程。

1. 創(chuàng)建父工程

1. 通過Spring Initializer創(chuàng)建

???????? b.創(chuàng)建好后刪除剛創(chuàng)建工程里不需要的文件， 只保留：.idea 文件夾 、項(xiàng)目 pom 文件、以及一個(gè) *.iml 文件

刪除前->刪除后

2.創(chuàng)建子模塊

1. 右鍵點(diǎn)擊父工程，選擇 New -> Module... 創(chuàng)建子模塊。這里依次創(chuàng)建 scaffold-common、scaffold-api、scaffold-dao、scaffold-service 和 scaffold-web 共 5 個(gè)模塊

   
   

   注意：除了 scaffold-web 子模塊創(chuàng)建時(shí)選擇添加 Spring Web 依賴（當(dāng)然也可以創(chuàng)建時(shí)不添加，等后面再手動(dòng)編輯 pom.xml 文件添加），其他模塊暫時(shí)不添加依賴。

???????? b.將所有子模塊的 mvnw、mvnw.cmd 文件及 .mvn 文件夾全部刪除

???????? c.對(duì)于 src 里的內(nèi)容，只保留 scaffold-web 的啟動(dòng)類和配置文件，其他子模塊的的啟動(dòng)類和配置文件都刪除

3.編輯父工程的pom.xml文件

???????? a.將父工程 pom.xml 文件修改成如下內(nèi)容，里面聲明該父工程包含的子模塊，同時(shí)抽取統(tǒng)一的配置信息和依賴版本控制，這樣可以方便子 pom 直接引用，簡(jiǎn)化子 pom 的配置

????? 注意??? · 多模塊項(xiàng)目中，父模塊打包類型必須是 pom。

????????? ????????? · 因?yàn)殚_發(fā)框架是 spring boot，父模塊默認(rèn)繼承 spring-boot-starter-parent，因此可以刪除 spring-boot-starter 和 spring-boot-starter-test 依賴（祖先已經(jīng)包含了）

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

?<groupId>com.xyy</groupId>
?<artifactId>scaffold</artifactId>
?<version>0.0.1-SNAPSHOT</version>
?<name>scaffold</name>
?<description>Demo project for Spring Boot</description>

?<!-- 父模塊打包類型必須為pom -->
?<packaging>pom</packaging>

?<!-- parent指明繼承關(guān)系，給出被繼承的父項(xiàng)目的具體信息-->
?<parent>
? ? ?<groupId>org.springframework.boot</groupId>
? ? ?<artifactId>spring-boot-starter-parent</artifactId>
? ? ?<version>2.7.12</version>
? ? ?<relativePath/> <!-- lookup parent from repository -->
?</parent>

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

?<!-- 模塊說明：這里聲明多個(gè)子模塊 -->
?<modules>
? ? ?<module>scaffold-web</module>
? ? ?<module>scaffold-api</module>
? ? ?<module>scaffold-common</module>
? ? ?<module>scaffold-dao</module>
? ? ?<module>scaffold-service</module>
?</modules>

?<!-- 版本說明：這里統(tǒng)一管理依賴的版本號(hào) -->
?<dependencyManagement>
? ? ?<dependencies>
? ? ? ? ?<!-- 這里可以刪除spring-boot-starter 和 spring-boot-starter-test 依賴（祖先已經(jīng)包含了） -->
? ? ? ? ?<!--<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>-->

? ? ? ? ?<dependency>
? ? ? ? ? ? ?<groupId>com.xyy</groupId>
? ? ? ? ? ? ?<artifactId>scaffold-web</artifactId>
? ? ? ? ? ? ?<version>0.0.1-SNAPSHOT</version>
? ? ? ? ?</dependency>
? ? ? ? ?<dependency>
? ? ? ? ? ? ?<groupId>com.xyy</groupId>
? ? ? ? ? ? ?<artifactId>scaffold-common</artifactId>
? ? ? ? ? ? ?<version>0.0.1-SNAPSHOT</version>
? ? ? ? ?</dependency>
? ? ? ? ?<dependency>
? ? ? ? ? ? ?<groupId>com.xyy</groupId>
? ? ? ? ? ? ?<artifactId>scaffold-dao</artifactId>
? ? ? ? ? ? ?<version>0.0.1-SNAPSHOT</version>
? ? ? ? ?</dependency>
? ? ? ? ?<dependency>
? ? ? ? ? ? ?<groupId>com.xyy</groupId>
? ? ? ? ? ? ?<artifactId>scaffold-service</artifactId>
? ? ? ? ? ? ?<version>0.0.1-SNAPSHOT</version>
? ? ? ? ?</dependency>
? ? ? ? ?<dependency>
? ? ? ? ? ? ?<groupId>com.xyy</groupId>
? ? ? ? ? ? ?<artifactId>scaffold-api</artifactId>
? ? ? ? ? ? ?<version>0.0.1-SNAPSHOT</version>
? ? ? ? ?</dependency>
? ? ?</dependencies>
?</dependencyManagement>


?<build>
? ? ?<plugins>
? ? ? ? ?<plugin>
? ? ? ? ? ? ?<groupId>org.springframework.boot</groupId>
? ? ? ? ? ? ?<artifactId>spring-boot-maven-plugin</artifactId>
? ? ? ? ?</plugin>
? ? ?</plugins>
?</build>

</project>

4.編輯子模塊pom.xml

???????? a.子模塊 scaffold-common 的 pom.xml 文件內(nèi)容如下，其中 parent 要使用頂層的父模塊，同時(shí)由于我們項(xiàng)目用到了 Lombok ，所以還添加了 lombok 依賴

????? 注意： 由于子模塊的配置信息會(huì)繼承父模塊的，所以子模塊原來的 properties 可刪掉

<?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>

?<groupId>com.xyy</groupId>
?<artifactId>scaffold-common</artifactId>
?<version>0.0.1-SNAPSHOT</version>
?<name>scaffold-common</name>
?<description>Demo project for Spring Boot</description>

?<!-- 繼承本項(xiàng)目的父工程 -->
?<parent>
? ? ?<groupId>com.xyy</groupId>
? ? ?<artifactId>scaffold</artifactId>
? ? ?<version>0.0.1-SNAPSHOT</version>
? ? ?<relativePath/> <!-- lookup parent from repository -->
?</parent>

?<properties>
? ? ?<java.version>1.8</java.version>
?</properties>
?<dependencies>
? ? ?<dependency>
? ? ? ? ?<groupId>org.projectlombok</groupId>
? ? ? ? ?<artifactId>lombok</artifactId>
? ? ? ? ?<version>1.18.6</version>
? ? ?</dependency>
?</dependencies>
</project>

???????? b.子模塊scaffold-dao 的 pom.xml 文件內(nèi)容如下，同樣 parent 要使用頂層的父模塊，并添加 scaffold-common 子模塊，以及數(shù)據(jù)庫相關(guān)依賴

<?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>

?<groupId>com.xyy</groupId>
?<artifactId>scaffold-dao</artifactId>
?<version>0.0.1-SNAPSHOT</version>
?<name>scaffold-dao</name>
?<description>Demo project for Spring Boot</description>

?<parent>
? ? ?<groupId>com.xyy</groupId>
? ? ?<artifactId>scaffold</artifactId>
? ? ?<version>0.0.1-SNAPSHOT</version>
? ? ?<relativePath/> <!-- lookup parent from repository -->
?</parent>

?<properties>
? ? ?<java.version>1.8</java.version>
?</properties>
?<dependencies>
? ? ?<dependency>
? ? ? ? ?<groupId>com.xyy</groupId>
? ? ? ? ?<artifactId>scaffold-common</artifactId>
? ? ?</dependency>
?</dependencies>

</project>

???????? c.子模塊 scaffold-service 的 pom.xml 文件內(nèi)容如下，同樣 parent 要使用頂層的父模塊，并添加 scaffold-dao 子模塊依賴

?????? 注意：實(shí)際開發(fā)中dao模塊會(huì)引入對(duì)數(shù)據(jù)相關(guān)包的依賴，如mysql、Druid連接池、mybatis等

<?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>

<groupId>com.xyy</groupId>
<artifactId>scaffold-service</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>scaffold-service</name>
<description>Demo project for Spring Boot</description>

<parent>
? ?<groupId>com.xyy</groupId>
? ?<artifactId>scaffold</artifactId>
? ?<version>0.0.1-SNAPSHOT</version>
? ?<relativePath/> <!-- lookup parent from repository -->
</parent>

<properties>
? ?<java.version>1.8</java.version>
</properties>
<dependencies>
? ?<dependency>
? ? ? <groupId>com.xyy</groupId>
? ? ? <artifactId>scaffold-dao</artifactId>
? ?</dependency>
</dependencies>
</project>




? ? ? ? d.子模塊 scaffold-web 的 pom.xml 文件內(nèi)容如下，同樣 parent 要使用頂層的父模塊，并添加 scaffold-service 子模塊依賴

? ? ?注意：之前創(chuàng)建這個(gè)子模塊的時(shí)候已經(jīng)添加了 spring-boot-starter-web 依賴，如果沒有則手動(dòng)添加

<?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>

?<groupId>com.xyy</groupId>
?<artifactId>scaffold-web</artifactId>
?<version>0.0.1-SNAPSHOT</version>
?<name>scaffold-web</name>
?<description>Demo project for Spring Boot</description>

?<parent>
? ? ?<groupId>com.xyy</groupId>
? ? ?<artifactId>scaffold</artifactId>
? ? ?<version>0.0.1-SNAPSHOT</version>
? ? ?<relativePath/> <!-- lookup parent from repository -->
?</parent>

?<properties>
? ? ?<java.version>1.8</java.version>
?</properties>
?<dependencies>
? ? ?<dependency>
? ? ? ? ?<groupId>org.springframework.boot</groupId>
? ? ? ? ?<artifactId>spring-boot-starter-web</artifactId>
? ? ?</dependency>

? ? ?<dependency>
? ? ? ? ?<groupId>com.xyy</groupId>
? ? ? ? ?<artifactId>scaffold-service</artifactId>
? ? ?</dependency>
?</dependencies>

?<build>
? ? ?<plugins>
? ? ? ? ?<plugin>
? ? ? ? ? ? ?<groupId>org.springframework.boot</groupId>
? ? ? ? ? ? ?<artifactId>spring-boot-maven-plugin</artifactId>
? ? ? ? ?</plugin>
? ? ?</plugins>
?</build>

</project>

? ? ? ?a.子模塊 scaffold-api 的 pom.xml 文件內(nèi)容如下，同樣 parent 要使用頂層的父模塊

<?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>

?<groupId>com.xyy</groupId>
?<artifactId>scaffold-api</artifactId>
?<version>0.0.1-SNAPSHOT</version>
?<name>scaffold-api</name>
?<description>Demo project for Spring Boot</description>

?<parent>
? ? ?<groupId>com.xyy</groupId>
? ? ?<artifactId>scaffold</artifactId>
? ? ?<version>0.0.1-SNAPSHOT</version>
? ? ?<relativePath/> <!-- lookup parent from repository -->
?</parent>

?<properties>
? ? ?<java.version>1.8</java.version>
?</properties>
?<dependencies>
? ? ?<dependency>
? ? ? ? ?<groupId>com.xyy</groupId>
? ? ? ? ?<artifactId>scaffold-common</artifactId>
? ? ?</dependency>

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

5.移動(dòng)項(xiàng)目啟動(dòng)類所在包

? ? ? ?a.目前項(xiàng)目啟動(dòng)類 ScaffoldWebApplication 在 com.xyy.scaffold 包下面，我們需要將其移動(dòng)移動(dòng)到 com.xyy 包下

? ? ? ?b.移動(dòng)的方式就是右鍵點(diǎn)擊 ScaffoldWebApplication 選擇 Refactor -> Move ，將to package改成com.xyy




? ? ? ?c.移動(dòng)后




6.編寫controller并啟動(dòng)

? ? ? ?a.在com.xyy.scaffoldweb下寫個(gè)測(cè)試Controller

? ? ? ? b.啟動(dòng)項(xiàng)目




???????? c. 打開瀏覽器訪問

搭建項(xiàng)目工程結(jié)構(gòu)

搭建好多module項(xiàng)目并成功啟動(dòng)后，我們?cè)賮順?gòu)建項(xiàng)目工程結(jié)構(gòu)

1. scaffold-web模塊

主要包含一個(gè)啟動(dòng)類、一個(gè)web和一個(gè)config包

• web包：包含所有controller

• config包：負(fù)責(zé)web模塊后續(xù)的統(tǒng)一配置類

? 2.scaffold-service模塊

主要包含業(yè)務(wù)邏輯代碼，包含業(yè)務(wù)接口及其實(shí)現(xiàn)類

• impl：包含所有業(yè)務(wù)接口的實(shí)現(xiàn)

3.scaffold-dao模塊

主要包含數(shù)據(jù)訪問層內(nèi)容，DO定義、DB訪問層以及數(shù)據(jù)庫相關(guān)配置類

4.ffold-common模塊

包含每個(gè)模塊可能都會(huì)用的一些基礎(chǔ)類，如：dto、錯(cuò)誤碼、util工具類以及全局異常類和常量等

5.scaffold-api模塊

主要負(fù)責(zé)外部依賴服務(wù)的管理，包含外部依賴服務(wù)的定義以及訪問部分，以及通過facade模式做的封裝類，如：request、response定義；外部服務(wù)api接口和外部服務(wù)通用枚舉等

6.整體服務(wù)的調(diào)用過程如下




???????????

????????
?