不能运行的jar文件可以使用java -jar运行


摘要

本文展示如何将不可运行的jar变为可运行的，并且不用直接操作manifest文件。你将学会开发一个短小的程序使得任何jar文件都可以使用java -jar命令或者通过在像windows上双击而运行。

你可以将一个应用的所有类和资源打包到一个jar文件中。实际上，那就是jar文件的一个目的。另外一个目的是让用户可以非常容易的执行存储在jar文件中的应用，那么为什么当他们可以成为一等公民而和本机可执行程序等同的时候，我们为什么要让他们只承担包的功能而成为java世界中的二等公民呢？

要执行一个jar文件，你可以使用java命令的-jar选项。例如你有一个可运行的文件名为myjar.jar的jar文件，因为它是可运行的，你可以像这样执行它：java -jar myjar.jar

另外，当jre安装在像windows这样的操作系统上时，将jar文件和jvm关联后你就可以双击他们运行应用了。这些jar必须是可运行的。

问题是：你如何让一个jar是可运行的？


manifest文件和main-class条目

在大部分jar文件中，meta-inf目录下会有一个manifest.mf文件，在那个文件中有一个特殊的条目main-class，它告诉java -jar命令去执行那么类。

问题是你必须自己恰当的将这个特殊条目加到manifest文件中：它必须位于特定的位置并且必须符合特定的格式，然而有些人不喜欢编辑配置文件。


让api帮你做

从java 1.2开始引人的java.util.jar包可以让你操作jar文件(注意：它建立在java.util.zip包的基础上)。更确切的说法是，java.util.jar可以让你通过manifest类非常容易的操作那个特殊的manifest文件。
让我们编写一个程序使用那个api。首先这个程序必须知道三件事情：

1. 我们希望可以执行的jar
2. 我们希望执行的主类(这个类必须存在于jar内)
3. 新的jar文件的文件名，因为我们不应该简单的覆盖那些文件


编写程序

上面的列表将会构成我们的程序的参数，基于这一点，让我们为这个应用挑选一个合适的名字。makejarrunnable听起来如何？


检查main的参数

假设我们的main入口是一个标准的main(string[])方法，我们首先应该检查程序的参数：

if (args.length != 3) { system.out.println("usage: makejarrunnable " + "

"); system.exit(0); }

请注意参数列表是如何被解释的，因为这对于后面的代码是非常重要的。参数的顺序和内容并不是硬性设置的，但是如果你改变它们也要记得适当的修改其他的代码。


访问jar和它的manifest文件

首先我们必须创建一些知道jar和manifest文件的对象:

//create the jarinputstream object, and get its manifest jarinputstream jarin = new jarinputstream(new fileinputstream(args[0])); manifest manifest = jarin.getmanifest(); if (manifest == null) { //this will happen if no manifest exists manifest = new manifest(); }


设置main-class属性

我们将main-class条目放到manifest文件的主要属性部分。一旦我们从manifest对象获得了这个属性集我们就可以设置适当的主类。然而如果一个main-class属性已经存在于原来的jar时怎么办？这个程序简单的打印一个警告并退出。或许我们可以增加一个命令行参数告诉程序用新的值替换已经存在的那个值.

attributes a = manifest.getmainattributes(); string oldmainclass = a.putvalue("main-class", args[1]); //if an old value exists, tell the user and exit if (oldmainclass != null) { system.out.println("warning: old main-class value is: " + oldmainclass); system.exit(1); }


输出新的jar

我们需要创建一个新的jar文件，因为我们必须使用jaroutputstream类。注意我们必须保证没有将输入作为输出使用。作为替代，也许程序应该考虑两个jar文件相同并且提示用户是否覆盖原来的。然而我将这个保留给读者作为练习。

system.out.println("writing to " + args[2] + "..."); jaroutputstream jarout = new jaroutputstream(new fileoutputstream(args[2]), manifest);

我们必须将原来的jar中的每个条目都写到新的jar中，因为对那些条目迭代：

//create a read buffer to transfer data from the input byte[] buf = new byte[4096]; //iterate the entries jarentry entry; while ((entry = jarin.getnextjarentry()) != null) { //exclude the manifest file from the old jar if ("meta-inf/manifest.mf".equals(entry.getname())) continue; //write the entry to the output jar jarout.putnextentry(entry); int read; while ((read = jarin.read(buf)) != -1) { jarout.write(buf, 0, read); } jarout.closeentry(); } //flush and close all the streams jarout.flush(); jarout.close(); jarin.close();


完整程序

当然我们必须将这些代码放到一个类里面的main方法里面，并且具有合适的import声明。


使用范例

让我们用一个范例来使用这个程序。假设你有一个应用其main入口点是类hellorunnableworld(这个是它的全类名，也就是包含包名)，同样假设你已经创建了一个名字为myjar.jar的jar，包含整个应用。对于这个jar，我们像这样运行makejarrunnable：

java makejarrunnable myjar.jar hellorunnableworld myjar_r.jar

再强调一次，就像早先提到的，注意参数列表的顺序。如果忘记了顺序，以无参的形式运行程序它就会告诉你使用信息。

使用java -jar命令运行myjar.jar和myjar_r.jar，注意它们的差异。完成这些之后，查看一下它们的manifest文件(meta-inf/manifest.mf)。

这里有一个建议：将makejarrunnable制作成一个可以运行的jar!


运行它

通过双击一个jar或者使用简单的命令总是比将它包含在你的classpath并运行特定的main类方便。为了帮助你作到这一点，jar规范为jar的manifest文件提供了一个main-class属性。我在这里提出的这个程序让你利用java的jar api非常容易的操作这个属性并制作你自己的可运行的jar。