Maven基础配置小结

阳光穿透心脏的1/2处 2022-10-06 02:53 244阅读 0赞

### 文章目录 ###

*  前言
 *  一、Maven库之setting.xml配置
 *   *  1. 几个常用的setting.xml配置项
 *  二、POM（项目对象模型）文件结构
 *   *  1. 项目总体信息(General Project Information)
     *  2. POM关系 (POM Relationships)
     *   *  2.1 基本信息
         *  2.2 多模块配置
         *  2.3 属性常量配置
         *  2.4 整体项目依赖包控制
         *  2.5 依赖包引入
         *  2.6 分发上传管理
         *  2.7 其他
     *  3. 构建设置 (Build Setting)
     *  4. 构建环境 (Build Environment)
 *  三、IDEA与Maven
 *  参考

--------------------

# 前言 #

Maven是现时在开发过程中比较流行的项目管理工具，它在处理依赖包较复杂的场景时（例如上百个互相依赖的包）相对比较方便和直观。它包含了一个项目对象模型 (Project Object Model)，一组标准集合，一个项目生命周期(Project Lifecycle)，一个依赖管理系统(Dependency Management System)，和用来运行定义在生命周期阶段(phase)中插件(plugin)目标(goal)的逻辑。 本文主要罗列一些比较好用和常用的功能，方便大家快速上手。

# 一、Maven库之setting.xml配置 #

