更新记录

1.1.6(2020-09-14)

  • 修复部分情况下微信小程序token校验失败的Bug

1.1.5(2020-09-05)

  • 登录成功返回用户信息
  • 修复获取用户信息是不传field未返回全部字段的Bug
查看更多

云函数类插件通用教程

  1. 使用云函数类插件的前提是:使用HBuilderX 2.7+;已通过实名认证并开通了uniCloud。
  2. 如果下载的是完整项目,则需要在manifest.json的可视化界面获取appid。
  3. 需要对cloudfunctions目录点右键,绑定服务空间。如无服务空间,需先创建。建议在测试服务空间体验插件,避免对现网项目产生影响。
  4. 对cloudfunctions目录点右键上传所有云函数。在HBuilderX 2.7.8以前,如有common目录,还需单独对每个common目录下的公共模块上传。
  5. 如果cloudfunctions目录下有db_init.json,请点击右键,初始化云数据库。
  6. 通过以上步骤,完成uniCloud服务空间的初始化和云函数部署。然后就可以在HBuilderX的运行菜单里运行该项目,体验云端一体完整流程。

需求背景

99%的应用,都要开发用户注册、登录、发送短信验证码、密码加密保存、修改密码、token管理等功能,从前端到后端都需要。

为什么不能有一个开源的通用项目,避免大家的重复开发呢?

uni-id应需而生。

uni-iduniCloud开发者提供了简单、统一、可扩展的用户管理能力封装。

组成部分

uni-id包括如下组成部分:

  1. 云数据库

主表为 uni-id-users 表,保存用户的基本信息。

扩展字段有很多,如实名认证数据、工作履历数据,开发者可以自由扩展。

  1. 云函数

提供一个名为uni-id的公共模块,该模块封装了一系列API,包括注册、登录、修改密码、设置头像等。

示例工程中还提供了一个user-center的云函数,演示在云函数中如何调用uni-id公共模块。

  1. 前端调用

前端示例通过callfunction调用云函数user-center,在注册和登录时保存token。

uniCloud框架底层,会自动在callfunction时传递uni-id的token(uni-app 2.7.13+版本)。在云函数的event中可直接拿到uni-id的token。也就是说开发者无需自己管理token了。

uni-id 对开发者的价值

  1. 节省了大量重复劳动
  2. 降低门槛,前端开发者无需纠结怎样设计数据库设计才更合理
  3. 多系统打通用户和上下游协同

关于第三点,着重强调下。

一个应用,往往需要集成多个功能模块。比如一个电商应用,需要一个基本电商模板,还需要客服聊天模板,甚至还需要用户交流社区。

在插件市场,每类模板插件都能找到,但他们如果不是基于同一套用户体系设计,就很难整合。

DCloud推荐所有uniCloud的应用,都基于uni-id来做。

有了统一的账户规范,并且围绕这套账户规范,有各种各样插件,那么开发者可以随意整合这些插件,让数据连同。

规范,还可以让上下游充分协同。插件市场会出现各种数据迁移插件,比如把从discuz里把用户迁移到uni-id中的插件,相信围绕这套规范的产业链会非常活跃。

现状和未来

uni-id已完整的内容:

  • 注册、登录、发送短信验证码、密码加密保存、修改密码、token管理(短信验证码功能需要HBuilderX 2.8.3+)
  • 三方登录:App中的微信登录、微信小程序中的微信登录、支付宝小程序中的支付宝账户登录

关于还缺少的部分,哪些DCloud在完善,哪些希望开发者给共同完善开源项目,计划与边界公布如下:

  1. 部分社交账户登录

DCloud暂无计划开发百度、头条、QQ等小程序的登录,以及Apple ID、微博、QQ等App端的登录。欢迎其他开发者在开源项目上提交pr,共同完善uni-id

  1. 邮箱验证和手机号一键认证sdk集成

手机号一键认证sdk,目前插件市场里已经有不少相关插件,未来DCloud会整合到uni-id中。邮箱验证,DCloud暂无计划开发,有需求的开发者欢迎提供pr。

  1. 实名认证、活体检测

目前插件市场里已经有不少相关插件,未来DCloud会整合到uni-id中。

  1. 权限管理ACL

这部分欢迎开发者参与完善。

其他方面,各种常见开源项目如discuz、wordPress、ecshop的用户导入插件,不属于uni-id主工程,欢迎开发者单独提交插件到插件市场。

uni-id的git仓库:https://gitee.com/dcloud/uni-id.git

快速上手

使用uni-id需要按照以下步骤操作

  1. 准备2.7.14或以上版本的HBuilderX
  2. 插件市场导入uni-id公用模块,插件市场 uni-id
  3. 修改公用模块uni-id下的config.json内所需参数(请参考下面config.json的说明)
  4. 上传cloudfunctions/common下的uni-id模块
  5. 按照公用模块使用说明在云函数下安装uni-id模块
  6. 创建uni-id-usersuni-verify集合(可以直接使用示例项目里面的db_init.json进行初始化)

