关于Maven的使用,这些你都真的了解么-APISpace

关于Maven的使用,这些你都真的了解么

Maven使用说明及规范

此文档主要说明Maven的基础使用方式，以及在使用过程过程中需要遵守哪些默认的准则。

我们工作中会经常写maven的配置，但是很多maven使用细节你可能并不知道，但你掌握后使用maven会更加上手。

MAVEN是什么？

Apache Maven是一个软件项目管理工具。基于项目对象模型（POM）的概念，Maven可以通过一小段描述信息来管理项目的构建，报告和文档。

Maven的核心是一个插件执行框架，所有工作都是通过插件完成的。

最熟悉的插件如我们比较常用的：

clean

compiler

install

deploy

除了这些默认流程的插件，我们针对Maven的工作机制也制作了自己的插件，如授权系统抽取api.json文件的插件，如通过erm对象描述文件生成Entity实体的插件等。

基本使用

基础信息

定义pom模型的基本信息

使用Maven构建的项目，首先需要在pom.xml文件中写明基本信息，如：

com.yudianbank.project //组织ID

salesAppParent//工程名称

pom//打包方式，如：jar、war、pom、rar等

1.0-RELEASES //版本号

由groupId、artifactId、version三个元素定位唯一的jar信息，常说的发个Maven坐标也就是这三个元素

modules 节点，聚合子模块

在多模块的项目中使用，用来定义子模块，一般多模块项目中，父模块的packaging都定义为pom

api

producer

parent节点，继承其他pom模型的属性

如：在spring boot项目中，会有如下parent节点，用来继承spring boot已经定义好的pom

org.springframework.boot

spring-boot-starter-parent

1.5.7.RELEASE

properties 节点，定义属性信息

这个节点一般用于定义一些属性，用来作为插件的默认值。在这里定义的属性可以贯穿Maven build的整个生命周期，Maven属性是值占位符，可以在pom中通过${XXX}符号来使用

Dalston.SR3

UTF-8

1.8

1.6.4

6.18

除了如上手动定义的一些属性，我们还可以通过如下的方式，访问到其他的一些变量，如：

env.X : 使用“env.”对变量进行前缀。将返回shell的环境变量。例如，$ {env.PATH}包含PATH环境变量。注意：虽然环境变量本身在Windows上不区分大小写，但属性的查找区分大小写。换句话说，当Windows shell为％PATH％和％Path％返回相同的值时，Maven会区分$ {env.PATH}和$ {env.Path}。从Maven 2.1.0开始，为了可靠性，环境变量的名称被归一化为所有大写。

project.x : POM中的标记路径将包含相应元素的值。例如： 1.0 version> project>可通过$ {project.version}访问。

settings.x : Mavne Home路径的settings.xml将包含相应的元素的值。例如： false offline> settings>可通过$ {settings.offline}访问。

java系统属性 : 通过java.lang.System.getProperties（）访问的所有属性都可用作POM属性，例如${java.home}。

dependencies 节点，定义项目依赖

org.springframework.cloud

spring-cloud-dependencies

${spring-cloud.version}

除了基本的groupId、artifactId、version坐标属性外，dependency节点中还包括如下的常用属性设置

type : 依赖的类型，默认是jar

classifier : 分类器，额外的jar坐标标记，用来依赖那些从同一个POM中打出的不同的jar包。

scope : 依赖的jar的作用范围，可选（compile，runtime，test，system，provided）

compile : 这是默认范围。所有类路径中都提供了编译依赖项。此外，这些依赖项将传播到依赖项目

runtime : 这很像compile，但表示您希望JDK或容器在运行时提供它。它仅在编译和测试类路径中可用，并且不可传递。

test : 此范围表示正常使用应用程序不需要依赖项，并且仅适用于测试编译和执行阶段。它不是传递性的。

provided :这很像compile，但表示您希望JDK或容器在运行时提供它。它仅在编译和测试类路径中可用，并且不可传递。

system :此范围与provided的类似，只是您必须提供明确包含它的JAR，声明后不会在存储库中查找

Systempath:当scope为system生效，用于定义本地依赖的路径

optional :是否启用依赖传递，默认false需要依赖传递。如A依赖B，B依赖C，默认情况下A中会有C的依赖，如果在依赖B时设置optional为true，则A中不会有C的依赖

exclusions :排除依赖传递

dependencies -> exclusions 节点，排除依赖传递

