Java приложение как служба windows

Введение

В общем, расскажу я вам сказку про Terracota’овский сервер.

В одной далёкой галактике

На одной из наших виртуалок на конторе, жила-была ВебСфера(прожорливая сволочь), которая голодала от недостатка места на жёстом диске и, как результат, приложения живущие на ней начинали сильно лагать, вследствие чего приходилось часто приходилось ребутать вирталку для нормальной жизни приложений на сфере. Но не одиноки мы во вселенной(возможно), тем не менее на Земле так точно не одни, так и на виртуалке кроме сферы жили и другие монстры, куда менее прожорливые, вроде Terracotta сервера и других приложений. Так вот,

вследствие перерождения галактики

перезагрузки виртуалки терракотовский сервак постоянно надо было поднимать, так как наши приложения хранящие данные в кластере не могли запуститься, потому ожидали коннекшена от лежачего сервака. Естественно, кому-то из команды постоянно приходилось запускать Терракотту вручную, что, в общем, то было утомительно:). Мною было принято решение

создать галактический отряд

windows сервис по поднятию сервера после перезагрузки виртуалки, что казалось задачей на 15 минут, и тут я наткнулся на

Дарта Вейдера

подводные камни. Хренова конечно, что из коробки в терракоте нет создания сервиса после установки.

К делу

Посмотрим, что у нас есть:

1. Windows Server 2008 какой-то edition(с установленным Windows Resource Kit Tools).
2. Установленная JDK6
3. Terracotta
4. Световые мечи

Чего не хватало:

1. Пива
2. srvany.exe – утилита, позволяющая запускать любую программу как службу, позволяя тем самым создавать пользовательские службы(странно но у меня на виртуалке этого файла не было). Скачаваем с инета.
3. Знаний использования реестра.(Этот недостатот быстро отпадает)

Для начала скопируем скачанный srvany.exe в папки /bin с терракотой. В моём случае нехватало батника для создания сервиса, т.к. путь к терракоте содержал
пробелы. Если кто знает как в консоли прописывать пути без пробелов, прошу писать в комменты.
Сообственно createService.bat:
sc.exe create Terracotta binPath=“c:\Program Files\terracotta-3.2.1_1\bin\srvany.exe” type=own start=auto DisplayName=“Terracotta Server 3.2.1_1”
Думаю пояснений не требуется. Windows сервис требует данных о приложении в регистре. Создаём tcservice.reg:

REGEDIT4
[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Terracotta\Parameters]
"Application"="\"C:\\Java\\jdk1.6.0_17\\bin\\java.exe\\"
"AppParameters"="-cp c:\\Program Files\\terracotta-3.2.1_1\\lib\\tc.jar -server -Xms4G –Xmx4G -XX:+HeapDumpOnOutOfMemoryError -Dtc.install-root=c:\\Program files\\terracotta-3.2.1_1 com.tc.server.TCServerMain"
"AppDirectory"="c:\\Program Files\\terracotta-3.2.1_1\\"


И запускаем его. Не знаю почему, да и в общем то времени на разборку не было, но скрипт у меня не запускался, а данные в регистр не попадали:(. Поэтому делаем всё ручками. Запускаем regedit, заходим по пути HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Terracotta\Parameters и создаём там строковые параметры типа Application с указанием путей типа С:\\Java\\jdk1.6.0_17\\bin\\java.exe Также можно применить дополнительные параметры, если терракота работает не с дефолтовыми настройками:

"AppParameters"="-cp c:\\ Program Files \\terracotta-3.2.1_1\\lib\\tc.jar -server –Xms512M –Xmx512M -XX:+HeapDumpOnOutOfMemoryError -Dtc.install-root=c:\\terracotta\\terracotta-3.2.1_1 com.tc.server.TCServerMain -f c:\\ Program Files \\my-tc-config.xml -n Server1"

Всё сделали. Тестим заходим в Панель Управления -> Администрирование –> Службы, ищем сервис с названием Terracotta Server 3.2.1_1. Запускаем. Провеяем порты и видим, что приложение стартануло, если нет, проверьте правильность указания путей. Надо бы ещё убедиться что приложение встанет после перезагрузки виртуалки. Значит, что делаем?

Выключаем сервер из розетки

перезагружаем виртуалку – видим, что сервер поднялся автоматически. Ура. Таким макаром можно любое Java приложение сделать как windows сервис.

Быстрый ответ

Чтобы преобразовать ваше Java-приложение в службу Windows, вы можете использовать инструмент Apache Commons Daemon’s prunsrv. Для этого выполните следующую команду:

Замените myAppPath на путь к вашему приложению, ВашОсновнойКласс на имя вашего основного класса и добавьте методы startService и stopService для управления жизненным циклом службы. С помощью prunsrv.exe вы сможете управлять службой: запускать, останавливать и удалить её.

Картинка с сайта: sky.pro

Доступные инструменты

В вашем распоряжении множество инструментов для создания службы. Для систем на базе Windows рекомендуется использовать Procrun из пакета Apache Commons Daemon, а для Unix-систем подходит Jsvc.

Руководство по созданию службы

Если не хотите вносить изменения в существующие методы приложения, создайте отдельный загрузочный класс, который будет взаимодействовать с Procrun, принимая команды start и stop.

Настройка и управление

WinRun4J предоставляет возможности для детализированной настройки: вы сможете задавать собственные иконки и отслеживать состояние вашей службы через системный трей.

Визуализация

Ваше Java-приложение превращается в автономную службу Windows с помощью мощного инструмента Apache Procrun.

Подготовка вашего Java-приложения к работе в качестве службы

Чтобы преобразовать ваше приложение в службу, выполните следующие действия:

• Упакуйте приложение в .jar файл.
• Настройте Procrun таким образом, чтобы он запускал ваш .jar файл при необходимости.
• Ищете вдохновение? Обратите внимание на успешные проекты, такие как Tomcat, или изучите Java Service Wrapper и WinRun4J.

Выбор наиболее надежного решения для долгосрочной работы

Выбирайте решение, которое обеспечит стабильность и надежность вашей службы в долгосрочной перспективе:

• YAJSW на GitHub характеризуется стабильной работой и регулярными обновлениями.
• WinRun4J предлагает на выбор удобные инструменты мониторинга.

Полезные материалы

1. Daemon – Daemon: Java based daemons or services — официальная документация Apache по созданию нативных служб на основе Java-приложений.
2. GitHub – yajsw/yajsw: Mirror of YAJSW repository — GitHub-репозиторий с надежным решением для создания обертки Java-сервиса.
3. WinRun4J — гибко настраиваемый Java Service Wrapper.
4. Download Java Service Wrapper — Скачайте Tanuki Wrapper для повышения защищенности и управляемости вашего программного обеспечения.
5. WrapperSimpleApp Integration (Windows) — пошаговое руководство интеграции Tanuki Java Service Wrapper.
6. How to create a windows service from java app – Stack Overflow — обсуждение на форуме Stack Overflow, где знаниями делится профессиональное сообщество.
7. Daemon – Daemon: Procrun — подробная документация для освоения Procrun.

Introduction

One project required the development of a Windows service that could perform a number of actions using the Windows API, Websocket and standard Java tools. The article below gives the description of the steps that have been taken to create such a service.

The need for the Windows service arose because of the necessity to have a software with the following features:

Картинка с сайта: jazzteam.org

Creating a minimalized JRE version

As GraalVM still does not support creation of executable files for Windows, it was decided to take advantage of other capabilities offered by the Java ecosystem, specifically, creation of a minimalized JRE version.

In order to create the minimized JRE version, first it is needed to know the dependencies on certain packages that will be included in the JRE.

First of all, it is necessary to create the “fat jar” file with all dependencies.

Then run the jdeps -s <path to jar file> command to get a list of all dependencies. For example:

jdeps -s application.jar
application.jar -> java.base
application.jar -> java.datatransfer
application.jar -> java.desktop
application.jar -> java.logging
application.jar -> java.net.http
application.jar -> java.sql
application.jar -> java.xml
application.jar -> jdk.unsupported
application.jar -> not found

After that, create your version of JRE with these dependencies:

jlink –module-path <path to the jmods folder, which is located in jdk> –add-modules

java.base, java.datatransfer, java.desktop, java.logging, java.net.http, java.sql, java.xml, jdk.unsupported –strip-debug –compress 2 –no-header-files –no-man-pages –output <name of the folder that will contain the generated JRE>

Note that the listed packages for –add-modules option should be separated by a comma with no spaces between them. The other options are responsible for compressing and removing files and other information that is not useful for software execution.

After performing these actions, the JRE will take around 30 mb instead of hundreds.

Creating a Windows service from any application

Java does not have standard services creation tools, so third-party tools were studied and WinSW has been selected because it is free and easy to use.

Картинка с сайта: jazzteam.org

WinSW

WinSW is a utility that allows to start and wrap any process as a Windows service. In order to start working with it, you need to download executable and configuration files through this link https://github.com/kohsuke/winsw/releases.

Place these two files in the directory. Rename the executable file at your discretion and give the same name to the configuration file, then place the application’s jar file and the created JRE in this directory.

Write a minimum configuration in the configuration file:

<configuration>
<!– ID of the service. It should be unique across the Windows system–>
<id>service id</id>
<!– Display name of the service –>
<name>name</name>
<!– Service description –>
<description>Description</description>
<!– Path to the executable, which should be started –>
<executable>jre\bin\java.exe</executable>
<arguments>-jar application.jar</arguments>
</configuration>

jre\bin\java.exe – the relative path inside our folder to our JRE executable file.

After these actions, you can install the service by running the command as the administrator:

winsw.exe install

The list of commands is available here.

Interaction between Java and Windows API

To use Windows functions (such as creating a new process or adding registry keys) we used JNA in our application.

JNA (Java Native Access) provides Java software with easy access to libraries written in another language without writing anything but Java code. JNA allows calling directly native functions using natural Java method invocation. Most methods require no special handling or configuration; no boilerplate or generated code is required.

Connecting and working with JNA is very easy, you need to download the jar file or connect the dependency to a project builder, which is Maven in our case:

<dependency>
<groupId>net.java.dev.jna</groupId>
<artifactId>jna-platform</artifactId>
<version>5.0.0</version>
</dependency>

In our project we used JNA to achieve the following goals: disable and enable the task manager 1) through the Ctrl+Shift+Esc combination, and 2) in the menu available by the Ctrl+Alt+Del combination.

