[ 云计算 | AWS 实践 ] 使用 Java 检查指定的密钥是否存在于给定的 Amazon S3 存储桶中

浅浅的花香味﹌ 2024-02-05 11:30 31阅读 0赞

![在这里插入图片描述][f6b4b45ef01445aa9a147e7c5f1a8f15.png]

本文收录于【[\#云计算入门与实践 - AWS][- AWS]】专栏中，收录 AWS 入门与实践相关博文。

本文同步于个人公众号：【**云计算洞察**】

更多关于云计算技术内容敬请关注：CSDN【[\#云计算入门与实践 - AWS][- AWS]】专栏。

本系列已更新博文：

*  [\[ 云计算 | AWS 实践 \] Java 应用中使用 Amazon S3 进行存储桶和对象操作完全指南][_ _ AWS _ _ Java _ Amazon S3]
 *  [\[ 云计算 | AWS 实践 \] Java 如何重命名 Amazon S3 中的文件和文件夹][_ _ AWS _ _ Java _ Amazon S3 1]
 *  [\[ 云计算 | AWS 实践 \] 使用 Java 列出存储桶中的所有 AWS S3 对象][_ _ AWS _ _ _ Java _ AWS S3]
 *  [\[ 云计算 | AWS 实践 \] 使用 Java 更新现有 Amazon S3 对象][_ _ AWS _ _ _ Java _ Amazon S3]
 *  [\[ 云计算 | AWS 实践 \] 基于 Amazon S3 协议搭建个人云存储服务][_ _ AWS _ _ _ Amazon S3]
 *  [\[ 云计算 | AWS 实践 \] 使用 Java 检查指定的密钥是否存在于给定的 Amazon S3 存储桶中][_ _ AWS _ _ _ Java _ Amazon S3 1]

#### 文章目录 ####

*   *  一、前言
     *  二、前期准备
     *  三、创建 AmazonS3 客户端的实例
     *  四、检查秘钥是否存在（两种方法）
     *   *  4.1 使用 headObject() 检查密钥是否存在
         *  4.2 使用 listObjectsV2() 检查密钥是否存在
     *  五、文末总结

### 一、前言 ###

在本博文中，我们将探讨如何使用 Java 检查指定的秘钥是否存在于亚马逊 S3 存储桶中。

Amazon S3 是一个非常流行的云存储服务，为存储和检索数据提供了可伸缩、安全和高可用的平台。就个人而言，后续很多的公有云平台或者一些 SaaS 服务，都或多或少有 Amazon S3 的影子。

对于开发人员来说，了解特定的秘钥是否存在是至关重要的，以便根据需要进行操作或访问。我们将逐步介绍设置 AWS SDK 并使用它执行此检查所需的步骤。

### 二、前期准备 ###

首先，我们需要确保 AWS SDK Maven 依赖包已合并到项目中，让我们创建一个新的 Java 项目并将以下 Maven 依赖项添加到 pom.xml 文件中：

<dependency>
        <groupId>software.amazon.awssdk</groupId>
        <artifactId>s3</artifactId>
        <version>2.21.0</version>
    </dependency>

### 三、创建 AmazonS3 客户端的实例 ###

一旦我们设置好了 AWS 的 Java SDK，我们就创建 Amazon S3 客户端的实例来与存储桶进行交互。

让我们指定 AWS 凭证和存储桶位置区域并创建客户端：

AmazonS3 s3Client = AmazonS3ClientBuilder.standard()
      .withRegion(Regions.US_EAST_1)
      .withCredentials(new AWSStaticCredentialsProvider(credentials))
      .build();

### 四、检查秘钥是否存在（两种方法） ###

此处是我们博文的重点，接下来将会讲解两种方法，来介绍如何检查秘钥是否存在。

#### 4.1 使用 headObject() 检查密钥是否存在 ####

检查 Amazon S3 存储桶中是否存在特定密钥的最简单、最明显的方法是使用`headObject()`方法。

我们需要使用其构建器方法创建一个 *HeadObjectRequest* 实例，并将存储桶名称和对象密钥传递给它。然后我们可以将请求对象传递给`headObject()`方法。

参考示例代码如下：

try {
        
        // 创建一个HeadObjectRequest对象，用于检查指定的秘钥是否存在于存储桶中
        HeadObjectRequest headObjectRequest = HeadObjectRequest.builder()
            .bucket(bucket)  // 指定存储桶名称
            .key(key)  // 指定秘钥名称
            .build();
    
        // 发起HeadObject请求以检查对象是否存在
        s3Client.headObject(headObjectRequest);
    
        System.out.println("对象存在"); // 输出对象存在的信息
        return true; // 返回true，表示对象存在
    } catch (S3Exception e) {
        
        if (e.statusCode() == 404) {
        
            System.out.println("对象不存在"); // 输出对象不存在的信息
            return false; // 返回false，表示对象不存在
        } else {
        
            throw e; // 抛出异常
        }
    }

此方法检查指定存储桶位置是否存在对象，并返回包含对象元数据的 *HeadObjectResponse* 对象。如果指定的键不存在，则该方法会抛出 *NoSuchKeyException* 异常。

#### 4.2 使用 listObjectsV2() 检查密钥是否存在 ####

另一种选择是使用`listObjectsV2()`方法。为此，我们需要创建一个 *ListObjectsV2Request* 对象并将存储桶名称传递给它。接下来，我们调用 *listObjectsV2* 方法来获取 *ListObjectsV2Response*。然后我们可以遍历响应的内容来检查所需的密钥是否存在。

示例代码如下：

public boolean doesObjectExistByListObjects(String bucketName, String key) {
        
        // 创建ListObjectsV2Request对象以列出指定存储桶中的对象
        ListObjectsV2Request listObjectsV2Request = ListObjectsV2Request.builder()
            .bucket(bucketName) // 指定存储桶名称
            .build();
        
        // 发起列出对象的请求并获取响应
        ListObjectsV2Response listObjectsV2Response = s3Client.listObjectsV2(listObjectsV2Request);
    
        // 通过流处理检查是否存在指定的秘钥对应的对象
        return listObjectsV2Response.contents()
            .stream()
            .filter(s3ObjectSummary -> s3ObjectSummary.getValueForField("key", String.class)
                .equals(key)) // 根据秘钥筛选对象
            .findFirst()
            .isPresent(); // 返回是否存在指定的对象
    }

虽然这种方法可能不如`headObject()`方法高效，但在其他选项不可用时，它会很有帮助。

另外，`listObjectsV2()`的另一个优点是**可以同时列出多个对象**，这在特定情况下可能很有用。

> 注意：**这种方法可能由于多次迭代而更慢、效率较低。在选择最佳选项时，权衡各方面的利弊非常重要，要根据具体情况来决定。**

### 五、文末总结 ###

在本文中，我们探讨了使用 AWS Java SDK 来检查特定秘钥是否存在于 Amazon S3 存储桶中的几种方法。

这其中包括如何设置 Amazon S3 客户端并使用`headObject()`方法来检查秘钥是否存在。我们还探讨了`listObjects()`方法作为替代方案。

在选择方法时，需要权衡利弊，根据具体情况选择最适合的方案。无论是简单直接的方式还是更为灵活的多对象列举，都能帮助开发人员更好地管理和操作 Amazon S3 存储桶中的数据。

通过本文的介绍，读者可以更清晰地了解如何利用 AWS Java SDK 在开发中判断特定秘钥在 S3 存储桶中的存在性，为相关开发提供了有益的参考与指导。

[ 本文作者 ]   bluetata
    [ 原文链接 ]   https://bluetata.blog.csdn.net/article/details/134566027
    [ 最后更新 ]   11/23/2023 2:15
    [ 版权声明 ]   如果您在非 CSDN 网站内看到这一行，
    说明网络爬虫可能在本人还没有完整发布的时候就抓走了我的文章，
    可能导致内容不完整，请去上述的原文链接查看原文。

[f6b4b45ef01445aa9a147e7c5f1a8f15.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/7b74dbaa6987439c9a5803c3825e9f68.png
[- AWS]: https://blog.csdn.net/dietime1943/category_12069924.html
[_ _ AWS _ _ Java _ Amazon S3]: https://bluetata.blog.csdn.net/article/details/132531011
[_ _ AWS _ _ Java _ Amazon S3 1]: https://bluetata.blog.csdn.net/article/details/133980910
[_ _ AWS _ _ _ Java _ AWS S3]: https://bluetata.blog.csdn.net/article/details/134174962
[_ _ AWS _ _ _ Java _ Amazon S3]: https://bluetata.blog.csdn.net/article/details/134498219
[_ _ AWS _ _ _ Amazon S3]: https://bluetata.blog.csdn.net/article/details/134566027
[_ _ AWS _ _ _ Java _ Amazon S3 1]: https://bluetata.blog.csdn.net/article/details/134773478