全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

列举文件(Java)

最近更新时间:2023-03-15 17:03:50

通过GET Bucket(ListObjects)列举文件

/**
 *  列出一个bucket下的object,最多返回1000条
 */

public ObjectListing listObjectsSimple() {
       // yourEndpoint填写Bucket所在地域对应的Endpoint。以中国(北京)为例,Endpoint填写为ks3-cn-beijing.ksyuncs.com。如果使用自定义域名,设置endpoint为自定义域名,同时设置domainMode为true
       String endpoint = "yourEndpoint";
       // 金山云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用子账号账号进行 API 访问或日常运维,请登录 https://uc.console.ksyun.com/pro/iam/#/user/list 创建子账号。
       String accessKeyId = "yourAccessKeyId";
       String accessKeySecret = "yourAccessKeySecret";
       // 创建Ks3ClientConfig 实例。
       Ks3ClientConfig config = new Ks3ClientConfig();
       // 设置域名
       config.setEndpoint(endpoint);
       /**
        * false: (推荐)使用三级域名:{bucketName}.{endpoint}/{objectKey}的形式访问
        * true:  使用二级域名:{endpoint}/{bucketName}/{objectKey}的形式访问
        * 如果domainMode设置为true,则pathStyleAccess可忽略设置
        */
       config.setPathStyleAccess(false);

       // 创建Ks3Client实例
       Ks3 client = new Ks3Client(accessKeyId, accessKeySecret, config);
       // 获取桶下面的文件列表,最多返回1000条
       ObjectListing list = client.listObjects("<您的bucket名称>");
       // 遍历文件列表
       for (Ks3ObjectSummary objectSummary : list.getObjectSummaries()) {
            // 获取文件的名字
            objectSummary.getKey();
            // 获取文件的存储类型
            objectSummary.getStorageClass();
            // 获取文件的其他信息
            // objectSummary.
       }
       // 返回文件列表
       return list;
} 


/**
 * 将列出bucket下满足object key前缀为指定字符串的object,最多返回1000条
 */
public ObjectListing listObjectsWithPrefix(){
       // yourEndpoint填写Bucket所在地域对应的Endpoint。以中国(北京)为例,Endpoint填写为ks3-cn-beijing.ksyuncs.com。如果使用自定义域名,设置endpoint为自定义域名,同时设置domainMode为true
       String endpoint = "yourEndpoint";
       // 金山云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用子账号账号进行 API 访问或日常运维,请登录 https://uc.console.ksyun.com/pro/iam/#/user/list 创建子账号。
       String accessKeyId = "yourAccessKeyId";
       String accessKeySecret = "yourAccessKeySecret";
       // 创建Ks3ClientConfig 实例。
       Ks3ClientConfig config = new Ks3ClientConfig();
       // 设置域名
       config.setEndpoint(endpoint);
       /**
        * false: (推荐)使用三级域名:{bucketName}.{endpoint}/{objectKey}的形式访问
        * true:  使用二级域名:{endpoint}/{bucketName}/{objectKey}的形式访问
        * 如果domainMode设置为true,则pathStyleAccess可忽略设置
        */
       config.setPathStyleAccess(false);

       // 创建Ks3Client实例
       Ks3 client = new Ks3Client(accessKeyId, accessKeySecret, config);
       // 根据前缀去获取桶的文件列表
       ObjectListing list = client.listObjects("<您的bucket名称>","<object key前缀>");
       // 遍历文件列表
       for (Ks3ObjectSummary objectSummary : list.getObjectSummaries()) {
            // 获取文件的名字
            objectSummary.getKey();
            // 获取文件的存储类型
            objectSummary.getStorageClass();
            // 获取文件的其他信息
            // objectSummary.
       }
       // 返回文件列表
       return list;
}

/**
 * 自己调节列出object的参数,
 */

