Maven 入门实战(2)–POM

POM( Project Object Model，项目对象模型 ) 是 Maven 工程的基本工作单元，它是一个 XML 文件，包含了项目的基本信息，用于描述项目如何构建，声明项目依赖等等。执行任务或目标时，Maven 会在当前目录中查找并读取 POM，获取所需的配置信息，然后执行目标。

1、基本配置

<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">    <modelVersion>4.0.0</modelVersion>    <groupId>com.mycompany</groupId>    <artifactId>myproject</artifactId>    <version>1.0.0</version>    <description>项目描述</description>    <name>项目名称</name>    <url>https://www.mycompany.com/myproject</url>    <packaging>jar</packaging>    <inceptionYear>2023</inceptionYear></project>

配置说明：

2、parent

所有的 POM 都继承自一个父 POM（无论是否显式定义了这个父 POM），父 POM 包含了一些可以被继承的默认设置。

<parent>    <groupId>com.mycompany</groupId>    <artifactId>parent-project</artifactId>    <version>1.0</version>    <relativePath/></parent>

配置说明：

3、prerequisites

prerequisites 元素用于描述构建该项目的先决条件。

<prerequisites>    <maven>3.8.0</maven></prerequisites>

配置说明：

4、issueManagement

issueManagement 元素用于描述项目的问题管理系统。

<issueManagement>    <system>jira</system>    <url>http://10.39.196.10:8080/banseon</url></issueManagement>

配置说明：

5、ciManagement

ciManagement 元素用于描述项目的持续集成系统。

<ciManagement>    <system></system>    <url></url>    <notifiers>        <notifier>            <type></type>            <sendOnError>true</sendOnError>            <sendOnFailure>true</sendOnFailure>            <sendOnSuccess>true</sendOnSuccess>            <sendOnWarning>true</sendOnWarning>            <address></address>            <configuration/>        </notifier>    </notifiers></ciManagement>

配置说明：

6、mailingLists

mailingLists 元素用于描述项目相关的邮件信息。

<mailingLists>    <mailingList>        <name>jack</name>        <post>123456@qq.com</post>        <subscribe>123456@qq.com</subscribe>        <unsubscribe>123456@qq.com</unsubscribe>        <archive></archive>    </mailingList></mailingLists>

配置说明：

7、licenses

licenses 元素用于列出该项目的 license 列表。

<licenses>    <license>        <name>The Apache Software License, Version 2.0</name>        <url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>        <distribution>repo</distribution>        <comments></comments>    </license></licenses>

配置说明：

8、developers

developers 用于列出项目开发者。

<developers>    <developer>        <id>123</id>        <name>abc</name>        <email>123456789@qq.com</email>        <url>https://www.abc.com</url>        <roles>            <role>Project Manager</role>        </roles>        <organization>xyz</organization>        <organizationUrl>https://www.xyz.com</organizationUrl>        <properties>            <dept>aa</dept>        </properties>        <timezone>8</timezone>    </developer></developers>

配置说明：

9、contributors

contributors 元素描述尚未成为提交者的项目贡献者。

<contributors>    <contributor>        <name>abc</name>        <email>123456789@qq.com</email>        <url>https://www.abc.com</url>        <roles>            <role>Project Tester</role>        </roles>        <organization>xyz</organization>        <organizationUrl>https://www.xyz.com</organizationUrl>        <properties>            <dept>aa</dept>        </properties>        <timezone>8</timezone>    </contributor></contributors>

配置说明：

10、scm

SCM(Source Control Management)元素用于配置项目的代码库。

<scm>    <url>https://github.com/abc/abc-common</url>    <connection>https://github.com/abc/abc-common.git</connection>    <developerConnection>https://github.com/abc/abc-common-dev.git</developerConnection>    <tag></tag></scm>

配置说明：

11、organization

organization 元素用于描述项目所属组织。

12、properties

properties 用于定义键值对。

<properties>    <maven.compiler.source>8</maven.compiler.source>    <maven.compiler.target>8</maven.compiler.target>    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>    <spring.version>5.2.24.RELEASE</spring.version></properties>

13、dependencies

dependencies 用于定义项目的依赖。

<dependencies>    <dependency>        <groupId>com.abc</groupId>        <artifactId>commons</artifactId>        <version>1.0.0</version>        <type>jar</type>        <classifier></classifier>        <scope>compile</scope>        <!--systemPath></systemPath-->        <exclusions>            <exclusion>                <groupId>com.xyz</groupId>                <artifactId>xxx</artifactId>            </exclusion>        </exclusions>    </dependency>    <optional>true</optional></dependencies>

配置说明：

14、dependencyManagement

dependencyManagement 元素用于对依赖进行管理；这部分的依赖信息不会被立即解析，而是当在 dependencies 中声明一个依赖（groupId 和 artifactId 必须），如果 groupId 和 artifactId 以外的一些信息没有描述，则通过 groupId 和 artifactId 匹配到这里的依赖，并使用这里的依赖信息。

<dependencyManagement>    <dependencies>        <dependency>            ...        </dependency>    </dependencies></dependencyManagement>

15、modules

<modules>    <module>module-a</module>    <module>module-b</module>    <module>module-c</module></modules>

modules 元素用于列出项目的模块(子项目)。

配置说明：

16、reporting

