### 歡迎訪問我的GitHub
> 這裡分類和彙總了欣宸的全部原創(含配套原始碼)：[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos)

- 在[《極速體驗docker容器健康》](https://xinchen.blog.csdn.net/article/details/102641942)一文已體驗了docker容器健康檢查功能，今天就來給java應用的容器加入健康檢查，使應用的狀態隨時都可以被監控和檢視。
### 實戰環境資訊
1. 作業系統：macOS Catalina 10.15
2. Docker：19.03.2
### java應用簡介
- 今天實戰的java應用，是用來模擬生產環境應用的，特點如下：
1. 普通springboot應用，對外提供http服務，路徑： **/hello**
2. springboot應用執行在docker容器，在容器的 **/app/depend/** 目錄下有名為 **abc.txt** 的檔案；
3. 上述abc.txt檔案存在時，springboot應用的hello介面正常，若abc.txt不存在，springboot應用就不對外提供服務，相當於不健康狀態（以此來模擬應用出現異常）；
### 原始碼下載
- 如果您不想寫程式碼，上述springboot應用的原始碼可在GitHub下載到，地址和連結資訊如下表所示：

| 名稱      |   連結 |   備註|
| :-------- | :----| :----|
| 專案主頁| https://github.com/zq2599/blog_demos | 該專案在GitHub上的主頁 |
| git倉庫地址(https)| https://github.com/zq2599/blog_demos.git | 該專案原始碼的倉庫地址，https協議 |
| git倉庫地址(ssh)| git@github.com:zq2599/blog_demos.git | 該專案原始碼的倉庫地址，ssh協議 |

- 這個git專案中有多個資料夾，本章的應用在 **springboot-app-docker-health-check** 資料夾下，如下圖紅框所示：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20191020234117855.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)
### 步驟簡介
- 應用接入容器健康檢查的步驟如下：
1. 將java應用製作成docker映象時需要基礎映象，因此先準備好基礎映象，將容器健康檢查的引數都配置在基礎映象中，包括提供容器健康資訊的介面路徑，這裡定為 **/getstate** ；
2. 改造java應用，提供 **/getstate** 介面服務，根據業務的實際情況決定當前應用是否健康，健康時返回碼為200，不健康時返回碼為403；
3. 編譯構建應用並且生成docker映象；
4. 驗證；
### 製作基礎映象
- 建立名為 **Dockerfile** 的檔案，內容如下：
```shell
# Docker file from bolingcavalry # VERSION 0.0.1
# Author: bolingcavalry

#基礎映象
FROM openjdk:8-jdk-stretch

#作者
MAINTAINER BolingCavalry <zq2599>

#健康檢查引數設定，每5秒檢查一次，介面超時時間2秒，連續10次返回1就判定該容器不健康
HEALTHCHECK --interval=5s --timeout=2s --retries=10 \
  CMD curl --silent --fail localhost:8080/getstate || exit 1
```
- 由上述可見Dockerfile的內容非常簡單，選定自身的基礎映象為 **openjdk:8-jdk-stretch** ，再配置好健康檢查引數：

- 在Dockerfile檔案所在目錄執行命令 **docker build -t bolingcavalry/jdk8-healthcheck:0.0.1 .** (最後那個點號不要漏掉)，控制檯輸出如下，提示映象構建成功：
```shell
(base) zhaoqindeMacBook-Pro:springboot-app-docker-health-check zhaoqin$ docker build -t bolingcavalry/jdk8-healthcheck:0.0.1 .
Sending build context to Docker daemon  217.6kB
Step 1/3 : FROM openjdk:8-jdk-stretch
8-jdk-stretch: Pulling from library/openjdk
9a0b0ce99936: Already exists
db3b6004c61a: Already exists
f8f075920295: Already exists
6ef14aff1139: Already exists
962785d3b7f9: Already exists
631589572f9b: Already exists
c55a0c6f4c7b: Already exists
Digest: sha256:8bce852e5ccd41b17bf9704c0047f962f891bdde3e401678a52d14a628defa49
Status: Downloaded newer image for openjdk:8-jdk-stretch
 ---> 57c2c2d2643d
Step 2/3 : MAINTAINER BolingCavalry <zq2599>
 ---> Running in 270f78efa617
Removing intermediate container 270f78efa617
 ---> 01b5df83611d
Step 3/3 : HEALTHCHECK --interval=5s --timeout=2s --retries=10   CMD curl --silent --fail localhost:8080/getstate || exit 1
 ---> Running in 7cdd08b9ca22
Removing intermediate container 7cdd08b9ca22
 ---> 9dd7ffb22df4
Successfully built 9dd7ffb22df4
Successfully tagged bolingcavalry/jdk8-healthcheck:0.0.1
```

- 此時宿主機上已經有了名為 **bolingcavalry/jdk8-healthcheck:0.0.1** 的映象，該映象帶有容器健康檢查的引數配置，以此作為基礎映象來構建的其他映象都整合了健康檢查的特性；
- 如果您已經在hub.docker.com上註冊過，就可以用 **docker login** 命令登入，然後執行以下命令將本地映象推送到hub.docker.com給更多人使用：
```shell
docker push bolingcavalry/jdk8-healthcheck:0.0.1
```
### 改造Java應用
- 本次實戰的目標是讓Java應用支援docker的容器健康檢查功能，接下來一起建立這個Java應用：
- 這是個基於maven構建的springboot工程，pom.xml內容如下：
```xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemalocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelversion>4.0.0</modelversion>
    <parent>
        <groupid>org.springframework.boot</groupid>
        <artifactid>spring-boot-starter-parent</artifactid>
        <version>2.2.0.RELEASE</version>
        <relativepath></relativepath> 
    </parent>
    <groupid>com.bolingcavalry</groupid>
    <artifactid>springboot-app-docker-health-check</artifactid>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-app-docker-health-check</name>
    <description>Demo project for Spring Boot</description>

<dependencies>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-web</artifactid>
        </dependency>
        <dependency>
          <groupid>org.projectlombok</groupid>
          <artifactid>lombok</artifactid>
          <optional>true</optional>
        </dependency>
        <dependency>
            <groupid>commons-io</groupid>
            <artifactid>commons-io</artifactid>
            <version>2.5</version>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-test</artifactid>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupid>org.junit.vintage</groupid>
                    <artifactid>junit-vintage-engine</artifactid>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

<build>
        <plugins>
            <plugin>
                <groupid>org.springframework.boot</groupid>
                <artifactid>spring-boot-maven-plugin</artifactid>
            </plugin>

<plugin>
                <groupid>com.google.cloud.tools</groupid>
                <artifactid>jib-maven-plugin</artifactid>
                <version>1.7.0</version>
                <configuration>
                    
                    <from>
                        
                        <image>bolingcavalry/jdk8-healthcheck:0.0.1</image>
                    </from>
                    <to>
                        
                        <image>bolingcavalry/${project.artifactId}:${project.version}</image>
                    </to>
                    
                    <container>
                        
                        <jvmflags>
                            <jvmflag>-Xms1g</jvmflag>
                            <jvmflag>-Xmx1g</jvmflag>
                        </jvmflags>
                        
                        <ports>
                            <port>8080</port>
                        </ports>
                        
                        <usecurrenttimestamp>true</usecurrenttimestamp>
                    </container>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>
```
- 上述pom.xml有以下幾處需要注意：
a. 使用jib外掛來將當前工程構建成docker映象；
b. 基礎映象是前面構建的 **bolingcavalry/jdk8-healthcheck:0.0.1** ，以此為基礎映象的映象都帶有健康檢查功能；

- 主要功能類是 **SpringbootAppDockerHealthCheckApplication.java** ：
```java
package com.bolingcavalry.springbootappdockerhealthcheck;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.http.ResponseEntity;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import java.io.*;
import java.util.List;

@SpringBootApplication
@RestController
@Slf4j
public class SpringbootAppDockerHealthCheckApplication {

public static void main(String[] args) {
        SpringApplication.run(SpringbootAppDockerHealthCheckApplication.class, args);
    }

/**
     * 讀取本地文字檔案的內容並返回
     * @return
     */
    private String getLocalFileContent() {
        String content = null;

try{
            InputStream is = new FileInputStream("/app/depend/abc.txt");
            List<string> lines = IOUtils.readLines(is, "UTF-8");

if(null!=lines && lines.size()>0){
                content = lines.get(0);
            }
        } catch (FileNotFoundException e) {
            log.error("local file not found", e);
        } catch (IOException e) {
            log.error("io exception", e);
        }

return content;
    }

/**
     * 對外提供的http服務，讀取本地的txt檔案將內容返回，
     * 如果讀取不到內容返回碼為403
     * @return
     */
    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public ResponseEntity<string> hello(){
        String localFileContent = getLocalFileContent();

if(StringUtils.isEmpty(localFileContent)) {
            log.error("hello service error");
            return ResponseEntity.status(403).build();
        } else {
            log.info("hello service success");
            return ResponseEntity.status(200).body(localFileContent);
        }
    }

/**
     * 該http服務返回當前應用是否正常，
     * 如果能從本地txt檔案成功讀取內容，當前應用就算正常，返回碼為200，
     * 如果無法從本地txt檔案成功讀取內容，當前應用就算異常，返回碼為403
     * @return
     */
    @RequestMapping(value = "/getstate", method = RequestMethod.GET)
    public ResponseEntity<string> getstate(){
        String localFileContent = getLocalFileContent();

if(StringUtils.isEmpty(localFileContent)) {
            log.error("service is unhealthy");
            return ResponseEntity.status(403).build();
        } else {
            log.info("service is healthy");
            return ResponseEntity.status(200).build();
        }
    }
}
```
- 上述程式碼有以下幾處需要注意：
a.  **hello** 方法是此應用對外提供的服務，如果本地檔案abc.txt存在且內容不為空，hello方法的返回碼就是200，否則返回碼為403，表示當前服務出現異常；
b.  **getstate** 方法是新增的服務，該介面會被docke-daemon呼叫，如果返回碼是200，就表示容器健康，如果返回碼是403，表示容器不健康；

- 在pom.xml檔案所在目錄執行 **mvn clean compile -U -DskipTests jib:dockerBuild** ，即可將當前工程構建為映象，名為 **bolingcavalry/springboot-app-docker-health-check:0.0.1-SNAPSHOT**
- 至此，支援容器健康檢查的Java應用映象構建成功，接下來驗證容器的健康檢查功能是否正常；
### 驗證步驟
- 驗證的步驟如下：
a. 讓應用容器正常工作，確保檔案 **/app/depend/abc.txt** 是正常的，此時容器狀態應該是 **healthy**
b. 將檔案 **/app/depend/abc.txt** 刪除，此時應用hello介面返回碼為403，並且容器狀態變為 **unhealthy**
### 驗證操作
- 建立檔案 **abc.txt** ，完整路徑是 **/Users/zhaoqin/temp/201910/20/abc.txt** ，檔案內容是個字串，例如：123456
- 執行以下命令，用新建的java應用映象建立容器，該容器會將 **test** 資料夾對映到容器的 **/app/depend** 資料夾：
```shell
docker run --rm \
--name=java-health-check \
-p 8080:8080 \
-v /Users/zhaoqin/temp/201910/20:/app/depend \
bolingcavalry/springboot-app-docker-health-check:0.0.1-SNAPSHOT
```
- 控制檯可見以下輸出，表明健康檢查介面已經被呼叫：
```shell
2019-10-20 14:16:34.875  INFO 1 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring DispatcherServlet 'dispatcherServlet'
2019-10-20 14:16:34.876  INFO 1 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
2019-10-20 14:16:34.892  INFO 1 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Completed initialization in 16 ms
2019-10-20 14:16:34.959  INFO 1 --- [nio-8080-exec-1] pringbootAppDockerHealthCheckApplication : service is healthy
2019-10-20 14:16:40.159  INFO 1 --- [nio-8080-exec-2] pringbootAppDockerHealthCheckApplication : service is healthy
2019-10-20 14:16:45.356  INFO 1 --- [nio-8080-exec-4] pringbootAppDockerHealthCheckApplication : service is healthy
2019-10-20 14:16:50.580  INFO 1 --- [nio-8080-exec-6] pringbootAppDockerHealthCheckApplication : service is healthy
```
- 執行命令 **docker ps** 檢視容器狀態，可見已經是 **healthy** ：
```shell
(base) zhaoqindeMBP:20 zhaoqin$ docker ps
CONTAINER ID        IMAGE                                                             COMMAND                  CREATED              STATUS                        PORTS                    NAMES
51572d2488fb        bolingcavalry/springboot-app-docker-health-check:0.0.1-SNAPSHOT   "java -Xms1g -Xmx1g …"   About a minute ago   Up About a minute (healthy)   0.0.0.0:8080->8080/tcp   java-health-check
```
- 刪除宿主機上的 **/Users/zhaoqin/temp/201910/20/abc.txt** ，相當於容器內的abc.txt檔案被刪除，此時控制檯可見健康檢查介面在被呼叫時發現檔案不存在，已返回了403錯誤碼：
```shell
019-10-20 14:22:37.490 ERROR 1 --- [nio-8080-exec-7] pringbootAppDockerHealthCheckApplication : service is unhealthy
```
- 健康檢查介面被連續10次呼叫後，再執行命令 **docker ps** 檢視容器狀態，可見已經是 **unhealthy** ：
```shell
(base) zhaoqindeMBP:20 zhaoqin$ docker ps
CONTAINER ID        IMAGE                                                             COMMAND                  CREATED             STATUS                     PORTS                    NAMES
51572d2488fb        bolingcavalry/springboot-app-docker-health-check:0.0.1-SNAPSHOT   "java -Xms1g -Xmx1g …"   7 minutes ago       Up 7 minutes (unhealthy)   0.0.0.0:8080->8080/tcp   java-health-check
```

- 至此，Java應用在docker環境配置容器健康檢查的實戰就完成了，希望您在給自己的應用新增健康檢查時，此文能給您一些參考。

### 歡迎關注ITpub：程式設計師欣宸
> [學習路上，你不孤單，欣宸原創一路相伴...](http://blog.itpub.net/70017844/)</string></string></string></zq2599></zq2599>

Java應用在docker環境配置容器健康檢查

相關文章