在工作项目中,出于方便的的角度考虑,我们往往会使用Maven这种项目管理工具,让我们的项目更加简单明了。
那么Maven是什么呢?
Maven全称Apache Maven,它是一个软件(特别是Java)项目管理及自动构建工具。由Apache软件基金会所提供。基于项目对象模型(缩写:POM)概念,Maven利用一个中央信息片断能管理一个项目的构建、报告和文档等步骤。Maven也可被用于构建和管理各种项目,例如C#,Ruby,Scala和其他语言编写的项目。Maven曾是Jakarta项目的子项目,现为由Apache软件基金会主持的独立Apache项目。简单的说,Maven本质上是一个项目管理和理解工具。Maven通过提供了一种帮助管理项目的方法,提高项目可读性和生产效率。
这里涉及到一个项目对象模型POM(Project Object Model)的概念。POM.xml文件是Maven能够起作用的核心文件。因为Maven本质上是以项目为中心的,一切都围绕一个项目的概念,而POM包含有关您的项目的所有重要信息,并且基本上是一站式购物,可以在POM中查找与您的项目相关的任何内容。Apache官方对POM的解释如下:
A Project Object Model or POM is the fundamental unit of work in Maven. It is an XML file that contains information about the project and configuration details used by Maven to build the project. It contains default values for most projects.
这段话翻译过来大概是这样的:
一个项目对象模型POM是Maven的一个基本单元。
POM是一个包含Maven配置细节和项目信息的XML文件。它包含了项目中所有的默认值。
在Maven1中POM模型是用文件:project.xml来表示的,而在Maven的第二个版本Maven2中这个文件的名字改成了POM.xml。在Maven中并没有一个能够执行的、名字叫做Maven.xml的文件。当任务或项目启动时,Maven会在当前目录下查找POM.xml文件读取并获取相关信息。
那么POM文件中存放些什么呢?在POM.xml文件中可以对项目所依赖的信息、可执行的插件或目标、构建配置信息进行配置。除此之外,POM.xml文件中还包含项目版本、说明、开发者、邮件列表等信息。为了更加直观的展现出POM文件存放的内容,我们介绍两个POM文件,看看他们具体是如何工作的。
super POM文件定义了部分属性的默认值。并且我们规定,所有的POM文件都继承于super POM文件,如果你不在自己的文件中对一些值手动修改,那么它们将会延续使用super POM中的默认值。下面的代码片段是Maven2.1.0版本的super POM。
4.0.0
Maven Default Project
central
Maven Repository Switchboard
default
http://repo1.maven.org/maven2
false
central
Maven Plugin Repository
http://repo1.maven.org/maven2
default
false
never
${project.basedir}/target
${project.build.directory}/classes
${project.artifactId}-${project.version}
${project.build.directory}/test-classes
${project.basedir}/src/main/java
src/main/scripts
${project.basedir}/src/test/java
${project.basedir}/src/main/resources
${project.basedir}/src/test/resources
maven-antrun-plugin
1.3
maven-assembly-plugin
2.2-beta-2
maven-clean-plugin
2.2
maven-compiler-plugin
2.0.2
maven-dependency-plugin
2.0
maven-deploy-plugin
2.4
maven-ear-plugin
2.3.1
maven-ejb-plugin
2.1
maven-install-plugin
2.2
maven-jar-plugin
2.2
maven-javadoc-plugin
2.5
maven-plugin-plugin
2.4.3
maven-rar-plugin
2.2
maven-release-plugin
2.0-beta-8
maven-resources-plugin
2.3
maven-site-plugin
2.0-beta-7
maven-source-plugin
2.0.4
maven-surefire-plugin
2.4.3
maven-war-plugin
2.1-alpha-2
${project.build.directory}/site
release-profile
performRelease
true
true
org.apache.maven.plugins
maven-source-plugin
attach-sources
jar
true
org.apache.maven.plugins
maven-javadoc-plugin
attach-javadocs
jar
true
org.apache.maven.plugins
maven-deploy-plugin
true
我们并不需要将每行都看懂,当我们需要修改某些值的时候,这份xml文件才会派上用场。
POM采用xml格式进行书写,那么POM文件最短需要哪些必要的元素呢?
最简单的POM文件也需要下面的几个基本元素:
4.0.0
com.mycompany.app
my-app
1
无论如何,一个完整的项目都需要groupId、artifactId、version三个属性,这三个值形成了一个项目的完全限定名,如上的min POM中,这个项目的完全限定名是:com.mycompany.app:my-app:1。
4.0.0
com.mycompany.app
my-app
jar
1.0-SNAPSHOT
Maven Quick Start Archetype
http://maven.apache.org
junit
junit
4.11
test
project
这是所有Maven pom.xml文件中的顶级元素。
modelVersion
此元素指示此POM正在使用的对象模型的版本。模型本身的版本很少变化,通常我们使用4.0.0即可,但是如果Maven开发人员认为有必要更改模型,则为了确保使用的稳定性是强制性的。
groupId
此元素指示创建项目的组织或组的唯一标识符。groupId是项目的关键标识符之一,通常基于您组织的完全限定域名。例如,org.apache.maven.plugins是所有Maven插件的指定groupId。
artifactId
此元素指示此项目正在生成的主要工件的唯一基本名称。项目的主要工件通常是JAR文件。诸如源码包之类的辅助工件也使用artifactId作为其最终名称的一部分。由Maven生成的典型工件将具有 - 。(例如myapp-1.0.jar)的形式。
packaging
此元素指示此工件要使用的包类型(例如JAR,WAR,EAR等)。这不仅意味着如果生成的工件是JAR,WAR或EAR,但也可以指示在构建过程中使用的特定生命周期。(生命周期是我们将在指南中进一步处理的主题,现在,请记住,指定的项目包装可以在定制构建生命周期中发挥作用。)包装元素的默认值为JAR所以你不必为大多数项目指定。
version
此元素指示项目生成的工件的版本。Maven可以帮助您进行版本管理,您将经常在一个版本中看到SNAPSHOT指示符,这表明项目处于开发状态。
dependencies
在该元素内部可以使用多个dependency元素表示该项目依赖的包。
dependency
表示项目中需要使用到的文件信息,通常可以有多个这样的dependency并列写出。
name
此元素指示用于项目的显示名称。这通常用在Maven生成的文档中。
url
此元素指示可以找到项目的站点。这通常用在Maven生成的文档中。
description
此元素提供了项目的基本描述。这通常用在Maven生成的文档中。
好的目录结构可以使开发人员更容易理解项目,为以后的维护工作也打下良好的基础。Maven2根据业界公认的最佳目录结构,为开发者提供了缺省的标准目录模板。如果开发的是web项目或者其他,可能具体的目录树结构可以进一步进行调整。
目录名 | 功能 |
---|---|
src/ | src目录文件 |
src/main/ | 项目主目录 |
src/main/java | 项目源代码目录 |
src/main/resources | 项目所需资源目录 |
src/main/filters | 资源过滤文件目录 |
src/main/assembly | 文件部件部署目录 |
src/main/config | 配置文件目录 |
src/webapp | 网络应用目录 |
src/test/ | 项目测试目录 |
src/test/java | 项目测试源代码目录 |
src/test/resources | 项目测试资源目录 |
src/test/filters | 资源过滤文件目录 |
src/site | 与设置相关的资源目录 |
target/ | 输出目录 |
target/classes | 项目主输出目录,主要与main关联 |
target/test-classes | 项目测试输出目录,主要与test关联 |
target/site | 项目设置目录 |
pom.xml | Maven的POM基本单元 |
Maven目录结构非常清晰,但这并不表示我们在实际的项目中必须采用这种目录层次。如果对test目录不感兴趣,把它删除也不会引起任何问题。Maven作为一种工具,只是默认提供这种优秀的目录结构。
Maven的功能很多,在我们做一些规模并不是很大的项目时,之所以采用Maven其实主要是认可它的两个作用:1.自动下载jar包和它所依赖的包,这样可以保证了多人开发时jar版本不同的问题。2.文件结构清晰,java文件,资源文件,测试文件都分的很清楚。在实际开发中,我们应该如何去配置文件,编写POM呢?
上图是MyEclipse中的POM.xml文件界面。OverView标签页主要展示出了几个比较重要的信息,并且支持我们在这里直接对这些信息进行修改。如果想要直接阅读代码可以点击下面的pom.xml标签页。
Dependences标签页中表示出了所有需要用到的jar包(除了放在lib文件夹下的本地jar包)。只要我们把所有需要使用的包放在这个位置,当项目在另外一台计算机上第一次部署时,会联机下载所有部署的jar包,这样保证了多个计算机同一项目间jar包的一致性。如果我们需要添加jar包,点击add按钮,输入想要添加的jar包的部分名字字段,MyEclipse会智能的列出所有含有该字段的jar包供我们添加。