在windows服務器上使用winsw部署spring boot項目

簡介

springboot項目須要在windows上部署，spring官方推薦使用winsw來將springboot項目做爲服務運行，參考

https://docs.spring.io/spring-boot/docs/2.0.8.RELEASE/reference/htmlsingle/#deployment-windows

winsw下載及文檔：https://github.com/kohsuke/winsw

安裝使用

winsw的使用比較簡單。從github上下載：winsw下載，要下載的文件有兩個：1.winsw.exe程序；2.xml配置文件。能夠下載最新版本的WinSW.NET4.exe和sample-minimal.xml。下載完成後，將下載的兩個文件及springboot項目的jar包放在同一個文件夾中。

下載winsw後，檢查window上是否安裝 .net framework4 ，若是沒裝後面會出問題。關於.net framework4的安裝請自行搜索。

SpringBoot項目經過執行mvn clean package命令後獲得可執行jar包：Milan_ZKT-0.0.1-SNAPSHOT.jar

須要將winsw執行程序跟xml改爲一樣的名字，推薦使用項目名+Service的命名方式，好比：WinSW.NET4.exe改爲Milan_ZKT_Service.exe，sample-minmal.xml改爲Milan_ZKT_Service.xml。

更名完成後，編輯Milan_ZKT_Service.xml文件，配置以下

<configuration>
  
  <!-- ID of the service. It should be unique accross the Windows system-->
  <id>Milan_ZKT</id>
  <!-- Display name of the service -->
  <name>Milan_ZKT Service (powered by WinSW)</name>
  <!-- Service description -->
  <description>This service is a service cratead from ...</description>
  
  <!-- Path to the executable, which should be started -->
  <executable>C:\Program Files\Java\jre1.8.0_191\bin\java.exe</executable>
  
  <arguments>-Xmx256m -jar Milan_ZKT.jar --spring.profiles.active=test</arguments>
  
  
  <!--日誌模式 Throw away stdout and stderr, and do not produce any log files at all.-->
  <log mode="none"/>
  <!--延遲啓動-->
  <delayedAutoStart/>
  <!--中止 -->
  <stopexecutable>D:\Milan_ZKT\CURL.EXE</stopexecutable>
  <stoparguments>-X POST -u username:password http://127.0.0.1:8088/actuator/shutdown</stoparguments>
  
  <onfailure action="restart" delay="120 sec"/>
  <onfailure action="restart" delay="240 sec"/>

</configuration>

xml配置參考：https://github.com/kohsuke/winsw/blob/master/doc/xmlConfigFile.md

配置完成後，命令行進入winsw所在的文件夾，執行「Milan_ZKT_Service.exe install」，其中Milan_ZKT_Service是你修改後的名稱。注意：命令提示符界面要用管理員權限進入，不然安裝服務會失敗，提示「WMI Operation failure: AccessDenied」

Milan_ZKT_Service.exe install

進入服務界面，能夠看到Milan_ZKT_Service服務已經生成了：

命令提示符界面輸入命令「net start Milan_ZKT_Service」啓動服務。

winsw優雅中止springboot進程

經過winsw配置文檔，知道winsw是經過WindowsAPI中TerminateProcess函數能夠用來終止或者說殺死進程，它不會留給進程及其全部線程清理的時間，系統會立刻終止(殺死)這個進程的全部線程，導致進程終止。這就致使咱們不能優雅終止springboot服務，這在生產環境頗有可能產生不可預知問題。

springboot經過 Actuator 的 HTTP Endpoint能夠方便地對應用的監控與管理，能夠經過以下命令結束springboot服務

curl -X POST -u username:password http://127.0.0.1:8088/actuator/shutdown

此命令包含了一個curl工具，咱們須要下載一個curl.exe

在Milan_ZKT_Service.xml配置文件中增長winsw中止參數，配置以下

<stopexecutable>D:\Milan_ZKT\CURL.EXE</stopexecutable>
<stoparguments>-X POST -u username:password http://127.0.0.1:8088/actuator/shutdown</stoparguments>

winsw會在服務中止的時候執行如上參數，執行的過程當中會增長一個進程，這個進程經過web請求讓springboot進程中止，而後進程結束，springboot進程也結束以後，winsw服務就徹底中止了。

詳細配置請參考：Spring Boot 2.X優雅中止

刪除服務

刪除服務分爲兩步：1中止服務；2刪除服務，都是在命令行界面實現。

輸入「net stop Milan_ZKT_Service」中止運行服務。

輸入「Milan_ZKT_Service.exe uninstall」刪除服務。

最後

上面全部的命令均可以寫在批處理文件中，部署的時候就能夠實現一鍵部署了。

將命令寫在批處理文件中，但願將批處理文件默認爲管理員權限打開，能夠在批處理文件的開頭寫上：

%1 mshta vbscript:CreateObject("Shell.Application").ShellExecute("cmd.exe","/c %~s0 ::","","runas",1)(window.close)&&exit

cd /d "%~dp0"
 

%1 mshta vbscript:CreateObject("Shell.Application").ShellExecute("cmd.exe","/c %~s0 ::","","runas",1)(window.close)&&exit
cd /d "%~dp0"
net stop Milan_ZKT
net start Milan_ZKT