Merge branch 'master' of gitcode.net:dcloud/unidocs-zh into master

074e264e · 杜庆泉 · 9f6bb4cb · 919c328d · 074e264e · 074e264e
8 changed file
--- a/docs/tutorial/build/publish-mp-weixin-cli.md
+++ b/docs/tutorial/build/publish-mp-weixin-cli.md
@@ -2,7 +2,7 @@
 > HBuilderX 3.3.7+, uni-app 发行到微信小程序，支持自动上传代码到微信平台，无需再打开微信开发者工具上传发行
-![](https://hx.dcloud.net.cn/static/snapshots/cli/wechat-upload.png)
+<img src="https://f184e7c3-1912-41b2-b81f-435d1b37c7b4.cdn.bspapp.com/VKCEYUGU-f184e7c3-1912-41b2-b81f-435d1b37c7b4/f6a5835a-1fcc-4241-a995-11f50240ece8.jpg" style="zoom: 50%;" />
 通过微信小程序CI，使用上传密钥上传代码，无需打开微信开发者工具，一键完成微信小程序代码的上传、预览等操作。
@@ -10,4 +10,5 @@
 - 自动上传到微信平台，依赖CI插件，如弹窗提示要求安装CI插件，请点击确认安装；
 - 自动上传到微信平台，需要配置`上传密钥`，并正确填写`微信小程序appid`和`privatekey`；
 - 自动上传到微信平台，如果开启了`IP白名单`，请确保微信平台已正确配置 `IP白名单`。
\ No newline at end of file
+- 关于微信ci机器人编号，仅支持HBuilderX 3.6.16+
\ No newline at end of file
--- a/docs/uniCloud/aliyun-migrate-business.md
+++ b/docs/uniCloud/aliyun-migrate-business.md
@@ -156,3 +156,44 @@ url化访问时不管是默认域名还是自定义域名均和上述转发逻
 ![](https://f184e7c3-1912-41b2-b81f-435d1b37c7b4.cdn.bspapp.com/VKCEYUGU-f184e7c3-1912-41b2-b81f-435d1b37c7b4/5fa6249a-2900-40aa-b4b8-16f37d2307a1.png)
 需要开发者在[uniCloud控制台](https://unicloud.dcloud.net.cn)将自定义域名删除后重新绑定，通过该操作获取到新的CNAME后，将域名解析更换到新的CNAME以完成域名迁移。 这个期间前端网页托管自定义域名访问会中断，建议在访问量较低的时候处理。
+## 迁移后uniCloud相关业务消耗资源费用变更情况
+### 短信及一键登录资源消耗评估@sms-unilogin-fee
+`短信`和`一键登录`业务涉及费用的部分主要是云函数/云对象的使用量、调用次数、和出网流量(如：使用`uni-id-co`或自定义的云函数/云对象来发送短信)。
+接下来，我们对不同资源，分别进行费用评估。
+我们按照[uniCloud官网](https://uniapp.dcloud.net.cn/uniCloud/price.html#aliyun-postpay)列出的按量计费规则，计算一下云函数的资源消耗。
+![](https://mp-8ca8132b-2139-4831-aff2-582d4c8385da.cdn.bspapp.com/cloudstorage/8492ba8e-f4c6-45de-abf2-f9d6825ceefb.png)
+我们可以简单得出如下公式：
+`云函数/云对象费用 = 资源使用量 * 0.000110592  + 调用次数 * 0.0133 / 10000 + 出网流量 * 0.8`
+其中：
+- 资源使用量 = 云函数内存（单位为G） * 云函数平均单次执行时长（单位为秒） * 调用次数
+- 调用次数 = 发送短信条数（一般情况下发送条数 = 调用次数，特殊情况除外）+ 一键登录调用次数（如果只使用其中某一项业务，则可设另一项业务调用次数为0）
+我们假设如下数据模型：
+- 云函数内存：512M，即0.5G （云函数内存默认为512M，用户可以自定义设置，最低可设置为128M）
+- 云函数平均单次执行时长：200毫秒，即0.2秒
+- 短信和一键登录业务平均每日调用次数：10000次
+- 出网流量：单次请求 2 KB
+按照如上公式，其`短信`业务云函数每天的费用为：
+```
+云函数费用（天） = 资源使用量 * 0.000110592  + 调用次数 * 0.0133 / 10000 + 出网流量 * 0.8
+			  = 云函数内存（单位为G） * 云函数平均单次执行时长（单位为秒） * 调用次数 + 调用次数 * 0.0133 / 10000 + 出网流量 * 0.8
+			  = 0.5G * 0.2S * 10000 * 0.000110592 + 10000 * 0.0133/10000 + 10000 * 2 * 0.8 / 1024 * 1024 
+			  = 0.110592 + 0.0133 + 0.0152587890625
+			  = 0.1391507890625（元）
+			  ≈ 0.139（元）
+```
+即：如果你的`短信`和`一键登录`业务平均每天发送条数为10000条，使用阿里云正式版云服务空间后，对应云函数每天大概消耗0.139元，对比之前的短信和一键登录费用，平均每次调用多花0.0000139元，几乎可忽略不计。
\ No newline at end of file
--- a/docs/uniCloud/cf-database-aggregate-operator.md
+++ b/docs/uniCloud/cf-database-aggregate-operator.md
@@ -315,32 +315,41 @@ let res = await db.collection('sales').aggregate()
 ####  API 说明
- 语法如下：  
+语法如下：  
 ```js
 db.command.aggregate.ln(<number>)
 ```
 `<number>` 可以是任意解析为非负数字的表达式。  
- `ln` 等价于 `log([<number>, Math.E])`，其中 `Math.E` 是 `JavaScript` 获取 `e` 的值的方法。  
+`ln` 等价于 `log([<number>, Math.E])`，其中 `Math.E` 是 `JavaScript` 获取 `e` 的值的方法。  
 ####  示例代码
-####  db.command.aggregate.ln
-计算给定数字在自然对数值。  
-语法如下：  
+假设集合 curve 有如下记录：
 ```js
-db.command.aggregate.ln(<number>)
+{ _id: 1, x: 1 }
+{ _id: 2, x: 2 }
+{ _id: 3, x: 3 }
+```
+计算 ln(x) 的值：
+```js
+const $ = db.command.aggregate
+let res = await db.collection('curve').aggregate()
+  .project({
+    log: $.ln('$x')
+  })
+  .end()
+```
+返回结果如下：
+```js
+{ _id: 1, ln: 0 }
+{ _id: 2, ln: 0.6931471805599453 }
+{ _id: 3, ln: 1.0986122886681098 }
 ```
-`<number>` 可以是任意解析为非负数字的表达式。  
- `ln` 等价于 `log([<number>, Math.E])`，其中 `Math.E` 是 `JavaScript` 获取 `e` 的值的方法。
 ### log

--- a/docs/uniCloud/cf-database-dbcmd.md
+++ b/docs/uniCloud/cf-database-dbcmd.md
@@ -98,8 +98,8 @@ function and(...expressions: Expression[]): Command
 ```js
-let res = await const dbCmd = db.command
+const dbCmd = db.command
-db.collection('todo').where({
+let res = await db.collection('todo').where({
  progress: dbCmd.gt(80).or(dbCmd.lt(20))
 }).get()
 ```

--- a/docs/uniCloud/price.md
+++ b/docs/uniCloud/price.md
@@ -40,7 +40,7 @@ uniCloud提供包月、按量计费两种计费方式，具体说明如下：
 **免费额度注意事项：**
 - 单个账号只能创建一个阿里云免费服务空间
- 阿里云免费服务空间有效期默认一个月，到期时需主动续费（续费时依旧免费），否则将会被停服释放
+- 阿里云免费服务空间有效期默认一个月，到期时需主动续费（到期前15天可续费，续费时依旧免费），否则将会被停服释放
 - 免费版如需升配，只能针对剩余有效期进行操作，无法自定义升配时间
 - 免费版可以转换为按量计费
 - 免费版升配或转为按量计费后，免费额度会释放，此时仍可再创建一个免费版

--- a/docs/uniCloud/redis.md
+++ b/docs/uniCloud/redis.md
@@ -2166,7 +2166,7 @@ member 移除成功返回 1，member 不是 source 集合成员，并且没有
 **示例**
 ```js
-await redis.sadd('key', 'a', 'b', 'c')
+await redis.sadd('source', 'a', 'b', 'c')
 await redis.smove('source', 'destination', 'a') // 返回 1
 ```

--- a/docs/uniCloud/send-sms.md
+++ b/docs/uniCloud/send-sms.md
--- a/docs/uniCloud/univerify.md
+++ b/docs/uniCloud/univerify.md
 ## 一键登录@univerify
 <!--
 /// meta
 keyword: 手机号
 -->
 `univerify` 是DCloud 推出的一键登录产品，通过与运营商深度合作，实现APP用户无需输入帐号密码，即可使用本机手机号码自动登录的能力。
 `univerify`是替代短信验证登录的下一代登录验证方式，能消除现有短信验证模式等待时间长、操作繁琐和容易泄露的痛点。
 >  注意：一键登录必须是手机使用流量的前提下才能获取到手机号码，用Wi-Fi联网时无法获取到手机号码，同时如果是双卡手机，获取到的手机号码是默认移动数据的那个手机卡的号码。
 ## 重要调整
 ### 云函数使用一键登录扩展库@extension
 自`HBuilderX 3.4.0`起，一键登录相关功能移至扩展库`uni-cloud-verify`内。在一段时间内无论开发者是否使用扩展库云函数都可以正常使用`uniCloud.getPhoneNumber`。HBuilderX 3.4.0及之后的版本上传云函数时如果没有指定使用`uni-cloud-verify`扩展库的云函数将无法调用uniCloud.getPhoneNumber接口。
 关于扩展库的说明见：[云函数扩展库](uniCloud/cf-functions.md?id=extension)
 在云函数的package.json内添加`uni-cloud-verify`的引用即可为云函数启用此扩展，无需做其他调整，完整的package.json示例如下：
 ```js
 {
 	"name": "univerify",
 	"extensions": {
 		"uni-cloud-verify": {} // 启用一键登录扩展，值为空对象即可
 	}
 }
 ```
 ## 客户端@client
 客户端如何使用一键登录请参考此文档：[univerify 使用指南](/univerify)
 ## 云函数@cloud
 > 自`HBuilderX 3.4.0`起云函数需启用uni-cloud-verify之后才可以调用getPhoneNumber接口，详细说明见：[云函数使用一键登录扩展库](#extension)
 客户端调用一键登录接口会获取如下结果
 ```js
 {  
    "target": {  
        "id": "univerify",  
        "description": "一键登录",  
        "authResult": {  
            "openid": "xxx",  
            "access_token": "xxx"  
        }  
    }  
 }  
 ```
 使用上面结果中的`openid`和`access_token`即可在`云函数`内调用接口获取手机号
 云函数内接口调用形式如下
 ```js
 exports.main = async function(event, context){
  const res = await uniCloud.getPhoneNumber({
    provider: 'univerify',
    appid: context.APPID, // 客户端callFunction时携带的AppId信息
    apiKey: 'xxx', // 在开发者中心开通服务并获取apiKey
    apiSecret: 'xxx', // 在开发者中心开通服务并获取apiSecret
    access_token: event.access_token,
    openid: event.openid
  })
  // res形式如下
  // {
  //   code: 0,
  //   message: '',
  //   phoneNumber: '138xxxxxxxx'
  // }
 }
 ```
 **相关文档**
 - [uniCloud快速上手](https://uniapp.dcloud.net.cn/uniCloud/quickstart)
 - [云函数URL化](https://uniapp.dcloud.net.cn/uniCloud/http)
 ### uni-app项目
 如果开发uni-app项目可以使用callFunction的方式调用云函数
 ```js
 // 客户端
 uniCloud.callFunction({
  name: 'xxx', // 你的云函数名称
  data: {
    access_token: 'xxx', // 客户端一键登录接口返回的access_token
    openid: 'xxx' // 客户端一键登录接口返回的openid
  }
 }).then(res => {
  // res.result = {
  //   code: '',
  //   message: ''
  // }
 }).catch(err=>{
  // 处理错误
 })
 // 云函数
 exports.main = async function (event, context){
  const res = await uniCloud.getPhoneNumber({
    appid: context.APPID, // 客户端callFunction时携带的AppId信息
  	provider: 'univerify',
  	apiKey: 'xxx', // 在开发者中心开通服务并获取apiKey
  	apiSecret: 'xxx', // 在开发者中心开通服务并获取apiSecret
  	access_token: event.access_token,
  	openid: event.openid
  })
  // 执行入库等操作，正常情况下不要把完整手机号返回给前端
  return {
    code: 0,
    message: '获取手机号成功'
  }
 }
 ```
 **注意**
 - 开发期间如果重新获取过appid需要重新编译uni-app项目
 ### 5+项目
 5+项目不可使用callFunction请求云函数，这时候可以使用云函数URL化让5+项目通过http请求的方式访问云函数
 ```js
 // 客户端
 const xhr = new plus.net.XMLHttpRequest();
 xhr.onload = function(e) {
  const {
    code,
    message
  } = JSON.parse(xhr.responseText)
 }
 xhr.open( "POST", "https://xxx" ); // url应为云函数Url化之后的地址，可以在uniCloud web控制台云函数详情页面看到
 xhr.setRequestHeader('Content-Type','application/json');
 xhr.send(JSON.stringify({
  access_token: 'xxx', // 客户端一键登录接口返回的access_token
  openid: 'xxx' // 客户端一键登录接口返回的openid
 }));
 // 云函数，下面仅展示客户端使用post方式发送content-type为application/json请求的场景
 exports.main = async function(event){
  let body = event.body
  if(event.isBase64Encoded) {
    body = Buffer.from(body,'base64')
  }
  const {
    access_token,
    openid
  } = JSON.parse(body)
  const res = await uniCloud.getPhoneNumber({
    provider: 'univerify',
    appid: 'xxx', // DCloud appid
    apiKey: 'xxx', // 在开发者中心开通服务并获取apiKey
    apiSecret: 'xxx', // 在开发者中心开通服务并获取apiSecret
    access_token: access_token,
    openid: openid
  })
  // 执行入库等操作，正常情况下不要把完整手机号返回给前端
  return {
    code: 0,
    message: '获取手机号成功'
  }
 }
 ```
 ### 自有服务器调用
 写法类似上面5+项目的云函数url化的方式，但是不同的是需要云函数返回手机号给自己服务器，这样就需要确保数据安全。
 下面以一个简单的例子演示如何使用签名验证请求是否合法
 ```js
 // 以nodejs为例
 const crypto = require('crypto')
 const secret = 'your-secret-string' // 自己的密钥不要直接使用示例值，且注意不要泄露
 const hmac = crypto.createHmac('sha256', secret);
 // 自有服务器生成签名，并以GET方式发送请求
 const params = {
  access_token: 'xxx', // 客户端传到自己服务器的参数
  openid: 'xxx'
 }
 // 字母顺序排序后拼接签名串
 const signStr = Object.keys(params).sort().map(key => {
  return `${key}=${params[key]}`
 }).join('&')
 hmac.update(signStr);
 const sign = hmac.digest('hex')
 // 最终请求如下链接，其中https://xxxx/xxx为云函数Url化地址
 // https://xxxx/xxx?access_token=xxx&openid=xxx&sign=${sign} 其中${sign}为上一步得到的sign值
 ```
 ```js
 // 云函数验证签名，此示例中以接受GET请求为例作演示
 const crypto = require('crypto')
 exports.main = async function (event){
  const secret = 'your-secret-string' // 自己的密钥不要直接使用示例值，且注意不要泄露
  const hmac = crypto.createHmac('sha256', secret);
  let params = event.queryStringParameters
  const sign = params.sign
  delete params.sign
  const signStr = Object.keys(params).sort().map(key => {
    return `${key}=${params[key]}`
  }).join('&')
  hmac.update(signStr);
  if(sign!==hmac.digest('hex')){
    throw new Error('非法访问')
  }
  const {
    access_token,
    openid
  } = params
  const res = await uniCloud.getPhoneNumber({
  	provider: 'univerify',
    appid: 'xxx', // DCloud appid
  	apiKey: 'xxx', // 在开发者中心开通服务并获取apiKey
  	apiSecret: 'xxx', // 在开发者中心开通服务并获取apiSecret
  	access_token: access_token,
  	openid: openid
  })
  // 返回手机号给自己服务器
  return res
 }
 ```
+### 一键登录费用说明@unilogin-fee
+- 0.02元/次，失败不计费，但在实际使用中需要依赖`uniCloud`云服务，在使用阿里云正式版后，每条大约需要多花0.0000139元，几乎可以忽略不计，费用计算详见[短信及一键登录资源消耗评估](uniCloud/aliyun-migrate-business.md#sms-unilogin-fee)。