在上一篇中我们讲了OSS是什么?为什么要用?以及怎样选购和配置。本篇我们主要来看看怎样使用,我们以Java和PHP两种语言来示范。
在OSS控制台右侧的Bucket管理界面上,我们可以看到官方提供的新手入门和API文档:
现在我们知道官方既提供了API接口方式接入,有提供了SDK集成的方式。官方提供的SDK覆盖了大部分热门的语言技术栈,包括Java、Python、Go、C++、PHP等,很少情况下我们需要自己通过API的方式来接入。但如果你有代码洁癖或者使用的技术栈确实没有SDK,譬如Perl或者Lisp,那可以尝试使用API的方式来接入。
API方式接入OSS
我们就以PHP语言来演示如何通过API的方式接入OSS。首先,在常用入口那儿可以查询到Access Key,包括一对AccessKey ID和AccessKey Secret。无论是通过API还是SDK方式接入,这两个参数都是必须的。
其实,文件上传到OSS上和文件上传到我们自己服务器上的流程,并没有多少区别,我们还是会用HTTP协议,通过FORM表单的形式提交数据。不同在于构建这个header头的参数有些差异罢了。OSS要求我们在header头中,携带一个Authorization参数,用于验证客户端身份。所以重点就是围绕如何构建这个参数,来实现HTTP协议的通信。
既然和我们传统http的form表单上传差异在header上,我们不妨就从header入手。首先定义一个数组来放置我们的header参数:
//GMT时间
$date = gmdate('D, d M Y H:i:s T');
//mime
$mime = 'image/png';
//构建报头
$header = array(
'Host' => 'oss.aliyuncs.com',
'Date' => $date,
'Content-Type' => $mime
);
如上示例定义的header头中,包含了一个Host用于指定HTTP协议送达的主机域,另外,OSS的API文档中,要求我们提供一个Date参数来表示时间,格式使用GMT。最后,Content-Type参数来表明我们上传的文件格式。为了演示方便,我们这里写死为"image/png",表示上传的是png格式的图片。读者可以根据自身业务逻辑来获取并传递这个MIME。
还记得我们上一篇中创建的Bucket名字么?这里就派上用场了,我们得指定文件往哪上传,以为OSS中可能不止一个bucket。通常这个资源标识符是这样的:
仓库(bucket)名称 + 目录名称 + 文件名
假设我们在名为1doc的bucket中有个目录叫做images,现在要上传defult.png文件到这个目录中,那么uri就应该是这样子的:
1doc/images/default.png
我们把这个资源标识符保存到一个变量中,待会使用:
$bucketMame = '1doc';
$menu = '/images/';
$fileName = 'default.png';
$savePath = $bucketName . $menu . $fileName;
那么重点来了,我们要开始准备构建Authorization参数了。
第一步根据API文档中的指导精神,我们遵循HTTP协议,通过PUT方式来上传文件,拼接出请求头:
$signStr = "PUT\n" . $mime . "n" . $date . "\n" . $savePath;
第二步,通过sha1算法将上面这个待签名的字符串和AccessKey Secret加密,再用base64编码:
$signature = base64_encode(hash_mac('sha1', $signStr, $accessKeySecret, true));
第三步,使用AccessKey ID 与上面的签名字符拼接成最终的Authorization,并加到header头中:
$sign = 'OSS ' . $accessKeyID . ':' . $signture;
$header['Authorization'] = $sign;
接下来的事儿就简单了,就是普通的HTTP请求了。当然,我们先准备好要上传的文件:
$file = file_get_contents('default.png');
然后通过curl来提交请求:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'http://oss.aliyuncs.com/' . $savePath);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
$result = curl_exec($ch);
$info = curl_getinfo($ch);
curl_close($ch);
return $info['http_code'];
对于PHP而言,笔者注意到OSS近来已经支持composer来引入SDK了,相较于早些年自己去加载.php文件要方便的多。所以,除非没有更好的解决方案,笔者还是建议使用SDK来集成。
SDK方式接入OSS
我们用java来演示通过sdk的方式接入OSS。笔者的项目使用Maven构建的,在Maven的pom.xml可以很方便地引入OSS SDK依赖:
<!-- 阿里云oss组件 -->
<dependency>
<groupId>com.aliyun.oss</groupId>
<artifactId>aliyun-sdk-oss</artifactId>
<version>3.10.2</version>
</dependency>
我们在控制器中定义一个action用来接收客户端的form表单数据,并上传到OSS中:
@RestController
public class ResourceController {
@PostMapping("upload.do")
public JsonResult upload(MultipartFile file) {
//具体上传逻辑
}
}
现在我们来准备一些参数吧,包括AccessKey ID和AccessKey Secret,还有Bucket名字。
String accessKey = "your key";
String accessSecret = "your secret";
String bucketName = "1doc";
String endpoint = "http://oss-cn-shanghai.aliyuncs.com"
相对于API的繁琐,java的SDK提供了一个OSSClient来帮我们构建请求客户端,我们稍加封装成一个方法,以供不同的操作使用:
private OSS getClient() {
return new OSSClientBuilder().build(endpoint, accessKey, accessSecret)
}
我们可以通过这个client去操作OSS文件的上传、下载、更新以及删除等操作,不必关系身份验证等细节问题。
来瞧瞧上传一个文件是多么的简单:
OSS ossClient = getClient();
ossClient.putObject(bucketName, fileName, inputStream);
ossClient.shutdown();
OSSClient对象中提供的putObject()方法用来上传文件,当然putObject有多个重载的方法,以上是以文件流的方式上传。
我们在控制器中接收到来自客户端form表单数据的 MultipartFile,通过getInputStream()方法就可以获得一个文件流,在这里传入就可以了。
除了putObject()方法,OSSClient对象还提供了诸多的操作OSS文件的方法,包括常用的增删改查,诸如此类无需再演示。
此致,祝你OSS用的开心!