本示例讲解在服务端通过各种语言代码完成签名,并且设置上传回调,然后通过表单直传数据到OSS。

背景

采用服务端签名后直传方案有个问题:用户上传数据后,很多场景下,应用服务器需要知道用户上传了哪些文件以及文件名称,如果是图片的话,还需要知道图片的大小等。为此OSS提供了上传回调方案。OSS回调完成后,应用服务器再返回结果给客户端。这样服务端就可以实时了解用户上传了什么文件。

Demo

您可以通过样例体验服务端签名直传并设置上传回调的效果:PC浏览器测试样例

流程介绍



流程如下:
  1. 用户向应用服务器请求上传Policy和回调。
  2. 应用服务器返回上传Policy和回调设置。
  3. 用户直接向OSS发送文件上传请求。
  4. OSS根据用户的回调设置,发送回调请求给应用服务器。
  5. 应用服务器返回响应给OSS。
  6. OSS将应用服务器返回的内容返回给用户。

简单讲,就是用户要上传一个文件到OSS,而且希望将上传的结果返回给应用服务器,这时就需要设置一个回调函数,将请求告知应用服务器。用户上传完文件后,不会直接得到返回结果,而是先通知应用服务器,再把结果转达给用户。

流程解析

服务端签名直传并设置上传回调提供了PHPJavaPythonGoRuby语言版本的具体示例。以下根据流程讲解核心代码和消息内容。

  1. 用户向应用服务器请求上传Policy和回调。

    在客户端源码中的upload.js文件中,如下代码片段的变量serverUrl的值可以用来设置签名服务器的URL。设置好之后,客户端会向该serverUrl发送GET请求来获取需要的信息。

    // serverUrl是 用户获取 '签名和Policy' 等信息的应用服务器的URL,请将下面的IP和Port配置为您自己的真实信息。
    serverUrl = 'http://88.88.88.88:8888'
  2. 应用服务器返回上传Policy和回调设置代码。

    应用服务器侧的签名直传服务会处理客户端发过来的GET请求消息,您可以设置对应的代码让应用服务器能够给客户端返回正确的消息。各个语言版本的配置文档中都有明确的说明供您参考。

    下面是签名直传服务返回给客户端消息body内容的示例,这个body的内容将作为客户端上传文件的重要参数。

    {
    "accessid":"6MKOqxGiGU4AUk44",
    "host":"http://post-test.oss-cn-hangzhou.aliyuncs.com",
    "policy":"eyJleHBpcmF0aW9uIjoiMjAxNS0xMS0wNVQyMDo1MjoyOVoiLCJjdb25kaXRpb25zIjpbWyJjdb250ZW50LWxlbmd0aC1yYW5nZSIsMCwxMDQ4NTc2MDAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInVzZXItZGlyXC8iXV19",
    "signature":"VsxOcOudxDbtNSvz93CLaXPz+4s=",
    "expire":1446727949,
    "callback":"eyJjYWxsYmFja1VybCI6Imh0dHA6Ly9vc3MtZGVtby5hbGl5dW5jcy5jdb206MjM0NTAiLCJjYWxsYmFja0hvc3QiOiJvc3MtZGVtby5hbGl5dW5jcy5jdb20iLCJjYWxsYmFja0JvZHkiOiJmaWxlbmFtZT0ke29iamVjdH0mc2l6ZT0ke3NpemV9Jm1pbWVUeXBlPSR7bWltZVR5cGV9JmhlaWdodD0ke2ltYWdlSW5mby5oZWlnaHR9JndpZHRoPSR7aW1hZ2VJdbmZvLndpZHRofSIsImNhbGxiYWNrQm9keVR5cGUiOiJhcHBsaWNhdGlvbi94LXd3dy1mb3JtLXVybGVuY29kZWQifQ==",
    "dir":"user-dirs/"
    }

    上述示例的callback内容采用的是base64编码。经过base64解码后的内容如下:

    {"callbackUrl":"http://oss-demo.aliyuncs.com:23450",
    "callbackHost":"oss-demo.aliyuncs.com",
    "callbackBody":"filename=${object}&size=${size}&mimeType=${mimeType}&height=${imageInfo.height}&width=${imageInfo.width}",
    "callbackBodyType":"application/x-www-form-urlencoded"}
    说明 回调方式并不是固定的,以上仅为示例,您可以修改服务端代码自行设置回调。

    内容解析如下:

    • CallbackUrl:OSS往这个服务器发送的URL请求。
    • callbackHost:OSS发送这个请求时,请求头部所带的Host头。
    • callbackBody:OSS请求时,发送给应用服务器的内容,可以包括文件的名称、大小、类型。如果是图片,可以是图片的高度、宽度。
    • callbackBodyType:请求发送的Content-Type。
  3. 用户直接向OSS发送文件上传请求。

    在客户端源码upload.js文件中,callbackbody的值是步骤2中应用服务器返回给客户端消息body中callback的内容。

    new_multipart_params = {
         'key' : key + '${filename}',
         'policy': policyBase64,
         'OSSAccessKeyId': accessid,
         'success_action_status' : '200', //让服务端返回200,不设置则默认返回204
         'callback':  callbackbody,
         'signature': signature,
     };
  4. OSS根据用户的回调设置,发送回调请求给应用服务器。

    客户端上传文件到OSS结束后,OSS解析客户端的上传回调设置,发送POST回调请求给应用服务器。消息内容大致如下:

    Hypertext Transfer Protocol
        POST / HTTP/1.1\r\n
        Host: 47.97.168.53\r\n
        Connection: close\r\n
        Content-Length: 76\r\n
        Authorization: fsNxFF0wNOpC0YMNAoFb//a8x6v2lI1ih7kXIh3nFUDALgku9bhC+cWQsnxuCo88vahKtBUmnDI6k1PofggA4g==\r\n
        Content-MD5: eiEMyp7lbL8KStPBzMdr9w==\r\n
        Content-Type: application/x-www-form-urlencoded\r\n
        Date: Sat, 15 Sep 2018 10:24:12 GMT\r\n
        User-Agent: aliyun-oss-callback\r\n
        x-oss-additional-headers: \r\n
        x-oss-bucket: signedcallback\r\n
        x-oss-owner: 1544709436620439\r\n
        x-oss-pub-key-url: aHR0cHM6Ly9nb3NzcHVibGljLmFsaWNkbi5jb20vY2FsbGJhY2tfcHViX2tleV92MS5wZW0=\r\n
        x-oss-request-id: 5B9CDDCC9D2B0CA88AE2BEA1\r\n
        x-oss-requester: 1544709436620439\r\n
        x-oss-signature-version: 1.0\r\n
        x-oss-tag: CALLBACK\r\n
        eagleeye-rpcid: 0.1\r\n
        \r\n
        [Full request URI: http://47.97.168.53/]
        [HTTP request 1/1]
        [Response in frame: 39]
        File Data: 76 bytes
    HTML Form URL Encoded: application/x-www-form-urlencoded
        Form item: "filename" = ".snappython.png"
        Form item: "size" = "6014"
        Form item: "mimeType" = "image/png"
        Form item: "height" = "221"
  5. 应用服务器返回响应给OSS。

    应用服务器根据OSS发送消息中的authorization来进行验证,如果验证通过,则向OSS返回如下json格式的成功消息。

    String value: OK
    Key: Status
  6. OSS将应用服务器返回的消息返回给用户。

客户端源码解析

客户端源码下载地址:aliyun-oss-appserver-js-master.zip
说明 客户端JavaScript代码使用的是Plupload组件。Plupload是一款简单易用且功能强大的文件上传工具, 支持多种上传方式,包括html5、flash、silverlight、html4。它会智能检测当前环境,选择最适合的上传方式,并且会优先采用html5方式。详情请参见Plupload官网

下面举例介绍几个关键功能的代码实现:

  • 设置成随机文件名

    若上传时采用固定格式的随机文件名,且后缀跟客户端文件名保持一致,可以将函数改为:

    function check_object_radio() {
        g_object_name_type = 'random_name';
    }
  • 设置成用户的文件名

    如果想在上传时设置成用户的文件名,可以将函数改为:

    function check_object_radio() {
        g_object_name_type = 'local_name';
    }
  • 设置上传目录

    上传的目录由服务端指定, 每个客户端只能上传到指定的目录,实现安全隔离。下面的代码以PHP为例,将上传目录改成abc/,注意目录必须以正斜线(/)结尾。

    $dir ='abc/';
  • 设置上传过滤条件

    您可以利用Plupload的属性filters设置上传的过滤条件,如设置只能上传图片、上传文件的大小、不能有重复上传等。

    var uploader = new plupload.Uploader({
        ……
        filters: {
            mime_types : [ //只允许上传图片和zip文件
            { title : "Image files", extensions : "jpg,gif,png,bmp" },
            { title : "Zip files", extensions : "zip" }
            ], 
            max_file_size : '400kb', //最大只能上传400KB的文件
            prevent_duplicates : true //不允许选取重复文件
        },
    • mime_types:限制上传的文件后缀。
    • max_file_size:限制上传的文件大小。
    • prevent_duplicates:限制不能重复上传。
  • 获取上传后的文件名

    如果要知道文件上传成功后的文件名,可以用Plupload调用FileUploaded事件获取,如下所示:

    FileUploaded: function(up, file, info) {
                if (info.status == 200)
                {
                    document.getElementById(file.id).getElementsByTagName('b')[0].innerHTML = 'upload to oss success, object name:' + get_uploaded_object_name(file.name);
                }
                else
                {
                    document.getElementById(file.id).getElementsByTagName('b')[0].innerHTML = info.response;
                }
        }

    可以利用如下函数,得到上传到OSS的文件名,其中file.name记录了本地文件上传的名称。

    get_uploaded_object_name(file.name)
  • 上传签名

    JavaScript可以从服务端获取policyBase64、accessid、signature这三个变量,核心代码如下:

    function get_signature()
    {
        // 判断expire的值是否超过了当前时间,如果超过了当前时间,就重新获取签名,缓冲时间为3秒。
        now = timestamp = Date.parse(new Date()) / 1000; 
        if (expire < now + 3)
        {
            body = send_request()
            var obj = eval ("(" + body + ")");
            host = obj['host']
            policyBase64 = obj['policy']
            accessid = obj['accessid']
            signature = obj['signature']
            expire = parseInt(obj['expire'])
            callbackbody = obj['callback'] 
            key = obj['dir']
            return true;
        }
        return false;
    };

    从服务端返回的消息解析如下:

    说明 以下仅为示例,并不要求相同的格式,但必须有accessid、policy、signature三个值。
    {"accessid":"6MKOqxGiGU4AUk44",
    "host":"http://post-test.oss-cn-hangzhou.aliyuncs.com",
    "policy":"eyJleHBpcmF0aW9uIjoiMjAxNS0xMS0wNVQyMDoyMzoyM1oiLCJjxb25kaXRpb25zIjpbWyJjcb250ZW50LWxlbmd0aC1yYW5nZSIsMCwxMDQ4NTc2MDAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInVzZXItZGlyXC8iXV19",
    "signature":"I2u57FWjTKqX/AE6doIdyff151E=",
    "expire":1446726203,"dir":"user-dir/"}
    • accessid:用户请求的accessid。
    • host:用户要往哪个域名发送上传请求。
    • policy:用户表单上传的策略(Policy),是经过base64编码过的字符串。详情请参见Post Policy
    • signature:对变量policy签名后的字符串。
    • expire:上传策略Policy失效时间,在服务端指定。失效时间之前都可以利用此Policy上传文件,无需每次上传都去服务端获取签名。
    说明 为了减少服务端的压力,设计思路是:初始化上传时,每上传一个文件,获取一次签名。再上传时,比较当前时间与签名时间,看签名时间是否失效。如果失效,就重新获取一次签名,如果没有失效,就使用之前的签名。

    解析Policy的内容如下:

    {"expiration":"2015-11-05T20:23:23Z",
    "conditions":[["content-length-range",0,1048576000],
    ["starts-with","$key","user-dir/"]]

    上面Policy中增加了starts-with,用来指定此次上传的文件名必须以user-dir开头,用户也可自行指定。增加starts-with的原因是:在很多场景下,一个应用对应一个Bucket,为了防止数据覆盖,每个用户上传到OSS的文件都可以有特定的前缀。但这样存在一个问题,用户获取到这个Policy后,在失效期内都能修改上传前缀,从而上传到别人的目录下。解决方法为,在应用服务器端就指定用户上传文件的前缀。如果用户获取了Policy也没有办法上传到别人的目录,从而保证了数据的安全性。

  • 设置应用服务器的地址

    在客户端源码upload.js文件中,如下代码片段的变量serverUrl的值可以用来设置签名服务器的URL,设置好之后,客户端会向该serverUrl发送GET请求来获取需要的信息。

    // serverUrl是 用户获取签名和Policy等信息的应用服务器的URL,请将下面的IP和Port配置为您自己的真实信息。
    serverUrl = 'http://88.88.88.88:8888'