maven插件maven-jar-plugin構(gòu)建jar文件的詳細使用
前言
maven-jar-plugin插件時maven中最常用的插件，也是maven構(gòu)建Java程序執(zhí)行包或者依賴包的默認插件，大部分情況下我們不需要對其進行配置，但在特殊情況下，我們可以通過配置來定制我們的jar包。
一、使用方式
大部分情況下，我們的配置如下：
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>2.4</version> </plugin>
而且這里的版本號是可選的，如果不配置版本號，maven會自動去尋找最新的版本。
二、常用配置詳解
1.classesDirectory
這個表示class文件的目錄，默認值是：${project.build.outputDirectory}也就是target目錄下的class目錄，當(dāng)然我們也可以指定其他目錄。
2.outputDirectory
表示jar文件的輸出目錄，默認值是：${project.build.directory}，就是target目錄，生成的jar文件就輸出到這里。
3.excludes
表示jar文件打包時，需要排除哪些文件，比如我們在開發(fā)時有個dev.properties文件，打包時我們就不需要了，可以這樣配置：
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.4</version>
<configuration>
<excludes>
<exclude>conf/**</exclude>
<exclude>bin/**</exclude>
<exclude>cache/**</exclude>
<exclude>attachment/**</exclude>
<exclude>dev.properties</exclude>
</excludes>
</configuration>
</plugin>
這里我們排除了部分文件夾和開發(fā)時用到的文件，在打包時不加入到j(luò)ar文件中。
4.includes
這個與excludes相反，就是把需要的文件在打包時加入到j(luò)ar文件中，具體配置可以參照excludes的配置。
5.archive
這個屬性配置很多，主要是用于定制化我們的jar包結(jié)構(gòu)以及對Manifest文件的定制化。下面我們用幾個實例來演示。
添加Implementation和Specification屬性
默認情況下面Manifest文件結(jié)構(gòu)如下：
Manifest-Version: 1.0
Created-By: Apache Maven ${maven.version}
Build-Jdk: ${java.version}
我們可配置下面屬性：
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.4</version>
<configuration>
<archive>
<manifest>
<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
<addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
</manifest>
</archive>
</configuration>
</plugin>
這樣生成的Manifest如下：
Manifest-Version: 1.0
Created-By: Apache Maven ${maven.version}
Build-Jdk: ${java.version}
Specification-Title: ${project.name}
Specification-Version: ${project.artifact.selectedVersion.majorVersion}.${project.artifact.selectedVersion.minorVersion}
Specification-Vendor: ${project.organization.name}
Implementation-Title: ${project.name}
Implementation-Version: ${project.version}
Implementation-Vendor: ${project.organization.name}
添加manifestEntries
這個屬性可以添加一下項目信息到j(luò)ar文件中。常用配置如下：
<configuration>
<archive>
<manifestEntries>
<mode>prod</mode>
<url>${project.url}</url>
</manifestEntries>
</archive>
</configuration>
生成的Manifest如下：
Manifest-Version: 1.0
Created-By: Apache Maven ${maven.version}
Build-Jdk: ${java.version}
mode: prod
url: http://project.url.com
添加鍵值對屬性Manifest Sections
這個功能可以添加多個鍵值屬性，配置如下：
<archive>
<manifestSections>
<manifestSection>
<name>value1</name>
<manifestEntries>
<id>key1</id>
</manifestEntries>
</manifestSection>
<manifestSection>
<name>value2</name>
<manifestEntries>
<id>key2</id>
</manifestEntries>
</manifestSection>
</manifestSections>
</archive>
結(jié)果如下：
Manifest-Version: 1.0
Created-By: Apache Maven ${maven.version}
Build-Jdk: ${java.version}
Name: value1
id: key1
Name: value2
id: key2
自定義manifest配置
可以根據(jù)下面的配置來定制化manifest文件的加載機制：
設(shè)置一個可執(zhí)行的jar文件
我們可以發(fā)布一個可執(zhí)行的jar文件，就是可以通過命令行來啟動一個jar。也可以把一個jar文件當(dāng)做依賴庫，提供給其他項目來使用。如果要發(fā)布一個可執(zhí)行的jar，配置如下：
<configuration>
<archive>
<manifest>
<mainClass>com.test.Main</mainClass>
</manifest>
</archive>
</configuration>
這里com.test.Main必須要有一個main方法
精確設(shè)置Classpath
就是將所有的jar文件全部枚舉出來，配置如下：
<project>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
</manifest>
</archive>
</configuration>
</plugin>
</plugins>
</build>
<dependencies>
<dependency>
<groupId>commons-lang</groupId>
<artifactId>commons-lang</artifactId>
<version>2.1</version>
</dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.11.0</version>
</dependency>
</dependencies>
</project>
Manifest生成結(jié)果如下：
Manifest-Version: 1.0
Created-By: Apache Maven ${maven.version}
Build-Jdk: ${java.version}
Class-Path: commons-io-2.11.0.jar commons-lang-2.1.jar
注意這樣運行這個jar文件時，需要保證Class-Path的依賴jar在目錄中保持平級。
根據(jù)目錄設(shè)置classpath
這里需要用到屬性classpathPrefix，配置如下：
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<classpathPrefix>lib/</classpathPrefix>
</manifest>
</archive>
</configuration>
Manifest生成結(jié)果如下：
Class-Path: lib/commons-io-2.11.0.jar lib/commons-lang-2.1.jar
注意這樣運行這個jar文件時，需要保證lib目錄和執(zhí)行jar保持平級。
配置classpath的加載樣式
加載樣式意思是可以通過特定的配置來配置classpath的路徑，配置屬性是：classpathLayoutType
自定義加載樣式classpathLayoutType=custom
配置如下：
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<classpathLayoutType>custom</classpathLayoutType>
<customClasspathLayout>lib/$${artifact.groupIdPath}/$${artifact.artifactId}-$${artifact.version}$${dashClassifier?}.$${artifact.extension}</customClasspathLayout>
</manifest>
</archive>
</configuration>
接入如下：
Class-Path: lib/commons-io/commons-io-2.11.0.jar lib/commons-lang/commons-lang-2.1.jar
maven風(fēng)格加載樣式classpathLayoutType=repository
我們也可以設(shè)置maven風(fēng)格的加載樣式，如果目標(biāo)機器上有maven庫，我們可以這樣設(shè)置：
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<classpathPrefix>${user.home}/.m2/repository</classpathPrefix>
<classpathLayoutType>repository</classpathLayoutType>
</manifest>
</archive>
</configuration>
結(jié)果如下：
Class-Path: ${user.home}/.m2/repository/commons-io/commons-io-2.11.0.jar ${user.home}/.m2/repository/commons-lang/commons-lang/2.1/commons-lang-2.1.jar
這里的${user.home}會替換成你電腦上的絕對路徑
強制使用SNAPSHOT版本的依賴
有時我們依賴的jar包可能是SNAPSHOT版本的，默認情況SNAPSHOT版本的庫文件是不會被加載的，這里可以使用useUniqueVersions來啟用，配置如下：
<configuration>
<archive>
<manifest>
<useUniqueVersions>false</useUniqueVersions>
</manifest>
</archive>
</configuration>
這樣SNAPSHOT版本的jar依賴也會被加載。
加載外部的manifest文件
我們也可以將manifest編寫好，然后直接使用我們自己編寫的文件，配置如下：
<configuration>
<archive>
<manifestFile>src/main/resources/META-INF/MANIFEST.MF</manifestFile>
</archive>
</configuration>
這里就直接加載我們自己編寫的MANIFEST文件。
總結(jié)
與maven-jar-plugin相同的還有一個maven-war-plugin插件，用于將我們的程序打包成war格式的執(zhí)行包，也是maven默認的打包工具。這個主要用于web項目。它的用法和maven-jar-plugin完全一樣，大家可以參照上面的使用。
到此這篇關(guān)于maven插件maven-jar-plugin構(gòu)建jar文件的詳細使用的文章就介紹到這了,更多相關(guān)maven-jar-plugin構(gòu)建jar文件內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
最近公司有一個需求是接入第三方支付(微信&支付寶),我接到了支付寶支付,所以下面這篇文章主要給大家介紹了關(guān)于java對接支付寶支付項目的相關(guān)資料,需要的朋友可以參考下2022-06-06
使用spring的websocket創(chuàng)建通信服務(wù)的示例代碼
這篇文章主要介紹了使用spring的websocket創(chuàng)建通信服務(wù)的示例代碼，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-11-11
在Spring中,要想更簡單的存儲和讀取對象的核心是使用注解,這篇文章主要給大家介紹了關(guān)于Spring如何通過注解存儲和讀取對象的相關(guān)資料,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下2023-01-01
MyBatis中的@SelectProvider注解源碼分析
這篇文章主要介紹了MyBatis中的@SelectProvider注解源碼分析,@SelectProvider功能就是用來單獨寫一個class類與方法,用來提供一些xml或者注解中不好寫的sql,今天就來說下這個注解的具體用法與源碼,需要的朋友可以參考下2024-01-01
java實現(xiàn)周期性執(zhí)行(定時任務(wù))
這篇文章主要為大家詳細介紹了java實現(xiàn)周期性執(zhí)行定時任務(wù)，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-09-09
Spring中配置和讀取多個Properties文件的方式方法
本篇文章主要介紹了Spring中配置和讀取多個Properties文件的方式方法，具有一定的參考價值，感興趣的小伙伴們可以參考一下。2017-04-04
Spring boot實現(xiàn)文件上傳實例（多文件上傳)
本篇文章主要介紹了Spring boot實現(xiàn)文件上傳實例（多文件上傳)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-05-05
解決MyBatis報錯:There is no getter for
這篇文章主要介紹了解決MyBatis報錯:There is no getter for property named'Xxx'in'class xxx.xxx.Xxx'問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-08-08
SpringBoot+Querydsl?框架實現(xiàn)復(fù)雜查詢解析
本篇主要將介紹的是利用spring query dsl框架實現(xiàn)的服務(wù)端查詢解析和實現(xiàn)介紹，對SpringBoot?Querydsl?查詢操作感興趣的朋友一起看看吧2022-05-05
MyBatis SELECT基本查詢實現(xiàn)方法詳解
這篇文章主要介紹了MyBatis SELECT基本查詢實現(xiàn)方法詳解,文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-08-08