使用 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項目。