或者直接导入uni-id在插件市场的示例工程

导入示例项目时,如果选择腾讯云,在HBuilderX2.7及以下版本中,需要进入项目目录,手动将目录cloudfunctions-aliyun改名为cloudfunctions-tcb,然后在HBuilderX中右键cloudfunctions绑定服务空间。

config.json的说明

注意:

  • config.json是一个标准json文件,不支持注释
  • 如果不希望使用config.json初始化而是想自行传入参数,可以使用init方法uniID.init

配置项:

  • passwordSecret为用于加密密码入库的密钥
  • tokenSecret为生成token需要的密钥
  • tokenExpiresIntoken有效期,以秒为单位
  • passwordErrorLimit密码错误重试次数,分ip记录密码错误次数,达到重试次数之后等待passwordErrorRetryTime时间之后才可以重试
  • passwordErrorRetryTime单位为秒
  • 如果使用sendSmsCode接口发送短信需要前往https://dev.dcloud.net.cn/uniSms充值短信额度,配置config.jsonservice字段,字段说明见下方示例
  • 如果使用其他方式发送短信可以参考sendSmsCode接口的实现uni-id sendSmsCode
  • 另外可以按照客户端平台进行不同的配置,参考下面示例
// 如果拷贝此内容切记去除注释
{
    "passwordSecret": "passwordSecret-demo", // 加密密码所用的密钥,注意修改为自己的
    "tokenSecret": "tokenSecret-demo", // 生成token所用的密钥,注意修改为自己的
    "tokenExpiresIn": 7200, // 全平台token过期时间,未指定过期时间的平台会使用此值
    "bindTokenToDevice": true, // 是否将token和设备绑定,设置为true会进行ua校验,默认为true
    "passwordErrorLimit": 6, // 密码错误最大重试次数
    "passwordErrorRetryTime": 3600, // 密码错误重试次数超限之后的冻结时间
  "autoSetInviteCode": false, // 是否在用户注册时自动设置邀请码,默认不自动设置
  "forceInviteCode": false, // 是否强制用户注册时必填邀请码,默认为false(需要注意的是目前只有短信验证码注册才可以填写邀请码)
  "app-plus": {
        "tokenExpiresIn": 2592000,
        "oauth": {
            // App微信登录所用到的appid、appsecret需要在微信开放平台获取,注意:不是公众平台而是开放平台
            "weixin": {
                "appid": "weixin appid",
                "appsecret": "weixin appsecret"
            }
        }
    },
    "mp-weixin": {
        "oauth": {
            // 微信小程序登录所用的appid、appsecret需要在对应的小程序管理控制台获取
            "weixin": {
                "appid": "weixin appid",
                "appsecret": "weixin appsecret"
            }
        }
    },
    "mp-alipay": {
        "oauth": {
            // 支付宝小程序登录用到的appid、privateKey请参考支付宝小程序的文档进行设置或者获取,https://opendocs.alipay.com/open/291/105971#LDsXr
            "alipay": {
                "appid": "alipay appid",
                "privateKey": "alipay privateKey"
            }
        }
    },
    "service": {
        "sms": {
            "name": "your app name", // 应用名称,对应短信模版的name
            "codeExpiresIn": 180, // 验证码过期时间,单位为秒,注意一定要是60的整数倍
            "smsKey": "your sms key", // 短信密钥key,开通短信服务处可以看到
            "smsSecret": "your sms secret" // 短信密钥secret,开通短信服务处可以看到
        }
    }
}

API列表

用户注册 @register

用法uniID.register(Object user)

注意

  • 注册成功之后会返回token,在获取token之后应进行持久化存储,键值为:uniIdToken,uni.setStorageSync('uniIdToken',res.result.token)

user参数说明

字段 类型 必填 说明
username String 用户名,唯一
password String 密码
myInviteCode String 自行设置用户的邀请码

username可以是字符串、可以是email、可以是手机号,本插件不约束,开发者可以自己定。

比如要求username为手机号,则自行在前端界面上做好提示,在后台对格式进行校验。

password入库时会自动进行一次sha1加密,不明文存储密码。

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
token String - 注册完成自动登录之后返回的token信息
tokenExpired String - token过期时间

示例代码

// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const {
        username,
        password
    } = event
    // username、password验证是否合法的逻辑
    const res = await uniID.register({
        username,
        password
    })
    return res
}
// 客户端代码
uniCloud.callFunction({
    name: 'register',
    data: {
        username: 'username',
        password: 'user password'
    },
    success(res){
        if(res.result.code === 0) {
      // 目前版本是驼峰形式uniIdToken,后面会调整为蛇形uni_id_token(调整后会在一段时间内兼容驼峰)
            uni.setStorageSync('uniIdToken',res.result.token)
            // 其他业务代码,如跳转到首页等
            uni.showToast({
                title: '注册成功',
                icon: 'none'
            })
        } else {
            uni.showModal({
                content: res.result.msg,
                showCancel: false
            })
        }
    },
    fail(){
        uni.showModal({
            content: '注册失败,请稍后再试',
            showCancel: false
        })
    }
})