public ObjectListing listObjectsUseRequest(){
       // yourEndpoint填写Bucket所在地域对应的Endpoint。以中国(北京)为例,Endpoint填写为ks3-cn-beijing.ksyuncs.com。如果使用自定义域名,设置endpoint为自定义域名,同时设置domainMode为true
       String endpoint = "yourEndpoint";
       // 金山云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用子账号账号进行 API 访问或日常运维,请登录 https://uc.console.ksyun.com/pro/iam/#/user/list 创建子账号。
       String accessKeyId = "yourAccessKeyId";
       String accessKeySecret = "yourAccessKeySecret";
       // 创建Ks3ClientConfig 实例。
       Ks3ClientConfig config = new Ks3ClientConfig();
       // 设置域名
       config.setEndpoint(endpoint);
       /**
        * false: (推荐)使用三级域名:{bucketName}.{endpoint}/{objectKey}的形式访问
        * true:  使用二级域名:{endpoint}/{bucketName}/{objectKey}的形式访问
        * 如果domainMode设置为true,则pathStyleAccess可忽略设置
        */
       config.setPathStyleAccess(false);

       // 创建Ks3Client实例
       Ks3 client = new Ks3Client(accessKeyId, accessKeySecret, config);
       //新建一个ListObjectsRequest
       ListObjectsRequest request = new ListObjectsRequest("<您的bucket名称>");
       //设置参数
       request.setMaxKeys("<max keys>");//指定最多返回条数
       request.setPrefix("<object key前缀>");//返回以指定前缀开头的object
       request.setDelimiter("<delimiter>");//设置文件分隔符,系统将根据该分隔符组织文件夹结构,默认是"/"
       //执行操作
       ObjectListing list = client.listObjects(request);
       for (Ks3ObjectSummary objectSummary : list.getObjectSummaries()) {
            // 获取文件的名字
            objectSummary.getKey();
            // 获取文件的存储类型
            objectSummary.getStorageClass();
       }
       // 返回文件列表
       return list;
}



/**
 * 使用循环列出所有object
 */
public void listAllObjects(){
       // yourEndpoint填写Bucket所在地域对应的Endpoint。以中国(北京)为例,Endpoint填写为ks3-cn-beijing.ksyuncs.com。如果使用自定义域名,设置endpoint为自定义域名,同时设置domainMode为true
       String endpoint = "yourEndpoint";
       // 金山云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用子账号账号进行 API 访问或日常运维,请登录 https://uc.console.ksyun.com/pro/iam/#/user/list 创建子账号。
       String accessKeyId = "yourAccessKeyId";
       String accessKeySecret = "yourAccessKeySecret";
       // 创建Ks3ClientConfig 实例。
       Ks3ClientConfig config = new Ks3ClientConfig();
       // 设置域名
       config.setEndpoint(endpoint);
       /**
        * false: (推荐)使用三级域名:{bucketName}.{endpoint}/{objectKey}的形式访问
        * true:  使用二级域名:{endpoint}/{bucketName}/{objectKey}的形式访问
        * 如果domainMode设置为true,则pathStyleAccess可忽略设置
        */
       config.setPathStyleAccess(false);

       // 创建Ks3Client实例
       Ks3 client = new Ks3Client(accessKeyId, accessKeySecret, config);
       ObjectListing list = null;
       //初始化一个请求
       ListObjectsRequest request = new ListObjectsRequest("<您的bucket名称>");
       do {
              //isTruncated为true时表示之后还有object,所以应该继续循环
              if (list!=null&&list.isTruncated()) {
                     // 在ObjectListing中将返回下次请求的marker
                     // 如果请求的时候没有设置delimiter,则不会返回nextMarker,需要使用上一次list的最后一个key做为nextMarker
                     request.setMarker(list.getObjectSummaries().get(list.getObjectSummaries().size() - 1).getKey());
              }
              list = client.listObjects(request);
              for (Ks3ObjectSummary objectSummary : list.getObjectSummaries()) {
                     // 获取文件的名字
                     objectSummary.getKey();
                     // 获取文件的存储类型
                     objectSummary.getStorageClass();
              }
       } while (list.isTruncated());
}