有时候为了解决项目依赖冲突，需要排除依赖的jar包通过Maven依赖传递特性引用的其他jar，如：

com.yudianbank.public

pdf

1.1-RELEASES

commons-pool

关于Maven依赖传递特性，当出现多个jar依赖相同的不同版本jar时，遵循两个原则来引用：

最短路径原则:如A->B->C-D1 , A->B1->D2 , 那么最终项目A依赖的D的版本是D2。

最先定义原则: 如A->B->D1 , A->C->D2 , 那么最终项目A雨来的D的版本是D1.

dependencyManagement 节点，声明依赖项

dependencyManagement用来管理声明依赖项，最常见于spring boot项目中，在依赖节点只需要写groupId、artifactId就可以定位一个jar坐标，是因为spring boot的父pom中使用dependencyManagement声明了常用的依赖项，如：

org.springframework.boot

spring-boot

1.5.7.RELEASE

.......

使用dependencyManagement管理的依赖只是声明了，如果没有显示的定义在< dependencies >节点中是不生效的

profiles -> profile 节点，定义不同环境的构建属性

在软件项目迭代中，通常会有开发、测试、生产等不同的运行环境。很多时候不同的环境需要不同的依赖属性，诸如此场景，都可以使用profiles来定义不同环境下的变量，如：

dev

true

1.0-SNAPSHOT

${basedir}/target/logs

uat

1.0-SNAPSHOT

/data/logs/${appName}

prod

1.0-RELEASES

/data/logs/${appName}

repositories、pluginRepositories 节点，定义依赖和插件的仓库地址

这里可以定义jar拉取的仓库地址，除了Apache中央仓库外，还有很多其他的开源仓库，如spring的，

central

Central Repository

http://repo.maven.apache.org/maven2

default

false

central

Central Repository

http://repo.maven.apache.org/maven2

default

false

never

构建信息

build 节点，设置输入输出路径

为什么在使用Maven构建的项目中，项目编译后会在pom所在目录下生成target目录？是因为在build构建节点中有如下的默认的配置。

当然，如果你显示配置了如下的属性，就可以指定编译后文件的输出目录

${basedir}/src/main/java

${basedir}/src/main/scripts

${basedir}/src/test/java

${basedir}/target/classes

${basedir}/target/test-classes

...

build -> resources,定义项目资源

resources用来定义项目的资源路径，默认的路径为${basedir}/src/main/resources，在spring boot环境中，继承了spring boot的父pom属性，它的resources定义如下：

${basedir}/src/main/resources

true

**/application*.yml

**/application*.yaml

**/application*.properties

${basedir}/src/main/resources

**/application*.yml

**/application*.yaml

**/application*.properties

可以看到，spring boot中只定义了三种文件类型的资源，而且通配application开头的文件。

当项目中有其他的文件类型或不是application开头时，Maven就会过滤掉。

而且在spring boot中定义了属性占位符为@符号，所以在资源文件中使用${}时并不会生效。

为了解决这个问题，可以自己在pom中定义resources属性覆盖父pom的行为：如，

src/main/resources

