声明:
本文只教学代码的操作使用,COS的配置(如APPID、SecretId、SecretKey等)需自行提前准备好。您可以查阅其他相关博客或官方文档来获取。
配置
这些配置都是非常重要的,用于连接腾讯云的COS。点击查看 获取配置教程
使用 API 接口时会出现一些主要概念和术语:点击查看官方 术语信息
-
APPID:1234567890
-
SecretId:SecretId
-
SecretKey:SecretKey
-
存储桶名称:examplebucket-1250000000
-
访问域名:http://examples-1251000004.cos.ap-shanghai.myqcloud.com :此域名为腾讯示例域名
访问示例:http://examples-1251000004.cos.ap-shanghai.myqcloud.com/sample.jpeg
一、SDK(Maven)安装
快速入门:对象存储 快速入门-SDK 文档-文档中心-腾讯云 (tencent.com)
高级接口(推荐):对象存储 上传对象-SDK 文档-文档中心-腾讯云 (tencent.com)
简单操作:对象存储 上传对象-SDK 文档-文档中心-腾讯云 (tencent.com)
环境依赖:
SDK 支持 JDK 1.8 及以上版本,您可以通过命令 java -version 查看 Java 版本。
安装SDK
<!--腾讯云COS-->
<dependency>
<groupId>com.qcloud</groupId>
<artifactId>cos_api</artifactId>
<version>5.6.155</version>
</dependency>
二、设置配置Config
当我们拿到COS的配置和密钥等后,就可以设置配置类。这样方便后面的使用。
1. 配置yml
设置会用到的变量
TencentCos:
APPID: appid
SecretId: id
SecretKey: 密钥
testBucket: 存储桶名
CosPath: http://examples-1251000004.cos.ap-shanghai.myqcloud.com
region: ap-shanghai
2. 配置Config
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
/**
* 读取yml中的配置
*/
@Component
@Data
@NoArgsConstructor
@AllArgsConstructor
public class TencentConfig {
@Value("${TencentCos.CosPath}")
private String cosPath;
@Value("${TencentCos.SecretId}")
private String secretId;
@Value("${TencentCos.SecretKey}")
private String secretKey;
@Value("${TencentCos.region}")
private String regionName;
@Value("${TencentCos.testBucket}")
private String bucketName;
@Value("${TencentCos.APPID}")
private String APPID ;
}
三、初始化客户端
点击查阅 官方教程
在执行任何和 COS 服务相关请求之前,都需要先生成 COSClient 类的对象, COSClient 是调用 COS API 接口的对象。
//初始化cos客户端
public COSClient cosClientnew(String secretId, String secretKey, String regionName){
// System.out.println(SECRETID+" - "+SECRETKEY);
// 1 初始化用户身份信息(secretId, secretKey)。
// SECRETID 和 SECRETKEY 请登录访问管理控制台 https://console.cloud.tencent.com/cam/capi 进行查看和管理
// COSCredentials cred = new BasicCOSCredentials(SECRETID,SECRETKEY);
COSCredentials cred = new BasicCOSCredentials(secretId,secretKey);
// 2 设置 bucket 的地域, COS 地域的简称请参见 https://cloud.tencent.com/document/product/436/6224
// clientConfig 中包含了设置 region, https(默认 http), 超时, 代理等 set 方法, 使用可参见源码或者常见问题 Java SDK 部分。
Region region = new Region(regionName);
ClientConfig clientConfig = new ClientConfig(region);
// 这里建议设置使用 https 协议
// 从 5.6.54 版本开始,默认使用了 https
clientConfig.setHttpProtocol(HttpProtocol.https);
// 以下的设置,是可选的:
// 设置 socket 读取超时,默认 30s
clientConfig.setSocketTimeout(30*1000);
// 设置建立连接超时,默认 30s
clientConfig.setConnectionTimeout(30*1000);
// 3 初始化 cos 客户端。
return new COSClient(cred, clientConfig);
}
你可以像我这样创建一个方法,方便后面的调用。
四、对COS操作
创建存储桶
存储桶(Bucket)是对象的载体,可理解为存放对象的“容器”,且该“容器”无容量上限。对象以扁平化结构存放在存储桶中,无文件夹和目录的概念,用户可选择将对象存放到单个或多个存储桶中。
你可以选择在你的业务中是否去通过代码创建存储桶,它只是用于存放对象的“容器”。
(如果没有可以通过此项创建桶,如果有可以选择不创建)
String bucket = "examplebucket-1250000000"; //存储桶名称,格式:BucketName-APPID
CreateBucketRequest createBucketRequest = new CreateBucketRequest(bucket);
// 设置 bucket 的权限为 Private(私有读写)、其他可选有 PublicRead(公有读私有写)、PublicReadWrite(公有读写)
createBucketRequest.setCannedAcl(CannedAccessControlList.Private);
try{
Bucket bucketResult = cosClient.createBucket(createBucketRequest);
} catch (CosServiceException serverException) {
serverException.printStackTrace();
} catch (CosClientException clientException) {
clientException.printStackTrace();
}
查询存储桶列表
public void queryBuckets(){
COSClient cosClient = cosClientnew();
List<Bucket> buckets = cosClient.listBuckets();
for (Bucket bucketElement : buckets) {
String bucketName = bucketElement.getName();
String bucketLocation = bucketElement.getLocation();
System.out.println("存储桶名称:"+bucketName+" 存储桶路径:"+bucketLocation);
}
}
上传对象
localFilePath指定的文件路径为本地的文件路径。通过将本地路径转换为File对象,然后上传到COS中
// 指定要上传的文件
File localFile = new File(localFilePath);
// 指定文件将要存放的存储桶
String bucketName = "examplebucket-1250000000";
// 指定文件上传到 COS 上的路径,即对象键。例如对象键为 folder/picture.jpg,则表示将文件 picture.jpg 上传到 folder 路径下
String key = "exampleobject";
PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, key, localFile);
PutObjectResult putObjectResult = cosClient.putObject(putObjectRequest);
查询对象
你可以使用集合或数组将查询出来的对象存储起来使用
// Bucket 的命名格式为 BucketName-APPID ,此处填写的存储桶名称必须为此格式
String bucketName = "examplebucket-1250000000";
ListObjectsRequest listObjectsRequest = new ListObjectsRequest();
// 设置 bucket 名称
listObjectsRequest.setBucketName(bucketName);
// prefix 表示列出的 object 的 key 以 prefix 开始
listObjectsRequest.setPrefix("/");
// deliter 表示分隔符, 设置为/表示列出当前目录下的 object, 设置为空表示列出所有的 object
listObjectsRequest.setDelimiter("/");
// 设置最大遍历出多少个对象, 一次 listobject 最大支持1000
listObjectsRequest.setMaxKeys(1000);
ObjectListing objectListing = null;
do {
try {
objectListing = cosClient.listObjects(listObjectsRequest);
} catch (CosServiceException e) {
e.printStackTrace();
return;
} catch (CosClientException e) {
e.printStackTrace();
return;
}
// common prefix 表示被 delimiter 截断的路径, 如 delimter 设置为/, common prefix 则表示所有子目录的路径
List<String> commonPrefixs = objectListing.getCommonPrefixes();
// object summary 表示所有列出的 object 列表
List<COSObjectSummary> cosObjectSummaries = objectListing.getObjectSummaries();
for (COSObjectSummary cosObjectSummary : cosObjectSummaries) {
// 文件的路径 key
String key = cosObjectSummary.getKey();
// 文件的 etag
//etag是由对象内容的哈希值生成的文件内容标识符
String etag = cosObjectSummary.getETag();
// 文件的长度
long fileSize = cosObjectSummary.getSize();
// 文件的存储类型
String storageClasses = cosObjectSummary.getStorageClass();
System.out.println("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/"+key);
}
//实现分页查询存储桶的对象列表,因为设置了一次请求最多返回1000个对象信息,所以如果超出1k个就进行分页
String nextMarker = objectListing.getNextMarker();
//setMarker用来设置下一页的起始位置
listObjectsRequest.setMarker(nextMarker);
} while (objectListing.isTruncated());
删除对象
// Bucket 的命名格式为 BucketName-APPID ,此处填写的存储桶名称必须为此格式
String bucketName = "examplebucket-1250000000";
// 指定被删除的文件在 COS 上的路径,即对象键。例如对象键为 folder/picture.jpg,则表示删除位于 folder 路径下的文件 picture.jpg
//传入文件对象名
String key = "文件对象名";
cosClient.deleteObject(bucketName, key);
使用MultipartFile上传
private final TencentConfig txConfig;
@Autowired
public TopicController(TencentConfig txConfig){
this.txConfig = txConfig;
}
public ResponseEntity uploadCos(MultipartFile[] multipartFiles) throws IOException {
// 初始化腾讯云 COS 客户端
COSClient cosClient = new TencentCosClientUtils().cosClientnew(txConfig.getSecretId(),txConfig.getSecretKey(),txConfig.getRegionName());
List<String> keyList = new ArrayList<>();
for (MultipartFile file1: multipartFiles){
// 配置上传图片的元数据
ObjectMetadata objectMetadata = new ObjectMetadata();
objectMetadata.setContentLength(file1.getSize());
String oldFileName = file1.getOriginalFilename();
String fileType = "";//文件类型
int dotIndex = oldFileName.lastIndexOf('.');
if (dotIndex > 0 && dotIndex < oldFileName.length() - 1) {
fileType = oldFileName.substring(dotIndex + 1).toLowerCase();
}
// 配置腾讯云 COS 存储路径
// 生成上传到服务器的文件路径和随机文件名
String randomUUID = UUID.randomUUID().toString();
String key = randomUUID.replace("-", "") + "." + fileType;
// 使用腾讯云 COS SDK 上传图片
PutObjectRequest putObjectRequest = new PutObjectRequest(txConfig.getBucketName(), key, file1.getInputStream(), objectMetadata);
cosClient.putObject(putObjectRequest);
String imageUrl = txConfig.getCosPath() +"/"+ key;
keyList.add(imageUrl);
System.out.println(imageUrl);
}
return ResponseEntity.ok(keyList);
}
相关资料
-
Http API 文档
-
SDK 文档
-
Java SDK 文档
-
签名生成文档
今天的文章腾讯云存储是对象存储_免费对象存储空间云存储服务「建议收藏」分享到此就结束了,感谢您的阅读。
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。
如需转载请保留出处:https://bianchenghao.cn/83684.html