使用 Maven 创建 Java 工程
翻译自:http://spring.io/guides/gs/maven/
1、将会创建什么
教程会一步一步教您用 Maven 创建一个简单的 Java 工程。
2、开始之前
- 这将会花费您15分钟时间
- 一款您钟爱的编辑器或者 IDE
- JDK6或更高版本
3、如何完成这次教程
和其他的 Spring 入门教程一样,您可以从零开始完成每一步操作,也可以跳过一些您熟悉的步骤。两种方法都是可行的。
如果您想从零开始,请跳到 4、开始创建工程
如果您想跳过基础步骤,请按照下面的步骤做:
- 下载源码库或者使用 git 的 clone 功能:
git clone https://github.com/spring-guides/gs-maven.git
- cd 到 gs-maven/initial 目录下
- 调到 [initial]
当您完成了,您可以对照 gs-maven/complete 里的代码来检查您的结果。
4、开始创建工程
首先您需要给先建一个 Java 工程,以提供给 Maven 来构建。为了把注意力集中在 Maven 身上,所以我们把 Java 工程建的尽可能简单。
创建目录结构
选择一个目录作为您的工程根目录,然后使用下面的命令创建工程子目录结构:
mkdir -p src/main/java/hello
在 hello 目录内,您可以创建任何 Java 的 class 文件。
为了保持与教程剩余部分的一致性,请创建这两个 class 文件: HelloWorld.java 和 Greeter.java 。
src/main/java/hello/HelloWorld.java
package hello;
public class HelloWorld {
public static void main(String[] args) {
Greeter greeter = new Greeter();
System.out.println(greeter.sayHello());
}
}
src/main/java/hello/Greeter.java
package hello;
public class Greeter {
public String sayHello() {
return "Hello world!";
}
}
现在,为 Maven 准备的工程已经建好了,下一步是安装 Maven:
Maven 在网址 可以作为 zip 格式下载,我们只需要二进制文件,所以请点击类似 apache-maven-{version}-bin.zip 或者 apache-maven-{version}-bin.tar.gz 的链接。
下载之后解压,并把 bin 目录添加到您的路径中,使用下面的命令测试是否配置成功:
mvn -v
如果出现类似下面的信息,表示配置成功
Apache Maven 3.0.5 (r01de14724cdef164cd33c7c8c2fe155faf9602da; 2013-02-19 07:51:28-0600)
Maven home: /usr/share/maven
Java version: 1.7.0_09, vendor: Oracle Corporation
Java home: /Library/Java/JavaVirtualMachines/jdk1.7.0_09.jdk/Contents/Home/jre
Default locale: en_US, platform encoding: UTF-8
OS name: "mac os x", version: "10.8.3", arch: "x86_64", family: "mac"
恭喜您,Maven 已经安装成功了。
5、定义一个简单的 Maven
Maven 工程通过一个 pom.xml 文件来定义,该文件给出了工程的名称、版本、依赖关系等
在刚才建立的 Java 工程的根目录下建立 pom.xml 文件并填入一下内容:
<?xml version="1.0" encoding="UTF-8"?>
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework</groupId>
<artifactId>gs-maven</artifactId>
<packaging>jar</packaging>
<version>0.1.0</version>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>2.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<transformers>
<transformer
implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>hello.HelloWorld</mainClass>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
这个 xml 文件是最简单的形式了,除了 packaging 元素是可选的。
一下是所包含的工程配置的细节:
- modelVersion, 项目对象模型版本 (总是 4.0.0)。
- groupId,项目所属的团组或机构,经常写成域名的逆序形式。
- artifactId,被构建的工程目录的名称,比如 jar 包或者 war 包的名称。
- version,工程创建版本号。
- packaging,定义工程的打包方式,默认是 jar ,可以定义为 war 。
至此,您已经定义了一个迷你但可以使用的 Maven 工程。
6、构建Java代码
Maven 现在已经准备好构建项目,您可以使用 Maven 执行几种构建生命周期的方式,包括编译项目的代码,创建一个库包(如JAR文件),并在当地的 Maven 依赖存储库安装库。
第一种方法:
mvn compile
该命令运行 Maven 并告诉它执行编译的目标,当完成后,您应该在 target/classes 目录下看到编译过的 .class 文件。
第二种方法:
mvn package
这个命令将会编译源代码,运行所有测试,并打包成一个 jar 包保存在 target 目录下,jar 包的名字是根据 artifactId 和 version 生成的。例如,根据上面的 pom.xml 文件,将会生成 gs-maven-0.1.0.jar。
Maven 也在您的本地计算机维护一个依赖库(通常是在你的主目录的 .m2/repository 目录),以便快速访问项目的依赖库。如果您想安装项目的JAR文件到本地仓库,那么您可以使用第三种方法。
第三种方法:
mvn install
该命令会编译、测试和打包项目的代码,然后将其复制到本地依赖库,准备作为其他项目的引用依赖。
7、声明依赖
这个简单的 HelloWorld 小栗子是完全独立的,不依赖于任何额外的库。但是,大多数的应用程序要依赖于外部库,来获得(实现)一些通用或者复杂的功能。
例如,除了让程序显示 ” Hello World !”,也想打印当前的日期和时间,当然您可以在本地Java库使用的日期和时间功能,但为了说明依赖的关系我们使用 Joda 时间库。
首先,把 HelloWorld.java 类修改如下:
package hello;
import org.joda.time.LocalTime;
public class HelloWorld {
public static void main(String[] args) {
LocalTime currentTime = new LocalTime();
System.out.println("The current local time is: " + currentTime);
Greeter greeter = new Greeter();
System.out.println(greeter.sayHello());
}
}
这里使用 Joda 时间的本地时间类获取并打印当前时间。
下面关键来了,如果这时您在运行 mvn compile 就会失败,为什么呢?因为 Maven 根本不知道 Joda 时间是什么鬼,您必须添加依赖告诉 Maven 。
在 pom.xml 的 project 元素内添加以下内容:
<dependency>
<groupId>joda-time</groupId>
<artifactId>joda-time</artifactId>
<version>2.2</version>
</dependency>
xml 的这块代码块声明了依赖项目的清单,具体地说,只是声明了了对 Joda 时间库的单一依赖,在<依赖 dependency >元素,依赖坐标由三个子要素定义:
- groupId
- artifactId
- version
默认情况下,所有依赖作用域都作为为编译依赖。也就是说,他们应该可以在编译时可获得(如果您构建了一个war文件,其中包括在 war 的/ web- inf / libs文件夹)。此外,您可以指定<范围 scope >元素指定下列范围之一:
- provided,依赖会用于编译、测试和应用
- test,依赖只用于编译和测试
此时,如果您运行 mvn compile 或 mvn package 命令, 将会成功。
8、写一个测试
首先引用 Junit 依赖,以便做单元测试。
在 pom.xml 文件中添加以下内容:
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
然后再建立下面的测试 Java 类:
src/main/test/hello/HelloWorldTest.java
Unresolved directive in <stdin> - include::complete/src/test/java/hello/HelloWorldTest.java[]
Maven 使用一个名为“万全 surefire ”的插件来运行单元。这个插件的默认配置编译和运行所有测试类 。您可以使用下面的命令进行测试:
mvn test
当然,之前的几个命令也包含了测试步骤。
下面是完整的 pom.xml 文件:
<?xml version="1.0" encoding="UTF-8"?>
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework</groupId>
<artifactId>gs-maven</artifactId>
<packaging>jar</packaging>
<version>0.1.0</version>
<dependencies>
<!-- tag::joda[] -->
<dependency>
<groupId>joda-time</groupId>
<artifactId>joda-time</artifactId>
<version>2.2</version>
</dependency>
<!-- end::joda[] -->
<!-- tag::junit[] -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
<!-- end::junit[] -->
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>2.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>hello.HelloWorld</mainClass>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
9、小结
恭喜!您已经创建了一个简单而有效的使用 Maven 定义构建的 Java项目。