Spring Boot项目中pom.xml文件各标签详解
前言
在Spring Boot工程中,pom.xml文件是maven项目的配置基础,它让我们的项目自动导入了很多相关的依赖,下面以我曾经开发过的一个简单项目中的pom.xml文件为例,对文件配置进行部分注释。
pom.xml文件配置的demo
<?xml version="1.0" encoding="UTF-8"?>
<!-- xml的版本和编码-->
<!-- xml 可扩展标记语言(EXtensible Markup Language)-->
<!-- xml 被设计用来传输和存储数据 html 被设计用来显示数据-->
<!-- xmlns-命名空间,类似包名,因为xml的标签可以自定义,所以需要命名空间来区分-->
<!-- xmlns:xsi-xml遵循的标签规范-->
<!-- xsi:schemaLocation-用来定义xmlschema的地址,也就是xml书写时需要遵循的语法,
两部分组成,前面部分就是命名空间的名字,后面是xsd(xmlschema)的地址-->
<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">
<!-- pom作为项目对象模型。通过xml表示maven项目,使用pom.xml来实现。
主要描述了项目:包括配置文件;开发者需要遵循的规则,缺陷管理系统,
组织和licenses,项目的url,项目的依赖性,以及其他所有的项目相关因素。-->
<!-- pom模型的版本-->
<modelVersion>4.0.0</modelVersion>
<!-- 父级项目,parent的引用是固定的-->
<!-- 当我们创建一个 Spring Boot 工程时,可以继承自一个 spring-boot-starter-parent-->
<!-- 父项目中定义了依赖的版本,我们继承了它,所以依赖dependence可以不写版本号,
若不用父项目中的版本号则自己用<version>标签指定-->
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.6.0</version>
<relativePath/>
<!-- lookup parent from repository(从存储库中查找父级项目) -->
</parent>
<!-- 本项目的一些信息-->
<!-- groupId是项目的唯一标识-->
<groupId>com.upc.pipeline</groupId>
<!-- 项目的名称-->
<artifactId>pdfs</artifactId>
<!-- 版本-->
<version>0.0.1-SNAPSHOT</version>
<!-- 项目的名称,Maven产生的文档用-->
<name>pdfs</name>
<!-- 项目的描述,Maven产生的文档用-->
<description>Demo project for Spring Boot</description>
<!-- 一些属性的设置-->
<properties>
<!-- JDK的版本-->
<java.version>1.8</java.version>
</properties>
<!-- <groupId>-主要用来唯一标识一个项目或者一组项目,通常是java包名的全称,例如上面的com.upc.pipeline-->
<!-- <artifactId>-用来标识同一groupId下不同的项目,例如spring-boot-starter-thymeleaf,都是这种格式的-->
<!-- <version>-用来标识一个artifact的版本,格式有8.0.21 0.0.1-SNAPSHOT 等-->
<!-- <scope>-用来表示当前的这个依赖(通过pom加载进来的包)所作用的场景,就是说应该把它添加到哪个环境当中,例如只在测试时此jar包生效,
取值主要有compile-编译时(若未指定则为该默认值) runtime-运行时 test-测试时 等 -->
<!-- <optional>-标记依赖是否可以传递,默认值是false,可以用来减少项目之间jar包的冲突-->
<!-- 依赖关系-->
<dependencies>
<!-- 支持Thymeleaf模板引擎,包括与Spring的集成。使用模板thymeleaf,Thymeleaf是一个java类库,他是一个xml/xhtml/html5的模板引擎,可以作为mvc的web应用的view层-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!-- 支持全栈式Web开发,包括Tomcat和spring-webmvc-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- mysql数据库的连接-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.21</version>
<scope>runtime</scope>
</dependency>
<!-- JDBC驱动,支持JDBC数据库-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<!-- lombok能通过注解帮我们消除那些必须要写但是重复的代码,比如setter,getter,构造函数之类的方法-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!-- 单元测试-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- 类似一个中间件,链接Spring Boot和MyBatis,构建基于Spring Boot的MyBatis应用程序-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.4</version>
</dependency>
<!-- Mybatis分页插件-->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>4.1.0</version>
</dependency>
<!-- JSON包,因为后端业务中用到了将对象数组转换为JSON格式的数据-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.38</version>
</dependency>
<!-- springboot devtools 的主要作用是热部署,引入devtools,这样每次在保存代码的时候都会自动重新加载-->
<!-- 所谓热部署,就是在应用正在运行的时候升级软件,却不需要重新启动应用,在运行时更新Java类文件-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
<scope>runtime</scope>
</dependency>
</dependencies>
<!-- <configuration>-指定插件配置-->
<!-- <excludes>-指定哪些文件将被忽略-->
<!-- <plugins>-用于指定使用的插件-->
<!-- 编译-->
<build>
<!-- 一些插件-->
<plugins>
<!-- Maven插件-->
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
</project>