2020-08-16
JAVAMAVENSPRING

Maven 專案建立與打包

使用 Maven 打包 Spring 專案官方範例。

Maven

這篇是來自 spring.io 的官方範例。 Building Java Projects with Maven

這一篇是基礎中的基礎了,我們可能連 IDE 都不需要用到,用簡單的 vi 或 純文字編輯器就好了。


這是我們要一開始要的專案結構:

├── src
│   ├── main
│   │   └── java
│   │       └── hello

建立起目錄:

$ mkdir -p src/main/java/hello

再來建立兩個類別,分別是 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 環境

因為我的環境是 Mac,就用 Homebrew 簡單的 install 就好了。

$ brew install maven

再來看一下 Maven 的版本資訊:

Apache Maven 3.9.2 (c9616018c7a021c1c39be70fb2843d6f5f9b8a1c)
Maven home: /usr/local/Cellar/maven/3.9.2/libexec
Java version: 20.0.1, vendor: Homebrew, runtime: /usr/local/Cellar/openjdk/20.0.1/libexec/openjdk.jdk/Contents/Home
Default locale: en_CA, platform encoding: UTF-8
OS name: "mac os x", version: "13.3.1", arch: "x86_64", family: "mac"

這樣我們的 Maven 環境就算是準備好了。


Maven 的描述檔是 XML 格式,檔名是 pom.xml,裡面可以定義專案名稱、版本訊息、相依性等等的。

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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.springframework</groupId>
    <artifactId>gs-maven</artifactId>
    <packaging>jar</packaging>
    <version>0.1.0</version>

    <properties>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>

    <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>

編譯專案

$ mvn compile

這個指令會將專案內的 .java 編譯為 .class

打包專案

$ mvn package

故名思議,會根據 pom.xml 的 標籤決定打包的專案副檔名 war, jar... 的打包格式。

執行專案

當我們打包、編譯過後的結果都會放在 /target 目錄下, 以本專案為例我們就可以用底下的 .jar 來執行起我們剛才打包的專案。

$ java -jar target/gs-maven-0.1.0.jar