怎样简洁高效的搭建一个SpringCloud2023的maven工程

前言

依靠管理有gradle和maven，在这里选择比较常用和方便的Maven作为工程项目和依靠管理工具来搭建SpringCloud实战工程。主要用到的maven管理方式是多模块和bom依靠管理。
什么是maven的多模块依靠管理

Maven 多模块项目相对于单模块项目而言，依靠是不共享的，但父模块提供了全局共享依靠的功能，可以针对差别模块所需要依靠的包进行分模块引入。具体如下：

• 所有子模块都依靠的包，如junit可以同一由父模块中的设置依靠。
  
• 多个子模块但非全部子模块依靠的包，可以在父模块中的中同一管理依靠版本，再由每个子模块自主引入依靠，如许设置可以达到项目中多个子模块依靠的包版本同一的目的。
  
• 单个子模块依靠的包，可以直接交由这个子模块引入即可。但偶然候出于对后续可能添加子模块思量，纵然当前只有一个子模块依靠的包，也可以同一交由父模块的同一管理，而如果确认后续不会再加子模块的，可以按前者进行处理。
  

在父模块中，可通过同一管理依靠包的版本，让共享包也更加同一管理。
什么是maven的bom依靠管理

Maven 的 BOM（Bill of Materials）依靠管理是一种用于集中管理项目依靠关系和版本的方式，它提供了一种方便的方法来确保多个项目或模块在使用雷同依靠时具有划一的版本。
BOM 通常是一个特殊的 Maven POM（Project Object Model）文件，其中定义了项目所需的依靠项及其版本。通过在其他项目中引用这个 BOM，这些项目将主动获取 BOM 中定义的依靠版本，而无需明确指定每个依靠的版本。
如许做的好处是可以减少重复的依靠设置工作，并确保在多个项目中使用雷同的依靠版本，从而减少由于依靠不划一导致的问题。此外，BOM 还可以用于管理依靠的升级和版本控制，只需在 BOM 中更新依靠的版本，所有引用该 BOM 的项目都会主动获取最新的版本。
要使用 Maven 的 BOM 依靠管理，通常需要实行以下步骤：

• 创建或获取一个 BOM POM 文件，其中定义了项目的依靠和版本信息。
  
• 在需要使用 BOM 的项目中，通过在部分引用 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的版本怎样选择，具体可以查看合集里面的相关文档。
组件版本jdk17spring boot3.2.xspring cloud2023.0.xspring cloud alibaba2022.0.0.0（还未更新，但是兼容2023）为什么选择JDK17

选择JDK17的原因如下：

• JDK 17是 LTS（恒久支持版）。
  
• JDK 17性能提升不少。
  
• 大多数第三方框架和库都已经支持，不会有什么大坑。
  
• JDK 17有更多的新特性支持。
  

Maven工程依靠阐明

