表单上传功能适用于文件内容可以在一次HTTP请求即可传递完成的场景。该功能非常适合于在浏览器中使用HTML表单上传资源,或者在不需要处理复杂情况的客户端开发中使用。
开发者只要组装一个符合HTML文件上传表单规范(参见RFC1867)的HTTP请求,并以POST方式向域名upload.qiniu.com
发起这个请求,即可将指定文件上传到服务端。业务逻辑非常简单明了。
使用方法
我们可以用如下的HTML表单来描述表单上传的基本用法:
<form method="post" action="http://upload.qiniu.com/"
enctype="multipart/form-data">
<input name="key" type="hidden" value="<resource_key>">
<input name="x:<custom_name>" type="hidden" value="<custom_value>">
<input name="token" type="hidden" value="<upload_token>">
<input name="file" type="file" />
<input name="crc32" type="hidden" />
<input name="accept" type="hidden" />
</form>
HTML表单上传的几个关键参数说明如下:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
token | string | 是 | 必须是一个符合相应规格的上传凭证,否则会返回401表示权限认证失败。 |
file | file | 是 | 文件本身。 |
key | string | 否 | 资源名,必须为UTF-8编码。注: 如果在生成上传凭证的上传策略 中 scope 指定为:<bucket>:<key> , 则该字段也必须指定。 |
x: | string | 否 | 自定义变量,必须以 x: 开头命名,不限个数。里面的内容将在 callbackBody 参数中的 $(x:custom_field_name) 求值时使用。 |
crc32 | string | 否 | 上传内容的 CRC32 校验码。如填入,则七牛服务器会使用此值进行内容检验。 |
accept | string | 否 | 当 HTTP 请求指定 Accept 头部时,七牛会返回的 Content-Type 头部的值。该值用于兼容低版本 IE 浏览器行为。低版本 IE 浏览器在 multiform 返回 application/json 的时候会表现为下载,返回text/plain 才会显示返回内容。 |
上传过程在一个HTTP请求和响应中完成,因此该过程将阻塞直到文件传输成功完成或失败为止。如果文件较大,或者网络环境较差,可能会导致HTTP连接超时而上传失败。若发生这种情况,开发者需要考虑换用更安全但也相对复杂的分片上传功能。
提交以上这个HTML表单而生成的HTTP请求内容大致如下所示:
POST http://upload.qiniu.com/
Content-Type: multipart/form-data; boundary=<Boundary>
--<Boundary>
Content-Disposition: form-data; name="key"
<resource_key>
--<Boundary>
Content-Disposition: form-data; name="x:<custom_field_name>"
<custom_value>
--<Boundary>
Content-Disposition: form-data; name="token"
<upload_token>
--<Boundary>
Content-Disposition: form-data; name="file"; filename="[文件名]"
Content-Type: <MimeType>
[文件内容]
--<Boundary>--
在非网页开发的场景中,开发者完全可以自行组装这个HTML表单请求。考虑到各个平台上的网络库都已经对HTML文件上传表单有非常完整的支持,组装这个请求的过程将会非常轻松。
后续动作
我们可以在生成上传凭证时指定一系列的参数,以控制服务器在文件上传完成后的后续动作。我们将在上传后续动作中详细描述各种参数的用法和作用。
另外如果需要,我们可以在表单参数中增加一系列的魔法变量和自定义变量。上述表单例子中的``就是变量的使用方法示意。我们可以将其更换为一系列魔法变量或自定义变量。