Maven的使用一
1、 Maven标准目录结构:
用如下命令创建一个项目目录:
mkdir sameple_echo cd sameple_echo |
推荐使用如下的目录结构:
sample-echo [current directory] +- src +- main +- java +- samples [package structure] +- echo +- resources +- test +- java +- samples [package structure] +- echo +- xdocs |
|
以下是对各个目录的详细解析:
src | 其子目录中包含了源文件的所有类型 |
src/main | 最终应用的主体部分,代码只是其中的一部分 |
src/main/java | 组成应用的java代码部分,其下的子目录将按照包结构排列 |
src/main/resources | 最终应用的其它组成部分,例如META-INF/MANIFEST.MF |
|
|
src/test | 最终应用的单元测试部分 |
src/test/java |
|
src/main/resources |
|
Xdocs |
|
2、 对于Maven来说,最重要的文件是:project.xml,如果没有它,你将无从得知你的项目的任何信息。可以通过genapp或scm:checkout命令来创建它。
project.xml文件的项目描述符的典型格式如下:
<project> <groupId>sample</groupId> <artifactId>sample-echo</artifactId> <version>1.0-SNAPSHOT</version> <dependencies> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version> 1.2.8</version> </dependency> </dependencies> <build> <sourceDirectory>src/main/java</sourceDirectory> <unitTestSourceDirectory>src/test/java</unitTestSourceDirectory> <resources> <resource> <directory>src/main/resources</directory> </resource> </resources> <unitTest> <includes> <include>**/*Test.java</include> </includes> </unitTest> </build> </project> |
注意将此配置文件和1的目录格式做比较。
3、 以1、2为例子,在src/main/java目录中拷贝一些java文件,注意,其目录结构要符合包结构名称。则,以下命令可以完成对应的功能:
maven java:compile | 编译代码并测试错误-仅此而已 |
maven test | 编译代码并测试,之后运行所有的单元测试 |
mave jar | 运行完上面的命令后,创建相应的jar文件 |
mave site | 在target/docs中创建一个站点,并见识以下是什么样子 |
如果想自定义创建,可以创建project.properties文件(与project.xml文件在同一目录),并在里面添加属性描述,如下:
maven.compile.source=1.3 maven.compile.target=1.1 maven.compile.debug=true |
定义在project.properties文件中的属性可以被项目的所有成员共享。
但如果属性牵涉到系统环境,则最好将其添加在build.properties文件中,其既可以放在项目目录下(只能被这个项目使用),也可以放在主目录(home)中(可以被多个项目共享)。
4、 产生站点:
举个例子说明:
在xdocs目录下,创建index.xml文件,其内容主体是:
<document> <properties> <title>Hello World</title> <author email="me@mycompany.com">Me</author> </properties> <body> <section name="Section 1"> <p> Hello world! </p> </section> </body> </document> |
则,用
Maven site
命令编译后,将在target/docs/目录下将产生index.html文件,XHTML将被包涵在<section />标签中。
5、 用:maven jar 命令可以编译源代码,并执行所有的单元测试,并最终把所有资源打包成一个jar文件。而单元测试所产生的文档可以被作为生成站点的HTML报告文档。
输出的目标目录(target)的结构如下:
target/classes | 编译后的类文件和资源 |
target/test-classes | 编译后的测试类文件和资源 |
target/test-reports | 关于测试结果的test或xml格式的文本表述。 |
target/project-X.Y.Z.jar | 从target/classes中打包输出的jar文件 |
以上的过程也可以被分解为以下步骤来执行:
Maven java:compile Maven test |
6、 用maven site 命令可以编译整个项目为一个web 站点应用。这个命令的执行结果将以文档的形式被发布在target/docs目录中,网站管理员可以将此作为web service发布。
7、 编译后如果想作些清除工作,可以用make clean 命令。
8、 编译成war应用可用maven war 命令。
9、 如果项目中包涵有maven.xml文件,则这个项目的所有要做的工作都已被定义在其中,我们不需要再用maven java:compile,maven jar…等命令去达到我们不同的目的了。只需要用 maven 命令来执行maven.xml文件已定义好的操作即可。如果想知道maven.xml文件中定义了哪些操作,可以用maven –u 命令来查看。
10、 正式编译之前,可以用maven build:end命令来彻底检测project.xml中所定义的项目文件(包涵jar文件)之间的依赖关系。如果依赖关系不完整,将报告错误信息。
11、 项目所需要的依赖库有本地和远程之分,依赖库提供项目所需要的jar等资源文件,设置远程依赖库可以在maven.jar包中的defaults.properties中设置,但也可以在~/build. Properties或project. Properties文件中定义远程依赖库,推荐在project. Properties文件中定义,因为这样具有更高的优先级,远程依赖库的定义如下:
maven.repo.remote=http://planetmirror.com/maven/,http://www.ibiblio.org/maven/ |
12、 脱机编译:
如果需要脱机编译项目,可以通过CLI来实现转换,命令如下:
maven –o jar:jar |
这等同于:
maven -Dmaven.mode.online=false jar:jar |
或者,我们也可以将build.properties 文件中的 maven.mode.online 设置为 false 以确定我们总是脱机编译。
13、 处于安全和带宽的考虑,一个项目更多的是使用内部的依赖库,可以通过HTTP协议和文件系统file://来加载远程依赖库,通过SCP,FTP,和文件复制来实现依赖库上载。
设置一个内部依赖库仅仅需要你有空间去放它,要使用它,只需要在项目(project)属性中做如下简单设置:
maven.repo.remote=http://repository.company.com/ 或者 maven.repo.remote=file:///shared/repository |
要将项目发布到远程依赖库中,可以通过多种协议,假如我们通过SCP协议来传输数据,可以设置如下属性:
maven.repo.list=myrepo maven.repo.myrepo=scp://repository.mycompany.com/ maven.repo.myrepo.directory=/www/repository.mycompany.com/ maven.repo.myrepo.username=${user.name} maven.repo.myrepo.privatekey=${user.home}/.ssh/id_dsa |
注意:某些SUN发布的jar包有版权信息,可能需要手动将其下载,或手动部署到服务器端。