To achieve these goals, we used the Advapi32Util class (an easy-to-use wrapping around the advapi32.dll library) and the WinReg interface with useful constants which provide functionality to make changes to the Windows registry (Figure 1. TaskManager class with enable() and disable() methods to modify the task manager registry keys).

Картинка с сайта: jazzteam.org

Картинка с сайта: jazzteam.org

Картинка с сайта: jazzteam.org

Working with processes

For working and tracking processes on Windows, we used the ProcessHandle class added to Java 9. ProcessHandle allows receiving and make various manipulations with processes. In particular, when solving the task, it was required to collect PIDs of processes, filter processes based on the name and abort necessary processes.

Картинка с сайта: jazzteam.org

Interaction with other system components

WebSocket

For Java there is a standard API for working with WebSocket.

<dependency>
<groupId>javax.websocket</groupId>
<artifactId>javax.websocket-api</artifactId>
<version>1.1</version>
<scope>provided</scope>
</dependency>

But just the API was not enough, so one of its implementations Tyrus was chosen to run the code.

<dependency>
<groupId>org.glassfish.tyrus</groupId>
<artifactId>tyrus-server</artifactId>
<version>1.14</version>
</dependency>
<dependency>
<groupId>org.glassfish.tyrus</groupId>
<artifactId>tyrus-container-grizzly-server</artifactId>
<version>1.14</version>
</dependency>

Then you can create a minimalistic server and specify handlers (EndPoints).

var server = new Server(
“localhost”,
8080,
“/endpoints”,
null,
EndPoint1.class,
EndPoint2.class,
…);
try {
server.start();
Thread.currentThread().join();
} catch (Exception e) {
log.error(“Ooops! “, e);
} finally {
server.stop();
log.info(“Finally…”);
}

A handler skeleton is looking as follows:

@ServerEndpoint(value = “endpoint/url”)
public class SampleEndpoint {

@OnOpen
public void onOpen(Session session) throws IOException {
// Called when a new connection is initialized
}

@OnMessage
public void onMessage(Session session, Message message) throws IOException {
// Called when a message from the client is received
}

@OnClose
public void onClose(Session session) throws IOException {
// Called when a connection is closed
}

@OnError
public void onError(Session session, Throwable throwable) {
// Called when errors appear
}
}

HTTP Client

The release of the 11th version of Java brought us a convenient HTTP client, so there is no need for third-party clients.

To create a client instance, you need to use a builder. In the simplest case:

var client = HttpClient .newBuilder() .build()

After that, you need to create a request, for example:

var request = HttpRequest.newBuilder()
.uri(URI.create(“https://myserver.com”))
.timeout(Duration.ofMillis(1000))
.header(“Content-Type”, “application/json”)
.POST(bean.toJSON())
.build();

Then this request can be used for sending to the server:

var response = client.send(closeSession(sessionId, token),
HttpResponse.BodyHandlers.ofString())

Conclusion

Due to the modular organization of Java 9 and higher, WinSW utility, updated Process API for interaction with operating system processes and JNA (Java Native Access) library, which provides Java programs with easy access to native libraries, we were able to create a Windows service using Java language which was also used for the server part implementation. As the result, this allowed us not to introduce a new language into the development process.