**/*

true

build -> plugins -> plugin,定义构建插件

plugin这个节点主要用来定义构建的插件，包括自定义和已经发布到中央仓库的。如spring boot环境想构建可执行的jar需要添加spring-boot-maven-plugin插件。

<!扫描url-->

com.yudianbank.plugin

api-abstractor

1.1.1-RELEASE

process-classes

createAbstract

org.springframework.boot

spring-boot-maven-plugin

更多可用的插件：http://maven.apache.org/plugins/index.html

distributionManagement 节点，配置deploy的仓库地址

当我们自己搭建了私服，想要将jar包编译后上传到私服时，需要在这个节点配置仓库的地址，如：

repo

User Project Releases

http://192.168.1.204:8081/nexus/content/repositories/releases

repo

User Project SNAPSHOTS

http://192.168.1.204:8081/nexus/content/repositories/snapshots

项目信息

根节点下的name、description、url等节点

根节点下的name、description、url等节点用来描述项目的基本信息，如：

sales

这是一个销售系统

http://kailing.pub

Licenses节点，描述许可证信息

Apache License, Version 2.0

https://apache.org/licenses/LICENSE-2.0.txt

repo

A business-friendly OSS license

Organization节点，描述组织信息

keking

http://keking.cn

省略....

遵守的准则规范

MAVEN坐标VERSION属性设置

一般建议在开发和测试环境中的jar，打成SNAPSHOT的，生产环境的版本打成RELEASES的，这个可以通过上面的profiles节点来控制，他们的区别如下：

SNAPSHOT :当版本号带'-SNAPSHOT'后缀时，既定义发布的jar为快照版本，应用在依赖时，总是会拉取最新的快照版本。

RELEASES :当版本号带'-RELEASES'后缀时，既定义发布的jar为发行版，应用依赖时，首次会从远程仓库拉取，当本地仓库已有时，就不会从远程仓库拉最新的依赖了。RELEASES版本的每次更新必须指定版本号。

开发中的API模块，需要DEPLOY

应用有些模块需要提供给别人依赖，比如api模块、common模块等。在开发时，每次接口有变动时，记得mvn deploy下，把jar上传到私服。

依赖的JAR的版本使用属性控制

建议依赖别的jar时，不要写死jar的版本，通过properties节点定义的属性来控制，那么当你pom被别人依赖时，上层pom可以通过定义属性值覆盖父pom中属性来控制依赖的版本

多模块项目时，模块命名规范

在多模块时，子模块的命名建议使用父模块作为前缀，如sales系统，api模块为sales-api,app模块为sales-app

附录，INCUBATOR-SKYWALKING的MAVEN配置，提供参考

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

4.0.0

org.apache.skywalking

apm

6.1.0-SNAPSHOT

org.apache

apache

oap-server

apm-commons

apm-sniffer

apm-application-toolkit

apm-protocol

apm-webapp

apm-dist

apm-checkstyle

pom

apm

https://github.com/apache/incubator-skywalking

scm:git:https://github.com/apache/incubator-skywalking.git

HEAD

GitHub

https://github.com/apache/incubator-skywalking/issues

The Apache Software License, Version 2.0

http://apache.org/licenses/LICENSE-2.0.txt

SkyWalking Developer List

dev@skywalking.incubator.apache.org

dev-subscribe@skywalking.incubator.apache.org

dev-unsubscribe@skywalking.incubator.apache.org

SkyWalking Commits

commits@skywalking.incubator.apache.org

commits-subscribe@skywalking.incubator.apache.org

commits-unsubscribe@skywalking.incubator.apache.org

UTF-8

1.8

1.6.4

6.18

4.12

1.10.19

0.4.13

0.6.1

1.6.0

1.8

2.8.2

3.1.0

2.22.0

3.1.0

3.1.1

3.0.0-M2

0.12

3.8.0

3.1.0

3.0.1

2.5

4.3.0

3.0.0

0.8.3

junit

test

org.mockito

mockito-all

test

org.powermock

powermock-module-junit4

test

org.powermock

powermock-api-mockito

test

junit

${junit.version}

test

org.mockito

mockito-all

${mockito-all.version}

test

org.powermock

powermock-module-junit4

${powermock.version}

test

org.powermock

powermock-api-mockito

${powermock.version}

test

org.codehaus.mojo

exec-maven-plugin

git submodule update

initialize

false

git

submodule

update

--init

--recursive

exec

io.takari

maven

${takari-maven-plugin.version}

org.codehaus.mojo

exec-maven-plugin

${exec-maven-plugin.version}

maven-antrun-plugin

${maven-antrun-plugin.version}

maven-deploy-plugin

${maven-deploy-plugin.version}

maven-assembly-plugin

${maven-assembly-plugin.version}

maven-failsafe-plugin

${maven-failsafe-plugin.version}

maven-surefire-plugin

${maven-surefire-plugin.version}

maven-jar-plugin

${maven-jar-plugin.version}

maven-shade-plugin

${maven-shade-plugin.version}

maven-enforcer-plugin

${maven-enforcer-plugin.version}

enforce-java

enforce

[1.8,9)

org.apache.rat

apache-rat-plugin

${apache-rat-plugin.version}

**/target/**

**/DISCLAIMER

**/licenses/**

**/ui-licenses/**

**/codeStyle.xml

**/*.iml

**/.idea/**

**/*.classpath

**/.project

**/.settings/**

**/dependency-reduced-pom.xml

**/skywalking-ui/.editorconfig

**/skywalking-ui/.webpackrc.js

**/skywalking-ui/.roadhogrc.mock.js

**/skywalking-ui/jest.config.js

**/skywalking-ui/.eslintrc.js

