search

qiniu / js-sdk

Qiniu Cloud JavaScript SDK
1.39k stars 519 forks source link

readme

Qiniu-JavaScript-SDK

Build Status GitHub release Coverage Status

基于七牛 API 开发的前端 JavaScript SDK

当前版本为 3.x，旧版本文档：2.x、1.x

2.x 升级到 3.x 的注意事项请参考 文档

4.x 正在迭代中，已经发布测试版本，同时在 4.x 的分支我们添加了小程序、鸿蒙、浏览器 Webworker 的支持，详细信息请切换到 4.x 分支查看

快速导航

概述

Qiniu-JavaScript-SDK （下文简称为 JS-SDK）适用于 ：IE11、Edge、Chrome、Firefox、Safari 等浏览器，基于七牛云存储官方 API 构建，其中上传功能基于 H5 File API。开发者基于 JS-SDK 可以方便的从浏览器端上传文件至七牛云存储，并对上传成功后的图片进行丰富的数据处理操作。 JS-SDK 兼容支持 H5 File API 的浏览器，在低版本浏览器下，需要额外的插件如 plupload，JS-SDK 提供了一些接口可以结合插件来进行上传工作，注意：(在低版本浏览器需要引入 babel-polyfill 来解决 SDK 里某些语法或者属性浏览器不能识别的问题)。

Qiniu-JavaScript-SDK 为客户端 SDK，没有包含 token 生成实现，为了安全，token 建议通过网络从服务端获取，具体生成代码可以参考以下服务端 SDK 的文档。

Qiniu-JavaScript-SDK 的示例 Demo 中的服务器端部分是基于 Node.js 服务器端 SDK 开发的。

功能简介

准备

引入

支持以下几种安装方式

git clone git@github.com:qiniu/js-sdk.git，进入项目根目录执行 npm install ，执行 npm run build，即可在dist 目录生成 qiniu.min.js。

使用

qiniu.upload 返回一个 observable 对象用来控制上传行为，observable 对像通过 subscribe 方法可以被 observer 所订阅，订阅同时会开始触发上传，同时返回一个 subscription 对象，该对象有一个 unsubscribe 方法取消订阅，同时终止上传行为。对于不支持 SDK 的浏览器可以参考 demo1 中用插件处理和 form 直传的方式； 一般 form 提交常常会导致网页跳转，demo1 中 form 直传通过加入 iframe，并结合后端 SDK 上传来解决网页跳转问题，实现 form 无刷新上传。分片上传时，JS-SDK支持断点续传功能，会把已上传片的后端返回值ctx信息存储到本地，有效期为一天，超过一天后，当继续上传该文件时会清除掉本地存储信息重新上传。

Example

文件上传：


const observable = qiniu.upload(file, key, token, putExtra, config)

const subscription = observable.subscribe(observer) // 上传开始
// or
const subscription = observable.subscribe(next, error, complete) // 这样传参形式也可以

subscription.unsubscribe() // 上传取消

图片上传前压缩：

const options = {
  quality: 0.92,
  noCompressIfLarger: true
  // maxWidth: 1000,
  // maxHeight: 618
}
qiniu.compressImage(file, options).then(data => {
  const observable = qiniu.upload(data.dist, key, token, putExtra, config)
  const subscription = observable.subscribe(observer) // 上传开始
})

API Reference Interface

qiniu.upload(file: File, key: string, token: string, putExtra?: object, config?: object): observable

qiniu.region: object

qiniu.getUploadUrl(config: object, token: string): Promise

接收参数为 config 对象，返回根据 config 里所配置信息的上传域名

  qiniu.getUploadUrl(config, token).then(res => {}) // res 即为上传的 url

qiniu.getHeadersForChunkUpload(token: string): object

返回 object，包含用来获得分片上传设置的头信息，参数为 token 字符串；当分片上传时，请求需要带该函数返回的头信息

qiniu.deleteUploadedChunks(token: string, key: stting, uploadInfo: object): Promise

删除指定上传任务中已上传完成的片，key 为目标文件名，uploadInfo 可通过 next 的返回获取，token 由服务端生成

