tags： java jsw maven zip

1、概述

使用java開發程序，在windows平臺下，一般有web應用，后臺服務應用，桌面應用：

web應用多數打成war包在web容器(如tomcat,jetty等)中運行

桌面應用一般打成jar包或exe文件運行

后臺服務應用一般打成jar包，然后使用命令行(如java -jar xxx.jar)運行

前面兩種運行方式在本文不作討論，主要描述java開發的后臺服務程序(如定時任務程序，文件處理，數據備份等)。

1.1、為什么要用服務形式運行

若使用命令行方式運行java程序，把命令寫成腳本(如bat腳本)運行即可，但命令行方式有其不方便之處，如命令行窗口不能關閉，關閉即停止，因此維護人員容易誤操作(關閉窗口使程序停止);若服務器宕機或其它原因，程序往往無法在服務器重啟時自動啟動。在windows下，很多程序都是以服務的形式運行，這也符合windows的管理。因此，建議使用服務形式運行，操作方便。

1.2、如何讓java程序以服務形式運行

有幾種方法可以讓java程序以服務形式運行：

Java Service Wrapper目前業界最知名、最成熟的解決方案，添加任何額外的代碼即可使用，不足之處是收費、64位版本需要購買Licence，不過在64位使用32位的也關系不大(除非你的程序需要很大的運算量)。

Apache Commons Daemon著名的Apache Commons工具包的成員，按規則添加啟動程序，再編寫腳本實現。

其它的(如WinRun4J，Launch4j)未使用過，更多可參考java開源打包工具

本文主要講解使用java service wrapper把java程序作為windows的服務運行，它不需要添加任何代碼，配置即可。

1.3、打包需求

java程序打包一般打成jar包，如果是供其它調用打包成一個jar包上傳到倉庫，其它人可以引用，這種方式可行，如果它是獨立的程序，有其它的額外文件(如配置文件，本文中說的wrapper文件)，打成jar包就比較難處理了，因此，更多的情況是把程序把成zip包以便傳輸，并規定好程序包目錄結構，打包時打成一個zip包，解壓即用。如下是我經常用到的一種包結構：

說明：

classes目錄：存放所有java編譯文件及資源配置文件

lib目錄：存放所有程序使用到所有依賴jar

wrapper：所有存放wrapper相關的文件，包括運行腳本bin，wrapper的配置文件conf，wrapper使用的依賴lib，及日志存放目錄

因此，需要使用maven把程序打成zip包，解壓出來后就是上述的目錄結構，可直接運行。

2、程序示例

按前面所說的要求，本文以下面的一個示例進行講解，示例使用標準maven archetype結構，只實現了一個簡單的文件寫入內容的功能，使用jsw對程序進行包裝，并把它使用maven打包成zip，解壓后直接使用jsw的bin下的腳本安裝或卸載服務。

從圖中可見，程序很簡單，僅一個java類FileLogger用于寫日志到文件，使用log4j(1.2.16版本，現在流行slf4j和logback了)輸出日志內容。日志路徑是當前的classpath下的logs目錄。log4j使用參考它的官網，當前我們主要關注以下兩點：

wrapper文件夾:當前只配置windows，存放jsw的文件，以便把程序包裝為服務安裝。若是linux，可自行添加文件夾。

pom.xml及assembly文件夾：用于maven配置按需打包成zip包，zip包內容如上面"打包需求"所示。

3、maven打zip包

3.1、maven-assembly-plugin介紹

maven-assembly-plugin是maven中用于構建發布包的插件，“assembly”是把一組文件、目錄、依賴元素組裝成一個歸檔文件，不僅支持創建二進制歸檔文件，也支持創建源碼歸檔文件。目前Assembly插件支持如下格式的歸檔文件:

zip 打zip包

tar.gz 打tar.gz包

tar.bz2 打tar.bz2包

jar 打jar包

dir 直接打包目錄

war 打war包

使用方法也比較簡單，可參考maven官網的assembly，一般是三個步驟

工程的pom.xml里配置Assembly插件。

自定義打包格式的描述符

運行"mvn package"或"mvn assembly:assembly"命令即可

3.2、maven-assembly-plugin配置

如下所示，在pom.xml文件中的build>plugins元素下配置assembly插件，請看注釋說明：

org.apache.maven.plugins

maven-assembly-plugin

2.2.1

make-wrapper-win-zip

package

single

jsw-test

true

${project.build.directory}

src/main/assembly/wrapper-win-zip.xml

復制代碼

assembly插件在pom.xml的配置比較簡單，回答幾個問題即可：

在什么時候打包：phase，

