Docker-Java 项目入门指南：从零开始使用 Java 操作 Docker

Docker-Java 项目入门指南：从零开始使用 Java 操作 Docker

docker-java Java Docker API Client 项目地址: https://gitcode.com/gh_mirrors/do/docker-java

项目概述

Docker-Java 是一个功能强大的 Java 客户端库，它允许开发者通过 Java 代码与 Docker 守护进程进行交互。通过这个库，你可以在 Java 应用中执行各种 Docker 操作，如管理容器、镜像、网络等，而无需直接使用 Docker 命令行工具。

环境准备

依赖配置

要开始使用 docker-java，需要在项目中添加以下两个核心依赖：

1. 核心库：docker-java-core，提供 DockerClient 核心功能
2. 传输层实现：选择一个 docker-java-transport-* 实现，用于与 Docker 守护进程通信

建议使用最新稳定版本，可以通过 Maven 或 Gradle 等构建工具引入这些依赖。

配置 Docker 客户端

创建 DockerClientConfig

DockerClientConfig 是配置 Docker 客户端的关键类，它定义了如何连接到 Docker 守护进程、使用的认证信息等重要参数。

默认配置

import com.github.dockerjava.core.DockerClientConfig;
import com.github.dockerjava.core.DefaultDockerClientConfig;

DockerClientConfig standard = DefaultDockerClientConfig.createDefaultConfigBuilder().build();

自定义配置

DockerClientConfig custom = DefaultDockerClientConfig.createDefaultConfigBuilder()
    .withDockerHost("tcp://docker.somewhere.tld:2376")  // Docker 主机地址
    .withDockerTlsVerify(true)  // 启用 TLS 验证
    .withDockerCertPath("/home/user/.docker")  // 证书路径
    .withRegistryUsername(registryUser)  // 仓库用户名
    .withRegistryPassword(registryPass)  // 仓库密码
    .withRegistryEmail(registryMail)  // 仓库邮箱
    .withRegistryUrl(registryUrl)  // 仓库地址
    .build();

配置项详解

Docker-Java 支持多种配置项，所有配置都有合理的默认值：

• DOCKER_HOST：Docker 主机地址，如 tcp://localhost:2376 或 Unix 套接字 unix:///var/run/docker.sock
• DOCKER_TLS_VERIFY：是否启用 TLS 验证（切换 http 和 https 协议）
• DOCKER_CERT_PATH：TLS 验证所需的证书路径
• DOCKER_CONFIG：额外 Docker 配置文件的路径（如 .dockercfg）
• api.version：使用的 Docker API 版本
• registry.url：镜像仓库地址
• registry.username：仓库用户名（推送镜像时需要）
• registry.password：仓库密码
• registry.email：仓库邮箱

配置加载顺序

Docker-Java 支持多种配置方式，按优先级从高到低依次为：

1. Java 系统属性：通过 -D 参数设置
2. 系统环境变量：通过 export 设置
3. 配置文件：
   • 用户主目录下的 .docker-java.properties 文件
   • 类路径下的 /docker-java.properties 文件

自定义 Jackson ObjectMapper

如果需要自定义 Jackson 的 ObjectMapper，可以创建自己的 DockerClientConfig 并重写 getObjectMapper() 方法。

创建 HTTP 客户端

实例化 DockerHttpClient

选择传输层实现后，需要实例化 HTTP 客户端：

DockerClientConfig config = ...;

DockerHttpClient httpClient = new ApacheDockerHttpClient.Builder()
    .dockerHost(config.getDockerHost())
    .sslConfig(config.getSSLConfig())
    .maxConnections(100)  // 最大连接数
    .connectionTimeout(Duration.ofSeconds(30))  // 连接超时
    .responseTimeout(Duration.ofSeconds(45))  // 响应超时
    .build();

不同传输层实现可能提供额外的配置选项，如各种超时设置。

直接与 Docker 守护进程通信

获得 HTTP 客户端后，可以直接向 Docker 守护进程发送原始请求：

Request request = Request.builder()
    .method(Request.Method.GET)
    .path("/_ping")  // Docker 健康检查端点
    .build();

try (Response response = httpClient.execute(request)) {
    assertThat(response.getStatusCode(), equalTo(200));
    assertThat(IOUtils.toString(response.getBody()), equalTo("OK"));
}

创建 DockerClient

实例化 DockerClient

要获取 DockerClient 实例，需要同时传入 DockerClientConfig 和 DockerHttpClient：

DockerClient dockerClient = DockerClientImpl.getInstance(config, httpClient);

执行 Docker 命令

获得 DockerClient 后，就可以开始执行各种 Docker 命令了：

// 简单的 ping 命令，测试连接是否正常
dockerClient.pingCmd().exec();

最佳实践建议

1. 连接管理：合理设置连接超时和最大连接数，特别是在高并发场景下
2. 资源释放：确保在使用完毕后关闭 DockerClient 和相关资源
3. 异常处理：妥善处理可能出现的各种异常情况
4. 配置安全：敏感信息如密码等应通过安全的方式存储和传递

通过以上步骤，你已经成功搭建了使用 Docker-Java 的基础环境。接下来可以探索更多高级功能，如容器管理、镜像操作、网络配置等，充分发挥 Docker-Java 的强大功能。

docker-java Java Docker API Client 项目地址: https://gitcode.com/gh_mirrors/do/docker-java