從零開始打jar包

常常會頭疼於一個jar包是如何製做的，包括maven的打包方式，springboot的打jar包的原理，jar包稍稍有錯誤就會徹底沒法運行。在網上折騰了好久終於有些思路和步驟，在這裏作個筆記

本文大綱：

1、製做只含有字節碼文件的jar包
一、最簡單的jar包——直接輸出hello
二、含有兩個類的jar包——經過調用輸出hello
三、有目錄結構的jar包——經過引包並調用輸出hello

2、製做含有jar文件的jar包
一、兩個jar包間相互調用——調用jar外的jar輸出hello
二、jar包中含有jar包——調用jar內的jar輸出hello

3、製做含有資源文件的jar包
一、資源文件在jar包內部——讀取jar內的文件
二、資源文件在另外一個jar包內部——讀取另外一個jar內的文件
三、資源文件在jar包外部——讀取jar外的文件

正文：

1、製做只含有字節碼文件的jar包

咱們先來看只含有字節碼文件，即只含有class文件的jar包怎麼製做，這是最簡單的形式

一、最簡單的jar包——直接輸出hello

最終生成的jar包結構

META-INF
Hello.class

方法步驟

（1）用記事本寫一個Hello.java的文件

1 class Hello{
2     public static void main(String[] agrs){
3         System.out.println("hello");
4     }
5 }

（2）用命令行進入到該目錄下，編譯這個文件

　　 javac Hello.java 

（3）將編譯後的Hello.class文件打成jar包

　　 jar -cvf hello.jar Hello.class 

　　c表示要建立一個新的jar包，v表示建立的過程當中在控制檯輸出建立過程的一些信息，f表示給生成的jar包命名

（4）運行jar包

　　 java -jar hello.jar  這時會報以下錯誤  hello.jar中沒有主清單屬性 

　　添加Main-Class屬性

　　用壓縮軟件打開hello.jar，會發現裏面多了一個META-INF文件夾，裏面有一個MENIFEST.MF的文件，用記事本打開

1 Manifest-Version: 1.0
2 Created-By: 1.8.0_121 (Oracle Corporation)
3 

　　在第三行的位置寫入 Main-Class: Hello （注意冒號後面有一個空格，整個文件最後有一行空行），保存

　　再次運行 java -jar hello.jar ，此時成功在控制檯看到  hello ，成功

 

二、含有兩個類的jar包——經過調用輸出hello

最終生成的jar包結構

META-INF
Tom.class
Hello.class

方法步驟

（1）用記事本寫一個Hello.java和一個Tom.java的文件

　　目的是讓Hello調用Tom的speak方法

1 class Hello{
2     public static void main(String[] agrs){
3         Tom.speak();
4     }
5 }

1 class Tom{
2     public static void speak(){
3         System.out.println("hello");
4     }
5 }

（2）編譯： javac Hello.java 

　　此時Hello.java和Tom.java同時被編譯，由於Hello中調用了Tom，在編譯Hello的過程當中發現還須要編譯Tom

（3）打jar包，此次咱們換一種方式直接定義Main-Class。

1 Manifest-Version: 1.0
2 Created-By: 1.8.0_121 (Oracle Corporation)
3 Main-Class: Hello
4  

　　事先準備好上述的MENIFEST.MF文件，並存放在META-INF文件夾下，此時打jar包的命令以下

　　 jar -cvfm hello.jar META-INF\MENIFEST.MF Hello.class Tom.class 

　　該命令表示用第一個文件當作MENIFEST.MF文件，hello.jar做爲名稱，將Hello.class和Tom.class打成jar包。其中多了一個參數m，表示要定義MENIFEST文件

（4）運行 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;

方法步驟

（1）編譯Hello.java

（2）打jar包，一樣準備好MENIFEST文件

　　 jar -cvfm hello.jar META-INF\MENIFEST.MF Hello.class com 

　　注意，最後一個com表示把com這個文件夾下的全部文件都打進jar包

（3）運行 java -jar hello.jar  ，此時成功在控制檯看到  hello ，成功

（4）優化過程

　　咱們注意到，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 命名 MENIFEST文件 要打包的文件1 要打包的文件2

 

2、製做含有jar文件的jar包

咱們將場景稍稍變得複雜一點，看看jar包中須要引入其餘jar包的場景

一、兩個jar包間相互調用——調用jar外的jar輸出hello

最終生成的jar包結構

hello.jar
tom.jar

方法步驟

準備：將上述一中寫好的那個不帶包的tom.jar複製過來（目的是調用裏面的speak方法）

（1）編寫一個Hello.java並將其編譯成Hello.class，注意，因爲Hello裏面引用了Tom類的speak方法，所以在打jar包時應使用-cp參數，將tom.jar包引入