**/skywalking-ui/.stylelintrc

**/skywalking-ui/.prettierignore

**/skywalking-ui/.prettierrc

**/skywalking-ui/public/font/iconfont/**

**/.gitignore

**/.gitmodules

**/.git/**

**/.travis.yml

**/.github/**

**/*.md

**/*.MD

**/*.txt

**/docs/**

**/src/test/resources/json/*.json

**/skywalking-ui/node_modules/**

**/skywalking-ui/node/**

**/skywalking-ui/dist/**

skywalking-ui/package.json

skywalking-ui/package-lock.json

**/src/main/proto/gogoproto/gogo.proto

**/src/main/proto/envoy/**

**/src/main/proto/google/protobuf/*.proto

**/src/main/proto/prometheus/client_model/metrics.proto

**/src/main/proto/validate/validate.proto

**/src/main/antlr4/org/apache/skywalking/oal/tool/grammar/OALLexer.tokens

.mvn/wrapper/maven-wrapper.properties

verify

check

maven-compiler-plugin

${maven-compiler-plugin.version}

${compiler.version}

${project.build.sourceEncoding}

maven-resources-plugin

${maven-resource-plugin.version}

${project.build.sourceEncoding}

com.spotify

docker-maven-plugin

${docker.plugin.version}

true

maven-source-plugin

${maven-source-plugin.version}

attach-sources

none

jar

org.codehaus.mojo

versions-maven-plugin

${versions-maven-plugin.version}

org.eluder.coveralls

coveralls-maven-plugin

${coveralls-maven-plugin.version}

xFwR2GqmxcMxV7tGEpW2NfwIrbCD4cQCS

${project.build.sourceDirectory}

org.jacoco

jacoco-maven-plugin

${jacoco-maven-plugin.version}

prepare-agent

maven-checkstyle-plugin

http:// ${maven-checkstyle-plugin.version}

org.apache.skywalking

apm-checkstyle&http://lt;/artifactId>

5.0.0-beta

com.puppycrawl.tools

checkstyle

8.11

validate

skywalking/checkStyle.xml

skywalking/CHECKSTYLE_HEAD

UTF-8

true

org.apache.skywalking.apm/network/**/*.java,

org.apache.skywalking.apm/collector/remote/grpc/**/*.java,

org.apache.skywalking.apm/agent/core/context/ids/base64/*.java

check

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

4.0.0

org.apache.skywalking

apm

6.1.0-SNAPSHOT

org.apache

apache

oap-server

apm-commons

apm-sniffer

apm-application-toolkit

apm-protocol

apm-webapp

apm-dist

apm-checkstyle

pom

apm

https://github.com/apache/incubator-skywalking

scm:git:https://github.com/apache/incubator-skywalking.git

HEAD

GitHub

https://github.com/apache/incubator-skywalking/issues

The Apache Software License, Version 2.0

http://apache.org/licenses/LICENSE-2.0.txt

SkyWalking Developer List

dev@skywalking.incubator.apache.org

dev-subscribe@skywalking.incubator.apache.org

dev-unsubscribe@skywalking.incubator.apache.org

SkyWalking Commits

commits@skywalking.incubator.apache.org

commits-subscribe@skywalking.incubator.apache.org

commits-unsubscribe@skywalking.incubator.apache.org

UTF-8

1.8

1.6.4

6.18

4.12

1.10.19

0.4.13

0.6.1

1.6.0

1.8

2.8.2

3.1.0

2.22.0

3.1.0

3.1.1

3.0.0-M2

0.12

3.8.0

3.1.0

3.0.1

2.5

4.3.0

3.0.0

0.8.3

junit

test

org.mockito

mockito-all

test

org.powermock

powermock-module-junit4

test

org.powermock

powermock-api-mockito

test

junit

${junit.version}

test

org.mockito

mockito-all

${mockito-all.version}

test

org.powermock

powermock-module-junit4

${powermock.version}

test

org.powermock

powermock-api-mockito

${powermock.version}

test

org.codehaus.mojo

exec-maven-plugin

git submodule update

initialize

false

git

submodule

update

--init

--recursive

exec

io.takari

maven

${takari-maven-plugin.version}

org.codehaus.mojo

exec-maven-plugin

${exec-maven-plugin.version}

maven-antrun-plugin

${maven-antrun-plugin.version}

maven-deploy-plugin

${maven-deploy-plugin.version}

maven-assembly-plugin

${maven-assembly-plugin.version}

maven-failsafe-plugin

${maven-failsafe-plugin.version}

maven-surefire-plugin

${maven-surefire-plugin.version}

maven-jar-plugin

${maven-jar-plugin.version}

maven-shade-plugin

${maven-shade-plugin.version}

maven-enforcer-plugin

${maven-enforcer-plugin.version}

enforce-java

enforce

[1.8,9)

org.apache.rat

apache-rat-plugin

${apache-rat-plugin.version}

**/target/**

**/DISCLAIMER

