如何簡潔高效的搭建一個SpringCloud2023的maven工程

落叶微风發表於2024-03-06

SpringGCCloudMaven

前言

依賴管理有gradle和maven，在這裡選擇比較常用和方便的Maven作為工程專案和依賴管理工具來搭建SpringCloud實戰工程。主要用到的maven管理方式是多模組和bom依賴管理。

什麼是maven的多模組依賴管理

Maven 多模組專案相對於單模組專案而言，依賴是不共享的，但父模組提供了全域性共享依賴的功能，可以針對不同模組所需要依賴的包進行分模組引入。具體如下：

所有子模組都依賴的包，如junit可以統一由父模組中的<dependencies>設定依賴。
多個子模組但非全部子模組依賴的包，可以在父模組中的<dependencyManagement>中統一管理依賴版本，再由每個子模組自主引入依賴，這樣設定可以達到專案中多個子模組依賴的包版本統一的目的。
單個子模組依賴的包，可以直接交由這個子模組引入即可。但有時候出於對後續可能新增子模組考慮，即使當前只有一個子模組依賴的包，也可以統一交由父模組的<dependencyManagement>統一管理，而如果確認後續不會再加子模組的，可以按前者進行處理。

在父模組中，可透過<properties>統一管理依賴包的版本，讓共享包也更加統一管理。

什麼是maven的bom依賴管理

Maven 的 BOM（Bill of Materials）依賴管理是一種用於集中管理專案依賴關係和版本的方式，它提供了一種方便的方法來確保多個專案或模組在使用相同依賴時具有一致的版本。

BOM 通常是一個特殊的 Maven POM（Project Object Model）檔案，其中定義了專案所需的依賴項及其版本。透過在其他專案中引用這個 BOM，這些專案將自動獲取 BOM 中定義的依賴版本，而無需明確指定每個依賴的版本。

這樣做的好處是可以減少重複的依賴配置工作，並確保在多個專案中使用相同的依賴版本，從而減少由於依賴不一致導致的問題。此外，BOM 還可以用於管理依賴的升級和版本控制，只需在 BOM 中更新依賴的版本，所有引用該 BOM 的專案都會自動獲取最新的版本。

要使用 Maven 的 BOM 依賴管理，通常需要執行以下步驟：

建立或獲取一個 BOM POM 檔案，其中定義了專案的依賴和版本資訊。
在需要使用 BOM 的專案中，透過在<dependencyManagement>部分引用 BOM POM 檔案。
在專案的具體依賴部分，可以直接使用 BOM 中定義的依賴，而無需明確指定版本。

元件選型

在“SpringCloud2023最新版本該如何進行元件選型？”一文中已經具體的介紹了SpringCloud的元件對比和選型，具體可以檢視合集裡面的相關文件。

註冊中心（Spring Cloud Zookeeper）：負責服務的註冊和發現。
閘道器（Spring Cloud Gateway）：作為外部請求的入口，實現路由和負載均衡。
雲服務配置（Spring Cloud Config）：用於管理服務的配置資訊。
熔斷（Sentinel）：提供熔斷器功能，實現服務的限流和降級。
服務追蹤（Micrometer Tracing）：用於追蹤和監控服務的效能和呼叫情況。
測試整合（JUnit 5 + Spring Boot Test）：用於編寫和執行單元測試。
遠端呼叫（OpenFeign）：用於服務之間的遠端呼叫。
介面文件（springdoc-openapi + openapi3）：用於生成和管理 API 的文件。
分散式事務（Seata）：用於處理跨多個服務的事務。

版本選擇

在“SpringCloud和SpringBoot的版本依賴該怎麼選擇”一文中已經具體的介紹了SpringCloud的版本如何選擇，具體可以檢視合集裡面的相關文件。

元件	版本
jdk	17
spring boot	3.2.x
spring cloud	2023.0.x
spring cloud alibaba	2022.0.0.0（還未更新，但是相容2023）

為什麼選擇JDK17

選擇JDK17的原因如下：

JDK 17是 LTS（長期支援版）。
JDK 17效能提升不少。
大多數第三方框架和庫都已經支援，不會有什麼大坑。
JDK 17有更多的新特性支援。

Maven工程依賴說明

|-- banana-client1
|-- banana-client2
|-- banana-client3
|-- banana-client4-sentinel
|-- banana-client5-tracing
|-- banana-client6-test
|-- banana-common
|   |-- banana-common-bom
|   `-- banana-common-core
|-- banana-config
|-- banana-gateway
|-- banana-gateway-sso
`-- banana-seata-example

