翻开JBOSS、Tomcat的发布包,发现他们都使用了一个Open source——Java Service Wrapper。用Java Service Wrapper可以轻松解决我们的需求,让我们的服务程序成为 Win32系统服务。
当然,在Un*x下也可以使用Java Service Wrapper,可以避免加“&”的粗暴方式,导致每天收到一堆mail,通过Java Service Wrapper提供的日志方式查看运行信息。
Java Service Wrapper功能很强大,同时支持Windows及Un*x平台,提供三种方式把你的Java程序包装成系统服务,这里只介绍最简单的一种方式,因这种 方式无需对已有的服务程序作任何改变,仅仅增加几个script、配置文件就可以把你的Java服务程序改造成系统服务程序了。
当然在使用之前需要到http://sourceforge.net/project/showfiles.php?group_id=39428下载Java Service Wrapper的发布包。
下面简单介绍一下具体的使用步骤:
1. 将下载的Java Service Wrapper包解压到本地,目录为{WRAPPER_HOME};
2. 服务应用程序名为MyServApp,在目录d:\MyServApp下建立bin、conf、logs、lib目录;并把你的已有应用程序如NioBlockingServer.class拷贝到该目录下;
3. 将{WRAPPER_HOME}\src\bin\下的遗以下文件拷贝到MyServApp目录下,并重命名。
{WRAPPER_HOME}\bin\Wrapper.exe ? C:\ MyServApp \bin\Wrapper.exe
{WRAPPER_HOME}\src\bin\App.bat.in ? C:\ MyServApp\bin\MyApp.bat
{WRAPPER_HOME}\src\bin\InstallApp-NT.bat.in ? C:\ MyServApp\bin\InstallMyApp-NT.bat
{WRAPPER_HOME}\src\bin\UninstallApp-NT.bat.in ? C:\ MyServApp\bin\UninstallMyApp-NT.bat
4. 将{WRAPPER_HOME}\lib下的以下文件拷贝到C:\ MyServApp \lib目录下
{WRAPPER_HOME}\lib\Wrapper.DLL
{WRAPPER_HOME}\lib\wrapper.jar
5. 将{WRAPPER_HOME}\src\conf\wrapper.conf.in拷贝到C:\ MyServApp \conf目录下并命名为wrapper.conf;并修改wrapper.conf文件,在其中配置您的应用服务。
主要修改以下几项即可:
#你的JVM位置:
wrapper.java.command=D:\Sun\j2sdk1.4.0_03\bin\java
#运行参数:如:
wrapper.java.additional.1=-Dprogram.name=run.bat
#classpath:
wrapper.java.classpath.1=../lib/wrapper.jar
wrapper.java.classpath.2=../bin/.
# Java Library Path (location of Wrapper.DLL or libwrapper.so)
wrapper.java.library.path.1=../lib
#MAIN CLASS 此处决定了使用Java Service Wrapper的方式
wrapper.java.mainclass=org.tanukisoftware.wrapper.WrapperSimpleApp
#你的Java应用类
wrapper.app.parameter.1= NonBlockingServer
# 服务名
wrapper.ntservice.name=NB
# Display name of the service
wrapper.ntservice.displayname=Nio Nonblocking Server
# 服务描述
wrapper.ntservice.description=Nio Nonblocking Server
其他的配置根据你的需要改变即可
6. 对以上配置的MyApp.bat进行测试,运行MyApp.bat,就像在Console窗口下运行Tomcat一样;
7. 对以上配置的服务进行测试,运行C:\ MyServApp\bin\InstallMyApp-NT.bat将把你的应用(此处为NioBlockingServer)安装到Win32系统服务中了。
8. 打开控制面板-管理程序-服务,看到Nio Nonblocking Server已经在系统服务中了,其他用法就与我们熟悉的Windows服务一样了。
Tomcat使用的是Java Service Wrapper模式二,这种方式需要对已有的程序进行小的改动,但可以通过Socket端口的方式控制服务程序核心的启动,更加灵活。Java Service Wrapper提供的模式三比较复杂,需要作出更多的编码,我没有研究。
采用模式一,即可简单有效的把我们的服务程序包装成为系统服务程序,并增强了日志功能,我们可以把MyServApp的几个文件做成模板,每次修改文件名,配置文件就可以了,有精力的朋友更可以做成Eclipse的plugin,鼠标点点就把应用配成服务了。
附件是一个模板,可以直接修改文件名和配置文件就可以把服务改造了。
- aix - AIX
- freebsd - FreeBSD
- hpux, hpux64 - HP-UX, 32 and 64-bit versions.
- irix - SGI Irix
- linux - Linux kernels; 2.2.x 2.4.x, 2.6.x. Known to work with Debian and Red Hat, but should work with any distribution.
- macosx - Macintosh OS X.
- osf1 - DEC OSF1.
- solaris - Sun OS, Solaris 7, 8.
- win32 - Windows NT, 2000, XP, and 2003.
JSW的使用有三种方式:
-
用WrapperSimpleApp class启动应用程序。这是使用JSW最简单的方式,也是推荐的方式。但使用这种方式有个问题,因为JSW是直接使用System.exit()退出 JVM的,这等如使用者在应用程序运行期间直接按ctrl-c退出程序一样。如果应用程序在退出前需要执行clean up的话,需要自行登记shutdown hook,或不要使用这种方式。以这种方式配置JBoss的例子(Win32, Linux / UNIX)。
-
第二种方式是使用WrapperStartStopApp class。这种方式是给Tomcat之类的应用程序(即在一个类启动,但以另一个类结束的应用程序)。通常这类的应用程序都会在启动时打开一个 server socket,用来等待要求程序结束的连接,当接收到要求结束的请求,“结束”类会被执行。而JSW就是在收到停止运行的要求时,直接执行这个“结束” 类。以这这种方式配置Tomcat的例子(Win32, Linux / UNIX)。
-
第三种方式,也是最复杂,最灵活的一种方式,也是唯一一种需要编程的方式。这种方式要写一个实现WrapperListener接口的类。有些功能 是这种方式独有的,例如直接在程序中接收及回应系统控制事件(如启动及结束)。但这也增加了程序的复杂程度。如果不需要这些功能的话,还是使用第一种方式 比较方便。以这种方式配置的例子。
注:使用第一种方式最好不要使用JRE1.3.x或以上,因为1.2.x无shutdown hook的技持。如程序只能使用JRE1.2.x,就需要使用第二或第三种方式使用JSW。
- 在windows平台的以服务运行,在Unix平台以后台Daemon运行;
- 提供应用的高可用性,通过监控JVM进程来实现,发现JVM进程crash或者挂起,就restart it;
- 针对各平台提供一致的应用启动脚本;
- 提供应用restart自身JVM的能力(Restart on-demand);
- 易于安装和管理,支持JMX
个人感觉,特性1和2比较有价值。
很可惜,在以apache为首的多国部队围剿下,很有创意的JSR 96被killed。
项目中有一个java应用程序,交付后用户要求要把这个程序做成后台服务程序,即:系统启动后该程序可以自动启动,并且在前台不要出现运行窗口,维护人员只要在“服务管理”(Windows)中选择启动或停止即可.
解决办法如下:
Linux
在Linux中注册后台服务程序相对容易,只需编辑/etc/init.d/boot.local文件,在boot.local文件里加上下面这句脚本:
其中run.sh是java应用的运行脚本
Windows
在Windows下的情况较为复杂,需要使用Windows提供的两个工具:instsrv.exe(下载)和Srvany.exe(下载).
instsrv: 这个工具是把win32程序变成系统服务。
基本用法:
由于应用的需求,需要把Java App作为NT服务来运行,于是就找来了Java service wrapper这个工具来帮忙了。官方网址:http://wrapper.tanukisoftware.org/doc/english /download.jsp。
Java Service Wrapper提供了4种方式来Java App注册为服务运行(Integration Methods)。
- 使 用 WrapperSimpleApp帮助类来启动应用。 这种方法是最简单的方法。使用这种方法需要注意的是Java Service Wrapper停止Java App的时候不会调用Java App的相应的接收方法,而是直接调用System.exit()来结束Java App。
- 使 用 WrapperStartStopApp帮助类来启动应用。这种方法假设Java App有相应的启动,停止类。由ClassX负责启动Java App,ClassY负责停止Java App。当然了,具体使用的时候也可以用同一个类来启动或者停止Java App,只要初始化该类的不同启动或停止参数就可以了。
- 使 用WrapperManager类来启动应用。这种方法是最灵活的启动方式,而且需要Java App的启动类必须实现 WrapperListener接口。 WrapperListener接口有start(String[] arg0)和stop(int arg0)方法,需要Java App的启动类来实现。这就就可以用WrapperManager类来管理Java App的主类了。
- 使用 WrapperJarApp 帮助类来启动应用。这种方法和WrapperSimpleApp帮助类相似,只是使用这种方法的时候,Java App要求打包为可执行的Jar文件。
我使用第二种方式启动自己的Java App。下载Java Service Wrapper后首先是copy一些文件到自己的Java App应用相应的目录下。给目录的结构类似下面这个样子:
src
|
|--bin
| |--wrapper.exe
| |--App.bat
| |--InstallApp-NT.bat
| |--UninstallApp-NT.bat
|
|--conf
| |--wrapper.conf
|
|--lib
| |--Wrapper.dll
| |--Wrapper.jar
|
|--logs
| |--wrapper.log
|
|--<Your own Source Classes here>
当然了,如果你的应用程序已经写好了,不行改变已有目录的名称,那就修改Java Service Wrapper的配置文件吧。比如conf文件目录原来的名称为configuration,那就你就可以修改bin目录下引用wrapper.conf 的bat文件中相应的地方即可。
然后就是配置文件wrapper.conf的修改了。
wrapper .java .command=java : 指定要运行的Java .如果已经设定了Java的环境变量,这里可以不修改;如果没有,可以使用绝对路径指向 JDK bin 目录下的java。
wrapper .java .mainclass=org.tanukisoftware.wrapper.WrapperStartStopApp: 指定要运行的帮助类,这个类是上面说的4中方式的启动类之一。Java Service Wrapper是用自己的类来启动应用程序,并把实际要启动的Java应用程序的主类作为该类的第一个参数传进去。
wrapper .java .classpath.1=../lib/wrapper .jar :配置Java 的类路径,这里的将 wrapper .jar 也包含在内,这里可以设置参数的位置,而且这个位置必须得从 1 开始,不能跳过,必须顺序指定,指定类路径的时候还有根据依赖关系来排列 , 被依赖的排在前面,否则会出现 ClassNotFoundException 的错误,这里支持绝对路径和相对路径,也支持通配符 "*" ,比如 wrapper .java .classpath.1=../lib/wrapper * , 不过这个通配符只能用于匹配文件名,不能用于匹配文件夹名称。当然了,这里也必须添加上当前目录或者上一级目录,取决于你的主类所在的目录。
wrapper .java .library.path.1=../lib: 指定Wrapper 自带的类库文件存放文件夹,比如 Wrapper .DLL 文件等,只要指定到对应的上级目录名称就行,支持通配符。
wrapper .app.parameter.1= : 指启动类,如上面说的ClassX 。
wrapper .app.parameter.2= : 指启动类main方法需要的参数个数 。
wrapper .app.parameter.3= : 指启动类main方法的实际参数,依次列出。
wrapper .app.parameter.x= : 实际参数。
wrapper .app.parameter.y= : 指停止类,如上面说的ClassY 。当然了,也可以和启动类一样为ClassX,但是需要参数来区分相应的操作。
wrapper .console.title=Java App : 控制台窗口显示标题,
wrapper .ntservice.name=Service Name: 系统服务的名称 ,
wrapper .ntservice.displayname= Service Name : 在服务管理中显示的名称
wrapper .ntservice.description= Service Name 的介绍信息 : 在服务管理器显示服务的描述信息
wrapper .ntservice.starttype=AUTO_START: 配置服务启动方式,可以选择AUTO_START( 自动 ) 和 DEMAND_START( 手动 ) 两种方式。默认为自动。