全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
对象存储 OSS

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

更新时间:2017-08-09 14:48:49

背景

快速搭建移动应用直传服务介绍了如何在30分钟内中搭建一个基于OSS的移动应用数据直传服务。移动端开发场景流程图如下:

角色解析

  • 应用服务器负责为Android/iOS移动应用生成STS凭证。

  • Android/iOS移动应用负责从应用服务器申请及使用STS凭证。

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

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

您可以通过使用OSS的上传回调服务,就能解决上述问题,如下图所示:

OSS在收到Android/iOS移动的数据(上图中操作5)和在返回用户上传结果(上图中操作6)之间,触发一个上传回调工作。即第上图中操作5.5,先回调用户服务器,得到应用服务器返回的内容,将这个内容返回给Android/iOS移动应用。可以参考Callback API文档

上传回调的作用

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

    基本信息如下表。返回下述变量的一个或者多个,返回内容格式形式在Android/iOS上传时指定。

系统变量 含义
bucket 移动应用上传到哪个存储空间
object 移动应用上传到OSS保存的文件名
etag 该上传的文件的etag,即返回给用户的etag字段
size 该上传的文件的大小
mimeType 资源类型
imageInfo.height 图片高度
imageInfo.width 图片宽度
imageInfo.format 图片格式,如jpg、png,只以识别图片
  • 通过上传回调设定自定义参数,达到信息传递目的。

    假如您是一个开发者,您想知道当前用户所使用的APP版本、当前用户所在的操作系统版本、用户的GPS信息、用户的手机型号。您可以在Android/iOS端上传文件时,指定上述自定义参数,如下所示:

    • x:version指定APP版本

    • x:system指定操作系统版本

    • x:gps指定GPS信息

    • x:phone指定手机型号。

      上述这些值会在Android/iOS移动应用上传到OSS时附带上,OSS会把这些值放到CallbackBody里面一起发给应用服务器。这样应用服务器就能收到这些信息,达到信息传递的目的。

在移动应用端设定上传回调

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

  1. 要回调到哪个服务器callbackUrl,如 http://abc.com/callback.php,这个地址必须是公网能够访问的。

  2. 上传回调给应用服务器的内容callbackBody,可以是上述OSS返回应用服务器系统变量的一个或者多个。

示例

假如您的用户服务器上传回调地是http://abc.com/callback.php。您想获取手机上传的文件名字、文件的大小,并且定义了photo变量是指手机型号,system是指操作系统版本。

iOS指定上传回调示例:

  1. OSSPutObjectRequest * request = [OSSPutObjectRequest new];
  2. request.bucketName = @"<bucketName>";
  3. request.objectKey = @"<objectKey>";
  4. request.uploadingFileURL = [NSURL fileURLWithPath:@<filepath>"];
  5. // 设置回调参数
  6. request.callbackParam = @{
  7. @"callbackUrl": @"http://abc.com/callback.php",
  8. @"callbackBody": @"filename=${object}&size=${size}&photo=${x:photo}&system=${x:system}"
  9. };
  10. // 设置自定义变量
  11. request.callbackVar = @{
  12. @"x:photo": @"iphone6s",
  13. @"x:system": @"ios9.1"
  14. };

Android指定上传回调示例:

  1. PutObjectRequest put = new PutObjectRequest(testBucket, testObject, uploadFilePath);
  2. ObjectMetadata metadata = new ObjectMetadata();
  3. metadata.setContentType("application/octet-stream");
  4. put.setMetadata(metadata);
  5. put.setCallbackParam(new HashMap<String, String>() {
  6. {
  7. put("callbackUrl", "http://abc.com/callback.php");
  8. put("callbackBody", "filename=${object}&size=${size}&photo=${x:photo}&system=${x:system}");
  9. }
  10. });
  11. put.setCallbackVars(new HashMap<String, String>() {
  12. {
  13. put("x:photo", "IPOHE6S");
  14. put("x:system", "YunOS5.0");
  15. }
  16. });

上传回调对应用服务器的要求

  • 您必须部署一个可以接收POST请求的服务,这个服务必须有公网地址如www.abc.com/callback.php(或者外网IP也可以),不然OSS没有办法访问到这个地址。

  • 您要给OSS正确的返回,返回格式必须是JSON格式,内容自定义。因为OSS会把应用服务器返回的内容,原封不动地返回给Android/iOS移动应用。(切记,返回给OSS的Response Header一定要加上Content-Length这个头部)。

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

应用服务器收到的回调请求

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

  1. POST /index.html HTTP/1.0
  2. Host: 121.43.113.8
  3. Connection: close
  4. Content-Length: 81
  5. Content-Type: application/x-www-form-urlencoded
  6. User-Agent: ehttp-client/0.0.1
  7. authorization: kKQeGTRccDKyHB3H9vF+xYMSrmhMZjzzl2/kdD1ktNVgbWEfYTQG0G2SU/RaHBovRCE8OkQDjC3uG33esH2txA==
  8. x-oss-pub-key-url: aHR0cDovL2dvc3NwdWJsaWMuYWxpY2RuLmNvbS9jYWxsYmFja19wdWJfa2V5X3YxLnBlbQ==
  9. filename=test.txt&size=5&photo=iphone6s&system=ios9.1

更多内容请参考Callback API文档

应用服务器判断回调请求是否来自OSS

如果您的回调服务器被人恶意攻击了,例如恶意回调您的应用服务器,导致应用服务器收到一些非法的请求,影响正常逻辑,此时您就需要判断回调请求是来自OSS。

判断的方法主要是利用OSS给应用服务器返回的头部内容中, x-oss-pub-key-urlauthorization这两个参数进行RSA校验。只有通过RSA校验才能说明这个请求是来自OSS,本教程提供的示例程序都有实现的示例供您参考。

应用服务器收到回调请求后的处理

应用服务器在校验这个请求是来自OSS后,指定回调给应用服务器的内容格式,如

  1. 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。
本文导读目录