java服务安装(一)：使用java service wrapper及maven打zip包

梦里梦外; 2022-06-15 03:07 235阅读 0赞

*   *  [1概述][1]
        
         *  [1\_1为什么要用服务形式运行][1_1]
         *  [1\_2如何让java程序以服务形式运行][1_2_java]
         *  [1\_3打包需求][1_3]
     *  [2程序示例][2]
     *  [3maven打zip包][3maven_zip]
        
         *  [3\_1maven-assembly-plugin介绍][3_1maven-assembly-plugin]
         *  [3\_2maven-assembly-plugin配置][3_2maven-assembly-plugin]
         *  [3\_3描述符wrapper-win-zipxml配置][3_3_wrapper-win-zipxml]
     *  [4jsw集成java后台服务][4jsw_java]
        
         *  [4\_1jsw介绍与下载][4_1jsw]
         *  [4\_2添加jsw到java程序][4_2_jsw_java]
         *  [4\_3安装与卸载][4_3]
         *  [4\_4打包并测试][4_4]
     *  [5附件][5]

## 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位的也关系不大（除非你的程序需要很大的运算量）。
>  *  [Yet Another Java Service Wrapper][]类似JSW的开源实现版本，不过官方支持不怎么好。
>  *  [Apache Commons Daemon][]著名的Apache Commons工具包的成员，按规则添加启动程序，再编写脚本实现。
>  *  其它的（如WinRun4J，Launch4j）未使用过，更多可参考[java开源打包工具][java]

本文主要讲解使用[Java ][Java 1]service wrapper把java程序作为windows的服务运行，它不需要添加任何代码，配置即可。

### 1\_3、打包需求 ###

java程序打包一般打成jar包，如果是供其它调用打包成一个jar包上传到仓库，其它人可以引用，这种方式可行，如果它是独立的程序，有其它的额外文件（如配置文件，本文中说的wrapper文件），打成jar包就比较难处理了，因此，更多的情况是把程序把成zip包以便传输，并规定好程序包目录结构，打包时打成一个zip包，解压即用。如下是我经常用到的一种包结构：  
![程序包结构][jsw-test-structure.png]  
说明：

>  *  classes目录：存放所有java编译文件及资源配置文件
>  *  lib目录：存放所有程序使用到所有依赖jar
>  *  wrapper：所有存放wrapper相关的文件，包括运行脚本bin，wrapper的配置文件conf，wrapper使用的依赖lib，及日志存放目录

因此，需要使用maven把程序打成zip包，解压出来后就是上述的目录结构，可直接运行。

## 2、程序示例 ##

按前面所说的要求，本文以下面的一个示例进行讲解，示例使用标准maven archetype结构，只实现了一个简单的文件写入内容的功能，使用jsw对程序进行包装，并把它使用maven打包成zip，解压后直接使用jsw的bin下的脚本安装或卸载服务。  
![源码结构][jsw-test-src-structure.png]  
从图中可见，程序很简单，仅一个java类FileLogger用于写日志到文件，使用log4j(1.2.16版本，现在流行slf4j和logback了)输出日志内容。日志路径是当前的classpath下的logs目录。log4j使用参考它的[官网][Link 1]，当前我们主要关注以下两点：

*  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][maven_assembly]，一般是三个步骤

1.  工程的pom.xml里配置Assembly插件。
2.  自定义打包格式的描述符
3.  运行”mvn package”或”mvn assembly:assembly”命令即可

### 3\_2、maven-assembly-plugin配置 ###

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

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-assembly-plugin</artifactId>
        
        <version>2.2.1</version>
        <executions>
            
            <execution>
                
                <id>make-wrapper-win-zip</id>
                
                <phase>package</phase>
                <goals>
                    
                    <goal>single</goal>
                </goals>
                <configuration>
                    
                    <finalName>jsw-test</finalName>
                    
                    <appendAssemblyId>true</appendAssemblyId>
                    
                    <outputDirectory>${project.build.directory}</outputDirectory>
                    <descriptors>
                        
                        <descriptor>src/main/assembly/wrapper-win-zip.xml</descriptor>
                    </descriptors>
                </configuration>
            </execution>
        </executions>
    </plugin>
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
       14
       15
       16
       17
       18
       19
       20
       21
       22
       23
       24
       25
       26
       27
       28
       29
       30
       31
       32
      
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
       14
       15
       16
       17
       18
       19
       20
       21
       22
       23
       24
       25
       26
       27
       28
       29
       30
       31
       32

