Web端直传实践
最近更新时间: 2025-02-18 16:02:00
本文档介绍如何不依赖 SDK，用简单的代码，在网页（Web 端）直传文件到 COS 的存储桶。
本文档内容基于 XML API 。
一、前期准备
- 登录 COS 控制台 并创建存储桶，得到 Bucket（存储桶名称） 和 Region（地域名称）。
- 登录 控制台密钥管理 获取您的项目 SecretId 和 SecretKey。
- 在 COS 控制台，单击新建的存储桶名称，进入存储桶的文件列表页面。
- 单击【基础配置】页签，配置 CORS 规则。
二、计算签名
签名计算放在前端会暴露 SecretKey，因此我们把签名计算过程放在后端实现，前端通过 AJAX 向后端获取签名结果，正式部署时请在后端加一层您的网站本身的权限检验。 指引参考 PHP 和 Node.js 的签名示例，其他语言请参照对应的 XML SDK 文档。
三、前端上传
方案 A：使用 AJAX 上传
AJAX 上传需要浏览器支持基本的 HTML5 特性，当前方案使用的是 XML API 的 PutObject 接口，操作指引：
- 按照 步骤一、前期准备 的步骤，准备好存储桶。
- 创建
test.html文件，修改下方代码的 Bucket 和 Region，复制到test.html文件。 - 部署好后端的签名服务，并修改
test.html里的签名服务地址。 - 把
test.html放在 Web 服务器下，然后在浏览器访问页面，测试文件上传功能。
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Ajax Put 简单上传</title>
<style>
h1, h2 {
font-weight: normal;
}
#msg {
margin-top: 10px;
}
</style>
</head>
<body>
<h1>Ajax Put 上传</h1>
<div>最低兼容到 ie10，支持 onprogress</div>
<input id="fileSelector" type="file">
<input id="submitBtn" type="submit">
<div id="msg"></div>
<script>
(function () {
// 请求用到的参数
var Bucket = 'test-1250000000';
var Region = 'ap-guangzhou';
var protocol = location.protocol === 'https:' ? 'https:' : 'http:';
var prefix = protocol + '//' + Bucket + '.cos.' + Region + '.myqcloud.com/';
// 计算签名
var getAuthorization = function (options, callback) {
var method = (options.Method || 'get').toLowerCase();
var key = options.Key || '';
var pathname = key.indexOf('/') === 0 ? key : '/' + key;
var url = '../server/auth.php';
var xhr = new XMLHttpRequest();
var data = {
method: method,
pathname: pathname,
};
xhr.open('POST', url, true);
xhr.setRequestHeader('content-type', 'application/json');
xhr.onload = function (e) {
if (e.target.responseText === 'action deny') {
alert('action deny');
} else {
callback(e.target.responseText);
}
};
xhr.send(JSON.stringify(data));
};
// 上传文件
var uploadFile = function (file, callback) {
var Key = 'dir/' + file.name; // 这里指定上传目录和文件名
getAuthorization({Method: 'PUT', Key: Key}, function (auth) {
var url = prefix + Key;
var xhr = new XMLHttpRequest();
xhr.open('PUT', url, true);
xhr.setRequestHeader('Authorization', auth);
xhr.onload = function () {
if (xhr.status === 200 || xhr.status === 206) {
var ETag = xhr.getResponseHeader('etag');
callback(null, {url: url, ETag: ETag});
} else {
callback('文件 ' + Key + ' 上传失败，状态码：' + xhr.status);
}
};
xhr.onerror = function () {
callback('文件 ' + Key + ' 上传失败，请检查是否没配置 CORS 跨域规则');
};
xhr.send(file);
});
};
// 监听表单提交
document.getElementById('submitBtn').onclick = function (e) {
var file = document.getElementById('fileSelector').files[0];
if (!file) {
document.getElementById('msg').innerText = '未选择上传文件';
return;
}
file && uploadFile(file, function (err, data) {
console.log(err || data);
document.getElementById('msg').innerText = err ? err : ('上传成功，ETag=' + data.ETag);
});
};
})();
</script>
</body>
</html>执行效果如下图：
方案 B：使用 Form 表单上传
Form 表单上传支持低版本的浏览器的上传（如 IE8），当前方案使用的是 XML API 的 PostObject 接口。操作指引：
- 按照 步骤一、前期准备 的步骤，准备好存储桶。
- 创建
test.html文件，修改下方代码的 Bucket 和 Region，复制到test.html文件。 - 部署好后端的签名服务，并修改
test.html里的签名服务地址。 - 在
test.html同一个目录下创建一个空的empty.html，用于上传成功时跳转回来。 - 把
test.html和empty.html放在 Web 服务器下，然后在浏览器访问页面，测试文件上传功能。
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Form 表单简单上传</title>
<style>h1, h2 {font-weight: normal;}#msg {margin-top:10px;}</style>
</head>
<body>
<h1>Form 表单简单上传（兼容 IE8）</h1>
<div>最低兼容到 ie6 上传，不支持 onprogress</div>
<form id="form" target="submitTarget" action="" method="post" enctype="multipart/form-data" accept="*/*">
<input id="name" name="name" type="hidden" value="">
<input name="success_action_status" type="hidden" value="200">
<input id="success_action_redirect" name="success_action_redirect" type="hidden" value="">
<input id="key" name="key" type="hidden" value="">
<input id="Signature" name="Signature" type="hidden" value="">
<input id="x-cos-security-token" name="x-cos-security-token" type="hidden" value="">
<input id="fileSelector" name="file" type="file">
<input id="submitBtn" type="button" value="提交">
</form>
<iframe id="submitTarget" name="submitTarget" style="display:none;" frameborder="0"></iframe>
<div id="msg"></div>
<script>
(function () {
// 请求用到的参数
var Bucket = 'test-1250000000';
var Region = 'ap-guangzhou';
var protocol = location.protocol === 'https:' ? 'https:' : 'http:';
var prefix = protocol + '//' + Bucket + '.cos.' + Region + '.myqcloud.com/';
var form = document.getElementById('form');
form.action = prefix;
// 计算签名
var getAuthorization = function (options, callback) {
var method = (options.Method || 'get').toLowerCase();
var key = options.Key || '';
// var url = 'http://127.0.0.1:3000/sts-post-object' +
var url = '../server/sts-post-object.php' +
'?method=' + method +
'&pathname=' + encodeURIComponent('/') +
'&key=' + encodeURIComponent(key);
var xhr = new XMLHttpRequest();
xhr.open('GET', url, true);
xhr.onreadystatechange = function (e) {
if (xhr.readyState === 4) {
if (xhr.status === 200) {
var data = JSON.parse(xhr.responseText);
callback(null, {
Authorization: data.authorization,
XCosSecurityToken: data.sessionToken,
});
} else {
callback('获取签名出错');
}
}
};
xhr.send();
};
// 监听上传完成
var Key;
var submitTarget = document.getElementById('submitTarget');
var showMessage = function (err, data) {
console.log(err || data);
document.getElementById('msg').innerText = err ? err : ('上传成功，ETag=' + data.ETag);
};
submitTarget.onload = function () {
var search;
try {
search = submitTarget.contentWindow.location.search.substr(1);
} catch (e) {
showMessage('文件 ' + Key + ' 上传失败');
}
if (search) {
var items = search.split('&');
var i, arr, data = {};
for (i = 0; i < items.length; i++) {
arr = items[i].split('=');
data[arr[0]] = decodeURIComponent(arr[1] || '');
}
showMessage(null, {url: prefix + Key, ETag: data.etag});
} else {
}
};
// 发起上传
document.getElementById('submitBtn').onclick = function (e) {
var filePath = document.getElementById('fileSelector').value;
if (!filePath) {
document.getElementById('msg').innerText = '未选择上传文件';
return;
}
Key = 'dir/' + filePath.match(/[\\\/]?([^\\\/]+)$/)[1]; // 这里指定上传目录和文件名
getAuthorization({Method: 'POST', Key: Key}, function (err, AuthData) {
// 在当前目录下放一个空的 empty.html 以便让接口上传完成跳转回来
document.getElementById('success_action_redirect').value = location.href.substr(0, location.href.lastIndexOf('/') + 1) + 'empty.html';
document.getElementById('key').value = Key;
document.getElementById('Signature').value = AuthData.Authorization;
document.getElementById('x-cos-security-token').value = AuthData.XCosSecurityToken;
form.submit();
});
};
})();
</script>
</body>
</html>执行效果如下图：
相关文档
若您有更丰富的接口调用需求，请参考JavaScript SDK文档。