qiniu.compressImage(file: File, options: object): Promise (上传前图片压缩)

在 v3.3.3 版本之前，该压缩行为会根据图片的 Orientation(设备角度) 信息对图片进行旋转处理，详细的信息可以参考 issue：关于 canvas 绘制图像的方向兼容处理

  const imgLink = qiniu.compressImage(file, options).then(res => {
    // res : {
    //   dist: 压缩后输出的 Blob 对象或原始的 File 对象，具体看下面的 options 配置
    //   width: 压缩后的图片宽度
    //   height: 压缩后的图片高度
    // }
    }
  })

qiniu.watermark(options: object, key?: string, domain?: string): string（水印）

返回添加水印后的图片地址

qiniu.imageView2(options: object, key?: string, domain?: string): string (缩略)

返回处理后的图片url

  const imgLink = qiniu.imageView2({
     mode: 3,       // 缩略模式，共 6 种 [0-5]
     w: 100,        // 具体含义由缩略模式决定
     h: 100,        // 具体含义由缩略模式决定
     q: 100,        // 新图的图像质量，取值范围：1-100
     format: 'png'  // 新图的输出格式，取值范围：jpg，gif，png，webp 等
   }, key, domain)

options包含的具体缩略参数解释见 图片基本处理（imageView2）

qiniu.imageMogr2(options: object, key?: string, domain?: string): string (图像高级处理)

返回处理后的图片url

  const imgLink = qiniu.imageMogr2({
     "auto-orient": true,      // 布尔值，是否根据原图EXIF信息自动旋正，便于后续处理，建议放在首位。
     strip: true,              // 布尔值，是否去除图片中的元信息
     thumbnail: '1000x1000'    // 缩放操作参数
     crop: '!300x400a10a10',   // 裁剪操作参数
     gravity: 'NorthWest',     // 裁剪锚点参数
     quality: 40,              // 图片质量，取值范围1-100
     rotate: 20,               // 旋转角度，取值范围1-360，缺省为不旋转。
     format: 'png',            // 新图的输出格式，取值范围：jpg，gif，png，webp等
     blur: '3x5'               // 高斯模糊参数
   }, key, domain)

options包含的具体高级图像处理参数解释见 图像高级处理（imageMogr2）

qiniu.imageInfo(key: string, domain: string): Promise

  qiniu.imageInfo(key, domain).then(res => {})

具体 imageInfo 解释见 图片基本信息（imageInfo）

qiniu.exif(key: string, domain: string): Promise

  qiniu.exif(key, domain).then(res => {})

具体 exif 解释见 图片 EXIF 信息（exif）

qiniu.pipeline(fopArr: array, key?: string, domain?: string): string

  const fopArr = [{
      fop: 'watermark', // 指定watermark操作
      mode: 2,          // 此参数同watermark函数的参数，下同。
      text: 'hello world !',
      dissolve: 50,
      gravity: 'SouthWest',
      fontsize: 500,
      font : '黑体',
      dx: 100,
      dy: 100,
      fill: '#FFF000'
  },{
      fop: 'imageView2', // 指定imageView2操作
      mode: 3,           // 此参数同imageView2函数的参数，下同
      w: 100,
      h: 100,
      q: 100,
      format: 'png'
  },{
      fop: 'imageMogr2',  // 指定imageMogr2操作
      "auto-orient": true,  // 此参数同imageMogr2函数的参数，下同。
      strip: true,
      thumbnail: '1000x1000'
      crop: '!300x400a10a10',
      gravity: 'NorthWest',
      quality: 40,
      rotate: 20,
      format: 'png',
      blur:'3x5'
  }]

  // fopArr 可以为三种类型'watermark'、'imageMogr2'、'imageView2'中的任意1-3个
  // 例如只对'watermark'、'imageMogr2'进行管道操作，则如下即可
  // const fopArr = [{
  //    fop: 'watermark', // 指定watermark操作
  //    mode: 2, // 此参数同watermark函数的参数，下同。
  //    text: 'hello world !',
  //    dissolve: 50,
  //     gravity: 'SouthWest',
  //     fontsize: 500,
  //     font : '黑体',
  //     dx: 100,
  //     dy: 100,
  //     fill: '#FFF000'
  // },{
  //    fop: 'imageMogr2',  // 指定imageMogr2操作
  //    "auto-orient": true,  // 此参数同imageMogr2函数的参数，下同。
  //    strip: true,
  //    thumbnail: '1000x1000'
  //    crop: '!300x400a10a10',
  //    gravity: 'NorthWest',
  //    quality: 40,
  //    rotate: 20,
  //    format: 'png',
  //    blur:'3x5'
  // }];

  const imgLink = qiniu.pipeline(fopArr, key, domain))

