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

来源:https://www.cnblogs.com/r0ad/p/18056451
-Advertisement-
Play Games

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


前言

依賴管理有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配置

該maven的pom文件定義瞭如下內容：

  • 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">
    <groupId>io.rainforest</groupId>
    <artifactId>banana-common-bom</artifactId>
    <version>1.0</version>

    <modelVersion>4.0.0</modelVersion>
    <packaging>pom</packaging>
    <description>banana-common-bom 公共依賴管理</description>

    <properties>
        <banana.common.version>${project.version}</banana.common.version>
        <spring-boot.version>3.1.3</spring-boot.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <log4j2.version>2.17.1</log4j2.version>
        <maven.compiler.target>17</maven.compiler.target>
        <maven.compiler.source>17</maven.compiler.source>
        <git.commit.plugin>4.9.9</git.commit.plugin>
        <spring.checkstyle.plugin>0.0.39</spring.checkstyle.plugin>
        <fastjson.version>1.2.83</fastjson.version>
        <springdoc.version>2.1.0</springdoc.version>
        <swagger.core.version>2.2.14</swagger.core.version>
        <mybatis-plus.version>3.5.3.2</mybatis-plus.version>
        <mysql.version>8.0.33</mysql.version>
        <dynamic-ds.version>4.1.3</dynamic-ds.version>
        <seata.version>1.6.1</seata.version>
        <excel.version>3.1.0</excel.version>
        <asm.version>7.1</asm.version>
        <sms.version>3.0.0</sms.version>
        <jaxb.version>2.3.5</jaxb.version>
        <shardingsphere.version>5.4.0</shardingsphere.version>
        <hutool.version>5.8.21</hutool.version>
        <mica.version>3.0.8</mica.version>
        <sentinel.version>1.8.4</sentinel.version>
    </properties>
    <!-- 定義全局jar版本,模塊使用需要再次引入但不用寫版本號-->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>io.rainforest</groupId>
                <artifactId>banana-common-core</artifactId>
                <version>${banana.common.version}</version>
            </dependency>
            <dependency>
                <groupId>com.mysql</groupId>
                <artifactId>mysql-connector-j</artifactId>
                <version>${mysql.version}</version>
            </dependency>
            <!--springdoc -->
            <dependency>
                <groupId>org.springdoc</groupId>
                <artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
                <version>${springdoc.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springdoc</groupId>
                <artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
                <version>${springdoc.version}</version>
            </dependency>
            <dependency>
                <groupId>io.swagger.core.v3</groupId>
                <artifactId>swagger-annotations-jakarta</artifactId>
                <version>${swagger.core.version}</version>
            </dependency>
            <!--fastjson 版本-->
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>${fastjson.version}</version>
            </dependency>

            <!-- 多數據源依賴 -->
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>dynamic-datasource-spring-boot3-starter</artifactId>
                <version>${dynamic-ds.version}</version>
            </dependency>
            <!--  阿裡雲簡訊下發 -->
            <dependency>
                <groupId>io.springboot.sms</groupId>
                <artifactId>aliyun-sms-spring-boot-starter</artifactId>
                <version>${sms.version}</version>
            </dependency>
            <!--  seata kryo 序列化-->
            <dependency>
                <groupId>io.seata</groupId>
                <artifactId>seata-serializer-kryo</artifactId>
                <version>${seata.version}</version>
            </dependency>
            <!--orm 相關-->
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>${mybatis-plus.version}</version>
            </dependency>
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-extension</artifactId>
                <version>${mybatis-plus.version}</version>
            </dependency>
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-annotation</artifactId>
                <version>${mybatis-plus.version}</version>
            </dependency>
            <!--hutool bom 工具類-->
            <dependency>
                <groupId>cn.hutool</groupId>
                <artifactId>hutool-bom</artifactId>
                <version>${hutool.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--mica bom 工具類-->
            <dependency>
                <groupId>net.dreamlu</groupId>
                <artifactId>mica-bom</artifactId>
                <version>${mica.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--web 模塊-->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
                <version>${spring-boot.version}</version>
                <exclusions>
                    <!--排除tomcat依賴-->
                    <exclusion>
                        <artifactId>spring-boot-starter-tomcat</artifactId>
                        <groupId>org.springframework.boot</groupId>
                    </exclusion>
                </exclusions>
            </dependency>
            <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
                <version>4.3.0</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <!--打包jar 與git commit 關聯插件-->
            <plugin>
                <groupId>io.github.git-commit-id</groupId>
                <artifactId>git-commit-id-maven-plugin</artifactId>
                <version>${git.commit.plugin}</version>
            </plugin>
            <!--代碼格式插件，預設使用spring 規則-->
            <plugin>
                <groupId>io.spring.javaformat</groupId>
                <artifactId>spring-javaformat-maven-plugin</artifactId>
                <version>${spring.checkstyle.plugin}</version>
            </plugin>
        </plugins>
    </build>

</project>

源碼信息

和“SpringCloud實戰”對應的源碼信息如下：

關於作者

來自一線全棧程式員nine的八年探索與實踐，持續迭代中。歡迎關註“雨林尋北”或添加個人衛星codetrend（備註技術）。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • C++STL學習第一篇（什麼是STL以及string的各種功能用法）
    STL STL提供了六大組件，彼此之間可以組合套用，這六大組件分別是:容器、演算法、迭代器、仿函數、適配器、空間配置器。 數據結構和容器管理：STL 提供了多種數據結構和容器，如向量（vector）、鏈表（list）、集合（set）、映射（map）等。這些容器可以幫助程式員方便地存儲和管理數據，根據需 ...
  • java飛機大戰小游戲作業二次開發
    import java.awt.Color; import java.awt.Font; import java.io.IOException; import java.io.OutputStream; import java.util.ArrayList; import java.util.Lis ...
  • Java 枚舉（Enums）解析：提高代碼可讀性與易維護性
    介面 在 Java 中，實現抽象的另一種方式是使用介面。 介面定義 介面是一個完全抽象的類，用於將具有空方法體的相關方法分組： // 介面 interface Animal { public void animalSound(); // 介面方法（沒有具體實現體） public void run() ...
  • 為HTTP而生的requests庫，縱橫江湖難逢敵手
    既然Python是一門全球流行的語言，那麼對於網路通信的HTTP的支持肯定也是非常的優秀的。Python中原生的urllib模塊也有對HTTP的支持，雖然也可以用來發送 HTTP 請求，但使用起來相對繁瑣，並且 API 設計不夠直觀。 requests 庫的出現填補了 Python 在 HTTP 請 ...
  • 【Flink入門修煉】2-2 Flink State 狀態
    - 什麼是狀態？狀態有什麼作用？ - 如果你來設計，對於一個流式服務，如何根據不斷輸入的數據計算呢？ - 又如何做故障恢復呢？ ...
  • PbRL Preference Transformer
    論文題目：Preference Transformer: Modeling Human Preferences using Transformers for RL，ICLR 2023，5 6 6 8，poster。 pdf：https://arxiv.org/pdf/2303.00957.pdf h ...
  • Python函數每日一講 - hex()
    Maven安裝本地的jar包 如果沒配置Maven的環境變數，需要先CD到maven的安裝目錄，因為沒配置環境變數，mvn命令是無法在maven安裝目錄以外的目錄運行。 cd C:\Maven\apache-maven-3.6.3\bin 然後執行下麵命令格式如下： mvn install:inst ...
  • CMS垃圾收集器
    CMS GC的英文名為：“Mostly Concurrent Mark and Sweep Garbage Collector” （最大-併發-標記-清除-垃圾收集器）。 作用範圍： 老年代 演算法： 併發標記清除演算法。 啟用參數：-XX:+UseConMarkSweepGC預設回收線程數：（處理器核 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類