用户登录 @login

用法:uniID.login(Object user)

注意

  • 登录成功之后会返回token,在获取token之后应进行持久化存储,键值为:uniIdToken,uni.setStorageSync('uniIdToken',res.result.token)

user参数说明

字段 类型 必填 说明
username String 用户名
password String 密码
queryField Array 指定从哪些字段中比对username,不填默认与数据库内的username字段对比, 可取值'username'、'email'、'mobile'

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
token String - 登录成功之后返回的token信息
tokenExpired String - token过期时间

示例代码

// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const {
        username,
        password
    } = event
    // username、password验证是否合法的逻辑
    const res = await uniID.login({
        username,
        password,
    queryField: ['username', 'email', 'mobile']
    })
    return res
}

token校验

用法:uniID.checkToken(String token)

参数说明

字段 类型 必填 说明
token String 客户端callFunction带上的token

响应参数

字段 类型 说明
code Number 错误码,0表示成功
msg String 详细信息
uid String 用户Id,校验成功之后会返回
userInfo Object 用户信息,uid对应的uni-id-users全部字段

注意:

  • 2.7.14+ 客户端会自动查找storage内的token在callFunction时插入
  • 2.7.14 版本token存储在storage内使用的是驼峰形式的键值uniIdToken,下版会调整为蛇形uni_id_token,调整后会在一段时间内兼容驼峰形式

示例代码

const uniID = require('uni-id')
exports.main = async function(event,context) {
    const payload = await uniID.checkToken(event.uniIdToken)
    return payload
}

修改密码 @update-password

用法:uniID.updatePwd(Object passwordInfo)

passwordInfo参数说明

字段 类型 必填 说明
uid String 用户Id,可以通过checkToken返回
oldPassword String 旧密码
newPassword String 新密码
passwordConfirmation String 确认新密码

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息

示例代码

// 云函数update-pwd代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const {
        oldPassword,
        newPassword,
        passwordConfirmation
    } = event
    // 校验新密码与确认新密码是否一致

  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
  }

    const res = await uniID.updatePwd({
    uid: payload.uid,
        oldPassword,
        newPassword,
        passwordConfirmation
    })
    return res
}

重置密码 @reset-password

用法:uniID.resetPwd(Object passwordInfo)

passwordInfo参数说明

字段 类型 必填 说明
uid String 用户Id,可以通过checkToken返回
password String 重置后的密码

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息

示例代码

// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
  }

    const res = await uniID.resetPwd({
    uid: payload.uid,
        password: '12345678'
    })
    return res
}

加密密码 @encrypt-password

用法:uniID.encryptPwd(String password)

passwordInfo参数说明

字段 类型 必填 说明
password String 要加密的字符串

响应参数

字段 类型 必填 说明
password String 加密后的字符串

示例代码

// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const encResult = await uniID.encryptPwd('123456')
    return {
    encResult
  }
}

设置头像

用法:uniID.setAvatar(Object avatarInfo)

avatarInfo参数说明

字段 类型 必填 说明
uid String 用户Id,可以通过checkToken返回
avatar String 用户头像URL

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息

示例代码

// 云函数set-avatar代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const {
        avatar
    } = event
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
  }
    const res = await uniID.setAvatar({
    uid: payload.uid,
        avatar
    })
    return res
}

发送短信验证码

用法:uniID.sendSmsCode(Object codeInfo)

codeInfo参数说明

字段 类型 必填 说明
mobile String 用户手机号
code String 验证码字符串
type String 类型,用于防止不同功能的验证码混用,目前支持的类型login登录、register注册、bind绑定手机、unbind解绑手机

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息

示例代码

// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const {
        mobile
    } = event
  // 生成验证码可以按自己的需求来,这里以生成6位数字为例
  const randomStr = '00000' + Math.floor(Math.random() * 1000000)
  const code = randomStr.substring(randomStr.length - 6)
    const res = await uniID.sendSmsCode({
        mobile,
    code,
    type: 'login'
    })
    return res
}

设置验证码

如果你不想使用uni-id的sendSmsCode发送短信的话,可以使用此接口自行在库中创建验证码

用法:uniID.setVerifyCode(Object codeInfo)

codeInfo参数说明

字段 类型 必填 说明
mobile String 用户手机号,和邮箱二选一
email String 用户邮箱,和手机号二选一
code String 验证码字符串
expiresIn Number 验证码过期时间,单位秒
type String 类型,用于防止不同功能的验证码混用,目前支持的类型login登录、register注册、bind绑定手机、unbind解绑手机

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息

示例代码

// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const {
        mobile
    } = event
  // 生成验证码可以按自己的需求来,这里以生成6位数字为例
  const randomStr = '00000' + Math.floor(Math.random() * 1000000)
  const code = randomStr.substring(randomStr.length - 6)
    const res = await uniID.setVerifyCode({
        mobile,
    code,
    expiresIn: 180,
    type: 'login'
    })
    return res
}

校验验证码

uni-id内置方法loginBySmsbindMobileunbindMobile均已内置校验验证码方法,如果使用以上方法不需要再调用此接口,如需扩展类型请确保type和发送验证码/设置验证码时对应

用法:uniID.verifyCode(Object codeInfo)

codeInfo参数说明

字段 类型 必填 说明
mobile String 用户手机号,和邮箱二选一
email String 用户邮箱,和手机号二选一
code String 验证码字符串
type String 类型,用于防止不同功能的验证码混用,目前支持的类型login登录、register注册、bind绑定手机、unbind解绑手机

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息

示例代码

// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const {
        mobile,
    code
    } = event
    const res = await uniID.verifyCode({
        mobile,
    code,
    type: 'login'
    })
    return res
}

手机号验证码直接登录

用法:uniID.loginBySms(Object mobileInfo)

mobileInfo参数说明

字段 类型 必填 说明
mobile String 用户手机号
code String 验证码
type String 指定操作类型,可选值为loginregister,不传此参数时表现为手机号已注册则登录,手机号未注册则进行注册
password String 密码,type为register时生效
inviteCode String 邀请人的邀请码,type为register时生效
myInviteCode String 设置当前注册用户自己的邀请码,type为register时生效

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
uid String 用户uid
type String 操作类型,login为登录、register为注册
token String - 登录成功之后返回的token信息
tokenExpired String - token过期时间

示例代码

// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const {
        mobile,
    code
    } = event
    const res = await uniID.loginBySms({
        mobile,
    code
    })
    return res
}

绑定手机号

用法:uniID.bindMobile(Object mobileInfo)

mobileInfo参数说明

字段 类型 必填 说明
uid String 用户Id,可以通过checkToken返回
mobile String 用户手机号
code String 验证码,为兼容旧版逻辑此参数不填写时不会进行验证码校验,而是直接绑定手机号

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息

示例代码

// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const {
        mobile,
    code
    } = event
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
  }
    const res = await uniID.bindMobile({
    uid: payload.uid,
        mobile,
    code
    })
    return res
}

解绑手机

用法:uniID.unbindMobile(Object mobileInfo)

mobileInfo参数说明

字段 类型 必填 说明
uid String 用户Id,可以通过checkToken返回
mobile String 用户手机号
code String 验证码,此参数不填写时不会进行验证码校验,而是直接绑定手机号

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息

示例代码

// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const {
        mobile,
    code
    } = event
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
  }
    const res = await uniID.unbindMobile({
    uid: payload.uid,
        mobile,
    code
    })
    return res
}

邮箱验证码直接登录

用法:uniID.loginByEmail(Object emailInfo)

mobileInfo参数说明

字段 类型 必填 说明
email String 用户邮箱
code String 验证码
type String 指定操作类型,覆盖存在则登录不存在则注册的默认行为,可选值为loginregister
password String 密码,type为register时生效
myInviteCode String 设置当前注册用户自己的邀请码,type为register时生效

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
uid String 用户uid
type String 操作类型,login为登录、register为注册
token String - 登录成功之后返回的token信息
tokenExpired String - token过期时间

示例代码

// 云函数bind-mobile代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const {
        email,
    code
    } = event
    const res = await uniID.loginByEmail({
        email,
    code
    })
    return res
}

绑定邮箱

用法:uniID.bindEmail(Object emailInfo)

emailInfo参数说明

字段 类型 必填 说明
uid String 用户Id,可以通过checkToken返回
email String 用户邮箱
code String 用户邮箱验证码,不填此字段或留空时直接绑定不校验验证码

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息

示例代码

// 云函数bind-email代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const {
        email,
    code
    } = event
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
  }
    const res = await uniID.bindEmail({
    uid: payload.uid,
        email,
    code
    })
    return res
}

解绑邮箱

用法:uniID.unbindEmail(Object emailInfo)

emailInfo参数说明

字段 类型 必填 说明
uid String 用户Id,可以通过checkToken返回
email String 用户邮箱
code String 用户邮箱验证码,不填此字段或留空时直接绑定不校验验证码

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息

示例代码

// 云函数bind-email代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const {
        email,
    code
    } = event
  const payload = await uniID.checkToken(event.uniIdToken)
  if(payload.code > 0) {
    return payload
  }
    const res = await uniID.unbindEmail({
    uid: payload.uid,
        email,
    code
    })
    return res
}

登出

用法:uniID.logout(String token);

注意

  • 登出成功之后应删除持久化存储的token,键值为:uniIdToken,uni.removeStorageSync('uniIdToken')

参数说明

字段 类型 必填 说明
token String 用户token

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息

示例代码

// 云函数logout代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const res = await uniID.logout(uniIdToken)
    return res
}

