OSS移动开发实战2 (30分钟快速搭建移动应用上传回调服务)

2021-09-19 00:44:16

30分钟快速搭建移动应用上传回调服务

背景

上一篇文章我们介绍了如何快速搭建移动应用
参考移动端开发场景流程图
点击查看

上述图中Android/iOS移动应用的职责

会负责申请STS凭证，然后使用从应用服务器取的凭证上传

上述图中应用服务器的职责

负责给Android/iOS移动应用，生成STS凭证

上述图中OSS的职责

OSS负责处理移动应用的数据请求

问题

对于Android/iOS移动应来说，移动应用只需要执行操作1（申请STS凭证），就能调用多次5(使用该STS凭证上传数据到OSS)。这样就导致了应用服务器根本不知道用户都上传了哪些数据，如果那么作为该APP的开发者，就没法对应用上传数据进行管理。所以，有什么问题能让应用服务器感知到Android/iOS移动应用上传的数据呢?

答案

通过使用OSS的上传回调服务，就能解决上述问题，如下图：

即OSS在收到Android/iOS移动的数据(第5步）和在返回用户上传结果（第6步）之间，触发一个上传回调工作。即第5.5步。先回调用户服务器，然后得到应用服务器返回的内容，将这个内容返回给Android/iOS移动应用。

可以参考一下Callback API文档

上传回调的作用

通过上传回调可以让用户应用服务器知道当前上传文件的基本信息

基本信息如下表：

系统变量	含义
bucket	移动应用上传到哪个存储空间
object	移动应用上传到OSS保存的文件名
etag	该上传的文件的etag，即返回给用户的etag字段
size	该上传的文件的大小
mimeType	资源类型
imageInfo.height	图片高度
imageInfo.width	图片宽度
imageInfo.format	图片格式，如jpg、png，只以识别图片

返回上述变量的一个或者多个，返回内容格式形式在Android/iOS上传时指定

通过上传回调设定自定义参数，达到信息传递目的

如：假如我是一个开发者，我想知道当前用户所使用的APP版本、当前用户所在的操作系统版本、用户的GPS信息、用户的手机型号。那么我可以在Android/iOS端上传文件时，指定上述自定义参数，如x:version指定APP版本，x:system指定操作系统版本，x:gps指定GPS信息，x:phone指定手机型号
这些值，会在Android/iOS移动应用上传到OSS时，附带上。然后OSS，会把这些值，放到CallbackBody里面，一起发给应用服务器。这样应用服务器就能收到这些信息，达到信息传递的目的。

移动应用端怎么样设定上传回调？

要让OSS在接收上传请求时，触发上传回调，那么移动应用必须在构造上传请求，必须把要两个内容指定到上传请求里面。这两个内容如下：

要回调到哪个服务器callbackUrl,如上一点提到的http://abc.com/callback.php，注意这个地址必须是公网能够访问的
上传回调给应用服务器的内容callbackBody。可以是上述OSS返回应用服务器系统变量的一个或者多个。

举一个示例。假如我的用户服务器上传回调地址是：http://abc.com/callback.php。

我想获取手机上传的文件名字，文件的大小，并且我定义了photo变量是指手机型号。system是操作系统版本

iOS指定上传回调示例

OSSPutObjectRequest * request = [OSSPutObjectRequest new];
request.bucketName = @"<bucketName>";
request.objectKey = @"<objectKey>";
request.uploadingFileURL = [NSURL fileURLWithPath:@<filepath>"];

// 设置回调参数
request.callbackParam = @{
                          @"callbackUrl": @"http://abc.com/callback.php",
                          @"callbackBody": @"filename=${object}&size=${size}&photo=${x:photo}&system=${x:system}"
                          };
// 设置自定义变量
request.callbackVar = @{
                        @"x:photo": @"iphone6s",
                        @"x:system": @"ios9.1"
                        };

Android指定上传回调示例

PutObjectRequest put = new PutObjectRequest(testBucket, testObject, uploadFilePath);

ObjectMetadata metadata = new ObjectMetadata();
metadata.setContentType("application/octet-stream");

put.setMetadata(metadata);

put.setCallbackParam(new HashMap<String, String>() {
    {
        put("callbackUrl", "http://abc.com/callback.php");
        put("callbackBody", "filename=${object}&size=${size}&photo=${x:photo}&system=${x:system}");
    }
});

put.setCallbackVars(new HashMap<String, String>() {
     {
         put("x:photo", "IPOHE6S");
         put("x:system", "YunOS5.0");
     }
});

对于上传回调，应用服务器应该做些什么？

你必须要有部署一个可以接收POST请求的服务，这个服务必须有公网地址如www.abc.com/callback.php（或者外网IP也可以）,不然OSS没有办法访问到这个地址。
你要给OSS正确的返回，返回格式必须是JSON格式，内容自定义。因为OSS会把应用服务器返回的内容，原封不动地返回给Android/iOS移动应用。（切记，返回给OSS的Response Header一定要加上Content-Length这个头部）

本教程在后续内容，为大家准备了多个语言版本的示例, 下载及运行方法在本教程的最后。

应用服务器收到的回调请求是怎么样

应用服务器收到OSS的请求，抓包的请求如下（这个结果会根据不同人设定的不同URL和回调内容会有不同）

POST /index.html HTTP/1.0
Host: 121.43.113.8
Connection: close
Content-Length: 81
Content-Type: application/x-www-form-urlencoded
User-Agent: ehttp-client/0.0.1
authorization: kKQeGTRccDKyHB3H9vF+xYMSrmhMZjzzl2/kdD1ktNVgbWEfYTQG0G2SU/RaHBovRCE8OkQDjC3uG33esH2txA==
x-oss-pub-key-url: aHR0cDovL2dvc3NwdWJsaWMuYWxpY2RuLmNvbS9jYWxsYmFja19wdWJfa2V5X3YxLnBlbQ==

filename=test.txt&size=5&photo=iphone6s&system=ios9.1

可以参考一下Callback API文档

应用服务器怎么样判断这个请求是来自OSS

之所以要判断这个请求是来自OSS，是因为如果你的回调服务器被人恶意攻击了，别人恶意回调你的应用服务器，导致应用服务器收到一些非法的请求，影响正常逻辑。
判断的方法主要是利用OSS给应用服务器返回的头部内容中， x-oss-pub-key-url，authorization这两个参数进行RSA校验。只有通过RSA校验的请求，才能说明这个请求是来自OSS，本教程提供的示例程序都有实现的示例，大家可以参考。

应用服务器收到这个回调做什么

应用服务器在校验这个请求是来自OSS后（这一步不是必要的），因为Android/iOS应用在上传数据时，指定了回调给应用服务器的内容格式，如

filename=test.txt&size=5&photo=iphone6s&system=ios9.1

应用服务器就可以根据OSS的返回内容，解析得到自己想要得到的数据。得到这个数据后，应用服务器可以把数据存放起来，方便后续管理。

应用服务器收到这个回调要怎么样返回给OSS

返回状态码是200；
返回必须是json格式的内容；
并且返回的头部必须带有Content-Length这个头部

OSS怎么样处理应用服务器的返回内容

有两种情况：

OSS将回调请求发送给应用服务器，但是应用服务器接收失败或者访问不通，OSS会返回给Android/iOS移动应用203的状态码，但是数据已经存放到OSS上了。
应用服务器，接收到OSS的回调请求，并且正确返回了，OSS会返回给Android/iOS移动应用状态码是200, 并把应用服务器给OSS的内容，原封不动地返回给Android/iOS移动应用.

上传回调服务器示例程序下载

示例程序只是完成了如何检查应用服务器收到的签名，用户要自行增加对应用服务器收到回调的内容的格式解析。
Java版本：

下载地址：点击这里
运行方法，解压包运行java -jar oss-callback-server-demo.jar 9000（9000就运行的端口，可以自己指定）

注意这个jar例子在java 1.7运行通过，如果有问题可以自己依据提供的代码进行修改。这是一个maven项目

PHP版本:

下载地址：点击这里
运行方法：部署到Apache环境下，因为PHP本身语言的特点，取一些数据头部会依赖于环境。所以可以参考例子基于自己所在环境进行修改

Python版本：

下载地址：点击这里
运行方法：解压包直接运行python callback_app_server.py即可，程序自实现了一个简单的http server，运行该程序可能需要安装rsa的依赖。

Ruby版本：

下载地址：点击这里
运行方法： ruby aliyun_oss_callback_server.rb

码农公寓