根目錄下的pom.xml負責管理整個專案的版本和依賴引入版本管理，以及子模組的管理。
banana-common-bom 負責管理整個公共依賴的版本，比如undertow、swagger的版本。
banana-common-core 負責管理整個公共元件的引入，比如 hutool、validation、test等。
gateway 相關專案為SCG相關工程。
client 相關專案為springboot相關工程。
其他工程會在後續的文章說明。歡迎持續關注。

頂級工程pom.xml配置

該maven的pom檔案定義瞭如下內容：

Maven 專案的模組列表
Maven 專案的屬性列表
Maven 專案的依賴管理
Maven 專案的倉庫列表
Maven 專案的構建配置

<?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">
    <!-- Maven 專案的根節點 -->
    <modelVersion>4.0.0</modelVersion>
    <!-- Maven 專案的groupId，在 Maven 倉庫中，groupId 必須是唯一的 -->
    <groupId>io.rainforest</groupId>
    <!-- Maven 專案的 artifactId，可以包含多個模組 -->
    <artifactId>banana</artifactId>
    <!-- Maven 專案的版本號 -->
    <version>1.0</version>
    <!-- Maven 專案的打包方式，這裡是 pom -->
    <packaging>pom</packaging>

    <!-- Maven 專案的模組列表 -->
    <modules>
        <module>banana-gateway</module>
        <module>banana-config</module>
        <module>banana-common</module>
        <module>banana-client1</module>
        <module>banana-client2</module>
        <module>banana-client3</module>
        <module>banana-client4-sentinel</module>
        <module>banana-client5-tracing</module>
        <module>banana-client6-test</module>
        <module>banana-seata-example</module>
        <module>banana-gateway-sso</module>
    </modules>

    <!-- Maven 專案的屬性列表 -->
    <properties>
        <!-- Maven 編譯器的 source 版本 -->
        <maven.compiler.source>17</maven.compiler.source>
        <!-- Maven 編譯器的 target 版本 -->
        <maven.compiler.target>17</maven.compiler.target>
        <!-- 專案構建的源編碼 -->
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <!-- Spring Boot 的版本 -->
        <spring-boot.version>3.2.3</spring-boot.version>
        <!-- Spring Cloud 的版本 -->
        <spring-cloud.version>2023.0.0</spring-cloud.version>
        <!-- Spring Cloud Alibaba 的版本 -->
        <spring-cloud-alibaba.version>2022.0.0.0</spring-cloud-alibaba.version>
    </properties>

    <!-- Maven 專案的依賴管理 -->
    <dependencyManagement>
        <!-- Maven 專案的依賴列表 -->
        <dependencies>
            <!-- banana 公共版本定義 -->
            <dependency>
                <groupId>io.rainforest</groupId>
                <artifactId>banana-common-bom</artifactId>
                <version>${project.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- Spring Boot 依賴 -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- Spring Cloud 依賴 -->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- Spring Cloud Alibaba 依賴 -->
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <!-- Maven 專案的倉庫列表 -->
    <repositories>
        <!-- Maven 中央倉庫的配置 -->
        <repository>
            <id>central</id>
            <name>Central Repository</name>
            <url>https://mirrors.huaweicloud.com/repository/maven/</url>
            <layout>default</layout>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>

    <!-- Maven 專案的構建配置 -->
    <build>
        <!-- Maven 專案構建的最終名稱 -->
        <finalName>${project.name}</finalName>
        <!-- Maven 專案的資源配置 -->
        <resources>
            <!-- 資原始檔所在的目錄 -->
            <resource>
                <directory>src/main/resources</directory>
                <!-- 對資原始檔進行過濾 -->
                <filtering>true</filtering>
            </resource>
        </resources>
        <!-- Maven 專案的外掛管理 -->
        <pluginManagement>
            <!-- Maven 專案的外掛列表 -->
            <plugins>
                <!-- Spring Boot Maven 外掛的配置 -->
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <version>${spring-boot.version}</version>
                    <configuration>
                        <!-- 專案構建的最終名稱 -->
                        <finalName>${project.build.finalName}</finalName>
                        <!-- 啟用 Spring Boot 的分層 -->
                        <layers>
                            <enabled>true</enabled>
                        </layers>
                    </configuration>
                    <!-- Maven 外掛的執行配置 -->
                    <executions>
                        <!-- Maven 外掛的執行目標 -->
                        <execution>
                            <goals>
                                <goal>repackage</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
</project>

工程的公用依賴bom配置