使用Maven打包可運行jar和javaagent.jar的區別

簡介

javaagent 是 Java1.5 之后引入的新特性，其主要作用是在class被加載之前對其攔截，以插入我們的字節碼。

java1.5 之前使用的是JVMTI（jvm tool interface）技術來實現對class的攔截，不過這個是用 C++ 編寫的，比如 debug 功能就是用這個技術實現的，有興趣的自行百度。

jar

常見的jar包分為 可運行jar 和 javaagent.jar ,它們的主要區別如下：

	Executable Jar	Javaagent Jar
入口方法	main	premain
打包參數	Main-Class	Premain-Class
啟動方式	java -jar xxx.jar	-javaagent:xxx.jar=dddd
是否可啟動	是	否

入口方法

可運行 jar 包入口方法：

package org.coderead;
public class TestMain {
      // 這個是我們經常寫的
      public static void main(String[] args) {
            System.out.println("hello main");
      }
}

javaagent.jar 入口方法：

package org.coderead;

import java.lang.instrument.Instrumentation;

public class TestAgent {
    
    public static void premain(String arg, Instrumentation instrumentation) {
        System.out.println("javaagent arg=" + arg);
    }
}

MANIFEST.MF 文件方式

Use Your Own Manifest File 這篇官方文檔介紹了使用 MANIFEST.MF 打包的方法：

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jar-plugin</artifactId>
        ...
        <configuration>
          <archive>
            <manifestFile>src/main/resources/META-INF/MANIFEST.MF</manifestFile>
          </archive>
        </configuration>
        ...
      </plugin>
    </plugins>
  </build>
  ...
</project>

默認情況下，Maven Archiver為您創建清單文件。有時使用您自己手工制作的清單文件很有用。假設您要使用清單文件 src/main/resources/META-INF/MANIFEST.MF。 通過將 <manifestFile> 配置元素設置為文件的位置來完成此操作。

您自己的清單文件的內容將與Maven Archiver創建的條目合並。 如果您在自己的清單文件中指定一個條目，它將覆蓋Maven Archiver創建的值。

注意：與此處的所有示例一樣，此配置可以在所有使用Maven Archiver的插件中使用，而不僅僅是本示例中的maven-jar-plugin。

• 打包一個可運行 jar 包 Executable.jar 的 MANIFEST.MF

Main-Class: org.coderead.TestMain

注意：
MANIFEST.MF 中需要多留一個空行，也就是輸入完成最后一行之后回車

• 打包一個 javaagent 包 javaagent.jar 的 MANIFEST.MF

Premain-Class: org.coderead.TestAgent

Maven 項目結構

首先是 可運行jar 的項目結構：

然后是 javaagent.jar 的項目結構：

package 打包 jar

這個對應的命令是mvn package, 打包后會生成 target文件，並且生成 jar 包。
如果在 IDEA 沒有找到右邊欄，你可能需要點擊IDEA左下角的按鈕

驗證

我在對兩個項目執行了 package 之后，把 target\executable-1.0.jar 和 target\javaagent-1.0.jar 移動到同一個文件夾下，比如我在桌面新建了一個 test 文件夾。
然后執行命令

java -javaagent:javaagent-1.0.jar=test -jar executable-1.0.jar

執行結果如下圖所示

manifestEntries 標簽

還可以使用 <manifestEntries>代替創建 MANIFEST.MF 文件。這樣就更加省事了！少創建一個文件！

<?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>org.coderead</groupId>
    <artifactId>javaagent</artifactId>
    <version>1.0</version>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <configuration>
                    <archive>
                        <!--方法一：MANIFEST.MF 配置文件-->
<!--                        <manifestFile>src/main/resources/META-INF/MANIFEST.MF</manifestFile>-->
                        <!--方法二: pom 指定配置-->
                        <manifestEntries>
                            <Premain-Class>org.coderead.TestAgent</Premain-Class>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

*manifest 標簽

借助<manifest> 標簽，我們可以指定可運行 jar 的主類。
參考官方文檔 中關於<archive>標簽講解。

<archive>
  <addMavenDescriptor/>
  <compress/>
  <forced/>
  <index/>
  <pomPropertiesFile/>
 
  <manifestFile/>
  <manifest>
    <addClasspath/>
    <addDefaultEntries/>
    <addDefaultImplementationEntries/>
    <addDefaultSpecificationEntries/>
    <addBuildEnvironmentEntries/>
    <addExtensions/>
    <classpathLayoutType/>
    <classpathPrefix/>
    <customClasspathLayout/>
    <mainClass/> <!--The Main-Class manifest entry.-->
    <packageName/>
    <useUniqueVersions/>
  </manifest>
  <manifestEntries>
    <key>value</key>
  </manifestEntries>
  <manifestSections>
    <manifestSection>
      <name/>
      <manifestEntries>
        <key>value</key>
      </manifestEntries>
    <manifestSection/>
  </manifestSections>
</archive>

因此，我們的代碼還可以寫成

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jar-plugin</artifactId>
        ...
        <configuration>
          <archive>
            <!--指定 Main-Class 來指定可運行 jar 的主類 -->
            <manifest>
              <mainClass>org.coderead.TestMain</mainClass>
            </manifest>
          </archive>
        </configuration>
        ...
      </plugin>
    </plugins>
  </build>
  ...
</project>

總結

• 我們有兩種方式來使用 Maven 打包 javaagent.jar 。

  • 一種方式是在 <manifestFile> 標簽中指定 META-INF/MANIFEST.MF 文件路徑。在文件中填入 javaagent 打包屬性。
  • 另一種是在 <manifestEntries> 標簽下，直接設置 javaagent 打包屬性標簽。

• 如果是打包可運行 jar 包，除了前兩種方法外，第三種是使用 manifest 標簽。

• MANIFEST.MF 文件必須要在輸入完最后一行配置后輸入回車，即留出一行空白行

• 本文打包使用的插件是 maven-jar-plugin，生成 jar 包的命令是 mvn package

• 打包 javaagent.jar 必須指定 Premain-Class:org.coderead.TestAgent