reporting 元素用于生成报表，当执行”mvn site”，报表就会按照配置生成。

<reporting>    <excludeDefaults>false</excludeDefaults>    <outputDirectory>${project.build.directory}/site</outputDirectory>    <plugins>        <plugin>            <groupId>com.abc</groupId>            <artifactId>xyz</artifactId>            <version>1.0.0</version>            <inherited>true</inherited>            <configuration></configuration>            <reportSets>                <reportSet>                    <id>123</id>                    <configuration/>                    <inherited>true</inherited>                    <reports>                        <report></report>                    </reports>                </reportSet>            </reportSets>        </plugin>    </plugins></reporting>

配置说明：

17、build

build 元素用于描述项目如何构建。

<build>    <sourceDirectory>src/main/java</sourceDirectory>    <scriptSourceDirectory></scriptSourceDirectory>    <testSourceDirectory>src/test/java</testSourceDirectory>    <outputDirectory>target/classes</outputDirectory>    <testOutputDirectory>target/test-classes</testOutputDirectory>    <directory>target</directory>    <finalName>${project.artifactId}-${project.version}</finalName>    <defaultGoal>clean package</defaultGoal>    <resources>        <resource>            <directory>src/main/resources</directory>            <includes>                <include>*.xml</include>            </includes>            <excludes>                <exclude>*.abc</exclude>            </excludes>            <targetPath></targetPath>            <filtering>false</filtering>        </resource>    </resources>    <testResources>        <testResource>            <directory>src/test/resources</directory>            <includes>                <include>*.xml</include>            </includes>            <excludes>                <exclude>*.abc</exclude>            </excludes>            <targetPath></targetPath>            <filtering>false</filtering>        </testResource>    </testResources>    <filters>        <filter></filter>    </filters>    <extensions>        <extension>            <groupId>com.abc</groupId>            <artifactId>my-extension</artifactId>            <version>1.0.0</version>        </extension>    </extensions>    <plugins>        <plugin>            <groupId>org.apache.maven.plugins</groupId>            <artifactId>maven-source-plugin</artifactId>            <version>2.2.1</version>            <extensions>false</extensions>            <executions>                <execution>                    <id>attach-source</id>                    <phase></phase>                    <goals>                        <goal>jar-no-fork</goal>                    </goals>                    <inherited>true</inherited>                    <configuration></configuration>                </execution>            </executions>            <dependencies>                <dependency>                </dependency>            </dependencies>            <inherited>true</inherited>            <configuration></configuration>        </plugin>    </plugins>    <pluginManagement>        <plugins>        </plugins>    </pluginManagement></build>

配置说明：

18、repositories

repositories 用于配置依赖和扩展的远程仓库。

<repositories>    <repository>        <id>snapshot-repository</id>        <name>snapshots</name>        <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>        <layout>default</layout>        <releases>            <enabled>false</enabled>            <updatePolicy>daily</updatePolicy>            <checksumPolicy>warn</checksumPolicy>        </releases>        <snapshots>            <enabled>true</enabled>            <updatePolicy>always</updatePolicy>            <checksumPolicy>warn</checksumPolicy>        </snapshots>    </repository></repositories>

配置说明：

19、pluginRepositories

pluginRepositories 用于配置插件的远程仓库。

<pluginRepositories>    <pluginRepository>    ...    </pluginRepository></pluginRepositories>

pluginRepositories/pluginRepository 表示一个远程仓库配置，它的子元素与 repositories/repository 一致。

20、distributionManagement

distributionManagement 用于描述项目如何分发，执行 mvn deploy后将把项目分发到对应的位置；通过该配置可以把网站部署到远程服务器或者把构件部署到远程仓库。

<distributionManagement>    <repository>        <id>ossrh</id>        <name>ossrh</name>        <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>        <uniqueVersion>false</uniqueVersion>        <layout>default</layout>    </repository>    <snapshotRepository>        <id>ossrh</id>        <name>ossrh</name>        <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>        <uniqueVersion>false</uniqueVersion>        <layout>default</layout>    </snapshotRepository>    <site>        <id></id>        <name></name>        <url></url>    </site>    <downloadUrl></downloadUrl>    <relocation>        <groupId></groupId>        <artifactId></artifactId>        <version></version>        <message></message>    </relocation>    <status></status></distributionManagement>

配置说明：

21、profiles

profiles 元素用于描述项目构建配置，如果被激活，将会修改构建处理。

<profiles>    <profile>        <id>abc</id>        <activation>            <activeByDefault>false</activeByDefault>            <jdk>[1.8,)</jdk>            <os>                <name>Win10</name>                <family>Windows</family>                <arch>x86</arch>                <version>22H2</version>            </os>            <property>                <name>mavenVersion</name>                <value>3.8.1</value>            </property>            <file>                <exists>/home/mongo/a.txt</exists>                <missing>/home/mongo/b.txt</missing>            </file>        </activation>        <build>        </build>        <modules>        </modules>        <repositories>        </repositories>        <pluginRepositories>        </pluginRepositories>        <dependencies>        </dependencies>        <dependencyManagement>        </dependencyManagement>        <distributionManagement>        </distributionManagement>        <properties/>        <reports/>        <reporting>                    </reporting>    </profile></profiles>

配置说明：

参考：https://www.runoob.com/maven/maven-pom.html。