打包出來的名稱是什么:finalName

是否添加id到名稱后綴:appendAssemblyId

打包后輸出到哪里:outputDirectory

使用哪個描述符進行打包操作:descriptor

3.3、描述符wrapper-win-zip.xml配置

前面講到要使用一個描述符進行打包操作，即wrapper-win-zip.xml，此類文件可統一存放在目錄src/main/assembly中，以便統一管理。wrapper-win-zip.xml的格式如下所示：

wrapper-win

zip

false

false

/lib

${project.build.directory}/classes

/classes

install/wrapper/windows

/wrapper

復制代碼

詳細參考官網assembly的配置說明 說明一下，按上述的配置，使用maven命令進行打包(mvn package)，在target目錄會輸出的是一個jsw-test-wrapper-win包，當前此包名稱不影響程序運行，讀者可自行個性，包下面直接是三個文件夾(classes,lib,wrapper)。至此，即可以使用maven打出自定義的zip包。

4、jsw集成java后臺服務

jsw在不添加任何代碼的情況下可以直接使用，把java程序安裝為windows服務，這樣就可以隨著系統的運行而自動運行。

4.1、jsw介紹與下載

到java service wrapper官網下載，它支持各種操作系統，按系統下載即可，這里講解windows的，下載32位(64位的收費)。

下載解壓后，內容如下：

bin：wrapper運行文件及安裝腳本

conf：配置文件目錄

doc：說明文檔

lib：wrapper本身要用到的包和dll文件

logs：日志目錄

src：wrapper提供的模板文件(包括bin腳本和conf文件)，用戶直接復制這里的再修改為自己的腳本即可。

4.2、添加jsw到java程序

java程序中添加jsw的步驟很簡單，主要以下兩步：

復制必要的wrapper文件到程序需要的目錄中;只有四個目錄是必要的："bin","conf","lib","logs"，如當前示例中，在main目錄下新建wrapper目錄，復制上面wrapper的的"bin","conf","lib","logs"這四個文件夾到此目錄。去掉jsw的測試文件，最后結構如下：

修改conf/wrapper.conf文件， 一般會把經常修改的作為變量放在前面，以便后面配置使用，如當前示例，會先設置以下變量

rem 程序目錄位置

set.APP_HOME=../..

rem java目錄位置

set.JAVA_HOME=E:/Program Files/Java/jdk1.8.0_51

rem 服務英文名稱

set.SERVICE_EN_NAME=jsw-test

rem 服務中文名稱

set.SERVICE_CH_NAME=jsw測試

rem 服務描述

set.SERVICE_DESCRIPTION=jsw測試

rem 你的Java應用程序的運行類(主類)

set.USER_MAIN_CLASS=service.FileLogger

然后主要設置以下配置(%var%為變量引用)，其它配置按默認即可。如有個性化需求，可看官方文檔

JVM位置： wrapper.java.command=%JAVA_HOME%/bin/java

你的Java應用程序的運行類(主類) wrapper.app.parameter.1=%USER_MAIN_CLASS%

你的Java程序所需的類路徑： wrapper.java.classpath.1=../lib/wrapper.jar wrapper.java.classpath.2=%APP_HOME%/classes wrapper.java.classpath.3=%APP_HOME%/lib/*

你的Wrapper.DLL或wrapper.jar所在的目錄 wrapper.java.library.path.1=../lib

注冊為服務的名稱和顯示名，你可以隨意進行設置 wrapper.name=%SERVICE_EN_NAME% wrapper.displayname=%SERVICE_CH_NAME% wrapper.description=%SERVICE_DESCRIPTION%

日志文件位置 wrapper.logfile=../logs/wrapper.log

配置完之后，使用bin下的腳本可進行相應的安裝，卸載操作。

4.3、安裝與卸載

服務安裝 運行InstallTestWrapper-NT.bat即可安裝，在日志輸出目錄可查看日志檢查是否正常啟動。安裝成功后可在控制面板－管理程序－服務中看到注冊的服務名稱(當前示例是jsw測試)，并可進行啟動、關閉等操作。若啟動失敗，則需根據日志輸出檢查(一般是配置問題)。

服務卸載 運行UninstallTestWrapper-NT.bat進行卸載服務。

4.4、打包并測試

使用maven打包，mvn package，按前面的配置，即可輸出zip包，見前面的程序示例，把zip包放到服務，解壓，即可使用wrapper安裝服務。

5、附件

源碼：jsw-test.zip ; 密碼：3hs5

總結

以上是生活随笔為你收集整理的java 压缩jar 仓库,java服务安装(一)：使用java service wrapper及maven打zip包的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。