　　  javac -cp tom.jar Hello.class 

　　這裏的 -cp 表示 -classpath，指的是把tom.jar加入classpath路徑下

（2）將hello.class達成jar包，步驟略

（3）此時運行 java -jar 發現報錯  ClassNotFoundException：Tom 

　　緣由很簡單，引入jar包須要在MENIFEST.MF文件中配置一個新屬性：Class-Path，路徑指向你須要的全部jar包

　　如今MENIFEST.MF這個文件應該變成

1 Manifest-Version: 1.0
2 Created-By: 1.8.0_121 (Oracle Corporation)
3 Main-Class: Hello
4 Class-Path: Tom.jar
5  

（4）好了，修改這個文件，再次運行，發現成功在控制檯輸出 hello 

tips：引入多個jar包，中間用空格隔開

至此，咱們能夠總結出，命令變化以下

javac -cp xxx.jar 要編譯的文件 -d 目標位置

jar -cvfm 命名 MENIFEST文件 要打包的文件1 要打包的文件2

 

二、jar包中含有jar包——調用jar內的jar輸出hello

最終生成的jar包結構

META-INF
Hello.class
tom.jar

　　當項目中咱們把所須要的第三方jar包也打進了咱們本身的jar包中時，若是仍然按照上述操做方式，會報找不到Class異常。緣由就是jar引用不到放在本身內部的jar包。

　　這種狀況的具體實現細節比較複雜，我會在後一篇介紹一些知名的java應用是如何加載jar包的，來講明這種狀況。實現方式的簡單說明，能夠先參考這篇文章：

http://www.cnblogs.com/adolfmc/archive/2012/10/07/2713562.html

 

3、製做含有資源文件的jar包

一、資源文件在jar包內部——讀取jar內的文件

最終生成的jar包結構

META-INF
Hello.class
text.txt

 方法步驟

 1 import java.io.InputStream;
 2 import java.io.BufferedReader;
 3 import java.io.InputStreamReader;
 4 
 5 class Hello{
 6     public static void main(String[] args) throws Exception{
 7         Hello hello = new Hello();
 8         InputStream is = hello.getClass().getResourceAsStream("text.txt");
 9         print(is);
10     }
11     
12     /**
13      * 讀取文件，輸出裏面的內容，通用方法
14      */
15     public static void print(InputStream inputStream) throws Exception {
16         InputStreamReader reader = new InputStreamReader(inputStream, "utf-8");
17         BufferedReader br = new BufferedReader(reader);
18         String s = "";
19         while ((s = br.readLine()) != null)
20             System.out.println(s);
21         inputStream.close();
22     }
23 }

 

二、資源文件在另外一個jar包內部——讀取另外一個jar內的文件

最終生成的jar包結構

hello.jar
resource.jar
　text.txt

 方法步驟

同1同樣，只不過須要在MENIFEST文件中將resource.jar加入classpath

 1 import java.io.InputStream;
 2 import java.io.BufferedReader;
 3 import java.io.InputStreamReader;
 4 
 5 class Hello{
 6     public static void main(String[] args) throws Exception{
 7         Hello hello = new Hello();
 8         InputStream is = hello.getClass().getResourceAsStream("text.txt");  9         print(is);
10     }
11     
12     /**
13      * 讀取文件，輸出裏面的內容，通用方法
14      */
15     public static void print(InputStream inputStream) throws Exception {
16         InputStreamReader reader = new InputStreamReader(inputStream, "utf-8");
17         BufferedReader br = new BufferedReader(reader);
18         String s = "";
19         while ((s = br.readLine()) != null)
20             System.out.println(s);
21         inputStream.close();
22     }
23 }

 

三、資源文件在jar包外部——讀取jar外的文件

最終生成的jar包結構

hello.jar
text.txt

 方法步驟

 1 import java.io.InputStream;
 2 import java.io.BufferedReader;
 3 import java.io.InputStreamReader;
 4 import java.io.FileInputStream;
 5 
 6 class Hello{
 7     public static void main(String[] args) throws Exception{
 8         Hello hello = new Hello();
 9         InputStream is = new FileInputStream("text.txt"); 10         print(is);
11     }
12     
13     /**
14      * 讀取文件，輸出裏面的內容，通用方法
15      */
16     public static void print(InputStream inputStream) throws Exception {
17         InputStreamReader reader = new InputStreamReader(inputStream, "utf-8");
18         BufferedReader br = new BufferedReader(reader);
19         String s = "";
20         while ((s = br.readLine()) != null)
21             System.out.println(s);
22         inputStream.close();
23     }
24 }