assembly插件在pom.xml的配置比较简单，回答几个问题即可：

*  在什么时候打包：phase，
 *  打包出来的名称是什么:finalName
 *  是否添加id到名称后缀:appendAssemblyId
 *  打包后输出到哪里:outputDirectory
 *  使用哪个描述符进行打包操作:descriptor

可参考[maven官网的assembly][maven_assembly]

### 3\_3、描述符wrapper-win-zip.xml配置 ###

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

<assembly>
        
        <id>wrapper-win</id>
        <formats>
            
            <format>zip</format>
        </formats>
        
        <includeBaseDirectory>false</includeBaseDirectory>
        
        <dependencySets>
            <dependencySet>
                
                <useProjectArtifact>false</useProjectArtifact>
                
                <outputDirectory>/lib</outputDirectory>
            </dependencySet>
        </dependencySets>
        
        <fileSets>
            <fileSet>
                
                <directory>${project.build.directory}/classes</directory>
                
                <outputDirectory>/classes</outputDirectory>
            </fileSet>
            <fileSet>
                
                <directory>install/wrapper/windows</directory>
                <outputDirectory>/wrapper</outputDirectory>
            </fileSet>
        </fileSets>
    </assembly>
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
       14
       15
       16
       17
       18
       19
       20
       21
       22
       23
       24
       25
       26
       27
       28
       29
       30
       31
       32
       33
      
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
       14
       15
       16
       17
       18
       19
       20
       21
       22
       23
       24
       25
       26
       27
       28
       29
       30
       31
       32
       33

详细参考[官网assembly的配置说明][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官网][Java Service Wrapper]下载，它支持各种[操作系统][Link 2]，按系统下载即可，这里讲解windows的，下载32位(64位的收费)。  
![jsw下载][jsw]  
下载解压后，内容如下：  
![jsw解压内容][jsw 1]

*  bin：wrapper运行文件及安装脚本
 *  conf：配置文件目录
 *  doc：说明文档
 *  lib：wrapper本身要用到的包和dll文件
 *  logs：日志目录
 *  src：wrapper提供的模板文件（包括bin脚本和conf文件），用户直接复制这里的再修改为自己的脚本即可。

### 4\_2、添加jsw到java程序 ###

java程序中添加jsw的步骤很简单，主要以下两步：

1.  复制必要的wrapper文件到程序需要的目录中;只有四个目录是必要的：”bin”,”conf”,”lib”,”logs”，如当前示例中，在main目录下新建wrapper目录，复制上面wrapper的的”bin”,”conf”,”lib”,”logs”这四个文件夹到此目录。去掉jsw的测试文件，最后结构如下：  
    ![jsw结构][jsw 2]
2.  修改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
    
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13
      
     
      
       1
       2
       3
       4
       5
       6
       7
       8
       9
       10
       11
       12
       13

然后主要设置以下配置（`%var%`为变量引用），其它配置按默认即可。如有个性化需求，可看[官方文档][Link 3]

