Skip to content

Commit

Permalink
update csg doc
Browse files Browse the repository at this point in the history
  • Loading branch information
carsonxu committed Oct 29, 2018
1 parent e4d3d11 commit 52729cb
Show file tree
Hide file tree
Showing 5 changed files with 2,354 additions and 209 deletions.
90 changes: 4 additions & 86 deletions csp/README.md
Original file line number Diff line number Diff line change
@@ -1,89 +1,7 @@
# CSP 使用 COS JavaScript SDK
# COS JavaScript SDK 私有化使用文档

### SDK 获取
[快速入门](./start.md)

对象存储服务的 XML JS SDK 资源 github 地址:[tencentyun/cos-js-sdk-v5](https://github.com/tencentyun/cos-js-sdk-v5)
[API 文档](./api.md)

演示示例 Demo 下载地址:[XML JS SDK CSP Demo](https://github.com/tencentyun/cos-js-sdk-v5/tree/master/csp/csp.html)

### 开发准备

1. 首先,JS SDk 需要浏览器支持基本的 HTML5 特性,以便支持 ajax 上传文件和计算文件 md5 值。
2. 到COS 对象存储控制台创建存储桶,得到 Bucket(存储桶名称) 和 Region(地域名称)
3. 到控制台密钥管理获取您的项目 SecretId 和 SecretKey。
4. 配置 CORS 规则,配置例子如下图:
![cors](//mc.qcloudimg.com/static/img/2e7791e9274ce3ebf8b25bbeafcd7b45/image.png)

> 关于文章中出现的 SecretId、SecretKey、Bucket 等名称的含义和获取方式请参考:[COS 术语信息](https://cloud.tencent.com/document/product/436/7751)
## 快速入门
### 计算签名

由于签名计算放在前端会暴露 SecretId 和 SecretKey,我们把签名计算过程放在后端实现,前段通过 ajax 向后端获取签名结果,正式部署时请再后端加一层自己网站本身的权限检验。其他语言,请参照对应的 [XML SDK](https://cloud.tencent.com/document/product/436/6474) 文档。


### 上传例子

1. 创建 test.html,填入下面的代码,修改里面的 Bucket 和 Region。
2. 部署好后端的签名服务,并修改 getAuthorization 里的签名服务地址。
3. 把 test.html 放在 Web 服务器下,然后在浏览器访问页面,测试文件上传。

```html
<input id="file-selector" type="file">
<script src="dist/cos-js-sdk-v5.min.js"></script>
<script>
var Bucket = 'test-1250000000';
var Region = 'ap-guangzhou';
// 初始化实例
var cos = new COS({
CompatibilityMode: true,
ServiceDomain: 'http://cos.default.xxx.com', // 这里替换成 getService 域名
Domain: 'http://{Bucket}.cos.{Region}.xxx.com', 这里替换成 API 域名格式模板
getAuthorization: function (options, callback) {
// 异步获取签名
$.get('../server/sts.php', {
bucket: options.Bucket,
region: options.Region,
}, function (data) {
callback({
TmpSecretId: data.TmpSecretId,
TmpSecretKey: data.TmpSecretKey,
XCosSecurityToken: data.XCosSecurityToken,
ExpiredTime: data.ExpiredTime,
});
});
}
});
// 监听选文件
document.getElementById('file-selector').onchange = function () {
var file = this.files[0];
if (!file) return;
// 分片上传文件
cos.sliceUploadFile({
Bucket: Bucket,
Region: Region,
Key: file.name,
Body: file,
}, function (err, data) {
console.log(err, data);
});
};
</script>
```

## webpack 引入方式

支持 webpack 打包的场景,可以用 npm 引入作为模块
```shell
npm i cos-js-sdk-v5 --save
```

## 其他文档和例子

1. 更多例子请参阅 [XML JavaScript SDK Demo](https://github.com/tencentyun/cos-js-sdk-v5/blob/master/demo)
2. 完整接口文档请参阅 [XML JavaScript SDK 接口文档](https://cloud.tencent.com/document/product/436/12260)
[示例代码](./csp.html)
Loading

0 comments on commit 52729cb

Please sign in to comment.