Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Spring Boot as a Windows Service in 5 Minutes

DZone's Guide to

Spring Boot as a Windows Service in 5 Minutes

We take a look at how you can get up and running quickly using Spring Boot to create a Windows service as well as pass configuration details.

· Java Zone ·
Free Resource

Get the Edge with a Professional Java IDE. 30-day free trial.

I recently had to deploy a Spring Boot application as a Windows service and am surprised how easy it was using winsw. I’d previously written about using procrun – Java Programs as Windows Services, but winsw is much easier

Getting Started

 Section 59 of the Spring Boot documentation is about Installing Spring Boot applications, and it points you toward a GitHub page. This example uses that project for inspiration.

Project

I'm going to use the Spring IO “Serving Web Content” project as a starting point, so go to the webpage and download the example from GIT or as a ZIP file.

Running Spring Boot From Command Line

Running Spring Boot from the command line

We can then see our application running:

Spring MVC Example

Spring MVC example 

Wrapping as a Windows Service

  • Download winsw from GitHub – remember to choose the correct version depending on the version of .NET you are running
  • Create a Windows service directory and copy the EXE to this location.
Windows Service Directory

Windows service directory

  • I renamed the gs-serving-web-content-0.1.0.jar to gs-serving-web-content.jar
  • Rename the winsw EXE from WinSW.NET4.exe to gs-serving-web-content.exe
  • Create a XML file named gs-serving-web-content.xml with the following content –
<?xml version="1.0" encoding="UTF-8"?>
<service>
    <id>gs-serving-web-content</id>
    <name>gs-serving-web-content</name>
    <description>gs-serving-web-content Windows Service</description>
    <executable>java</executable>
    <arguments>-jar "gs-serving-web-content.jar"</arguments>
    <logmode>rotate</logmode>
</service>


  • We can then install with gs-serving-web-content.exe install (you may need to run as administrator)

  • We can then run this as a Windows service:

Windows Service

Windows service

  • To uninstall, we run – gs-serving-web-content.exe uninstall

Alternatives

I looked at procrun as an alternative wrapper for Spring Boot but couldn't get it to work. It probably can, but it needs more time.

Conclusion

I'm really impressed with winsw for installing Spring Boot applications as Windows services. It's really simple, and you can pass external application.properties files in through the XML configuration.

Get the Java IDE that understands code & makes developing enjoyable. Level up your code with IntelliJ IDEA. Download the free trial.

Topics:
spring boot ,windows services ,tutorial ,java ,winsw

Published at DZone with permission of

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}