Java调用Harbor API

介绍

Harbor是一个开源的Docker Registry，它提供了一个私有的Docker镜像仓库，可以用于存储、管理和分发Docker镜像。如果你需要通过Java代码来与Harbor进行交互，你可以使用Harbor的API来完成各种操作，如创建仓库、上传镜像、搜索镜像等。 本文将介绍如何使用Java代码调用Harbor API，以便于你在自己的项目中集成和管理Harbor仓库。

添加依赖

首先，你需要在你的Java项目中添加相应的依赖，以使用Harbor API。可以使用Maven或Gradle来管理依赖。在pom.xml（对于Maven）或build.gradle（对于Gradle）文件中添加以下依赖：

Maven

xmlCopy code
<dependencies>
    <dependency>
        <groupId>com.squareup.okhttp3</groupId>
        <artifactId>okhttp</artifactId>
        <version>4.9.1</version>
    </dependency>
</dependencies>

Gradle

groovyCopy code
dependencies {
    implementation 'com.squareup.okhttp3:okhttp:4.9.1'
}

发起HTTP请求

Harbor的API是通过HTTP协议进行通信的，因此我们需要使用Java的HTTP客户端库来发送HTTP请求。在本文中，我们使用OkHttp库来发送请求。 以下是一个使用OkHttp发送GET请求的示例：

javaCopy code
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
public class HarborApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();
        String harborUrl = "http://your-harbor-url";
        String apiEndpoint = "/api/v2/projects";
        String apiUrl = harborUrl + apiEndpoint;
        Request request = new Request.Builder()
                .url(apiUrl)
                .build();
        try {
            Response response = client.newCall(request).execute();
            String responseBody = response.body().string();
            System.out.println(responseBody);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

在上面的示例中，我们首先创建一个OkHttpClient对象，然后构造Harbor API的URL地址，并创建一个GET请求对象。最后，使用OkHttpClient发送请求并获取响应。 你可以根据需要修改harborUrl和apiEndpoint变量的值，以适应你的Harbor环境和具体的API端点。

解析响应

一旦你收到了Harbor API的响应，你通常需要对响应进行解析，以获取所需的数据。 Harbor的API响应通常是JSON格式的，因此你可以使用任何JSON解析库来解析响应。 以下是一个使用Jackson库来解析Harbor API响应的示例：

javaCopy code
import com.fasterxml.jackson.databind.ObjectMapper;
// ...
ObjectMapper objectMapper = new ObjectMapper();
ApiResponse apiResponse = objectMapper.readValue(responseBody, ApiResponse.class);
System.out.println(apiResponse.getName());
System.out.println(apiResponse.getCreatedDate());
// ...

在上面的示例中，我们使用Jackson的ObjectMapper类将JSON响应解析为一个自定义的ApiResponse对象。然后，我们可以通过访问ApiResponse对象的方法来获取响应中的数据。 需要注意的是，你需要根据实际的Harbor API响应结构来定义ApiResponse类，以便正确解析响应。

完成其他操作

除了GET请求之外，你还可以使用OkHttp执行POST、PUT、DELETE请求等来完成其他操作，如创建仓库、上传镜像等。 以下是一个使用OkHttp发送POST请求的示例：

javaCopy code
import okhttp3.MediaType;
import okhttp3.RequestBody;
// ...
MediaType mediaType = MediaType.parse("application/json");
String requestBodyJson = "{\"name\":\"my-repo\",\"public\":false}";
RequestBody requestBody = RequestBody.create(requestBodyJson, mediaType);
Request request = new Request.Builder()
        .url(apiUrl)
        .post(requestBody)
        .build();
// ...

在上面的示例中，我们首先创建一个JSON格式的请求体，并使用MediaType类设置请求体的媒体类型为application/json。然后，我们使用POST方法发送请求。 你可以根据需要修改requestBodyJson变量的值，以适应你的请求参数。

使用Java调用Harbor API的示例代码：

javaCopy code
import okhttp3.*;
import java.io.File;
import java.io.IOException;
public class HarborApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();
        // 设置Harbor API的基础URL地址
        String harborUrl = "http://your-harbor-url";
        // 创建镜像仓库
        createRepository(client, harborUrl, "my-repo");
        // 上传镜像
        String imageName = "my-image";
        String tag = "latest";
        File imageFile = new File("/path/to/my-image.tar");
        uploadImage(client, harborUrl, imageName, tag, imageFile);
    }
    private static void createRepository(OkHttpClient client, String harborUrl, String repositoryName) {
        String apiEndpoint = "/api/v2.0/projects";
        String apiUrl = harborUrl + apiEndpoint;
        MediaType mediaType = MediaType.parse("application/json");
        String requestBodyJson = "{\"project_name\":\"" + repositoryName + "\"}";
        RequestBody requestBody = RequestBody.create(requestBodyJson, mediaType);
        Request request = new Request.Builder()
                .url(apiUrl)
                .post(requestBody)
                .build();
        try {
            Response response = client.newCall(request).execute();
            if (response.isSuccessful()) {
                System.out.println("Repository created successfully.");
            } else {
                System.out.println("Failed to create repository: " + response.body().string());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    private static void uploadImage(OkHttpClient client, String harborUrl, String imageName, String tag, File imageFile) {
        String apiEndpoint = "/api/v2.0/projects/my-repo/repositories/" + imageName + "/artifacts";
        String apiUrl = harborUrl + apiEndpoint;
        MediaType mediaType = MediaType.parse("multipart/form-data");
        RequestBody requestBody = new MultipartBody.Builder()
                .setType(MultipartBody.FORM)
                .addFormDataPart("file", imageName + ".tar",
                        RequestBody.create(imageFile, MediaType.parse("application/octet-stream")))
                .addFormDataPart("tag", tag)
                .build();
        Request request = new Request.Builder()
                .url(apiUrl)
                .post(requestBody)
                .build();
        try {
            Response response = client.newCall(request).execute();
            if (response.isSuccessful()) {
                System.out.println("Image uploaded successfully.");
            } else {
                System.out.println("Failed to upload image: " + response.body().string());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

上述示例代码演示了如何使用Java代码创建Harbor镜像仓库并上传镜像。你只需将"your-harbor-url"替换为你的Harbor的URL地址，并提供正确的镜像及文件路径，即可运行该代码。代码中的apiEndpoint和requestBodyJson可根据你的具体需求进行调整。请确保该代码在正确设置的Java开发环境中运行。 注意：对于文件上传，示例中使用了"multipart/form-data"的请求类型，并添加了名称为"file"的表单字段来上传文件，你可以根据自己的需求进行修改。

总结

通过使用Java代码调用Harbor API，你可以实现与Harbor仓库的集成和管理。使用OkHttp作为HTTP客户端库，可以方便地发送各种类型的HTTP请求，并使用任何JSON解析库来解析API响应。