注意:

  • 单次list,最多只可能返回1000个文件。如果需要返回更多,请通过marker参数设置游标。
  • 具体输入输出参数说明详见GET Bucket(list Object)

通过List Object V2列举文件

/**
     * 列出一个bucket下的object,最多返回1000条
     * 创建ks3 client实例参见"初始化"文档
     */
    public ObjectListingV2 listObjectsV2Simple(Ks3 client) {

        // 获取桶下面的文件列表,最多返回1000条
        ObjectListingV2 list = client.listObjectsV2("<您的bucket名称>");
        // 遍历文件列表
        for (Ks3ObjectSummary objectSummary : list.getObjectSummaries()) {
            // 获取文件的名字
            objectSummary.getKey();
            // 获取文件的存储类型
            objectSummary.getStorageClass();
            // 获取文件的其他信息
            // objectSummary.
        }
        // 返回文件列表
        return list;
    }

    /**
     * 将列出bucket下满足object key前缀为指定字符串的object,最多返回1000条
     * 创建ks3 client实例参见"初始化"文档
     */
    public ObjectListingV2 listObjectsV2WithPrefix(Ks3 client) {
        // 根据前缀去获取桶的文件列表
        ObjectListingV2 list = client.listObjectsV2("<您的bucket名称>", "<object key前缀>");
        // 遍历文件列表
        for (Ks3ObjectSummary objectSummary : list.getObjectSummaries()) {
            // 获取文件的名字
            objectSummary.getKey();
            // 获取文件的存储类型
            objectSummary.getStorageClass();
            // 获取文件的其他信息
            // objectSummary.
        }
        // 返回文件列表
        return list;
    }

    /**
     * 自己调节列出object的参数,
     * 创建ks3 client实例参见"初始化"文档
     */
    public ObjectListingV2 listObjectsV2UseRequest(Ks3 client) {
        //新建一个ListObjectsV2Request
        ListObjectsV2Request request = new ListObjectsV2Request("<您的bucket名称>");
        //设置参数
        request.setMaxKeys(<max keys>);//指定最多返回条数
        request.setPrefix("<object key前缀>");//返回以指定前缀开头的object
        request.setDelimiter("<delimiter>");//设置文件分隔符,系统将根据该分隔符组织文件夹结构,默认是"/"
        //执行操作
        ObjectListingV2 list = client.listObjectsV2(request);
        for (Ks3ObjectSummary objectSummary : list.getObjectSummaries()) {
            // 获取文件的名字
            objectSummary.getKey();
            // 获取文件的存储类型
            objectSummary.getStorageClass();
        }
        // 返回文件列表
        return list;
    }


    /**
     * 使用循环列出所有object
     * 创建ks3 client实例参见"初始化"文档
     */
    public void listAllObjectsV2(Ks3 client) {
        ObjectListingV2 list = null;
        //初始化一个请求
        ListObjectsV2Request request = new ListObjectsV2Request("<您的bucket名称>");
        do {
            // isTruncated为true时表示之后还有object,所以应该继续循环
            if (list != null && list.isTruncated()) {
                // 当 isTruncated 是true时,会返回NextContinuationToken,需要将NextContinuationToken指定为下一次ListObjectsV2操作的ContinuationToken,以继续获取结果。
                request.setContinuationToken(list.getNextContinuationToken());
            }
            list = client.listObjectsV2(request);
            for (Ks3ObjectSummary objectSummary : list.getObjectSummaries()) {
                // 获取文件的名字
                objectSummary.getKey();
                // 获取文件的存储类型
                objectSummary.getStorageClass();
            }
        } while (list.isTruncated());
    }

注意:

  • 单次list,最多只可能返回1000个文件。如果需要返回更多,请通过start-after参数设置游标。
  • 具体输入输出参数说明详见List Object V2
文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