正確、安全地停止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依賴

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

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進行身份認證：

1. pom.xml添加security依賴
   xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> </dependency>
2. 開啟安全驗證
   在application.properties中變更配置,並
   #開啟shutdown的安全驗證 endpoints.shutdown.sensitive=true #驗證用戶名 security.user.name=admin #驗證密碼 security.user.password=secret #角色 management.security.role=SUPERUSER
3. 指定路徑、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中引入插件：

<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
  <executable>true</executable>
</configuration>
</plugin>

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文件來變更默認配置，方法如下：

1. 在jar包相同路徑下創建一個.conf文件，名稱應該與.jar的名稱相同，如appname.conf
2. 在其中配置相關變量，如：

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

References:

1. Installing Spring Boot applications
2. Endpoints
3. Securing sensitive endpoints