DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
  1. DZone
  2. Coding
  3. Frameworks
  4. Spring Boot as a Windows Service in 5 Minutes

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.

Martin Farrell user avatar by
Martin Farrell
·
Dec. 18, 17 · Tutorial
Like (27)
Save
Tweet
Share
83.24K Views

Join the DZone community and get the full member experience.

Join For Free

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.

Spring Framework Spring Boot Web Service

Published at DZone with permission of Martin Farrell, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • ChatGPT: The Unexpected API Test Automation Help
  • Visual Network Mapping Your K8s Clusters To Assess Performance
  • Why Does DevOps Recommend Shift-Left Testing Principles?
  • The Top 3 Challenges Facing Engineering Leaders Today—And How to Overcome Them

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: