快捷導(dǎo)航

java實現(xiàn)docker鏡像上傳到harbor倉庫的方式

更新時間：2025年06月27日 16:51:49 作者：yuhuofei2021

這篇文章主要介紹了java實現(xiàn)docker鏡像上傳到harbor倉庫的方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

1. 前言

在推送鏡像文件到鏡像倉庫時，我們往往是在鏡像文件所在的那個主機上，以 root 用戶的權(quán)限，執(zhí)行 docker push 命令，完成鏡像推送的工作。

但有這么一種令人匪夷所思的人，他直接打一個離線的鏡像包（docker save tomcat:latest > tomcat-892148dsadg-v1.tar）出來，比如 tomcat-892148dsadg-v1.tar ，然后通過郵件或者其它通訊工具發(fā)給你，讓你推送到鏡像倉庫。

這時，你怎么搞？直接通過 shell 指令操作，可行嗎？當(dāng)然可以，只要在有 docker 環(huán)境的服務(wù)器上，

以 root 權(quán)限的用戶執(zhí)行下面 5 步就能完成：

rz 命令，上傳 tar 包到服務(wù)器上
docker load -i xxxx.tar ，加載鏡像文件
docker login harbor倉庫地址 -u 用戶名 -p 密碼，登錄 harbor 倉庫
docker tag xxxx.tar harbor倉庫地址/命名空間/xxxxx.tar，重新打標(biāo)簽
docker push harbor倉庫地址/命名空間/xxxxx.tar，推送鏡像到 harbor 倉庫

上面的方式，看著是很清晰地解決了問題，但一般來說，開發(fā)人員很少能直接操控服務(wù)器，更別提拿到 root 用戶，在一些權(quán)限管控嚴格的企業(yè)，這種方式想想就好了，或者讓運維來。

那還有其它方式嗎？當(dāng)然！那就直接用 java 操作 docker 命令實現(xiàn)離線的 tar包推送至 harbor 倉庫吧！

2. 編寫工具類

2.1 引入依賴包

在 pom.xml 文件中引入下面的兩個依賴

<dependency>
    <groupId>com.github.docker-java</groupId>
    <artifactId>docker-java</artifactId>
    <version>3.2.13</version>
</dependency>
<dependency>
    <groupId>com.github.docker-java</groupId>
    <artifactId>docker-java-transport-httpclient5</artifactId>
    <version>3.2.13</version>
</dependency>

2.2 使用當(dāng)前服務(wù)器的docker環(huán)境推送鏡像

application.properties 配置文件

harbor.username=harbor
harbor.password=Harbor123!

工具類

import com.github.dockerjava.api.DockerClient;
import com.github.dockerjava.api.model.AuthConfig;
import com.github.dockerjava.api.model.Image;
import com.github.dockerjava.core.DefaultDockerClientConfig;
import com.github.dockerjava.core.DockerClientImpl;
import com.github.dockerjava.httpclient5.ApacheDockerHttpClient;
import com.github.dockerjava.transport.DockerHttpClient;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.time.Duration;
import java.util.List;

/**
 * @author yuhuofei
 * @version 1.0
 * @description 鏡像上傳工具類
 * @date 2022/6/13 21:19
 */
@Service
@Slf4j
public class DockerUtils {

    @Value("${harbor.username}")
    private String harborUserName;

    @Value("${harbor.password}")
    private String harborPassWord;

    /**
     * 獲取dockerClient對象
     */
    public DockerClient getDockerClient() {
    
        //創(chuàng)建DefaultDockerClientConfig（當(dāng)前服務(wù)器的默認配置）
        DefaultDockerClientConfig config = DefaultDockerClientConfig.createDefaultConfigBuilder().build();

        //創(chuàng)建DockerHttpClient
        DockerHttpClient httpClient = new ApacheDockerHttpClient.Builder()
                .dockerHost(config.getDockerHost())
                .maxConnections(100)
                .connectionTimeout(Duration.ofSeconds(30))
                .responseTimeout(Duration.ofSeconds(45))
                .build();

        //創(chuàng)建DockerClient
        return DockerClientImpl.getInstance(config, httpClient);

    }

    /**
     * @param file      鏡像文件
     * @param imageName 鏡像名稱，格式最好是：鏡像名-鏡像id-版本號.tar
     * @param harborLoginUrl harbor倉庫地址
     * @param imageId 鏡像id
     * @param tag 版本號
     */
    public void uploadImage(File file, String imageName, String harborLoginUrl, String imageId, String tag) {
        log.info("上傳鏡像文件時，傳遞的參數(shù)：{},{},{},{},{}", file.getAbsolutePath(), imageName, harborLoginUrl, imageId, tag);
        try (InputStream inputStream = new FileInputStream(file)) {
            DockerClient dockerClient = getDockerClient();
            //Harbor登錄信息
            AuthConfig autoConfig = new AuthConfig().withRegistryAddress(harborLoginUrl).withUsername(harborUserName).withPassword(harborPassWord);

            //加載鏡像
            log.info("====開始加載鏡像====，{}", inputStream);
            dockerClient.loadImageCmd(inputStream).exec();
            
            //獲取加載鏡像的名稱，如果根據(jù)鏡像名稱去匹配，有可能重復(fù)，所以用鏡像id去匹配
            String uploadImageName = "";
            List<Image> list = dockerClient.listImagesCmd().exec();
            for (Image image : list) {
                if (image.getId().contains(imageId)) {
                    uploadImageName = image.getRepoTags()[0];
                }
            }

            //給鏡像打上tag
            log.info("原始鏡像名:{}，要修改的鏡像名:{}", uploadImageName, imageName);
            dockerClient.tagImageCmd(uploadImageName, imageName, tag).exec();

            //推送鏡像至鏡像倉庫
            dockerClient.pushImageCmd(imageName).withAuthConfig(autoConfig).start().awaitCompletion();
            //push成功后，刪除本地加載的鏡像
            dockerClient.removeImageCmd(imageName).exec();
            dockerClient.removeImageCmd(uploadImageName).exec();
        } catch (InterruptedException exception) {
            throw new BaseException("推送鏡像到鏡像倉庫異常：{}", exception);
        } catch (IOException e) {
            throw new BaseException("鏡像文件流處理異常");
        }
    }
}

2.2 使用指定服務(wù)器的docker環(huán)境推送鏡像

application.properties 文件的配置

docker.server.url=tcp://xxxxxx:2376
docker.cert.path=/home/user/.docker/certs
api.version=1.41
registry.url=https://index.docker.io/v1/
registry.username=docker
registry.password=Docker123!
registry.email=xxxxxxx@qq.com

harbor.username=harbor
harbor.password=Harbor123!

工具類

import com.github.dockerjava.api.DockerClient;
import com.github.dockerjava.api.model.AuthConfig;
import com.github.dockerjava.api.model.Image;
import com.github.dockerjava.core.DefaultDockerClientConfig;
import com.github.dockerjava.core.DockerClientImpl;
import com.github.dockerjava.httpclient5.ApacheDockerHttpClient;
import com.github.dockerjava.transport.DockerHttpClient;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.time.Duration;
import java.util.List;

/**
 * @author yuhuofei
 * @version 1.0
 * @description 鏡像上傳工具類
 * @date 2022/6/13 21:19
 */
@Service
@Slf4j
public class DockerUtils {

    @Value("${docker.server.url}")
    private String dockerServerUrl;
    
    @Value("${docker.cert.path}")
    private String dcokerCertPath;

    @Value("${registry.user}")
    private String registryUser;
    
    @Value("${registry.pass}")
    private String registryPass;
    
    @Value("${registry.mail}")
    private String registryMail;
    
    @Value("${registry.url}")
    private String registryUrl;

	//harbor倉庫登錄用戶名
    @Value("${harbor.username}")
    private String harborUserName;
	//harbor倉庫登錄密碼
    @Value("${harbor.password}")
    private String harborPassWord;

    /**
     * 獲取dockerClient對象
     */
    public DockerClient getDockerClient() {
    
        //創(chuàng)建DefaultDockerClientConfig（指定docker服務(wù)器的配置）
        DockerClientConfig config = DefaultDockerClientConfig.createDefaultConfigBuilder()
            .withDockerHost(dockerServerUrl)
    		.withDockerTlsVerify(true)
    		.withDockerCertPath(dcokerCertPath)
    		.withRegistryUsername(registryUser)
    		.withRegistryPassword(registryPass)
    		.withRegistryEmail(registryMail)
    		.withRegistryUrl(registryUrl)
    		.build();

        //創(chuàng)建DockerHttpClient
        DockerHttpClient httpClient = new ApacheDockerHttpClient.Builder()
                .dockerHost(config.getDockerHost())
                .maxConnections(100)
                .connectionTimeout(Duration.ofSeconds(30))
                .responseTimeout(Duration.ofSeconds(45))
                .build();

        //創(chuàng)建DockerClient
        return DockerClientImpl.getInstance(config, httpClient);

    }

    /**
     * @param file      鏡像文件
     * @param imageName 鏡像名稱，格式最好是：鏡像名-鏡像id-版本號.tar
     * @param harborLoginUrl harbor倉庫地址
     * @param imageId 鏡像id
     * @param tag 版本號
     */
    public void uploadImage(File file, String imageName, String harborLoginUrl, String imageId, String tag) {
        log.info("上傳鏡像文件時，傳遞的參數(shù)：{},{},{},{},{}", file.getAbsolutePath(), imageName, harborLoginUrl, imageId, tag);
        try (InputStream inputStream = new FileInputStream(file)) {
            DockerClient dockerClient = getDockerClient();
            //Harbor登錄信息
            AuthConfig autoConfig = new AuthConfig().withRegistryAddress(harborLoginUrl).withUsername(harborUserName).withPassword(harborPassWord);

            //加載鏡像
            log.info("====開始加載鏡像====，{}", inputStream);
            dockerClient.loadImageCmd(inputStream).exec();
            
            //獲取加載鏡像的名稱，如果根據(jù)鏡像名稱去匹配，有可能重復(fù)，所以用鏡像id去匹配
            String uploadImageName = "";
            List<Image> list = dockerClient.listImagesCmd().exec();
            for (Image image : list) {
                if (image.getId().contains(imageId)) {
                    uploadImageName = image.getRepoTags()[0];
                }
            }

            //給鏡像打上tag
            log.info("原始鏡像名:{}，要修改的鏡像名:{}", uploadImageName, imageName);
            dockerClient.tagImageCmd(uploadImageName, imageName, tag).exec();

            //推送鏡像至鏡像倉庫
            dockerClient.pushImageCmd(imageName).withAuthConfig(autoConfig).start().awaitCompletion();
            //push成功后，刪除本地加載的鏡像
            dockerClient.removeImageCmd(imageName).exec();
            dockerClient.removeImageCmd(uploadImageName).exec();
        } catch (InterruptedException exception) {
            throw new Exception("推送鏡像到鏡像倉庫異常：{}", exception);
        } catch (IOException e) {
            throw new Exception("鏡像文件流處理異常");
        }
    }
}

3. 說明

上述的 java 服務(wù)，不能部署在 docker 環(huán)境的容器內(nèi)，需要部署在 docker 主機上，不然在容器中運行的 java 服務(wù)，是沒法操作到主機上的 docker 命令的
上傳 tar 包文件的前端內(nèi)容省略
這里上傳的 tar 包命名格式最好是：鏡像名-鏡像id-版本號.tar
打出來的 tar 包，大小最好不要超過 20 G