java上传图片到腾讯云cos

引入相关依赖

<!--腾讯云cos的依赖jar包-->
<dependency>
    <groupId>com.qcloud</groupId>
    <artifactId>cos_api</artifactId>
    <version>5.6.89</version>
</dependency>

<dependency>
    <groupId>com.tencent.cloud</groupId>
    <artifactId>cos-sts-java</artifactId>
    <version>3.0.5</version>
</dependency>

代码测试

@Test
public void cosTest() {
    // 1 初始化用户身份信息（secretId, secretKey）。
    // SECRETID和SECRETKEY请登录访问管理控制台 https://console.cloud.tencent.com/cam/capi 进行查看和管理
    String secretId = "*************************";
    String 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("COS_REGION");
    ClientConfig clientConfig = new ClientConfig(region);
    // 这里建议设置使用 https 协议
    // 从 5.6.54 版本开始，默认使用了 https
    clientConfig.setHttpProtocol(HttpProtocol.https);
    // 3 生成 cos 客户端。
    COSClient cosClient = new COSClient(cred, clientConfig);

    List<Bucket> buckets = cosClient.listBuckets();
    for (Bucket bucketElement : buckets) {
        String bucketName = bucketElement.getName();
        String bucketLocation = bucketElement.getLocation();
        System.out.println("bucketName : "+bucketName);
        System.out.println("bucketLocation : "+bucketLocation);
    }
}

ClientConfig 类为配置信息类，主要的成员如下：

成员名	设置方法	描述	类型
region	构造函数或 set 方法	存储桶所在的地域，COS 地域的简称请参见地域和访问域名文档	Region
httpProtocol	set 方法	请求所使用的协议，默认使用 HTTPS 协议与 COS 交互	HttpProtocol
signExpired	set 方法	请求签名的有效时间，单位：秒，默认为3600s	long
connectionTimeout	set 方法	连接 COS 服务的超时时间，单位：毫秒，默认为30000ms	int
socketTimeout	set 方法	客户端读取数据的超时时间，单位：毫秒，默认为30000ms	int
httpProxyIp	set 方法	代理服务器的 IP	String
httpProxyPort	set 方法	代理服务器的端口	int

启动测试，如果成功打印出相关信息，说明配置无误。

创建存储桶

String bucket = "****************"; //存储桶名称，格式：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();
}

上传文件测试

将本地文件或者已知长度的输入流内容上传到 COS，适用于20M以下图片类小文件上传，最大支持上传不超过5GB文件。5GB以上的文件必须使用分块上传或高级 API 接口上传。

注意前面地区（Region）初始化的时候名称填入存储桶的地区
下面上传文件的key 需要包含完整的文件名字（注意后缀）

@Test
public void cosTest() {
    // 指定要上传的文件
    String localFilePath="C:\\Users\\lenovo\\Pictures\\v2-2eb235a75af128a0374984559350242e_r.jpg";
    File localFile = new File(localFilePath);
    String fileName = localFile.getName();
    String suffix = fileName.substring(fileName.lastIndexOf(".") + 1);

    // 指定文件将要存放的存储桶
    String bucketName = "typora-1308522872";
    // 指定文件上传到 COS 上的路径，即对象键。例如对象键为folder/picture.jpg，则表示将文件 picture.jpg 上传到 folder 路径下
    String key = "test/"+ UUID.randomUUID().toString()+"."+suffix;
    PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, key, localFile);
    PutObjectResult putObjectResult = cosClient.putObject(putObjectRequest);
}

获取文件后缀的代码

1 2	String fileName = localFile.getName(); String suffix = fileName.substring(fileName.lastIndexOf(".") + 1);

查询对象列表

查询存储桶中对象列表，参考示例如下：

