背景介绍
经常会头疼于一个jar包是如何制作的,包括maven的打包方式,springboot的打jar包的原理,jar包稍稍有错误就会完全无法运行。
压缩jar包
大家都知道,java应用项目按照JSR标准协议,一般采用jar包进行运行,java程序可以打包成一个jar。此外,当然你必须指定一个拥有main方法的main class类作为Java程序的入口,同时它也是启动JVM进程的入口
制作只含有字节码文件的jar包
我们先来看只含有字节码文件,即只含有class文件的jar包怎么制作,这是最简单的形式
最简单的jar包——直接输出hello
最终生成的jar包结构
META-INF Hello.class 复制代码
方法步骤
- 用记事本写一个Hello.java的文件
class Hello{ public static void main(String[] agrs){ System.out.println("hello"); } } 复制代码
- 用命令行进入到该目录下,编译这个文件
javac Hello.java 复制代码
- 将编译后的Hello.class文件打成jar包
jar -cvf hello.jar Hello.class 复制代码
- c(create):表示要创建一个新的jar包,
- v(view):表示创建的过程中在控制台输出创建过程的一些信息。
- f(file)表示给生成的jar包命名
- 运行jar包
java -jar hello.jar 复制代码
这时会报如下错误 hello.jar中没有主清单属性。
- 添加Main-Class属性
- 用压缩软件打开hello.jar,会发现里面多了一个META-INF文件夹,里面有一个MANIFEST.MF的文件,用记事本打开。
- 在第三行的位置写入 Main-Class: Hello (注意冒号后面有一个空格,整个文件最后有一行空行),保存
- 再次运行 java -jar hello.jar ,此时成功在控制台看到 hello ,成功
含有两个类的jar包——通过调用输出hello
最终生成的jar包结构
META-INF Tom.class Hello.class 复制代码
方法步骤
- 用记事本写一个Hello.java和一个Tom.java的文件,目的是让Hello调用Tom的speak方法
class Hello{ public static void main(String[] agrs){ Tom.speak(); } } class Tom{ public static void speak(){ System.out.println("hello"); } } 复制代码
- 编译: javac Hello.java
此时Hello.java和Tom.java同时被编译,因为Hello中调用了Tom,在编译Hello的过程中发现还需要编译Tom
- 打jar包,这次我们换一种方式直接定义Main-Class。
Manifest-Version: 1.0 Created-By: 1.8.0_121 (Oracle Corporation) Main-Class: Hello 复制代码
事先准备好上述的MANIFEST.MF文件,并存放在META-INF文件夹下,此时打jar包的命令如下
jar -cvfm hello.jar META-INF\MANIFEST.MF Hello.class Tom.class 复制代码
- 该命令表示用第一个文件当做MANIFEST.MF文件,hello.jar作为名称,将Hello.class和Tom.class打成jar包。
- 其中多了一个参数m,表示要定义MANIFEST文件
- 运行 java -jar hello.jar ,此时成功在控制台看到 hello ,成功
有目录结构的jar包——通过引包并调用输出hello
最终生成的jar包结构
META-INF com Tom.class Hello.class 复制代码
我们将上一个稍稍变化一下,将Tom这个类放在com包下,源文件目录结构变成
com Tom.java Hello.java 复制代码
同时Tom.java需要在第一行声明自己的包名
package com;
Hello.java需要引入Tom这个类,同样要在第一行进行import
import com.Tom;
方法步骤
- 编译Hello.java
- 打jar包,同样准备好MANIFEST文件
jar -cvfm hello.jar META-INF\MANIFEST.MF Hello.class com 复制代码
注意,最后一个com表示把com这个文件夹下的所有文件都打进jar包
- 运行 java -jar hello.jar ,此时成功在控制台看到 hello ,成功
- 优化过程
com包下是有Tom.java源文件的,也被打进了jar包里,这样不太好,能不能优化一下javac命令,使所有的编译后文件编译到另一个隔离的地方呢,答案是可以的。
在编译Hello.java时,先新建一个target文件夹。然后我们用如下命令:
javac Hello.java -d target 复制代码
- 该命令表示,将所有编译后的文件,都放到target文件夹下。
- 将META-INF文件夹也复制到target目录下,进入这个目录,输入如下命令
jar -cvfm hello.jar META-INF\MENIFEST.MF * 复制代码
注意最后一个位置变成了*,表示把当前目录下所有文件都打在jar包里
至此,我们可以总结出,制作一个只含有class字节码文件的jar包,以下命令足以
javac 要编译的文件 -d 目标位置
jar -cvfm 命名 MANIFEST文件 class类文件1 class类文件2
制作含有jar文件的jar包
我们将场景稍稍变得复杂一点,看看jar包中需要引入其他jar包的场景
- 两个jar包间相互调用——调用jar外的jar输出hello
最终生成的jar包结构
hello.jar tom.jar 复制代码
方法步骤
准备:将上述一中写好的那个不带包的tom.jar复制过来(目的是调用里面的speak方法)
- 编写一个Hello.java并将其编译成Hello.class,注意,由于Hello里面引用了Tom类的speak方法,因此在打jar包时应使用-cp参数,将tom.jar包引入
javac -cp tom.jar Hello.class 复制代码
这里的 -cp 表示 -classpath,指的是把tom.jar加入classpath路径下
- 将hello.class打成jar包,步骤略
- 此时运行 java -jar 发现报错 ClassNotFoundException:Tom
原因很简单,引入jar包需要在MANIFEST.MF文件中配置一个新属性:Class-Path,路径指向你需要的所有jar包,现在MANIFEST.MF这个文件应该变成
Manifest-Version: 1.0 Created-By: 1.8.0_121 (Oracle Corporation) Main-Class: Hello Class-Path: Tom.jar 复制代码
- 修改这个文件,再次运行,发现成功在控制台输出 hello
- javac -cp xxx.jar 要编译的文件 -d 目标位置
- jar -cvfm 命名 MANIFEST文件 要打包的文件1 要打包的文件2
jar包中含有jar包——调用jar内的jar输出hello
最终生成的jar包结构
META-INF Hello.class tom.jar 复制代码
- 当项目中我们把所需要的第三方jar包也打进了我们自己的jar包中时,如果仍然按照上述操作方式,会报找不到Class异常。原因就是jar引用不到放在自己内部的jar包。
制作含有资源文件的jar包
资源文件在jar包内部——读取jar内的文件
最终生成的jar包结构
META-INF Hello.class text.txt 复制代码
方法步骤
import java.io.InputStream; import java.io.BufferedReader; import java.io.InputStreamReader; class Hello{ public static void main(String[] args) throws Exception{ Hello hello = new Hello(); InputStream is = hello.getClass().getResourceAsStream("text.txt"); print(is); } /** * 读取文件,输出里面的内容,通用方法 */ public static void print(InputStream inputStream) throws Exception { InputStreamReader reader = new InputStreamReader(inputStream, "utf-8"); BufferedReader br = new BufferedReader(reader); String s = ""; while ((s = br.readLine()) != null) System.out.println(s); inputStream.close(); } } 复制代码
资源文件在另一个jar包内部——读取另一个jar内的文件
最终生成的jar包结构
hello.jar resource.jar text.txt 复制代码
方法步骤
同1一样,只不过需要在MANIFEST文件中将resource.jar加入classpath
import java.io.InputStream; import java.io.BufferedReader; import java.io.InputStreamReader; class Hello{ public static void main(String[] args) throws Exception{ Hello hello = new Hello(); InputStream is = hello.getClass().getResourceAsStream("text.txt"); print(is); } /** * 读取文件,输出里面的内容,通用方法 */ public static void print(InputStream inputStream) throws Exception { InputStreamReader reader = new InputStreamReader(inputStream, "utf-8"); BufferedReader br = new BufferedReader(reader); String s = ""; while ((s = br.readLine()) != null) System.out.println(s); inputStream.close(); } } 复制代码
资源文件在jar包外部——读取jar外的文件
最终生成的jar包结构
hello.jar text.txt 复制代码
方法步骤
import java.io.InputStream; import java.io.BufferedReader; import java.io.InputStreamReader; import java.io.FileInputStream; class Hello{ public static void main(String[] args) throws Exception{ Hello hello = new Hello(); InputStream is = new FileInputStream("text.txt"); print(is); } /** * 读取文件,输出里面的内容,通用方法 */ public static void print(InputStream inputStream) throws Exception { InputStreamReader reader = new InputStreamReader(inputStream, "utf-8"); BufferedReader br = new BufferedReader(reader); String s = ""; while ((s = br.readLine()) != null) System.out.println(s); inputStream.close(); } } 复制代码
运行jar包
- 具体的方法是修改jar包内目录META-INF下的MANIFEST.MF文件。
- 比如有个叫做demo.jar的jar包,里面有一个拥有main方法的main class:demo.mainClassName
- jar包中有个MANIFEST.MF文件,就只要在MANIFEST.MF里面添加如下一句话:Main-Class: demo.mainClassName
- 然后我们可以在控制台里输入java -jar test.jar即可以运行这个jar。
如果这个项目需要引用其他第三方的jar包,在IDE里面以项目jar包的形式引用了这个叫做some.jar的包,当时放在项目的lib子目录下,最后项目打包时把这个some.jar也打进来了,但是用java -jar 执行这个test.jar的时候报找不到Class异常,原因就是jar引用不到放在自己内部的jar包。
classpath参数设置方式
运行时将其加入classpath的方式行不行?就是在运行jar的同时加入classpath参数。
java -classpath some.jar -jar test.jar 复制代码
- 这种方式是不行的,因为使用classpath指定的jar是由AppClassloader(系统型类加载器)来加载,java命令加了-jar 参数以后,AppClassloader就只关注test.jar范围内的class了,classpath参数失效。
那该怎么引用其他的jar包呢?
方法一
Bootstrap Classloader来加载这些类
我们之前在讲述类加载器的时候也介绍过,可以在运行时使用如下参数:
- -Xbootclasspath:完全取代系统Java classpath.最好不用。
- -Xbootclasspath/a::在系统class加载后加载。一般用这个。
- -Xbootclasspath/p: 在系统class加载前加载,注意使用,和系统类冲突就不好了.
- win32 java -Xbootclasspath/a: some.jar;some2.jar; -jar test.jar
- unix java -Xbootclasspath/a: some.jar:some2.jar: -jar test.jar
win32系统每个jar用分号隔开,unix系统下用冒号隔开
方法二
使用Extension Classloader来加载
你可以把需要加载的jar都扔到%JRE_HOME%/lib/ext下面,这个目录下的jar包会在Bootstrap Classloader工作完后由Extension Classloader来加载。非常方便,非常省心。
方法三
使用AppClassloader来加载,不过不需要classpath参数了,我们在MANIFEST.MF中添加如下代码:
Class-Path: lib/some.jar
lib是和test.jar同目录的一个子目录,test.jar要引用的some.jar包就在这里面。如果有多个jar包需要引用的情况:
Class-Path: lib/some.jar lib/some2.jar
每个单独的jar用空格隔开就可以了。注意使用相对路径。
另:如果META-INF 下包含INDEX.LIST文件的话,可能会使Class-Path配置失效。INDEX.LIST是Jar打包工具打包时生成的索引文件,删除对运行不产生影响。