>  *  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`

http://blog.csdn.net/masson32/article/details/51802732

[1]: http://blog.csdn.net/masson32/article/details/51802732#1%E6%A6%82%E8%BF%B0
[1_1]: http://blog.csdn.net/masson32/article/details/51802732#11%E4%B8%BA%E4%BB%80%E4%B9%88%E8%A6%81%E7%94%A8%E6%9C%8D%E5%8A%A1%E5%BD%A2%E5%BC%8F%E8%BF%90%E8%A1%8C
[1_2_java]: http://blog.csdn.net/masson32/article/details/51802732#12%E5%A6%82%E4%BD%95%E8%AE%A9java%E7%A8%8B%E5%BA%8F%E4%BB%A5%E6%9C%8D%E5%8A%A1%E5%BD%A2%E5%BC%8F%E8%BF%90%E8%A1%8C
[1_3]: http://blog.csdn.net/masson32/article/details/51802732#13%E6%89%93%E5%8C%85%E9%9C%80%E6%B1%82
[2]: http://blog.csdn.net/masson32/article/details/51802732#2%E7%A8%8B%E5%BA%8F%E7%A4%BA%E4%BE%8B
[3maven_zip]: http://blog.csdn.net/masson32/article/details/51802732#3maven%E6%89%93zip%E5%8C%85
[3_1maven-assembly-plugin]: http://blog.csdn.net/masson32/article/details/51802732#31maven-assembly-plugin%E4%BB%8B%E7%BB%8D
[3_2maven-assembly-plugin]: http://blog.csdn.net/masson32/article/details/51802732#32maven-assembly-plugin%E9%85%8D%E7%BD%AE
[3_3_wrapper-win-zipxml]: http://blog.csdn.net/masson32/article/details/51802732#33%E6%8F%8F%E8%BF%B0%E7%AC%A6wrapper-win-zipxml%E9%85%8D%E7%BD%AE
[4jsw_java]: http://blog.csdn.net/masson32/article/details/51802732#4jsw%E9%9B%86%E6%88%90java%E5%90%8E%E5%8F%B0%E6%9C%8D%E5%8A%A1
[4_1jsw]: http://blog.csdn.net/masson32/article/details/51802732#41jsw%E4%BB%8B%E7%BB%8D%E4%B8%8E%E4%B8%8B%E8%BD%BD
[4_2_jsw_java]: http://blog.csdn.net/masson32/article/details/51802732#42%E6%B7%BB%E5%8A%A0jsw%E5%88%B0java%E7%A8%8B%E5%BA%8F
[4_3]: http://blog.csdn.net/masson32/article/details/51802732#43%E5%AE%89%E8%A3%85%E4%B8%8E%E5%8D%B8%E8%BD%BD
[4_4]: http://blog.csdn.net/masson32/article/details/51802732#44%E6%89%93%E5%8C%85%E5%B9%B6%E6%B5%8B%E8%AF%95
[5]: http://blog.csdn.net/masson32/article/details/51802732#5%E9%99%84%E4%BB%B6
[Java]: http://lib.csdn.net/base/javase
[Java Service Wrapper]: http://wrapper.tanukisoftware.com/doc/english/download.jsp
[Yet Another Java Service Wrapper]: http://yajsw.sourceforge.net/
[Apache Commons Daemon]: http://commons.apache.org/proper/commons-daemon/index.html
[java]: http://www.open-open.com/47.htm
[Java 1]: http://lib.csdn.net/base/java
[jsw-test-structure.png]: https://raw.githubusercontent.com/mianshenglee/dataStorage/master/md-photo/%E7%BC%96%E7%A8%8Bblog-jsw%E5%8F%8Amaven%E6%89%93zip/jsw-test-structure.png
[jsw-test-src-structure.png]: https://raw.githubusercontent.com/mianshenglee/dataStorage/master/md-photo/%E7%BC%96%E7%A8%8Bblog-jsw%E5%8F%8Amaven%E6%89%93zip/jsw-test-src-structure.png
[Link 1]: http://logging.apache.org/log4j/1.2/
[maven_assembly]: http://maven.apache.org/plugins/maven-assembly-plugin/usage.html
[assembly]: http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html
[Link 2]: http://lib.csdn.net/base/operatingsystem
[jsw]: https://raw.githubusercontent.com/mianshenglee/dataStorage/master/md-photo/%E7%BC%96%E7%A8%8Bblog-jsw%E5%8F%8Amaven%E6%89%93zip/download-jsw.png
[jsw 1]: /images/20220615/e76a33eaab7b43d19bc77071a303ace9.png
[jsw 2]: /images/20220615/4cca9dc79516404faef710b12c0b6655.png
[Link 3]: http://wrapper.tanukisoftware.com/doc/english/introduction.html
[jsw-test.zip]: http://pan.baidu.com/s/1hs2QdJe