首页 / 知识

如何从Java应用程序创建Windows服务

2023-04-15 16:13:00

How to create a windows service from java app

我刚刚继承了一个Java应用程序，该应用程序需要作为服务安装在XP和Vista上。自从我以任何形式使用Windows至今已有大约8年的时间，而且我从未创建过服务，更不用说从Java应用程序之类的东西了了(我为该应用程序提供了一个jar，并且有一个依赖项jar-log4j)。使它作为服务运行所需的魔术是什么？我已经知道了源代码，因此尽管可以避免进行代码修改，但还是可以的。

Apache Commons Daemon是一个很好的选择。它具有用于Windows服务的Procrun和用于unix守护程序的Jsvc。它使用的Apache许可证限制较少，而Apache Tomcat则将其用作Windows和Linux的一部分！要使其工作起来有些棘手，但是有一篇详尽的文章带有工作示例。

除此之外，您还可以查看Apache Tomcat中的bin service.bat以了解如何设置服务。在Tomcat中，它们将Procrun二进制文件重命名(prunsrv.exe-> tomcat6.exe，prunmgr.exe-> tomcat6w.exe)。

我在使用Procrun时遇到了麻烦，您的start和stop方法必须接受参数(String [] argv)。例如，" start(String [] argv)"和" stop(String [] argv)"将起作用，但是" start()"和" stop()"将导致错误。如果您无法修改这些调用，请考虑建立一个引导程序类，以对这些调用进行调整以满足您的需求。

我对Java Service Wrapper感到很幸运

使用Apache Commons Daemon，您现在可以拥有一个自定义的可执行文件名称和图标！您还可以获得带有您自己的名称和图标的自定义Windows托盘监视器！

我现在使用自己的名称和图标(prunsrv.exe)运行服务，并且系统任务栏监视器(prunmgr.exe)也使用自己的自定义名称和图标！

下载Apache Commons Daemon二进制文件(您将需要prunsrv.exe和prunmgr.exe)。

将它们分别重命名为MyServiceName.exe和MyServiceNamew.exe。

下载WinRun4J并使用其随附的RCEDIT.exe程序修改Apache可执行文件以嵌入您自己的自定义图标，如下所示：

1 2	> RCEDIT.exe /I MyServiceName.exe customIcon.ico > RCEDIT.exe /I MyServiceNamew.exe customTrayIcon.ico

现在像这样安装Windows服务(有关更多详细信息和选项，请参阅文档)：

1
2
3
4
5

> MyServiceName.exe //IS//MyServiceName \
--Install="C:\path-to\MyServiceName.exe" \
--Jvm=auto --Startup=auto --StartMode=jvm \
--Classpath="C:\path-to\MyJarWithClassWithMainMethod.jar" \
--StartClass=com.mydomain.MyClassWithMainMethod

现在，您有了Jar的Windows服务，它将以您自己的图标和名称运行！您也可以启动监视器文件，它将以自己的图标和名称在系统托盘中运行。

一种简单的方法是NSSM Wrapper Wrapper(请参阅我的博客文章)。

另一种选择是WinRun4J。这是一个可配置的Java启动器，可以兼用作Windows服务主机(32位和64位版本)。它是开源的，对其使用没有任何限制。

(完整披露：我正在从事这个项目)。

另一个答案是"另一个Java服务包装程序"，这似乎可以更好地替代Java服务包装程序，因为它具有更好的许可。从JSW到YAJSW的迁移也很容易。对于我来说当然是Windows服务器的全新产品，并且试图使Java应用程序作为服务运行，它非常易于使用。

我找到了其他一些，但最终没有使用：

Java Service Launcher我没有使用它，因为它看起来比YAJSW更复杂。我不认为这是包装纸。
JSmooth创建Window的服务不是其主要目标，但可以实现。我没有使用它，因为自2007年以来没有任何活动。

我认为Java Service Wrapper运作良好。请注意，有三种方法可以集成您的应用程序。听起来，如果您不想更改代码，那么选项1最适合您。配置文件可能会有些疯狂，但请记住，(对于选项1)您正在启动的程序(将为其指定参数)是其帮助程序，该程序随后将启动您的程序。他们为此提供了一个示例配置文件。

如果您使用Gradle Build Tool，则可以尝试我的windows-service-plugin，它有助于使用Apache Commons Daemon Procrun。

要使用插件创建Java Windows Service应用程序，您需要执行几个简单的步骤。

使用适当的方法创建一个主服务类。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

public class MyService {

public static void main(String[] args) {
String command ="start";
if (args.length > 0) {
command = args[0];
}
if ("start".equals(command)) {
// process service start function
} else {
// process service stop function
}
}

}

将插件包含在您的build.gradle文件中。

1
2
3
4
5
6
7
8
9
10
11
12

buildscript {
repositories {
maven {
url"https://plugins.gradle.org/m2/"
}
}
dependencies {
classpath"gradle.plugin.com.github.alexeylisyutenko:windows-service-plugin:1.1.0"
}
}

apply plugin:"com.github.alexeylisyutenko.windows-service-plugin"

用于Gradle 2.1中引入的新的，可孵化的插件机制的相同脚本片段：

1
2
3

plugins {
id"com.github.alexeylisyutenko.windows-service-plugin" version"1.1.0"
}

配置插件。

1
2
3
4
5
6
7
8
9
10
11
12

windowsService {
architecture = 'amd64'
displayName = 'TestService'
description = 'Service generated with using gradle plugin'
startClass = 'MyService'
startMethod = 'main'
startParams = 'start'
stopClass = 'MyService'
stopMethod = 'main'
stopParams = 'stop'
startup = 'auto'
}

运行createWindowsService gradle任务以创建Windows服务分发。

这就是创建简单的Windows服务所需要做的。该插件将自动下载Apache Commons Daemon Procrun二进制文件，将此二进制文件解压缩到服务分发目录，并创建用于安装/卸载服务的批处理文件。

在${project.buildDir}/windows-service目录中，您将找到服务可执行文件，用于安装/卸载服务的批处理脚本以及所有运行时库。
要安装该服务，请运行-install.bat，如果要卸载该服务，请运行-uninstall.bat。
要启动和停止服务，请使用w.exe可执行文件。

请注意，方法处理服务启动应创建并启动一个单独的线程来执行处理，然后返回。启动和停止服务时，从不同的线程调用main方法。

有关更多信息，请阅读有关插件和Apache Commons Daemon Procrun的信息。

使用Java 8，我们无需任何外部工具即可处理这种情况。 Java 8附带的javapackager工具提供了一个创建自包含应用程序捆绑包的选项：

本机类型
生成独立的应用程序包(如果可能)。使用-B选项可为正在使用的捆绑程序提供参数。如果指定了type，则仅创建此类型的包。如果未指定类型，则全部使用。

以下值对类型有效：

1
2
3
4
5
6
7
8
9
10
11
12
13

-native type
Generate self-contained application bundles (if possible). Use the -B option to provide arguments to the bundlers being used. If type is specified, then only a bundle of this type is created. If no type is specified, all is used.

The following values are valid for type:

all: Runs all of the installers for the platform on which it is running, and creates a disk image for the application. This value is used if type is not specified.
installer: Runs all of the installers for the platform on which it is running.
image: Creates a disk image for the application. On OS X, the image is the .app file. On Linux, the image is the directory that gets installed.
dmg: Generates a DMG file for OS X.
pkg: Generates a .pkg package for OS X.
mac.appStore: Generates a package for the Mac App Store.
rpm: Generates an RPM package for Linux.
deb: Generates a Debian package for Linux.

如果是Windows，请参考以下文档，我们可以根据需要创建msi或exe。