1. |-- banana-client1
2. |-- banana-client2
3. |-- banana-client3
4. |-- banana-client4-sentinel
5. |-- banana-client5-tracing
6. |-- banana-client6-test
7. |-- banana-common
8. |   |-- banana-common-bom
9. |   `-- banana-common-core
10. |-- banana-config
11. |-- banana-gateway
12. |-- banana-gateway-sso
13. `-- 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 项目的构建设置
  

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0"
3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5.    
6.     <modelVersion>4.0.0</modelVersion>
7.    
8.     <groupId>io.rainforest</groupId>
9.    
10.     <artifactId>banana</artifactId>
11.    
12.     <version>1.0</version>
13.    
14.     <packaging>pom</packaging>
16.    
17.     <modules>
18.         <module>banana-gateway</module>
19.         <module>banana-config</module>
20.         <module>banana-common</module>
21.         <module>banana-client1</module>
22.         <module>banana-client2</module>
23.         <module>banana-client3</module>
24.         <module>banana-client4-sentinel</module>
25.         <module>banana-client5-tracing</module>
26.         <module>banana-client6-test</module>
27.         <module>banana-seata-example</module>
28.         <module>banana-gateway-sso</module>
29.     </modules>
31.    
32.     <properties>
33.         
34.         <maven.compiler.source>17</maven.compiler.source>
35.         
36.         <maven.compiler.target>17</maven.compiler.target>
37.         
38.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
39.         
40.         <spring-boot.version>3.2.3</spring-boot.version>
41.         
42.         <spring-cloud.version>2023.0.0</spring-cloud.version>
43.         
44.         <spring-cloud-alibaba.version>2022.0.0.0</spring-cloud-alibaba.version>
45.     </properties>
47.    
48.     <dependencyManagement>
49.         
50.         <dependencies>
51.             
52.             <dependency>
53.                 <groupId>io.rainforest</groupId>
54.                 <artifactId>banana-common-bom</artifactId>
55.                 <version>${project.version}</version>
56.                 <type>pom</type>
57.                 <scope>import</scope>
58.             </dependency>
59.             
60.             <dependency>
61.                 <groupId>org.springframework.boot</groupId>
62.                 <artifactId>spring-boot-dependencies</artifactId>
63.                 <version>${spring-boot.version}</version>
64.                 <type>pom</type>
65.                 <scope>import</scope>
66.             </dependency>
67.             
68.             <dependency>
69.                 <groupId>org.springframework.cloud</groupId>
70.                 <artifactId>spring-cloud-dependencies</artifactId>
71.                 <version>${spring-cloud.version}</version>
72.                 <type>pom</type>
73.                 <scope>import</scope>
74.             </dependency>
75.             
76.             <dependency>
77.                 <groupId>com.alibaba.cloud</groupId>
78.                 <artifactId>spring-cloud-alibaba-dependencies</artifactId>
79.                 <version>${spring-cloud-alibaba.version}</version>
80.                 <type>pom</type>
81.                 <scope>import</scope>
82.             </dependency>
83.         </dependencies>
84.     </dependencyManagement>
86.    
87.     <repositories>
88.         
89.         <repository>
90.             <id>central</id>
91.             <name>Central Repository</name>
92.             <url>https://mirrors.huaweicloud.com/repository/maven/</url>
93.             <layout>default</layout>
94.             <snapshots>
95.                 <enabled>false</enabled>
96.             </snapshots>
97.         </repository>
98.     </repositories>
100.    
101.     <build>
102.         
103.         <finalName>${project.name}</finalName>
104.         
105.         <resources>
106.             
107.             <resource>
108.                 <directory>src/main/resources</directory>
109.                
110.                 <filtering>true</filtering>
111.             </resource>
112.         </resources>
113.         
114.         <pluginManagement>
115.             
116.             <plugins>
117.                
118.                 <plugin>
119.                     <groupId>org.springframework.boot</groupId>
120.                     <artifactId>spring-boot-maven-plugin</artifactId>
121.                     <version>${spring-boot.version}</version>
122.                     <configuration>
123.                         
124.                         <finalName>${project.build.finalName}</finalName>
125.                         
126.                         <layers>
127.                             <enabled>true</enabled>
128.                         </layers>
129.                     </configuration>
130.                     
131.                     <executions>
132.                         
133.                         <execution>
134.                             <goals>
135.                                 <goal>repackage</goal>
136.                             </goals>
137.                         </execution>
138.                     </executions>
139.                 </plugin>
140.             </plugins>
141.         </pluginManagement>
142.     </build>
143. </project>

复制代码

工程的公用依靠bom设置

该maven的pom文件定义了如下内容：

• Maven 项目的属性列表，包含版本等信息
  