fopArr包含的具体管道操作解释见 管道操作

运行示例

  1. 进入 test 目录，按照目录下的 config.json.example 示例，创建 config.json 文件，其中，Access Key 和 Secret Key 按如下方式获取

    {
 "AccessKey": "<Your Access Key>",
 "SecretKey": "<Your Secret Key>",
 "Bucket": "<Your Bucket Name>",
 "Port": 9000,
 "UptokenUrl": "<Your Uptoken_Url>", // demo 启动后会在本地 /uptoken 上提供获取 uptoken 的接口，所以这里可以填 'token'
 "Domain": "<Your Bucket Domain>" // Bucket 的外链默认域名，在 Bucket 的内容管理里查看，如：'http://xxx.bkt.clouddn.com/'
}

  2. 进入项目根目录，执行 npm install 安装依赖库，然后打开两个终端，一个执行 npm run serve 跑 server， 一个执行 npm run dev 运行服务；demo1：http://0.0.0.0:8080/test/demo1；demo3：http://0.0.0.0:8080/test/demo3；demo1为测试上传功能的示例，demo3为测试图片压缩功能的示例；demo2 为测试 es6 语法的示例，进入 demo2 目录，执行 npm install，然后 npm start 运行 demo2；demo1、demo2 和 demo3 都共用一个 server，请注意 server 文件里的 region 设置跟 config 里的region 设置要保持一致。

说明

  1. 如果您想了解更多七牛的上传策略，建议您仔细阅读 七牛官方文档-上传。另外，七牛的上传策略是在后端服务指定的.

  2. 如果您想了解更多七牛的图片处理，建议您仔细阅读 七牛官方文档-图片处理

  3. JS-SDK 示例生成 token 时，指定的 Bucket Name 为公开空间，所以可以公开访问上传成功后的资源。若您生成 token 时，指定的 Bucket Name 为私有空间，那您还需要在服务端进行额外的处理才能访问您上传的资源。具体参见 下载凭证。JS-SDK 数据处理部分功能不适用于私有空间。

常见问题

1. 关于上传文件命名问题，可以参考：

  1. 上传的 scope 为 bucket 的形式，上传后文件资源名以设置的 key 为主，如果 key 为 null 或者 undefined，则文件资源名会以 hash 值作为资源名。
  2. 上传的 scope 为 bucket:key 的形式，上传文件本地的名字需要和 scope 中的 key 是一致的，不然会报错 key doesn‘t match with scope。
  3. 上传的 scope 为 bucket，但是 token 中有设定 saveKey，这种形式下客户端的 key 如果设定为 null 或者 undefined，则会以 saveKey 作为文件资源名，否则仍然是以 key 值作为资源名，并且上传的本地文件名也是需要和这个 savekey 文件名一致的。

2. 限制上传文件的类型：

通过在生成 token 时指定 上传策略 中的 mimeLimit 字段限定上传文件的类型，该功能由生成 token 的服务端 SDK 提供，请查看对应的服务端 SDK 文档。

贡献代码

  1. 登录 https://github.com

  2. Fork git@github.com:qiniu/js-sdk.git

  3. 创建您的特性分支 (git checkout -b new-feature)

  4. 提交您的改动 (git commit -am 'Added some features or fixed a bug')

  5. 将您的改动记录提交到远程 git 仓库 (git push origin new-feature)

  6. 然后到 github 网站的该 git 远程仓库的 new-feature 分支下发起 Pull Request

许可证

Copyright (c) 2018 qiniu.com

基于 MIT 协议发布