Spring Boot项目pom.xml配置详解 -- 知识铺

🔔简介

pom.xml是Maven项目的核心配置文件，用于管理项目的依赖、插件、构建配置等。在Spring Boot项目中，pom.xml文件也扮演着重要的角色。在pom.xml文件中，可以配置项目的资源文件。 在Spring Boot的pom.xml文件中，通常会有一个标签文件，用于指定资源文件的路径和名称 。

🔔基本配置

🌵1. project

元素是pom.xml文件的根元素，它包含了整个项目的配置信息。在元素下，可以定义一些子元素来配置项目的不同方面，如用于定义项目的依赖项，用于定义项目的构建配置，用于定义项目的属性等。

通过配置元素和其子元素，可以实现对项目的各种配置和管理，使得项目在构建和运行时具备所需的依赖和配置。

<span role="presentation">#定义了 pom(4.0) 命名空间（xmlns）</span><br><span role="presentation">xmlns="http://maven.apache.org/POM/4.0.0"</span><br><span role="presentation"><span cm-text=""></span></span><br><span role="presentation">#创建了一个 xsi 命名空间</span><br><span role="presentation">xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"</span><br><span role="presentation"><span cm-text=""></span></span><br><span role="presentation">#定义了 xsd 文件的位置，以便 XML 解析器解析 XML 文件</span><br><span role="presentation">xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd</span>

🌵2.parent

在SpringBoot项目的pom.xml中,元素用于定义该项目的父依赖,通常会指定为spring-boot-starter-parent。一个典型的配置如下:

<span role="presentation">xml</span><br><span role="presentation">&lt;parent&gt;</span><br><span role="presentation"> &nbsp;  &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;</span><br><span role="presentation"> &nbsp;  &lt;artifactId&gt;spring-boot-starter-parent&lt;/artifactId&gt; </span><br><span role="presentation"> &nbsp;  &lt;version&gt;2.3.1.RELEASE&lt;/version&gt;</span><br><span role="presentation">&lt;/parent&gt;</span>

它指定了:

• groupId:org.springframework.boot,Spring Boot项目的groupId

• artifactId:spring-boot-starter-parent,一个特殊的启动器

• version: 具体的Spring Boot版本通过继承这个父项目

Spring Boot项目可以获得以下好处:

1. 继承Spring Boot的依赖管理(dependencyManagement元素)

2. 获得合理的默认配置,如编译级别、资源过滤等

3. 使用Spring Boot提供的插件配置,如repackage插件

4. 能够使用常见的依赖版本,不需要显式指定版本号

注意,并不会直接继承依赖,只是引入了依赖管理功能。我们仍然需要在中显式声明需要的依赖。所以在SpringBoot项目中,使用spring-boot-starter-parent作为是标准做法,可以很好地管理项目的依赖。

🌵3.artifactId

定义了名称的副本,与一起定义了一个Maven项目中某个模块的坐标。

在SpringBoot项目中,的值通常遵循以下规范:

• 项目模块的名称,比如core、web、config等

• 服务或应用的名称,比如user-service、e-commerce-app等

• 通用名称,比如common、util等

另外,还会出现在依赖声明中:

<span role="presentation">&lt;dependency&gt;</span><br><span role="presentation">  &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;</span><br><span role="presentation">  &lt;artifactId&gt;spring-boot-starter-web&lt;/artifactId&gt;</span><br><span role="presentation">&lt;/dependency&gt;</span>

🌵4.groupId

在SpringBoot的pom.xml文件中,元素用于定义该项目隶属的组织或团体:出现在pom.xml文件的顶层元素中,它和一起定义了一个Maven项目中的模块坐标。通常与Java包命名类似,采用分层的命名空间,例如:

<span role="presentation">&lt;groupId&gt;com.example.organization&lt;/groupId&gt;</span>

SpringBoot项目中的通常遵循一些规范:

• 公司/组织域名反转,如com.example- 项目名称,如org.springframework.boot

• 功能模块,如org.springframework.boot.autoconfigure

• 通用名称,如org.example.common

另外,还会出现在依赖声明中:

<span role="presentation">&lt;dependency&gt;</span><br><span role="presentation"> &nbsp;  &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;</span><br><span role="presentation"> &nbsp;  &lt;artifactId&gt;spring-boot-starter-web&lt;/artifactId&gt;</span><br><span role="presentation">&lt;/dependency&gt;</span>

