Linux 下使用 java jar 运行可执行 jar 包的正确方式

发表于 | 更新于 | 分类于 | | 阅读次数：
本文字数： 3k | 阅读时长 ≈ 0:03

问题来源

一般来说，一个大型的项目都会有一些依赖的JAR包（Java归档，英语：Java ARchive），而在将项目部署到服务器的过程中，如果没有持续集成环境的话，也就是说服务器不支持在线编译及打包，那么需要自己上传依赖的JAR包，然而可能服务器上已经存在了该项目所依赖的JAR包（比如项目修复BUG，重新打包上传，而依赖不变或者版本升级，修改类中的方法，方法参数等），无需再次上传所依赖的JAR包，此时只需将该项目单独打包，在运行的时候指定CLASSPATH即可。

在将JAR包部署到服务器上之后，设置CLASSPATH环境变量，运行java -jar ...命令出现ClassNotFoundException异常。之后又试用了诸多其它参数设置CLASSPATH，例如下面几个命令，同样都是报找不到类异常。

1
2
3
4
5
set CLASSPATH = classpath1;classpath2...
java -classpath ".;D:/mylib/*" -jar jar包 #Windows设置
java -classpath ".:/data/home/mylib/*" -jar jar包 #Linux设置
java -cp ...
java -cp /lib/*

关于在CLASSPATH参数中使用通配符需要注意，正确使用方式如下，它们都是等效的（在Linux下用冒号作为分隔符，在Windows下用分号作为分隔符）

1
2
3
4
java -classpath "lib/*:." my.package.Program #其中MyApplication.jar放在lib目录下
java -cp "lib/*:." my.package.Program #其中MyApplication.jar放在lib目录下
java -classpath "MyApplication.jar:lib/*:." my.package.Program
java -cp "MyApplication.jar:lib/*:." my.package.Program

以下为不正确方式

1
2
3
4
java -classpath "lib/a*.jar:." my.package.Program
java -classpath "lib/a*:."     my.package.Program
java -classpath "lib/*.jar:."  my.package.Program
java -classpath  lib/*:.       my.package.Program

JAR的分类

首先你需要知道JAR分为可执行JAR和非可执行JAR，一个可执行的JAR文件是一个自包含的Java应用程序，它存储在特别配置的JAR文件中，可以由JVM直接执行它而无需事先提取文件或者设置类路径。可执行的JAR文件中的MANIFEST.MF文件用代码Main-Class: myPrograms.MyClass指定了入口类，同时这个入口类的入口方法一定是Main方法，而不能是其它方法，注意要指明该类的全路径（另外-cp参数将被忽略，-cp 是 -classpath的缩写）。有些操作系统可以在点击后直接运行可执行JAR文件。而更典型的调用则是通过命令行执行java -jar [/data/home/java/]foo.jar。

运行存储在非可执行的JAR中的应用程序，不需要配置MANIFEST.MF文件，只要将它加入到您的类路径中，并用包名.类名这种全路径的方式指定应用程序的主类，而这个主类的入口方法也必须是Main方法，不能是其它方法。但是使用可执行的JAR文件，我们可以不用提取它或者知道主要入口点就可以运行一个应用程序。可执行JAR有助于方便发布和执行Java应用程序。典型的调用非可执行JAR包的命令是java -cp [/data/home/java/]foo.jar [多个JAR之间用;(Windows)或者:(Linux)分隔] packageName.ClassName。

注意点：对于可执行JAR，在运行java -jar选项的时候，那么环境变量CLASSPATH和在命令行中指定的所有类路径都将被JVM忽略，也就是说，对于一个可执行JAR，使用java -classpath或者java -cp或者set classpath=lib/commons-io-2.4.jar等等命令指定CLASSPATH都是无效的。

正确姿势

对于一个可执行的JAR必须通过MANIFEST.MF文件的头引用它所需要的所有其他从属JAR，引用方式如下

1
Class-Path: lib/commons-io-2.4.jar lib/commons-lang3-3.4.jar

如果有多个JAR包那么相互之间使用空格分隔。MANIFEST文件的一般格式如下

1
2
3
4
5
6
7
8
9
Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Built-By: wangxu
X-Compile-Target-JDK: 1.7
X-Compile-Source-JDK: 1.7
Created-By: Apache Maven 3.3.3
Build-Jdk: 1.8.0_45
Main-Class: com.yuewen.statistics.report.service.Main
Class-Path: lib/commons-io-2.4.jar lib/commons-lang3-3.4.jar lib/guava-18.0.jar lib/junit-4.10.jar lib/log4j-api-2.0.jar lib/log4j-core-2.0.jar lib/lombok-1.16.4.jar lib/lucene-analyzers-common-5.5.0.jar lib/lucene-analyzers-smartcn-5.5.0.jar lib/lucene-core-5.5.0.jar lib/lucene-grouping-5.5.0.jar lib/lucene-queries-5.5.0.jar lib/lucene-queryparser-5.5.0.jar lib/mysql-connector-java-5.1.38-bin.jar

其中Manifest-Version表示版本号，一般由IDE工具自动生成，在编写MANIFEST文件的过程中，有如下注意点

  • Main-Class是JAR文件的主类，程序的入口
  • Class-Path指定需要依赖的JAR，多个JAR必须要在一行上，多个JAR之间以空格隔开，如果依赖的JAR在当前目录的子目录下，windows下使用”\”来分割，linux下用”/“分割
  • 文件的冒号后面必须要空一个空格，否则会出错
  • 文件的最后一行必须是一个回车换行符，否则也会出错

多条java jar命令的执行顺序问题

通常地，我们会在服务器上配置shell脚本去定时调用自己的JAR包，但是当shell脚本中存在多条java -jar命令时，其执行情况是怎么样的呢？是同时并行执行，还是按顺序执行呢？经过测试得出，多条java -jar命令是按顺序执行的，并且只有在第一条java -jar命令执行完毕后，才会执行下一条java -jar命令，依次类推。

参考文献
[1] http://stackoverflow.com/questions/219585/setting-multiple-jars-in-java-classpath/219801#219801
[2] https://www.ibm.com/developerworks/cn/java/j-jar/
[3] Difference between exporting as a JAR and exporting as a Runnable JAR