**/licenses/**

**/ui-licenses/**

**/codeStyle.xml

**/*.iml

**/.idea/**

**/*.classpath

**/.project

**/.settings/**

**/dependency-reduced-pom.xml

**/skywalking-ui/.editorconfig

**/skywalking-ui/.webpackrc.js

**/skywalking-ui/.roadhogrc.mock.js

**/skywalking-ui/jest.config.js

**/skywalking-ui/.eslintrc.js

**/skywalking-ui/.stylelintrc

**/skywalking-ui/.prettierignore

**/skywalking-ui/.prettierrc

**/skywalking-ui/public/font/iconfont/**

**/.gitignore

**/.gitmodules

**/.git/**

**/.travis.yml

**/.github/**

**/*.md

**/*.MD

**/*.txt

**/docs/**

**/src/test/resources/json/*.json

**/skywalking-ui/node_modules/**

**/skywalking-ui/node/**

**/skywalking-ui/dist/**

skywalking-ui/package.json

skywalking-ui/package-lock.json

**/src/main/proto/gogoproto/gogo.proto

**/src/main/proto/envoy/**

**/src/main/proto/google/protobuf/*.proto

**/src/main/proto/prometheus/client_model/metrics.proto

**/src/main/proto/validate/validate.proto

**/src/main/antlr4/org/apache/skywalking/oal/tool/grammar/OALLexer.tokens

.mvn/wrapper/maven-wrapper.properties

verify

check

maven-compiler-plugin

${maven-compiler-plugin.version}

${compiler.version}

${project.build.sourceEncoding}

maven-resources-plugin

${maven-resource-plugin.version}

${project.build.sourceEncoding}

com.spotify

docker-maven-plugin

${docker.plugin.version}

true

maven-source-plugin

${maven-source-plugin.version}

attach-sources

none

jar

org.codehaus.mojo

versions-maven-plugin

${versions-maven-plugin.version}

org.eluder.coveralls

coveralls-maven-plugin

${coveralls-maven-plugin.version}

xFwR2GqmxcMxV7tGEpW2NfwIrbCD4cQCS

${project.build.sourceDirectory}

org.jacoco

jacoco-maven-plugin

${jacoco-maven-plugin.version}

prepare-agent

maven-checkstyle-plugin

http:// ${maven-checkstyle-plugin.version}

org.apache.skywalking

apm-checkstyle&http://lt;/artifactId>

5.0.0-beta

com.puppycrawl.tools

checkstyle

8.11

validate

skywalking/checkStyle.xml

skywalking/CHECKSTYLE_HEAD

UTF-8

true

org.apache.skywalking.apm/network/**/*.java,

org.apache.skywalking.apm/collector/remote/grpc/**/*.java,

org.apache.skywalking.apm/agent/core/context/ids/base64/*.java

check

python怎么过滤字符串中的英文字母

249 2023-01-02

关于Maven的使用,这些你都真的了解么

c语言sscanf函数的用法是什么

linux cpu占用率如何看

python怎么过滤字符串中的英文字母

推荐文章

api接口有哪几种分类及功能

什么是API接口?API接口简单介绍

短信API接口概述，短信API接口的优势

7款快递物流的物流查询API工具，物流快递查询API接口怎么对接？

企业四要素: 了解企业经营成功的关键

什么是语音验证码?,语音验证码平台有哪些

全国工商查询系统怎么查企业名录

哪些平台提供实名认证的接口？

PHP如何调用API接口?

如何使用百度天气预报API接口?

最近发表

热评文章

数据接口api（数据接口API开发平台）

数据开放接口api（数据服务api开发）

Python爬虫教程：爬取酷狗音乐（python爬取

直播平台api接口 - 构建卓越的直播平台

java web实现简单留言板功能

接码平台api接口开发（接码平台api对接）