微信登录

用法:uniID.loginByWeixin(Object loginByWexinParams);

注意

  • 需要在config.json内使用微信登录的平台下配置appid和appsecret
  • uniId会自动判断客户端平台
  • 登录成功之后应持久化存储token,键值为:uniIdToken,uni.setStorageSync('uniIdToken', res.result.token)
  • App端获取code不可直接调用uni.login,详细用法可以看下面示例

参数说明

字段 类型 必填 说明
code String 微信登录返回的code
platform String 客户端类型:mp-weixinapp-plus,默认uni-id会自动取客户端类型,但是在云函数url化等场景无法取到客户端类型,可以使用此参数指定
myInviteCode String 设置当前注册用户自己的邀请码,type为register时生效

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
uid String 用户uid
type String 操作类型,login为登录、register为注册
openid String 用户openid
unionid String 用户unionid,能取到此参数时会返回
token String 登录成功之后返回的token信息
tokenExpired String token过期时间
mobileConfirmed Boolean 是否已验证手机号
emailConfirmed Boolean 是否已验证邮箱

示例代码

// 云函数login-by-weixin代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
  // 如下旧写法依然支持
    // const res = await uniID.loginByWeixin(event.code)
    const res = await uniID.loginByWeixin({
    code: event.code
  })
    return res
}

// 客户端代码
// 代码较长建议直接参考插件市场示例项目:https://ext.dcloud.net.cn/plugin?id=2116
let weixinAuthService
export default {
  data() {
    return {
      hasWeixinAuth: false
    }
  },
  onLoad() {
    // #ifdef APP-PLUS
    plus.oauth.getServices((services) => {
      weixinAuthService = services.find((service) => {
        return service.id === 'weixin'
      })
      if (weixinAuthService) {
        this.hasWeixinAuth = true
      }
    });
    // #endif
  },
  methods: {
    getWeixinCode() {
      return new Promise((resolve, reject) => {
        // #ifdef MP-WEIXIN
        uni.login({
          provider: 'weixin',
          success(res) {
            resolve(res.code)
          },
          fail(err) {
            reject(new Error('微信登录失败'))
          }
        })
        // #endif
        // #ifdef APP-PLUS
        weixinAuthService.authorize(function(res) {
          resolve(res.code)
        }, function(err) {
          console.log(err)
          reject(new Error('微信登录失败'))
        });
        // #endif
      })
    },
    loginByWeixin() {
      this.getWeixinCode().then((code) => {
        return uniCloud.callFunction({
          name: 'login-by-weixin',
          data: {
            code
          }
        })
      }).then((res) => {
        uni.showModal({
          showCancel: false,
          content: JSON.stringify(e.result)
        })
        if (res.result.code === 0) {
          uni.setStorageSync('uniIdToken', e.result.token)
        }
      }).catch(() => {
        uni.showModal({
          showCancel: false,
          content: '微信登录失败,请稍后再试'
        })
      })
    }
  }
}

获取微信openid

用法:uniID.code2SessionWeixin(Object Code2SessionWeixinParams);

参数说明

字段 类型 必填 说明
code String 微信登录返回的code
platform String 客户端类型:mp-weixinapp-plus,默认uni-id会自动取客户端类型,但是在云函数url化等场景无法取到客户端类型,可以使用此参数指定

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
openid String - 用户openid
unionid String - 用户unionid,可以取到此值时返回
sessionKey String - 客户端为微信小程序时返回
accessToken String - 客户端为APP时返回
expiresIn String - 客户端为APP时返回,accessToken 接口调用凭证超时时间,单位(秒)
refreshToken String - 客户端为APP时返回,用于刷新accessToken
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const res = await uniID.code2SessionWeixin({
    code: event.code
  })
    return res
}

绑定微信

用法:uniID.bindWeixin(Object weixinInfo);

weixinInfo 参数说明

参数说明

字段 类型 必填 说明
uid String 用户Id,可以通过checkToken返回
code String 微信登录返回的code
platform String 客户端类型:mp-weixinapp-plus,默认uni-id会自动取客户端类型,但是在云函数url化等场景无法取到客户端类型,可以使用此参数指定

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
    return payload
  }
    const res = await uniID.bindWeixin({
    uid: payload.uid,
    code: event.code
  })
    return res
}

解绑微信

用法:uniID.unbindWeixin(String uid);

参数说明

字段 类型 必填 说明
uid String 用户Id,可以通过checkToken返回

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
    return payload
  }
    const res = await uniID.unbindWeixin(payload.uid)
    return res
}

支付宝登录

用法:uniID.loginByAlipay(Object loginByAlipayParams);

注意

  • 需要在config.json内支付宝平台下配置appid和privateKey(应用私钥)
  • 登录成功之后应持久化存储token,键值为:uniIdToken,uni.setStorageSync('uniIdToken', res.result.token)

参数说明

