純手工開發Maven Hello World工程和Maven基本用法

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.javaHelloTest.javapom.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主要由兩部分組成,一部分是由groupIdartifactIdversion三個標簽組成的當前項目的唯一定位坐標,另一部分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 compilemvn 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其他的基本用法。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,345評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,494評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,283評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,953評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,714評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,186評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,255評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,410評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,940評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,776評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,976評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,518評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,210評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,642評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,878評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,654評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,958評論 2 373