🌵5.version

在SpringBoot项目的pom.xml文件中,元素用于定义这个Maven项目的版本号。出现在pom.xml文件的顶层元素中,与和一起定义项目的坐标。的格式通常为X.Y.Z,其中X是主版本号,Y是次版本号,Z是增量版本号。

例如:

<span role="presentation">&lt;version&gt;1.0.0&lt;/version&gt;</span>

对于SpringBoot项目,的定义通常遵循以下规范:- 使用语义化版本号,如1.0.0

• 主版本号:标识项目重大版本

• 次版本号:标识新增功能

• 增量版本号:标识Bug修复另外,SNAPSHOT表示当前为快照版本,还在开发中。

在依赖管理中,Maven根据的值来区分不同版本的构件。SpringBoot的依赖也会指定版本:

<span role="presentation">&lt;dependency&gt;</span><br><span role="presentation"> &nbsp;  &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt; </span><br><span role="presentation"> &nbsp;  &lt;artifactId&gt;spring-boot-starter&lt;/artifactId&gt;</span><br><span role="presentation"> &nbsp;  &lt;version&gt;2.3.1.RELEASE&lt;/version&gt;</span><br><span role="presentation">&lt;/dependency&gt;</span>

🌵6.properties

在SpringBoot项目的pom.xml文件中,元素用于定义Maven项目中可用的属性。出现在pom.xml文件的顶层元素中,是一个容器标签。在其中可以定义多个来指定不同的属性。例如:

<span role="presentation">&lt;properties&gt;</span><br><span role="presentation"> &nbsp;  &lt;java.version&gt;1.8&lt;/java.version&gt;</span><br><span role="presentation"> &nbsp;  &lt;project.build.sourceEncoding&gt;UTF-8&lt;/project.build.sourceEncoding&gt;</span><br><span role="presentation"> &nbsp;  &lt;project.reporting.outputEncoding&gt;UTF-8&lt;/project.reporting.outputEncoding&gt;</span><br><span role="presentation">&lt;/properties&gt;</span>

这为项目定义了java版本、项目构建编码和报告输出编码。SpringBoot项目的pom.xml通常会在中定义一些常用属性,如:- Java版本

• 资源过滤属性

• Encoding设置

• Spring Boot版本

• 其他通用属性

这样可以通过${propertyName}的形式在pom.xml中重用这些属性值,避免重复书写,提高可维护性。另外,子模块可以覆盖从父pom.xml继承的属性。所以SpringBoot项目中使用来定义可重用的Maven属性是非常有用的实践。它提高了pom.xml的配置效率。

🌵7.dependencies

在SpringBoot项目的pom.xml文件中,元素用于声明该项目的各种依赖。是pom.xml中的一个重要元素,Spring Boot项目的功能都是通过依赖来实现的。一个典型的示例如下:

xml<br>&lt;dependencies&gt;<br>    &lt;dependency&gt;<br>        &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;<br>        &lt;artifactId&gt;spring-boot-starter-web&lt;/artifactId&gt;<br>    &lt;/dependency&gt;<br><br>    &lt;dependency&gt;<br>        &lt;groupId&gt;org.mybatis.spring.boot&lt;/groupId&gt;<br>        &lt;artifactId&gt;mybatis-spring-boot-starter&lt;/artifactId&gt;<br>        &lt;version&gt;2.1.1&lt;/version&gt;<br>    &lt;/dependency&gt;<br>&lt;/dependencies&gt;

它显示了:

• spring-boot-starter-web:包含了web开发的依赖

• mybatis-spring-boot-starter:MyBatis与Spring Boot集成的依赖

Spring Boot提供了众多的启动器依赖,可以通过组合启动器快速搭建项目。需要注意的是,并不是中的所有依赖都会实际被使用,它们可能用于提供依赖管理而不引入实际的依赖 jar。

总之,SpringBoot项目主要通过来管理功能实现需要的各种依赖。合理选择和声明依赖对项目开发非常重要。

🌵8.dependencyManagement

在SpringBoot项目的pom.xml文件中,元素用于提供依赖的版本管理,它通常继承自spring-boot-dependencies。在Spring Boot项目中,一个典型的配置如下:

&lt;dependencyManagement&gt;<br>    &lt;dependencies&gt;<br>        &lt;dependency&gt;<br>            &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;<br>            &lt;artifactId&gt;spring-boot-dependencies&lt;/artifactId&gt;<br>            &lt;version&gt;2.3.1.RELEASE&lt;/version&gt;<br>            &lt;type&gt;pom&lt;/type&gt;<br>            &lt;scope&gt;import&lt;/scope&gt; <br>        &lt;/dependency&gt;<br>    &lt;/dependencies&gt;<br>&lt;/dependencyManagement&gt;

它显示了:

• 从spring-boot-dependencies导入依赖管理

• 不需要指定版本,继承自Boot的依赖管理

使用的好处是:

• 控制依赖的版本,避免版本冲突

• 依赖版本可以集中管理

• 依赖版本不需要重复声明

• 与Spring Boot依赖管理相兼容注意它只是声明了版本管理,并不会引入实际的依赖。需要在中显式声明。

总之,通过可以很好地管理Spring Boot项目中的依赖版本,是标准的依赖管理方式。

🌵9.build

在SpringBoot项目的pom.xml文件中,元素用于定义项目的构建配置,主要包括插件和资源过滤等配置。出现在pom.xml的顶层元素中,是一个重要的构建配置区。一个典型的示例:

&lt;build&gt;<br>  &lt;plugins&gt;<br>    &lt;plugin&gt;<br>        &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;<br>        &lt;artifactId&gt;spring-boot-maven-plugin&lt;/artifactId&gt;<br>    &lt;/plugin&gt;<br>  &lt;/plugins&gt;<br>  <br>  &lt;resources&gt;<br>    &lt;resource&gt;<br>        &lt;filtering&gt;true&lt;/filtering&gt; <br>        &lt;directory&gt;src/main/resources&lt;/directory&gt;<br>    &lt;/resource&gt;<br>  &lt;/resources&gt;<br>&lt;/build&gt;

它显示了:

• spring-boot-maven-plugin:Spring Boot的Maven插件

• 资源过滤配置:开启src/main/resources的资源过滤

SpringBoot项目通常需要的配置有:

• 编译插件:maven-compiler-plugin

• 打包插件:spring-boot-maven-plugin

• 资源过滤配置

• 插件管理配置

合理利用可以控制Spring Boot项目的构建过程,比如创建可执行的Fat jar包等。是项目构建的重要一环。

🌵10.repositories

在SpringBoot项目的pom.xml文件中,元素用于配置该Maven项目需要访问的各种仓库地址。出现在pom.xml文件的顶层元素中,它包含一个或多个元素,每个元素指定一个仓库地址,例如:

&lt;repositories&gt;<br>  &lt;repository&gt;<br>     &lt;id&gt;spring-milestones&lt;/id&gt;<br>     &lt;name&gt;Spring Milestones&lt;/name&gt;<br>     &lt;url&gt;https://repo.spring.io/milestone&lt;/url&gt;<br>  &lt;/repository&gt;<br>&lt;/repositories&gt;

这个配置添加了Spring Milestones仓库地址。SpringBoot项目中常见的仓库地址包括:

• Maven中央仓库:默认不需要配置

• Spring仓库:包含Spring的发布版本和里程碑版本

• SpringSnapshot仓库:包含Spring的快照版本

• 其他第三方库仓库通过配置,Maven可以从这些仓库下载依赖的Jar文件。

注意企业级项目中,通常会搭建私有Nexus仓库,并配置使用该私服地址。所以SpringBoot项目使用管理依赖仓库是非常常见和重要的实践。它支持从多种渠道获取依赖。

🌵11.profiles

不同环境的配置文件,比如开发、测试、生产环境。

在SpringBoot项目的pom.xml文件中,元素用于定义不同环境的构建配置文件。包含一个或多个元素,每个指定了一个环境,例如:

&lt;profiles&gt;<br>  &lt;profile&gt;<br>    &lt;id&gt;dev&lt;/id&gt;<br>    &lt;properties&gt;<br>      &lt;spring.profiles.active&gt;dev&lt;/spring.profiles.active&gt;<br>    &lt;/properties&gt;<br>  &lt;/profile&gt;<br>  <br>  &lt;profile&gt;  <br>    &lt;id&gt;prod&lt;/id&gt; <br>    &lt;properties&gt;<br>       &lt;spring.profiles.active&gt;prod&lt;/spring.profiles.active&gt;<br>    &lt;/properties&gt;<br>  &lt;/profile&gt;<br>&lt;/profiles&gt;

这里定义了dev和prod两个环境。通常一个profile可以指定:

• environment:执行环境

• properties:不同的属性配置

• dependencies:不同的依赖

• plugins:不同的插件配置

• resources:不同的资源

然后通过mvn命令使用参数"-Pprofile"激活不同环境的profile。这允许SpringBoot项目基于profile进行多环境构建。是实现不同环境隔离的重要方式。

🌵12.pluginRepositories

插件仓库列表。

在SpringBoot项目的pom.xml文件中,元素用于配置访问Maven插件的仓库地址。与类似,也包含多个子元素,例如:

&lt;pluginRepositories&gt;<br>  &lt;pluginRepository&gt;<br>    &lt;id&gt;spring-milestones&lt;/id&gt;<br>    &lt;name&gt;Spring Milestones&lt;/name&gt;<br>    &lt;url&gt;https://repo.spring.io/milestone&lt;/url&gt;<br>  &lt;/pluginRepository&gt;  <br>&lt;/pluginRepositories&gt;

这个配置添加了一个Spring Milestones仓库,用于下载Maven插件。它与的区别在于:

• :用于依赖 jars 的仓库

• :用于插件 jars 的仓库

一般需要配置的插件仓库包括:

• Maven中央仓库:默认可用

• Spring Milestones/Snapshot仓库:获取Spring插件

• 其他第三方库提供的插件仓库

通过,Maven可以从配置的仓库地址下载并使用插件。

对于SpringBoot项目,如果使用了Spring提供的自定义插件,则需要配置对应的Spring仓库地址,才能正确下载这些插件。所以它是启用Maven插件所必需的配置。

🌵13.name

项目名称。

🌵14.description

项目简单描述。

🌵15.packaging

在SpringBoot项目的pom.xml文件中,元素用于定义项目的打包方式。出现在pom.xml的顶层元素中,默认为"jar"。对于SpringBoot项目,通常会设置为"jar",用于构建一个可执行的、包含所有依赖的Fat jar。例如:

<packaging>jar</packaging>

这会将SpringBoot应用打包成一个运行时可以直接执行的jar包。其它可选的打包方式还包括:

• war:打包为一个Web应用的war包文件

• ear:打包为一个Enterprise Archive(EAR)文件

SpringBoot也支持这两种打包方式,但更常见的还是使用"jar"进行打包。另外,如果要打成war包,则需要移除中对spring-boot-starter-tomcat的依赖,而使用外置的Tomcat来运行war包。

总之,使用元素指定"jar"是SpringBoot项目标准的做法,可以构建出一个自包含、可执行的jar包。

🌵16.application

定义Spring Boot应用入口类名称。

🌵17.url

项目主页的URL, Maven产生的文档用。

http://maven.apache.org

🌵18.modules

在SpringBoot多模块项目的pom.xml文件中,元素用于定义该项目包含的各个子模块。出现在多模块项目的顶层父pom.xml中,包含各个子模块的名称,例如:

&lt;modules&gt;<br>  &lt;module&gt;spring-boot-module-A&lt;/module&gt;<br>  &lt;module&gt;spring-boot-module-B&lt;/module&gt;<br>&lt;/modules&gt;

这个多模块项目包含了两个子模块:

• spring-boot-module-A

• spring-boot-module-B

每个子模块会有自己的pom.xml文件。使用的好处包括:

• 一键构建整个项目

• 统一依赖管理和版本控制

• 代码重用和优化项目结构

SpringBoot多模块开发是很常见的实践,它有助于按功能或服务拆分工程,提高开发效率和维护性。所以合理使用管理多模块是SpringBoot项目中的重要配置。

🔔写在最后

如果大家对相关文章感兴趣，可以关注公众号"架构殿堂"，会持续更新AIGC，java基础面试题, netty, spring boot, spring cloud等系列文章，一系列干货随时送达!