字段 类型 必填 说明
code String 支付宝登录返回的code
platform String 客户端类型:mp-weixinapp-plus,默认uni-id会自动取客户端类型,但是在云函数url化等场景无法取到客户端类型,可以使用此参数指定
myInviteCode String 设置当前注册用户自己的邀请码,type为register时生效

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
uid String 用户uid
type String 操作类型,login为登录、register为注册
openid String 用户openid
token String 登录成功之后返回的token信息
tokenExpired String token过期时间
mobileConfirmed Boolean 是否已验证手机号
emailConfirmed Boolean 是否已验证邮箱

示例代码

// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
  // 如下旧写法依然支持
    // const res = await uniID.loginByAlipay(event.code)
    const res = await uniID.loginByAlipay({
    code: event.code
  })
    return res
}

获取微信openid

用法:uniID.code2SessionWeixin(Object Code2SessionWeixinParams);

参数说明

字段 类型 必填 说明
code String 微信登录返回的code
platform String 客户端类型:mp-weixinapp-plus,默认uni-id会自动取客户端类型,但是在云函数url化等场景无法取到客户端类型,可以使用此参数指定

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
openid String - 用户openid
accessToken String - 客户端为APP时返回
expiresIn String - 客户端为APP时返回,accessToken 接口调用凭证超时时间,单位(秒)
refreshToken String - 客户端为APP时返回,用于刷新accessToken
reExpiresIn String - refreshToken超时时间,单位(秒)
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
    const res = await uniID.code2SessionWeixin({
    code: event.code
  })
    return res
}

绑定支付宝

用法:uniID.bindAlipay(Object alipayInfo);

alipayInfo 参数说明

参数说明

字段 类型 必填 说明
uid String 用户Id,可以通过checkToken返回
code String 支付宝登录返回的code

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
    return payload
  }
    const res = await uniID.bindAlipay({
    uid: payload.uid,
    code: event.code
  })
    return res
}

解绑支付宝

用法:uniID.unbindAlipay(String uid);

参数说明

字段 类型 必填 说明
uid String 用户Id,可以通过checkToken返回

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
    return payload
  }
    const res = await uniID.unbindAlipay(payload.uid)
    return res
}

更新用户信息

用法:uniID.updateUser(Object userInfo);

此接口用于在其他接口不满足需求时使用

userInfo参数说明

字段 类型 必填 说明
uid String 用户Id,可以通过checkToken返回
其余参数 Any 要设置的用户信息

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
    return payload
  }
    const res = await uniID.updateUser({
    uid: payload.uid,
    nickname: 'user nickname'
  })
    return res
}

获取用户信息

用法:uniID.getUserInfo(Object GetUserInfoParams);

此接口用于在其他接口不满足需求时使用

参数说明

字段 类型 必填 说明
uid String 用户Id,可以通过checkToken返回
field Array 指定返回的字段,不传则返回所有

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
userInfo Object 获取的用户信息
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
    return payload
  }
    const res = await uniID.getUserInfo({
    uid: payload.uid,
    field: ['mobile']
  })
    return res
}

设置用户邀请码

针对未生成邀请码的用户使用此方法生成邀请码

用法:uniID.setUserInviteCode(Object SetUserInviteCodeParams);

此接口用于在其他接口不满足需求时使用

参数说明

字段 类型 必填 说明
uid String 用户Id
myInviteCode String 自行指定邀请码(不可与其他账号邀请码重复),如果不传此字段则自动生成不重复的6位邀请码

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
myInviteCode String 最终设置的邀请码

用户接受邀请

此接口用于在注册之后再填写邀请码的场景,多数情况下不会用到此接口而是在注册时填写邀请码

用法:uniID.acceptInvite(Object AcceptInviteParams);

参数说明

字段 类型 必填 说明
uid String 用户Id
inviteCode String 邀请人的邀请码

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息

获取接受邀请的用户清单

用法:uniID.getInvitedUser(Object GetInvitedUserParams);

此接口用于在其他接口不满足需求时使用

参数说明

字段 类型 必填 说明
uid String 用户Id
level Number 指定获取第几级邀请用户,默认1
limit Number 指定返回列表长度,默认20
offset Number 指定列表偏移量,默认0
needTotal Boolean 是否需要返回总数,默认false

响应参数

字段 类型 必填 说明
code Number 错误码,0表示成功
msg String 详细信息
invitedUser Array 邀请的用户列表

invitedUser每项结构

字段 类型 必填 说明
username String - 被邀请者用户名
mobile String - 被邀请者手机号
invite_time String - 被邀请者注册时间,以时间戳形式返回
// 云函数代码
const uniID = require('uni-id')
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
    return payload
  }
    const res = await uniID.getUserInfo({
    uid: payload.uid,
    limit: 10,
    offset: 0,
    needTotal: true
  })
    return res
}

自行初始化uni-id@init

用法:uniID.init(Object config);

此接口适用于不希望使用config.json初始化而是希望通过js的方式传入配置的情况

config参数说明

