使用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 之后，把 targetexecutable-1.0.jar 和 targetjavaagent-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