// Bucket的命名格式为 BucketName-APPID ，此处填写的存储桶名称必须为此格式
String bucketName = "examplebucket-1250000000";
ListObjectsRequest listObjectsRequest = new ListObjectsRequest();
// 设置bucket名称
listObjectsRequest.setBucketName(bucketName);
// prefix表示列出的object的key以prefix开始
listObjectsRequest.setPrefix("images/");
// 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
        String etag = cosObjectSummary.getETag();
        // 文件的长度
        long fileSize = cosObjectSummary.getSize();
        // 文件的存储类型
        String storageClasses = cosObjectSummary.getStorageClass();
    }

    String nextMarker = objectListing.getNextMarker();
    listObjectsRequest.setMarker(nextMarker);
} while (objectListing.isTruncated());

下载对象

可以用同样的 key，调用 GetObject 接口将对象下载到本地，也可以生成预签名链接

// Bucket的命名格式为 BucketName-APPID ，此处填写的存储桶名称必须为此格式
String bucketName = "examplebucket-1250000000";
// 指定文件在 COS 上的路径，即对象键。例如对象键为folder/picture.jpg，则表示下载的文件 picture.jpg 在 folder 路径下
String key = "exampleobject";
// 方法1 获取下载输入流
GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, key);
COSObject cosObject = cosClient.getObject(getObjectRequest);
COSObjectInputStream cosObjectInput = cosObject.getObjectContent();
// 下载对象的 CRC64
String crc64Ecma = cosObject.getObjectMetadata().getCrc64Ecma();
// 关闭输入流
cosObjectInput.close();

// 方法2 下载文件到本地的路径，例如 D 盘的某个目录
String outputFilePath = "exampleobject";
File downFile = new File(outputFilePath);
getObjectRequest = new GetObjectRequest(bucketName, key);
ObjectMetadata downObjectMeta = cosClient.getObject(getObjectRequest, downFile);

关闭客户端

关闭 cosClient，并释放 HTTP 连接的后台管理线程，代码如下：

1 2	// 关闭客户端(关闭后台线程) cosClient.shutdown();

示例代码

CosClientUtil

@Component
public class CosClientUtil {
    @Value("${tencent.secretId:#{null}}")
    private String secretId;
    @Value("${tencent.secretKey:#{null}}")
    private String secretKey;
    @Value("${tencent.region:#{null}}")
    private String regionName;
    @Value("${tencent.bucket:#{null}}")
    private String bucketName;
    @Value("${tencent.baseUrl:#{null}}")
    private String baseUrl;

    /**
     * 动物图片存储路径
     */
    public static final String ANIMAL_FILE="animal/";
    public static final String AVATAR_FILE="avatar/";
    public static final String TOPIC_FILE="topic/";

    public void testValue(){
        System.out.println(testValue);
    }
    /**
     * 获取实例
     * @return cosClient 实例
     */
    public COSClient getInstance(){
// 1 初始化用户身份信息（secretId, secretKey）。
// SECRETID和SECRETKEY请登录访问管理控制台 https://console.cloud.tencent.com/cam/capi 进行查看和管理
        System.out.println(secretId);
        System.out.println(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);
// 3 生成 cos 客户端。
        COSClient cosClient = new COSClient(cred, clientConfig);
        return cosClient;
    }

    /**
     * 上传文件
     * @param file 需要上传的文件
     * @return 返回文件的url
     */
    public String uploadFile(File file,String fileType){
        //获取文件后缀
        String fileName = file.getName();
        String suffix = fileName.substring(fileName.lastIndexOf(".") + 1);
        COSClient cosClient = getInstance();
// 指定文件上传到 COS 上的路径，即对象键。例如对象键为folder/picture.jpg，则表示将文件 picture.jpg 上传到 folder 路径下
        String key = fileType+ UUID.randomUUID().toString()+"."+suffix;
        PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, key, file);
        cosClient.putObject(putObjectRequest);
        String url= baseUrl+ key;
        return url;
    }
}

小插曲

@Value用法

为了避免信息泄露使用配置文件赋值时, 总是赋值失败

@Value("${tencent.secretId:#{null}}")
private String secretId;
@Value("${tencent.secretKey:#{null}}")
private String secretKey;
@Value("${tencent.region:#{null}}")
private String regionName;
@Value("${tencent.bucket:#{null}}")
private String bucketName;
@Value("${tencent.baseUrl:#{null}}")
private String baseUrl;