config格式与config.json完全相同

响应参数

// 云函数代码
const uniID = require('uni-id')
uniID.init({
    "passwordSecret": "passwordSecret-demo", // 用于加密用户密码
    "tokenSecret": "tokenSecret-demo", // 用于生成token
    "tokenExpiresIn": 7200, // token过期时间
    "passwordErrorLimit": 6, // 同一个ip密码错误最大重试次数
    "passwordErrorRetryTime": 3600, // 超过密码重试次数之后的等待时间
    "service": {
        "sms": {
            "name": "your app name", // 应用名称对应uniCloud.sendSms的data参数内的name
            "codeExpiresIn": 180, // 验证码过期时间,单位:秒,只可取60的整数倍,不填此参数时会取默认值180秒
            "smsKey": "your sms key", // 短信密钥key
            "smsSecret": "your sms secret" // 短信密钥secret
        }
    }
})
exports.main = async function(event,context) {
  payload = await uniID.checkToken(event.uniIdToken)
  if (payload.code && payload.code > 0) {
    return payload
  }
    const res = await uniID.updateUser({
    uid: payload.uid,
    nickname: 'user nickname'
  })
    return res
}

裂变@fission

1.1.2版本起uni-id支持裂变功能,目前仅适用手机号+验证码方式注册可以填写邀请码(inviteCode)接受邀请。

config.json内配置了autoSetInviteCode: true则在用户注册时会自动给设置不重复的6位邀请码,如果不希望使用自动设置的邀请码可以自行传入myInviteCode参数来设置邀请码,需要注意的是要保证邀请码唯一。

config.json内配置了forceInviteCode: true则只有使用邀请码才可以注册(仅手机号+验证码注册方式支持)。

针对之前使用了旧版本(不支持裂变)的uni-id,现在想增加裂变功能,可以调用setUserInviteCode接口给已注册用户设置邀请码,在设置之前可以使用my_invite_code不存在作为条件查询所有需要设置的用户。

如果希望用户注册完成之后再填写邀请人的邀请码,可以调用acceptInvite接口来使用户接受邀请。

getInvitedUser接口可以用于获取接受邀请的用户列表,其中level参数可以用来设置要获取哪一级的邀请用户,不填写level参数则默认获取第一级。

如果想详细的体验一下裂变流程,可以在插件市场导入前后一体登录模板,此项目内已有邀请用户注册示例,流程如下

分享邀请码/邀请链接

受邀者注册

数据库结构

用户表

表名:uni-id-users

字段 类型 必填 描述
_id Object ID 存储文档 ID(用户 ID),系统自动生成
username String 用户名,不允许重复
password String 密码,加密存储
nickname String 用户昵称
gender Integer 用户性别:0 未知 1 男性 2 女性
status Integer 用户状态:0 正常 1 禁用 2 审核中 3 审核拒绝
mobile String 手机号码
mobile_confirmed Integer 手机号验证状态:0 未验证 1 已验证
email String 邮箱地址
email_confirmed Integer 邮箱验证状态:0 未验证 1 已验证
avatar String 头像地址
wx_unionid String 微信unionid
wx_openid Object 微信各个平台openid
ali_openid String 支付宝平台openid
comment String 备注
realname_auth Object 实名认证信息
register_date Timestamp 注册时间
register_ip String 注册时 IP 地址
last_login_date Timestamp 最后登录时间
last_login_ip String 最后登录时 IP 地址
login_ip_limit Array 登录 IP 限制
inviter_uid Array 邀请人uid,按层级从下往上排列的uid数组,即第一个是直接上级
my_invite_code String 用户自己的邀请码

wx_openid字段定义

字段 类型 必填 描述
app-plus String app平台微信openid
mp-weixin String 微信小程序平台openid

realNameAuth 扩展字段定义 该字段存储实名认证信息。

字段 类型 必填 描述
type Integer 用户类型:0 个人用户 1 企业用户
auth_status Integer 认证状态:0 未认证 1 等待认证 2 认证通过 3 认证失败
auth_date Timestamp 认证通过时间
real_name String 真实姓名/企业名称
identity String 身份证号码/营业执照号码
id_card_front String 身份证正面照 URL
id_card_back String 身份证反面照 URL
id_card_in_hand String 手持身份证照片 URL
license String 营业执照 URL
contact_person String 联系人姓名
contact_mobile String 联系人手机号码
contact_email String 联系人邮箱

job 扩展字段定义

字段 类型 必填 描述
company String 公司名称
title String 职位

用户集合示例:

{
  "_id": "f2a60d815ee1da3900823d45541bb162",
  "username": "姓名"
  "password": "503005d4dd16dd7771b2d0a47aaef927e9dba89e",
  "status":0,//用户状态:0正常 1禁用 2审核中 3审核拒绝
  "mobile":"",
  "mobile_confirmed":0, //手机号是否验证,0为未验证,1为已验证
  "email":"amdin@domain.com",
  "email_confirmed":0, //邮箱是否验证,0为未验证,1为已验证
  "avatar":"https://cdn.domain.com/avatar.png"
  "register_ip": "123.120.11.128", //注册IP
  "last_login_ip": "123.120.11.128", //最后登录IP

}

