对象存储OSS之测试OSS的基本API

系统管理员 2021-06-10 20:40 763阅读 0赞

经过之前的学习，我们已经开通了阿里云OSS服务并配置了测试账号权限，接下来就可以开始学习OSS的基本API了。

## 如何快速的掌握使用一门技术？ ##

快速掌握使用一门技术，是每个程序员都要掌握的基本能力。一般只需要做到以下两点：  
1、查看官方文档  
2、练习基本的API

## 阿里云OSS帮助文档 ##

阿里云OSS的API都在帮助文档里，我们首先要做的就是找到帮助文档。步骤如下：  
1、进入概览页面，点击右上角“开始使用阿里云OSS”。  
![概览][fd8e7533f1e0527af03b22fffde99c1b.png]  
2、打开帮助文档，往下拉可以找到OSS针对不同编程语言提供的API和SDK包。我们这里点击“Java SDK快速入门”，其他语言点击对应的SDK进行查看即可。  
![使用API和SDK][API_SDK]  
3、在新页面中点击底部“在帮助文档中心打开”，进入帮助文档中心并且定位到“快速入门”菜单下，在这里我们可以看到关于OSS的所有API接口的说明。  
![帮助文档][d634aeebf8999504794160abc3e9bac8.png]  
4、点击“示例工程”下方的“Maven示例工程”文件，可以下载SDK的示例代码。  
![下载Maven示例工程][Maven]  
5、下载完成后解压SDK压缩包，打开pom文件，可以看到工程中引入了如下三个依赖，之后我们自己调用OSS的API的时候也引入这三个依赖即可。  
![引入OSS依赖][OSS]

## 测试API ##

查看了API文档和示例工程之后，接下来我们就可以开始测试OSS的几个基本API了。  
新建工程，在pom.xml中引入OSS的三个依赖。

<dependencies>
    	<dependency>
        	<groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.11</version>
        </dependency>
        <dependency>
        	<groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.5</version>
        </dependency>
        
        <dependency>
        	<groupId>com.aliyun.oss</groupId>
            <artifactId>aliyun-sdk-oss</artifactId>
            <version>3.8.0</version>
        </dependency>	
    </dependencies>

#### 开始前的准备工作 ####

首先我们需要拿到地域节点endPoint，以及之前获取测试权限时生成的accessKeyId、accessKeySecret以及bucketName，调用连接OSS的API时需要用到这些参数。

// Endpoint以杭州为例，其它Region请按实际情况填写。 
    String endpoint = "oss-cn-beijing.aliyuncs.com"; 
    // 阿里云主账号AccessKey拥有所有API的访问权限，风险很高
    String accessKeyId = "LTAI4FfEx3TmDfjemSd2Y7Q2"; 
    String accessKeySecret = "zopf47hTj40JsFb8PTxoGHKEMRaAvi"; 
    String bucketName = "wunian-edu-study";

![地域节点][fdf9000be4fee6da887172fe8c64f309.png]

#### 创建OSS实例 ####

传入上述参数，创建OSS对象，调用OSS对象的createBucket()方法创建Bucket，如果Bucket已经存在则会报错。

@Test
    public void testCreate(){
      //对象
      OSS ossClient = new OSSClientBuilder().build(endPoint,accessKeyId,accessKeySecret);
      //方法（创建Bucket）
      ossClient.createBucket(bucketName); //如果Bucket已经存在则会报错
      //关闭对象
      ossClient.shutdown();
    }

#### 修改权限 ####

调用OSS对象的setBucketAcl()方法，将Bucket权限修改为公共读。

@Test
    public void testUpdate(){
      OSS ossClient = new OSSClientBuilder().build(endPoint,accessKeyId,accessKeySecret);
      //修改已有的，创建新的
      ossClient.setBucketAcl(bucketName,CannedAccessControlList.PublicRead);
      ossClient.shutdown();
    }

#### 判断当前实例是否存在 ####

调用OSS对象的doesBucketExist()方法，返回true则表示实例存在。

@Test
    public void testExist(){
      OSS ossClient = new OSSClientBuilder().build(endPoint,accessKeyId,accessKeySecret);
      boolean exist = ossClient.doesBucketExist(bucketName);
      System.out.println(exist);
      ossClient.shutdown();
    }

#### 文件上传 ####

调用OSS对象的putObject()方法来实现文件上传，注意上传文件的名称应保持唯一。

@Test
    public void testUpload(){
      OSS ossClient = new OSSClientBuilder().build(endPoint,accessKeyId,accessKeySecret);
      //上传到OSS后需要一个文件名并且保证其唯一
      String objectName = "avatar/logo.png";
      ossClient.putObject(bucketName,objectName,new File("c:\\user\\admin\\DeskTop\\logo.png"))
      ossClient.shutdown();
    }

#### 文件下载 ####

调用OSS对象的getObject()方法来实现文件下载。

@Test
    public void testDownload(){
      OSS ossClient = new OSSClientBuilder().build(endPoint,accessKeyId,accessKeySecret);
      String objectName = "avatar/logo.png";
      ossClient.getObject(new GetObjectRequest(bucketName,objectName),new File("a.png"))
      ossClient.shutdown();
    }

#### 查看文件列表 ####

调用OSS对象的listObjects()方法返回ObjectListing对象，该对象包含此次listObject请求的返回结果，可以对该对象进行遍历。

@Test
    public void testShowList(){
      OSS ossClient = new OSSClientBuilder().build(endPoint,accessKeyId,accessKeySecret);
      //ObjectListing实例包含此次listObject请求的返回结果
      ObjectListing objectListing = ossClient.listObjects(bucketName);
      for(OSSObjectSummary os:objectListing.getObjectSumaries()){
        String key = os.getKey();
        String size = os.getSize();
        System.out.println("key="+key+",size="+size);
      }
      ossClient.shutdown();
    }

#### 删除文件 ####

调用OSS对象的deleteObject()方法来实现文件删除。

@Test
    public void testDelete(){
      OSS ossClient = new OSSClientBuilder().build(endPoint,accessKeyId,accessKeySecret);
      String objectName = "avatar/logo.png";
      ossClient.deleteObject(bucketName,objectName);
      ossClient.shutdown();
    }

以上测试API只是OSS的其中一小部分，更多API可以直接查看帮助文档进行学习，使用方法都是类似的。

[fd8e7533f1e0527af03b22fffde99c1b.png]: /images/20210607/0e5b34bb78f24c02a02655558c9a0cc9.png
[API_SDK]: /images/20210607/cf35c296ea174f95868bd7c322c1d8ae.png
[d634aeebf8999504794160abc3e9bac8.png]: /images/20210607/0dde0b9fd82c406bacd68a50b9112496.png
[Maven]: /images/20210607/8a33b45985d4429c993d18a2c8d9b275.png
[OSS]: /images/20210607/a9e78978fb8f4cd6a733b260fac3b302.png
[fdf9000be4fee6da887172fe8c64f309.png]: /images/20210607/698dfaa805ba446ab6e72edf8e770a4c.png