Java应用在docker环境配置容器健康检查

改造Java应用

本次实战的目标是让Java应用支持docker的容器健康检查功能，接下来一起创建这个Java应用：

1. 这是个基于maven构建的springboot工程，pom.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”>

4.0.0

org.springframework.boot

spring-boot-starter-parent

2.2.0.RELEASE

com.bolingcavalry

springboot-app-docker-health-check

0.0.1-SNAPSHOT

springboot-app-docker-health-check

Demo project for Spring Boot

<java.version>1.8</java.version>

org.springframework.boot

spring-boot-starter-web

org.projectlombok

lombok

true

commons-io

commons-io

2.5

org.springframework.boot

spring-boot-starter-test

test

org.junit.vintage

junit-vintage-engine

org.springframework.boot

spring-boot-maven-plugin

com.google.cloud.tools

jib-maven-plugin

1.7.0

bolingcavalry/jdk8-healthcheck:0.0.1

bolingcavalry/$project.artifactId:${project.version}

-Xms1g

-Xmx1g

8080

true

上述pom.xml有以下几处需要注意：

a. 使用jib插件来将当前工程构建成docker镜像；

b. 基础镜像是前面构建的bolingcavalry/jdk8-healthcheck:0.0.1，以此为基础镜像的镜像都带有健康检查功能；

2. 主要功能类是SpringbootAppDockerHealthCheckApplication.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 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 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 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，表示容器不健康；

3. 在pom.xml文件所在目录执行mvn clean compile -U -DskipTests jib:dockerBuild，即可将当前工程构建为镜像，名为bolingcavalry/springboot-app-docker-health-check:0.0.1-SNAPSHOT

4. 至此，支持容器健康检查的Java应用镜像构建成功，接下来验证容器的健康检查功能是否正常；

验证步骤

验证的步骤如下：

a. 让应用容器正常工作，确保文件/app/depend/abc.txt是正常的，此时容器状态应该是healthy

b. 将文件/app/depend/abc.txt删除，此时应用hello接口返回码为403，并且容器状态变为unhealthy

验证操作

1. 创建文件abc.txt，完整路径是/Users/zhaoqin/temp/201910/20/abc.txt，文件内容是个字符串，例如：123456

2. 执行以下命令，用新建的java应用镜像创建容器，该容器会将test文件夹映射到容器的/app/depend文件夹：

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

3. 控制台可见以下输出，表明健康检查接口已经被调用：

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

4. 执行命令docker ps查看容器状态，可见已经是healthy：

(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

5. 删除宿主机上的/Users/zhaoqin/temp/201910/20/abc.txt，相当于容器内的abc.txt文件被删除，此时控制台可见健康检查接口在被调用时发现文件不存在，已返回了403错误码：

019-10-20 14:22:37.490 ERROR 1 — [nio-8080-exec-7] pringbootAppDockerHealthCheckApplication : service is unhealthy

6. 健康检查接口被连续10次调用后，再执行命令docker ps查看容器状态，可见已经是unhealthy：

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且后续会持续更新

如果你觉得这些内容对你有帮助，可以添加V获取：vip1024b （备注Java）

最后

各位读者，由于本篇幅度过长，为了避免影响阅读体验，下面我就大概概括了整理了

一个人可以走的很快，但一群人才能走的更远。不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎扫码加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且后续会持续更新

如果你觉得这些内容对你有帮助，可以添加V获取：vip1024b （备注Java）
[外链图片转存中…(img-F4WBEKUx-1712852625910)]

最后

各位读者，由于本篇幅度过长，为了避免影响阅读体验，下面我就大概概括了整理了

[外链图片转存中…(img-nJJ3GJLg-1712852625910)]

[外链图片转存中…(img-RZIbRvmV-1712852625911)]

[外链图片转存中…(img-cCC2irHe-1712852625911)]

[外链图片转存中…(img-7GdKoX4O-1712852625912)]

一个人可以走的很快，但一群人才能走的更远。不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎扫码加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！
[外链图片转存中…(img-aiLGmMWv-1712852625912)]