验证码表

表名:uni-verify

字段 类型 必填 描述
_id Object ID 存储文档 ID(验证码 ID),系统自动生成
mobile String 手机号,和邮箱二选一
email String 邮箱,和手机号二选一
code String 验证码
type String 验证类型:login, bind, unbind, pay
state Integer 验证状态:0 未验证 1 已验证 2 已作废
ip String 请求时 IP 地址
created_at Timestamp 创建时间
expired_at Timestamp 验证码过期时间

错误码

1.1.0版本使用此错误码规范

模块 模块码 错误代码 错误信息
登录通用模块 100 01 账号已禁用
账号、邮箱、手机+密码登录 101 01 用户不存在
02 密码错误
03 密码错误次数过多
手机号验证码登录/注册 102 01 手机号已存在(传入type='register'且手机号已注册时触发)
102 02 此手机号尚未注册(传入type='login'且手机号未注册时触发)
102 03 邀请码无效(邀请码存在且唯一时才算有效)
邮箱验证码登录/注册 103 01 此邮箱已注册(传入type='register'且邮箱已注册时触发)
103 02 此邮箱尚未注册(传入type='login'且邮箱未注册时触发)
微信登录/注册 104 01 获取openid失败
支付宝登录/注册 105 01 获取openid失败
注册通用模块 200 - -
账号、邮箱、手机+密码注册 201 01 用户名、邮箱、手机号必填一项
02 用户名、邮箱、手机号冲突
Token类 300 - -
生成Token 301 - -
验证Token 302 01 设备特征校验未通过
02 云端以不包含此token
03 token已过期
04 token校验未通过
账号安全类 400 - -
登出 401 - -
修改密码 402 01 用户不存在
02 旧密码错误
重置密码 403 - -
验证类 500 - -
设置验证码 501 01 参数错误
校验验证码 502 01 参数错误
02 验证码错误或已失效
发送短信验证码 503 01 验证码发送失败,一般msg内有描述
绑定账号 600 - -
绑定手机号 601 01 此手机号已被绑定
绑定邮箱 602 01 此邮箱已被绑定
绑定微信 603 01 获取openid失败
02 此账号已被绑定
绑定支付宝 604 01 获取openid失败
02 此账号已被绑定
解绑账号 700 - -
解绑手机号 701 01 解绑失败,可能已经解绑或者账号不匹配
解绑邮箱 702 01 解绑失败,可能已经解绑或者账号不匹配
解绑微信 703 01 解绑失败,可能已经解绑
解绑支付宝 704 01 解绑失败,可能已经解绑
基础功能 800 - -
更新用户信息 801 01 参数错误
设置头像 802 - -
获取用户信息 803 01 未查询到用户信息
设置用户自己的邀请码 804 01 邀请码设置失败,验证码重复或自动设置重试多次依然重复
02 邀请码重试多次依然重复
填写邀请人邀请码 805 01 邀请码无效(邀请码存在且唯一时才算有效)
02 uid错误,用户不存在
03 邀请码不可修改
获取微信openid 806 01 未能获取openid
02 调用获取openid接口失败
获取支付宝openid 807 01 未能获取openid
02 调用获取openid接口失败
公用码 900 01 数据库读写异常

FAQ

  • token数组为什么越来越长

    • 每次登录成功都会新增一个token,并且检查所有token的有效期删除过期token。正常情况下客户端应该判断持久化存储的token是否还在有效期内,如果还有效就直接进入应用,不再执行登录。这样相当于用户的每个设备上都存在一个有效期内的token,云端也是。
  • 复制token到其他环境校验不通过

    • uni-id内会校验客户端ua,如果是在本地调试可以在云函数内修改context.CLIENTUA为生成token的设备ua,切记上线删除此逻辑
  • username、email、mobile三个字段

    • 三个字段均可能为空,但是建议限制一下插入数据库三个字段的格式,比如username不应是邮箱格式或手机号格式,因为登录时可以选择使用username或mobile或email+密码的方式
  • 关于邀请码

    • 目前仅手机号+验证码的注册方式支持填写邀请码

隐私、权限声明

1. 本插件需要申请的系统权限列表:

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

从开发者uniCloud数据库读写用户信息

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

  1. Definitions.

    "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

    "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

    "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

    "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

    "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

    "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

    "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

    "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

    "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

    "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

  2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

  3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

  4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

    (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and

    (b) You must cause any modified files to carry prominent notices stating that You changed the files; and

    (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

    (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

    You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

  5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

  6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

  7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

  8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

  9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

    END OF TERMS AND CONDITIONS

    APPENDIX: How to apply the Apache License to your work.

    To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.

    Copyright [yyyy] [name of copyright owner]

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问