七年開發經驗教你如何正確、安全地停止 SpringBoot 應用
Spring Boot,作為Spring框架對“約定優先於配置(Convention Over Configuration)”理念的最佳實踐的產物,它能幫助我們很快捷的創建出獨立執行、產品級別的基於Spring框架的應用,大部分Spring Boot應用只需要非常少的配置就可以快速執行起來,是一個與微服務(MicroServices)相當契合的微框架。 網路上關於Spring Boot的QuickStart式中文內容已經相當豐富,但是對於部署後怎樣便捷、安全地停止服務(shutdown),還比較缺乏,最近發現Spring Boot的官方指南更新了相關內容,因此結合該部分更新,對如何基於官方提供的特性正確地停止Spring Boot應用進行簡單說明。
主要有兩種方式:通過HTTP傳送shutdown訊號,或者通過service stop的方式
方式一:通過HTTP傳送shutdown訊號
該方式主要依賴Spring Boot Actuator的endpoint特性,具體步驟如下:
1. 在pom.xml中引入actuator依賴
org.springframework.boot spring-boot-starter-actuator
2. 開啟shutdown endpoint
Spring Boot Actuator的shutdown endpoint預設是關閉的,因此在application.properties中開啟shutdown endpoint:
#啟用shutdown endpoints.shutdown.enabled=true #禁用密碼驗證 endpoints.shutdown.sensitive=false
3. 傳送shutdown訊號
shutdown的預設url為host:port/shutdown,當需要停止服務時,向伺服器post該請求即可,如: curl -X POST host:port/shutdown 將得到形如{"message":"Shutting down, bye..."}的響應
4. 安全設定
可以看出,使用該方法可以非常方便的進行遠端操作,但是需要注意的是,正式使用時,必須對該請求進行必要的安全設定,比如藉助spring-boot-starter-security進行身份認證:
①.pom.xml新增security依賴
org.springframework.boot spring-boot-starter-security
②.開啟安全驗證 在application.properties中變更配置,並
#開啟shutdown的安全驗證 endpoints.shutdown.sensitive=true #驗證使用者名稱 security.user.name=admin #驗證密碼 security.user.password=secret #角色 management.security.role=SUPERUSER
③.指定路徑、IP、埠
#指定shutdown endpoint的路徑 endpoints.shutdown.path=/custompath #也可以統一指定所有endpoints的路徑`management.context-path=/manage` #指定管理埠和IP management.port=8081 management.address=127.0.0.1
方式二:部署為Unix/Linux Service
該方式主要藉助官方的spring-boot-maven-plugin建立”Fully executable” jar ,這中jar包內建一個shell指令碼,可以方便的將該應用設定為Unix/Linux的系統服務(init.d service),官方對該功能在CentOS和Ubuntu進行了測試,對於OS X和FreeBSD,可能需要自定義。具體步驟如下:
1. 在pom.xml中引入外掛:
org.springframework.boot spring-boot-maven-plugin true e>
2. 設定為系統服務
將你的應用打成jar包,部署到伺服器,假設部署路徑為/var/app,包名為app.jar,通過如下方式將應該設定為一個系統服務:
sudo ln -s /var/app/app.jar /etc/init.d/app
3. 賦予可執行許可權:
chmod u+x app.jar
4. 以系統服務的方式管理
接下來,就可以使用我們熟悉的service foo start|stop|restart來對應用進行啟停等管理了 sudo service app start|stop 命令將得到形如Started|Stopped [PID]的結果反饋
預設PID檔案路徑:/var/run/appname/appname.pid 預設日誌檔案路徑:/var/log/appname.log
這可能是我們更熟悉也更常用的管理方式。
自定義引數
在這種方式下,我們還可以使用自定義的.conf檔案來變更預設配置,方法如下:
①.在jar包相同路徑下建立一個.conf檔案,名稱應該與.jar的名稱相同,如appname.conf
②.在其中配置相關變數,如:
JAVA_HOME=/usr/local/jdk JAVA_OPTS=-Xmx1024M LOG_FOLDER=/custom/log
安全設定
作為應用服務,安全性是一個不能忽略的問題,如下一些操作可以作為部分基礎設定參考:
為服務建立一個獨立的使用者,同時最好將該使用者的shell繫結為/usr/sbin/nologin
賦予最小範圍許可權:chmod 500 app.jar
阻止修改:sudo chattr +i app.jar
對.conf檔案做類似的工作:chmod 400 app.conf,sudo chown root:root app.conf
歡迎Java工程師朋友們加入Java進階高階架構群:855355016
本群提供免費的學習指導 架構資料 以及免費的解答
不懂得問題都可以在本群提出來 之後還會有職業生涯規劃以及面試指導