Maven是一個強大的軟件開發工程管理工具,Java工程師一定都很熟悉。平時工作中幾乎天天都在用。但是用得久了就會發現一個問題,對于Maven的很多細節和深層原理并說不清楚,還是一知半解的水平。這主要是因為平時都是在IDE中使用Maven,IDE已經對Maven的各種細節做了高度封裝,只需要你會點幾下按鈕就可以用起來了,根本不需要搞懂那些復雜的細節。
直到有一天,因為種種原因,不能使用IDE了,只能用純文本編輯器寫代碼,這個時候不就傻眼了嗎?所以本文從一個Hello World說起,開始探索Maven的使用細節,力求達到不依賴任何IDE,也能開始熟練地使用Maven。
1. HelloMaven項目
首先創建一個名為HelloMaven
的目錄,這也是我們的Maven工程名稱。
目標
目標是通過Hello World項目,把Maven用起來,熟悉Maven的基本生命周期,并生成一個可以用的工程jar包。
Maven的配置
我是在Mac上開發的,Mac上Maven的配置可以詳見這一篇文章: Mac配置基本編程開發環境
項目結構
項目目錄結構如下:
m2foxdeMacBook-Pro:HelloMaven m2fox$ pwd
/Users/m2fox/hack/tmp/maven/HelloMaven
m2foxdeMacBook-Pro:HelloMaven m2fox$ tree
.
|____pom.xml
|____src
| |____test
| | |____java
| | | |____com
| | | | |____m2fox
| | | | | |____HelloTest.java
| |____main
| | |____java
| | | |____com
| | | | |____m2fox
| | | | | |____Hello.java
-
pom.xml
:maven配置文件 -
src/test
:單元測試代碼目錄 -
src/main
:代碼目錄
編寫代碼
該項目只有3個文件:Hello.java
、HelloTest.java
和pom.xml
,三個文件的內容分別如下:
-
Hello.java
:
package com.m2fox;
public class Hello {
public String hi() {
return "hello, maven world!";
}
}
非常簡單,只有一個名為hi
的方法,返回一個字符串。
-
HelloTest.java
:
package com.m2fox;
import org.junit.*;
import org.junit.Assert.*;
public class HelloTest {
@Test
public void hiTest() {
Assert.assertEquals("hello, maven world!", new Hello().hi());
}
}
這個測試類使用了JUnit,對Hello.java
中的hi
方法進行單元測試。
-
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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.m2fox</groupId>
<artifactId>HelloMaven</artifactId>
<version>0.0.1-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.10</version>
</dependency>
</dependencies>
</project>
pom.xml
主要由兩部分組成,一部分是由groupId
、artifactId
和version
三個標簽組成的當前項目的唯一定位坐標,另一部分dependencies
是外部依賴配置,這里只依賴了junit包,版本是4.10。
注:開頭的modelVersion
描述這個POM文件是遵從哪個版本的項目描述符,固定寫為4.0.0
。
編譯、運行、打包
編譯:完成上述代碼后,開始編譯上面的代碼:切換到
pom.xml
所在的路徑,這就是項目的根路徑,執行命令:mvn compile
進行編譯,如果沒有報錯,則表明編譯成功。這時在項目的根路徑會發現多了一個target
目錄,里面就是編譯生成的class文件。測試:下面我們執行單元測試,看上面寫的代碼有沒有問題:
mvn test
,如果沒有報錯,則說明單元測試通過。打包:我們把這個項目打成一個jar包,從而可以供其他人使用:
mvn package
,執行完后,會發現在項目根路徑下的target
目錄中生成了一個名為HelloMaven-0.0.1-SNAPSHOT.jar
的jar包。
2. AnotherProj項目
下面我們建一個新的名為AnotherProj的目錄,來開發另一個項目。
目標
我們想嘗試在AnotherProj項目中引用HelloMaven-0.0.1-SNAPSHOT.jar
。
項目結構
項目結構如下:
m2foxdeMacBook-Pro:AnotherProj m2fox$ pwd
/Users/m2fox/hack/tmp/maven/AnotherProj
m2foxdeMacBook-Pro:AnotherProj m2fox$ tree
.
|____pom.xml
|____lib
| |____HelloMaven-0.0.1-SNAPSHOT.jar
|____src
| |____test
| | |____java
| | | |____com
| | | | |____another
| | | | | |____BusinessTest.java
| |____main
| | |____java
| | | |____com
| | | | |____another
| | | | | |____Business.java
這里要注意的是,在項目根路徑下的lib
目錄下放了HelloMaven-0.0.1-SNAPSHOT.jar
這個jar包,代碼中要引用到。
代碼內容
-
Business.java
:
package com.another;
import com.m2fox.Hello;
public class Business {
public String callHelloMavenHi () {
return "call: " + new Hello().hi();
}
}
這個文件中,導入了com.m2fox.Hello
類,它來自于外部jar包HelloMaven-0.0.1-SNAPSHOT.jar
。
-
BusinessTest.java
:
package com.another;
import org.junit.*;
import org.junit.Assert.*;
public class BusinessTest {
@Test
public void callHelloMavenHiTest() {
Assert.assertEquals("call: hello, maven world!", new Business().callHelloMavenHi());
}
}
-
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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.another</groupId>
<artifactId>AnotherProj</artifactId>
<version>0.0.1-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.10</version>
</dependency>
<dependency>
<groupId>com.m2fox</groupId>
<artifactId>HelloMaven</artifactId>
<version>0.0.1-SNAPSHOT</version>
<scope>system</scope>
<systemPath>${project.basedir}/lib/HelloMaven-0.0.1-SNAPSHOT.jar</systemPath>
</dependency>
</dependencies>
</project>
在pom.xml
中引用本地外部jar包的關鍵是這兩行配置:
<scope>system</scope>
<systemPath>${project.basedir}/lib/HelloMaven-0.0.1-SNAPSHOT.jar</systemPath>
其中project.basedir
這個變量的值就是項目的根路徑。
編譯、測試
執行mvn compile
、mvn test
,可以看到編譯沒有問題,測試用例通過。
3. Maven基本用法
Maven的全局配置文件位置
一般在這個路徑:/usr/local/Cellar/maven/3.6.2/libexec/conf/settings.xml
指定JDK版本號和編碼
- 全局指定:在maven的settings.xml文件中加入:
<profile>
<id>jdk-1.8</id>
<activation>
<jdk>1.8</jdk>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<maven.compiler.encoding>UTF-8</maven.compiler.encoding>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<maven.compiler.compilerVersion>1.8</maven.compiler.compilerVersion>
</properties>
</profile>
- 當前項目指定:在pom.xml文件中加入:
<build>
<plugins>
<!-- 指定jdk -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>1.8</source>
<target>1.8</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
</plugins>
</build>
如何運行一個包含有main方法的類?
先用mvn compile
命令編譯工程,然后執行:
- 傳遞命令行參數執行:
mvn exec:java -Dexec.mainClass="com.proj.Main" -Dexec.args="arg0 arg1 arg2"
上面代碼執行com.proj.Main
類中的main方法,并傳了3個命令行參數。
- 指定運行時class_path運行:
mvn exec:java -Dexec.mainClass="com.proj.Main" -Dexec.classpathScope=runtime
如何在pom.xml中批量指定版本號?
比如有多個包要指定同一個flink的版本號,不想寫很多次,怎么辦呢?可以這樣:
- 先在pom.xml中定義一個表示版本號的屬性變量
flink.version
:
<properties>
<flink.version>1.9.2</flink.version>
</properties>
- 然后在依賴中這樣引用這個屬性變量即可:
<dependencies>
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-core</artifactId>
<version>${flink.version}</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-streaming-java_2.12</artifactId>
<version>${flink.version}</version>
<scope>provided</scope>
</dependency>
如何找到一個三方件的maven依賴坐標?
- 如果知道包名,直接去這里搜即可:https://mvnrepository.com
- 如果不知道包名,但知道用到的某一個類的類名,可以先找到這個類所在的項目的Github倉庫,然后在倉庫內按類名搜索,搜到包名,然后再去https://mvnrepository.com搜索即可。
怎么打包jar包并把所有依賴的三方jar包都打在一起?
- 在pom.xml文件中先加入如下配置:
<build>
<plugins>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<archive>
<manifest>
<mainClass>com.allen.capturewebdata.Main</mainClass>
</manifest>
</archive>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
</plugin>
</plugins>
</build>
- 然后執行命令:
mvn assembly:assembly
- 即可在target目錄生成一個名為
xxx-0.0.1-SNAPSHOT-jar-with-dependencies.jar
的jar包,它包含了所有依賴的三方jar包。
4. 總結
本文通過兩個非常簡單的demo項目,展示了mvn的基本用法,以及在項目中引用本地jar包的方法。此外,還總結了一些Maven其他的基本用法。