• Maven 项目使用到的依靠版本管理
  

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0"
3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5.     <groupId>io.rainforest</groupId>
6.     <artifactId>banana-common-bom</artifactId>
7.     <version>1.0</version>
9.     <modelVersion>4.0.0</modelVersion>
10.     <packaging>pom</packaging>
11.     <description>banana-common-bom 公共依赖管理</description>
13.     <properties>
14.         <banana.common.version>${project.version}</banana.common.version>
15.         <spring-boot.version>3.1.3</spring-boot.version>
16.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
17.         <log4j2.version>2.17.1</log4j2.version>
18.         <maven.compiler.target>17</maven.compiler.target>
19.         <maven.compiler.source>17</maven.compiler.source>
20.         <git.commit.plugin>4.9.9</git.commit.plugin>
21.         <spring.checkstyle.plugin>0.0.39</spring.checkstyle.plugin>
22.         <fastjson.version>1.2.83</fastjson.version>
23.         <springdoc.version>2.1.0</springdoc.version>
24.         <swagger.core.version>2.2.14</swagger.core.version>
25.         <mybatis-plus.version>3.5.3.2</mybatis-plus.version>
26.         <mysql.version>8.0.33</mysql.version>
27.         <dynamic-ds.version>4.1.3</dynamic-ds.version>
28.         <seata.version>1.6.1</seata.version>
29.         <excel.version>3.1.0</excel.version>
30.         <asm.version>7.1</asm.version>
31.         <sms.version>3.0.0</sms.version>
32.         <jaxb.version>2.3.5</jaxb.version>
33.         <shardingsphere.version>5.4.0</shardingsphere.version>
34.         <hutool.version>5.8.21</hutool.version>
35.         <mica.version>3.0.8</mica.version>
36.         <sentinel.version>1.8.4</sentinel.version>
37.     </properties>
38.    
39.     <dependencyManagement>
40.         <dependencies>
41.             <dependency>
42.                 <groupId>io.rainforest</groupId>
43.                 <artifactId>banana-common-core</artifactId>
44.                 <version>${banana.common.version}</version>
45.             </dependency>
46.             <dependency>
47.                 <groupId>com.mysql</groupId>
48.                 <artifactId>mysql-connector-j</artifactId>
49.                 <version>${mysql.version}</version>
50.             </dependency>
51.             
52.             <dependency>
53.                 <groupId>org.springdoc</groupId>
54.                 <artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
55.                 <version>${springdoc.version}</version>
56.             </dependency>
57.             <dependency>
58.                 <groupId>org.springdoc</groupId>
59.                 <artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
60.                 <version>${springdoc.version}</version>
61.             </dependency>
62.             <dependency>
63.                 <groupId>io.swagger.core.v3</groupId>
64.                 <artifactId>swagger-annotations-jakarta</artifactId>
65.                 <version>${swagger.core.version}</version>
66.             </dependency>
67.             
68.             <dependency>
69.                 <groupId>com.alibaba</groupId>
70.                 <artifactId>fastjson</artifactId>
71.                 <version>${fastjson.version}</version>
72.             </dependency>
74.             
75.             <dependency>
76.                 <groupId>com.baomidou</groupId>
77.                 <artifactId>dynamic-datasource-spring-boot3-starter</artifactId>
78.                 <version>${dynamic-ds.version}</version>
79.             </dependency>
80.             
81.             <dependency>
82.                 <groupId>io.springboot.sms</groupId>
83.                 <artifactId>aliyun-sms-spring-boot-starter</artifactId>
84.                 <version>${sms.version}</version>
85.             </dependency>
86.             
87.             <dependency>
88.                 <groupId>io.seata</groupId>
89.                 <artifactId>seata-serializer-kryo</artifactId>
90.                 <version>${seata.version}</version>
91.             </dependency>
92.             
93.             <dependency>
94.                 <groupId>com.baomidou</groupId>
95.                 <artifactId>mybatis-plus-boot-starter</artifactId>
96.                 <version>${mybatis-plus.version}</version>
97.             </dependency>
98.             <dependency>
99.                 <groupId>com.baomidou</groupId>
100.                 <artifactId>mybatis-plus-extension</artifactId>
101.                 <version>${mybatis-plus.version}</version>
102.             </dependency>
103.             <dependency>
104.                 <groupId>com.baomidou</groupId>
105.                 <artifactId>mybatis-plus-annotation</artifactId>
106.                 <version>${mybatis-plus.version}</version>
107.             </dependency>
108.             
109.             <dependency>
110.                 <groupId>cn.hutool</groupId>
111.                 <artifactId>hutool-bom</artifactId>
112.                 <version>${hutool.version}</version>
113.                 <type>pom</type>
114.                 <scope>import</scope>
115.             </dependency>
116.             
117.             <dependency>
118.                 <groupId>net.dreamlu</groupId>
119.                 <artifactId>mica-bom</artifactId>
120.                 <version>${mica.version}</version>
121.                 <type>pom</type>
122.                 <scope>import</scope>
123.             </dependency>
124.             
125.             <dependency>
126.                 <groupId>org.springframework.boot</groupId>
127.                 <artifactId>spring-boot-starter-web</artifactId>
128.                 <version>${spring-boot.version}</version>
129.                 <exclusions>
130.                     
131.                     <exclusion>
132.                         <artifactId>spring-boot-starter-tomcat</artifactId>
133.                         <groupId>org.springframework.boot</groupId>
134.                     </exclusion>
135.                 </exclusions>
136.             </dependency>
137.             <dependency>
138.                 <groupId>com.github.xiaoymin</groupId>
139.                 <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
140.                 <version>4.3.0</version>
141.             </dependency>
142.         </dependencies>
143.     </dependencyManagement>
145.     <build>
146.         <plugins>
147.             
148.             <plugin>
149.                 <groupId>io.github.git-commit-id</groupId>
150.                 <artifactId>git-commit-id-maven-plugin</artifactId>
151.                 <version>${git.commit.plugin}</version>
152.             </plugin>
153.             
154.             <plugin>
155.                 <groupId>io.spring.javaformat</groupId>
156.                 <artifactId>spring-javaformat-maven-plugin</artifactId>
157.                 <version>${spring.checkstyle.plugin}</version>
158.             </plugin>
159.         </plugins>
160.     </build>
162. </project>

复制代码

源码信息

和“SpringCloud实战”对应的源码信息如下：

• github https://github.com/r0ad/spring-cloud-example
  
• gitee https://gitee.com/r0ad/spring-cloud-example
  

关于作者

来自一线全栈程序员nine的八年探索与实践，持续迭代中。欢迎关注“雨林寻北”或添加个人卫星codetrend（备注技术）。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。