在总结Maven本身设置前，需要先提一下Maven库(包来源)的设置。通常我们会专门架设一套基于Nexus的私有Maven仓库提供包拉取的服务。它可以缓存远程中央仓库(https://repo.maven.apache.org/maven2/)的包到本地，避免过多的重复下载，以节省带宽和时间。而我们开发环境则需要针对这个Nexus的Maven仓库服务进行一些必要的设置，用以加快包的上传和下载。如果不作设置将可能直接链接到外部的中央Maven库，很可能会导致下载缓慢或者中断。  
其中，setting.xml是最主要的配置文件，它通常在maven安装包(http://maven.apache.org/)的/conf/目录下，或者IDE自带的也会生成到~/.m2/下。

## 1. 几个常用的setting.xml配置项 ##

*  **LocalRepository** —— 本机开发环境包仓库路径配置
 *  **Servers** —— 链接仓库资源的用户名、密码配置，通过设置id与distributionManagement(POM.xml配置项，后文将提及)中repository元素的id相匹配，再配置username和password即可。
 *  **Mirrors** —— 可设置为Nexus私有Maven仓库或中央仓库的下载镜像列表，url为仓库地址，mirrorOf必须与仓库中的Id一致。
 *  **Proxies** —— 用来配置不同的代理(不常用)，和一般的代理配置差不多
 *  **Profiles** – 最重要的配置之一，根据环境参数来调整构建配置的列表，settings.xml中的profile元素是pom.xml中profile元素的裁剪版本。它包含了**id**(唯一标识)、**activation**(自动触发**profile**的条件逻辑)、**repositories**(远程仓库列表)、**pluginRepositories**(插件仓库列表)和 **properties**(扩展属性列表)元素。这里的**profile**元素只包含这五个子元素是因为这里只关心构建系统这个整体（这正是settings.xml文件的角色定位），而非单独的项目对象模型设置。如果一个settings.xml中的profile被激活，它的值会覆盖任何其它定义在pom.xml中带有相同id的profile。
 *  **ActiveProfiles** —— 手动激活profiles的列表，按照profile被应用的顺序定义activeProfile。

具体实例可以直接参考默认生成的setting.xml文件，里面有详细的说明。

# 二、POM（项目对象模型）文件结构 #

POM（项目对象模型）是Maven的核心，其中项目，依赖，构建配置，以及构件都是要建模和表述的对象。这些对  
象通过一个名为项目对象模型(Project Object Model, POM)的XML文件描述。这个POM告诉Maven它正处理什么类型的项目,如何修改默认的行为来从源码生成输出。同样的方式,一个Java Web应用有一个 web.xml 文件来描述,配置,及自定义该应用,一个Maven项目则通过一个 pom.xml 文件定义。该文件是Maven中一个项目的描述性陈述;也是当Maven构建项目的时候需要理解的一份“地图”。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZpcHNob3BfZmluX2Rldg_size_16_color_FFFFFF_t_70]

## 1. 项目总体信息(General Project Information) ##

它包含了一个项目的名称，项目的URL，发起组织，以及项目的开发者贡献者列表和许可证，这些都是可选的内容。这里以开源项目sharding-sphere的主POM为例展示如下：

<url>http://shardingsphere.apache.org</url>
    <description>Distributed database ecosphere</description>
    <licenses>
        <license>
            <name>Apache License 2.0</name>
            <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
            <distribution>repo</distribution>
        </license>
    </licenses>

## 2. POM关系 (POM Relationships) ##

一个项目很少是孤立的存在，它会依赖于其它项目，可能从父项目继承POM设置，它要定义自身的坐标，可能还会包含子模块。通常各小模块都有自身的POM文件并继承于最外部的主POM，这些POM关系内容将会占据它的大部分篇幅。下面将展示其主要包含的内容，另外还有许多其他功能限于篇幅这里就不一一展开了。

### 2.1 基本信息 ###

如继承关系、groupId、artifactId、版本号等示例

<modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.apache</groupId>
        <artifactId>apache</artifactId>
        <version>21</version>
    </parent>
    <groupId>org.apache.shardingsphere</groupId>
    <artifactId>shardingsphere</artifactId>
    <version>5.0.0-RC1-SNAPSHOT</version>
    <packaging>pom</packaging>
    <name>${project.artifactId}</name>

### 2.2 多模块配置 ###

<modules>
        <module>shardingsphere-agent</module>
        <module>shardingsphere-sql-parser</module>
        <module>shardingsphere-distsql-parser</module>
        <module>shardingsphere-db-protocol</module>
        <module>shardingsphere-infra</module>
        
        <module>shardingsphere-jdbc</module>
        <module>shardingsphere-proxy</module>
        
        <module>shardingsphere-features</module>
        <module>shardingsphere-scaling</module>
        <module>shardingsphere-transaction</module>
        <module>shardingsphere-governance</module>
        
        <module>shardingsphere-test</module>
        <module>shardingsphere-distribution</module>
    </modules>

### 2.3 属性常量配置 ###

可通过$\{\}方式被引用于整个项目

### 2.4 整体项目依赖包控制 ###

该功能对项目的依赖包冲突问题提供了非常好的解决方案，子项目POM因继承了该主POM，也将受到控制

<dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>net.bytebuddy</groupId>
                <artifactId>byte-buddy</artifactId>
                <version>${bytebuddy.version}</version>
            </dependency>
            <dependency>
                <groupId>com.google.guava</groupId>
                <artifactId>guavaa</rtifactId>
                <version>${guava.version}</version>
            </dependency>
            <dependency>
                <groupId>com.google.code.gson</groupId>
                <artifactId>gson</artifactId>
                <version>${gson.version}</version>
            </dependency>
            ....
        </dependencies>
    </dependencyManagement>

### 2.5 依赖包引入 ###

在主POM中设置依赖则对所有继承它的子项目POM起作用，子项目也有配置时，将会一起生效，一般此时将无需指定版本，即使指定了版本造成冲突，都将以dependencyManagement中设置为准。

<dependencies>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>com.google.j2objc</groupId>
                    <artifactId>j2objc-annotations</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </dependency>
    </dependencies>

### 2.6 分发上传管理 ###

用于配置分发上传路径等信息，其中id需与前文提到的setting.xml中的Servers 匹配

<distributionManagement>
            
            <repository>
                <id>releases</id>
                <name>nexus - releases</name>
                <url>http://xxx.xxx.xxx.xxx/nexus/content/repositories/releases/</url>
            </repository>
    
            
            <snapshotRepository>
                <id>snapshots</id>
                <name>nexus - snapshots</name>
                <url>http://xxx.xxx.xxx.xxx/nexus/content/repositories/snapshots/</url>
            </snapshotRepository>
        </distributionManagement>

### 2.7 其他 ###

另外还有如“repositories”’、“pluginRepositories”这些与setting.xml中重复的内容，也可在此进行扩展设置。

## 3. 构建设置 (Build Setting) ##

在这一部分，我们自定义Maven构建的默认行为，比如打包、替换文件等这些行为都是通过插件的方式来实现。我们可以更改源码和测试代码的位置，可以添加新的插件，可以将插件目标绑定到生命周期，我们还可以自定义站点生成参数。其中比较重要的是插件控制管理，和依赖包控制一样，插件也分pluginManagement(整体项目插件管理)和plugins(插件引入)，都会作用于子模块。

<build>
        <pluginManagement>
            <plugins>
                
                <plugin>
                    <groupId>io.takari</groupId>
                    <artifactId>maven</artifactId>
                    <version>${takari-maven-plugin.version}</version>
                </plugin>
            ....
            </plugins>
        </pluginManagement>
        <plugins>
    	    <plugin>
    	        <groupId>org.apache.maven.plugins</groupId>
    	        <artifactId>maven-source-plugin</artifactId>
    	        <executions>
    	            <execution>
    	                <id>attach-sources</id>
    	                <phase>verify</phase>
    	                <goals>
    	                    <goal>jar-no-fork</goal>
    	                </goals>
    	            </execution>
    	        </executions>
    	    </plugin>
    	    <plugin>
    	        <groupId>org.apache.maven.plugins</groupId>
    	        <artifactId>maven-javadoc-plugin</artifactId>
    	        <executions>
    	            <execution>
    	                <id>attach-javadocs</id>
    	                <goals>
    	                    <goal>jar</goal>
    	                </goals>
    	            </execution>
    	        </executions>
    	        <configuration>
    	            <aggregate>true</aggregate>
    	            <charset>${project.build.sourceEncoding}</charset>
    	            <encoding>${project.build.sourceEncoding}</encoding>
    	            <docencoding>${project.build.sourceEncoding}</docencoding>
    	        </configuration>
    	    </plugin>
    	    ....
    	</plugings>
    </build>

## 4. 构建环境 (Build Environment) ##

构建环境包含了一些能在不同使用环境中 激活的profile。例如，在开发过程中你可能会想要将应用部署到一个而开发服务器上，而在产品环境中你会需要将应用部署到产品服务器上。构建环境为特定的环境定制了构建设置，通常它还会由~/.m2中的自定义settings.xml补充。

<profiles>
        <profile>
            <id>it.env.jaeger</id>
            <properties>
                <it.env>jaeger</it.env>
            </properties>
            <build>
                <plugins>
                    <plugin>
                        <artifactId>maven-assembly-plugin</artifactId>
                        <configuration>
                            <appendAssemblyId>false</appendAssemblyId>
                            <descriptors>
                                <descriptor>src/test/assembly/shardingsphere-proxy-agent-jaeger-assembly.xml</descriptor>
                            </descriptors>
                        </configuration>
                        <executions>
                            <execution>
                                <id>assembly</id>
                                <phase>package</phase>
                                <goals>
                                    <goal>single</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                    ...
                </plugins>
            </build>
        </profile>
    </profiles>

# 三、IDEA与Maven #

在写好了POM配置文件后，IDE的可视化工具将对我们查看、检查、执行POM等操作提供巨大的便利性。以IDEA为例，首先需安装Maven Helper。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZpcHNob3BfZmluX2Rldg_size_16_color_FFFFFF_t_70 1]  
打开pom文件，选择Dependency Analyzer，将显示如下  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZpcHNob3BfZmluX2Rldg_size_16_color_FFFFFF_t_70 2]  
左边是该项目引入的包及其确定的版本号，右边是影响引入该jar包的包名及版本号，通过这个可视化工具，将非常直观的了解到包的引入路径和依赖项，对于解决包冲突非常有用。

# 参考 #

1.  [Maven: The Complete Reference][Maven_ The Complete Reference]

侯嘉逊

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZpcHNob3BfZmluX2Rldg_size_16_color_FFFFFF_t_70]: /images/20221005/31e86d65214a402db30fa6bc23ec5b9f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZpcHNob3BfZmluX2Rldg_size_16_color_FFFFFF_t_70 1]: /images/20221005/aa9971f38cf243af8414f9f7f8dc521f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3ZpcHNob3BfZmluX2Rldg_size_16_color_FFFFFF_t_70 2]: /images/20221005/f141e23330ff4e9bae569871444b43b2.png
[Maven_ The Complete Reference]: https://www.sonatype.com/thanks/ebook