From 000a7e20252d057f51192e6adffcdecbae0b7b98 Mon Sep 17 00:00:00 2001
From: DCloud__JSON <linju@dcloud.io>
Date: Mon, 13 Feb 2023 17:04:49 +0800
Subject: [PATCH] Update uni-captcha.md

---
 docs/uniCloud/uni-captcha.md | 686 +++++++++++++++++------------------
 1 file changed, 343 insertions(+), 343 deletions(-)

diff --git a/docs/uniCloud/uni-captcha.md b/docs/uniCloud/uni-captcha.md
index 15cf1841e..3eebc6923 100644
--- a/docs/uniCloud/uni-captcha.md
+++ b/docs/uniCloud/uni-captcha.md
@@ -1,343 +1,343 @@
-下载地址：[https://ext.dcloud.net.cn/plugin?id=4048](https://ext.dcloud.net.cn/plugin?id=4048)
-
-GitCode 仓库：[https://gitee.com/dcloud/uni-captcha](https://gitee.com/dcloud/uni-captcha)
-
-## 用途说明
-主要起到人机校验或其他限制调用的作用，如：
-- 防止机器冒充人类做暴力破解
-- 防止大规模在线注册滥用服务
-- 防止滥用在线批量操作
-- 防止信息被大量采集聚合
-
-常见的业务场景有：
-- 注册环节：防止无效垃圾注册，从源头进行管理
-- 登录环节：防止撞库攻击、暴力破解，保障用户数据
-- 短信防刷：减少短信接口被刷情况，减少企业不必要成本
-- 互动环节：防止批量垃圾互动信息，破坏用户UGC内容生态
-- 激励领取：防止被批量褥羊毛
-
-## 组成部分
-1. 数据表：[opendb-verify-codes](https://gitee.com/dcloud/opendb/blob/master/collection/opendb-verify-codes/collection.json)，用于存储验证码相关数据
-2. 公共模块：`uni-captcha`，集成获取、刷新、校验验证码
-3. 云对象：`uni-captcha-co`，集成获取验证码的api
-4. 云端一体组件：`uni-captcha`和`uni-popup-captcha`，集成创建、刷新、显示验证码
-
-## 目录结构@catalogue
-<pre v-pre="" data-lang="">
-    <code class="lang-" style="padding:0">
-├─uni_modules                              			存放[uni_module](/uni_modules)规范的插件。
-│	└─uni-captcha
-│		├─uniCloud
-│		│	├─cloudfunctions						云函数目录
-│		│	│	├─common							公共模块目录
-│		│	│	│	└─uni-captcha					uni-captcha公共模块
-│		│	│	└─uni-captcha-co					集成调用uni-captcha方法的云对象
-│		│	└─database
-│		│	 	├─opendb-verify-codes.schema.json	验证码数据表
-│		│		└─db_init.json						初始化数据库文件
-│		└─components								组件目录
-│			├─uni-captcha					   		 
-│			│	└─uni-captcha.vue					普通验证码组件
-│			└─uni-popup-captcha				  		
-│				└─uni-popup-captcha.vue				弹出式验证码组件
-    </code>
-</pre>
-
-## 原理时序
-1. 客户端，向服务端请求某一应用场景的验证码。提示：这里用场景值`scene`，表示应用场景，用于防止不同功能的验证码混用，如：`login`、`pay`
-2. 服务端，创建验证码，即：向数据表`opendb-verify-codes`中创建状态为待验证的验证码记录（作废同一个设备id和场景值的旧验证码记录），并返回格式为base64的图形验证码资源数据。提示：这里的数据表，状态字段名：`state`用`0`表示待验证，用`2`表示已作废。
-3. 客户端，得到验证码图片，用户识别后输入验证码的值与表单数据一起提交至服务端
-4. 服务端，云函数或clientDB action中校验验证码，决定是否执行业务逻辑。如果验证码错误则返回错误信息，客户端再重复步骤1-3。提示：验证验证码，可以使用封装好的公共模块的`verify`方法[详情](#校验验证码@verify)，也可以直接查库校验。
-
-以上即完整的流程。
-如果在前端表单页面中，使用本插件封装好的云端一体组件，并配置组件的属性场景值`scene`，即等价于如上步骤1-3；
-
-本插件已集成使用示例，使用HBuilderX导入示例项目体验；另外你也可以参考插件在[uni-starter](https://ext.dcloud.net.cn/plugin?id=5057)中的应用。
-
-## 云端一体组件介绍
-内置调用`uni-captcha-co`云对象集成创建/刷新验证码，组件支持双向数据绑定。
-
-### 验证码配置（可选）：
-
-参数说明：
-
-| 字段			| 类型		| 默认值	| 说明															|
-| ------------	| -------	| -------	| ------------------------------------------------------------	|
-| width			| Number	| 150		| 图片宽度														|
-| height		| Number	| 40		| 图片高度														|
-| background	| String	| #FFFAE8	| 验证码背景色，设置空字符`''`不使用背景颜色					|
-| size			| Number	| 4			| 验证码长度，最多 6 个字符										|
-| noise			| Number	| 4			| 验证码干扰线条数												|
-| color			| Boolean	| false		| 字体是否使用随机颜色，当设置`background`后恒为`true`			|
-| fontSize		| Number	| 40		| 字体大小														|
-| ignoreChars	| String	| 			| 忽略哪些字符													|
-| mathExpr		| Boolean	| false		| 是否使用数学表达式											|
-| mathMin		| Number	| 1			| 表达式所使用的最小数字										|
-| mathMax		| Number	| 9			| 表达式所使用的最大数字										|
-| mathOperator	| String	| 			| 表达式所使用的运算符，支持 `+`、`-`。不传则随机使用				|
-| expiresDate	| Number	| 180		| 验证码过期时间(s)							|
-| scene			| Object	| 			| 根据场景值配置（版本号：0.6.0+ 支持）							|
-
-配置路径：[unicloud配置中心](https://ext.dcloud.net.cn/plugin?id=4425)，`uni-config-center`->`uni-captcha`->`config.json`
-示例：
-```
-	{
-		"width":150,
-		"height":40,
-		"background":"#FFFAE8",
-		"size":4,
-		"noise":4,
-		"color":false,
-		"fontSize":40,
-		"ignoreChars":"",
-		"mathExpr":false,
-		"mathMin":1,
-		"mathMax":9,
-		"mathOperator":"",
-		"expiresDate":180,
-		"scene":{
-			"login":{
-				"mathExpr":true	 	//该配置会覆盖根节点的值，表示scene的值为login时，验证码使用数学表达式
-			},
-			"register":{
-				"expiresDate":60,	 //该配置会覆盖根节点的值，表示scene的值为login时，验证码过期时间为60秒
-			}
-		}
-	}
-```
-
-注意：`uni-config-center`不支持注释，如果直接复制配置示例代码，要将注释删除
-
-**替换字体：**
-路径：`/uni_modules/uni-captcha/uniCloud/cloudfunctions/common/uni-captcha/fonts/font.ttf`。
-请保证字体格式为 `.ttf` 且包含 `ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+-` 字符
-
-
-**已过期的配置**（版本号：0.6.0+ 已不再支持此方式 ）：
-
-在云对象`uni-captcha-co`中配置，路径：`/uni_modules/uni-captcha/uniCloud/cloudfunctions/uni-captcha-co/config.js`->`image-captcha` 云对象`uni-captcha-co`中的配置，优先级大于在`unicloud配置中心`的配置
-
-### 普通验证码组件
-**组件名：uni-captcha**
-
-组件遵从[easycom组件规范](https://uniapp.dcloud.io/component/#easycom%E7%BB%84%E4%BB%B6%E8%A7%84%E8%8C%83)
-
-使用示例：
-```html
-<template>
-	<uni-captcha scene="场景值" v-model="验证码的值"></uni-captcha>
-</template>
-```
-#### Props:
-| 字段         | 类型    | 必填 | 默认值  | 说明                                                         |
-| ------------ | ------- | ---- | ------- | ------------------------------------------------------------ |
-| scene        | String  | 是   | -       | 使用场景值，用于防止不同功能的验证码混用，如：`login`、`pay` |
-| value/v-model| String  | -    | -       | 验证码的值 |
-
-
-### 弹出式验证码组件
-**组件名：uni-popup-captcha**
-
-组件遵从[easycom组件规范](https://uniapp.dcloud.io/component/#easycom%E7%BB%84%E4%BB%B6%E8%A7%84%E8%8C%83)
-
-验证码实现人机校验等作用的同时，降低了用户体验。为了提升用户体验：绝大部分情况下，验证码应当是非常态的，当接口被高频调用的情况下才需要。
-另外验证码会使得我们的前端界面设计变得复杂。所以弹出式验证码组件，应需而生。
-
-#### 使用示例：
-```html
-<template>
-	<uni-popup-captcha ref="popup-captcha" @confirm="verifyCaptcha" :scene="formData.scene" v-model="formData.captcha"></uni-popup-captcha>
-	<button @click="openPopupCaptcha" >显示弹出式验证码</button>
-</template>
-<script>
-	export default {
-		data() {
-			return {
-				formData:{
-					captcha:"",
-					scene:"test"
-				}
-			}
-		},
-		methods: {
-			verifyCaptcha(){
-				const uniCaptchaCo = uniCloud.importObject("uni-captcha-co")
-				uniCaptchaCo.verifyCaptcha(this.formData).then(e=>{
-					uni.showToast({
-						title: e.errMsg,
-						icon: 'none'
-					});
-				})
-			},
-			openPopupCaptcha(){
-				this.$refs['popup-captcha'].open()
-			}
-		}
-	}
-</script>
-```
-#### Props:
-| 字段         | 类型    | 必填 | 说明                                                         |
-| ------------ | ------- | ---- | ------------------------------------------------------------ |
-| scene        | String  | 是   | 使用场景值，用于防止不同功能的验证码混用，如：`login`、`pay` |
-| value/v-model| String  | -    | 验证码的值 |
-
-#### Events
-| 字段			| 类型		|   说明														|
-| ------------	| -------	|----------------	|
-| confirm		| Function	|  点击确定按钮事件	|
-
-
-## 公共模块
-- 云端一体组件`uni-captcha`和`uni-popup-captcha`，已经集成公共模块的获取验证码`create`和刷新验证码`refresh`接口。
-- 引入公共模块请参考[云函数公用模块](https://uniapp.dcloud.net.cn/uniCloud/cf-common)
-
-### 获取验证码@create
-用于新的验证码记录（使用云端一体组件的用户可以忽略）
-
-示例：
-```js
-//引入公共模块
-const uniCaptcha = require('uni-captcha')
-module.exports = {
-	async createCaptcha({scene}) {
-		return await uniCaptcha.create({
-			scene,
-			width:100,
-			height:44
-		});
-	}
-}
-```
-
-**参数说明**
-
-| 字段         | 类型    | 必填 | 默认值  | 说明                                                         |
-| ------------ | ------- | ---- | ------- | ------------------------------------------------------------ |
-| scene        | String  | 是   | -       | 使用场景值，用于防止不同功能的验证码混用，如：`login`、`pay` |
-| deviceId     | String  | -    | -       | 设备 id，如果不传，将自动从 uniCloud 上下文获取              |
-| uniPlatform  | String	 | -	| -		  | uni-app 运行平台 												|
-| width        | Number  | -    | 150     | 图片宽度                                                     |
-| height       | Number  | -    | 40      | 图片高度                                                     |
-| background   | String  | -    | #FFFAE8 | 验证码背景色，设置空字符`''`不使用背景颜色                   |
-| size         | Number  | -    | 4       | 验证码长度，最多 6 个字符                                    |
-| noise        | Number  | -    | 4       | 验证码干扰线条数                                             |
-| color        | Boolean | -    | false   | 字体是否使用随机颜色，当设置`background`后恒为`true`         |
-| fontSize     | Number  | -    | 40      | 字体大小                                                     |
-| ignoreChars  | String  | -    | ''      | 忽略哪些字符                                                 |
-| mathExpr     | Boolean | -    | false   | 是否使用数学表达式                                           |
-| mathMin      | Number  | -    | 1       | 表达式所使用的最小数字                                       |
-| mathMax      | Number  | -    | 9       | 表达式所使用的最大数字                                       |
-| mathOperator | String  | -    | ''      | 表达式所使用的运算符，支持 `+`、`-`。不传则随机使用            |
-| expiresDate  | Number  | -    | 180     | 验证码过期时间(s)                                            |
-
-**注意：**
-- **自`uni-captcha 0.3.0`起，支持在[unicloud配置中心](https://ext.dcloud.net.cn/plugin?id=4425)`uni-config-center`->`uni-captcha`->`config.json`中配置参数默认值**
-- 如果想替换字体，请保证字体格式为 `.ttf` 且包含 `ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+-` 字符
-
-
-**响应参数**
-
-| 字段          | 类型   | 说明                |
-| ------------- | ------ | ------------------- |
-| errCode          | Number | 错误码，0 表示成功  |
-| errMsg       | String | 详细信息            |
-| captchaBase64 | String | 验证码：base64 格式 |
-
-
-### 刷新验证码@refresh
-作废相同设备id和场景值的验证码记录，并创建新的验证码记录（使用云端一体组件的用户可以忽略）
-
-示例：
-```js
-//引入公共模块
-const uniCaptcha = require('uni-captcha')
-const db = uniCloud.database();
-const verifyCodes = db.collection('opendb-verify-codes')
-module.exports = {
-	async refreshCaptcha({scene}) {
-		let res = await verifyCodes.where({scene,deviceId,state:0}).limit(1).get()
-		if(res.data.length){
-			return await uniCaptcha.refresh({
-				scene,
-				width:100,
-				height:44
-			});
-		}else{
-			return {
-				errCode: "uni-captcha-refresh-fail",
-				errMsg: '未找到相同设备id和场景值的有效验证码记录'
-			}
-		}
-	}
-}
-```
-
-**参数说明**
-
-| 字段     | 类型   | 必填 | 默认值 | 说明                                            |
-| -------- | ------ | ---- | ------ | ----------------------------------------------- |
-| scene    | String | 是   | -      | 类型，用于防止不同功能的验证码混用              |
-| deviceId | String | -    | -      | 设备 id，如果不传，将自动从 uniCloud 上下文获取 |
-
-**响应参数**
-
-| 字段          | 类型   | 说明                |
-| ------------- | ------ | ------------------- |
-| errCode          | Number | 错误码，0 表示成功  |
-| errMsg       | String | 详细信息            |
-| captchaBase64 | String | 验证码：base64 格式 |
-
-`注意：`
-
-- 支持传入 create 方法的所有参数，如果不传，则自动按照 deviceId 匹配上次生成时的配置生成新的验证码
-
-
-### 校验验证码@verify
-用于验证用户输入的验证码是否正确
-
-```js
-const uniCaptcha = require('uni-captcha')
-module.exports = {
-	async verify({scene,captcha}) {
-		let res = await uniCaptcha.verify({scene,captcha})
-		if(res.code == 0){
-			//...这里写你的业务逻辑
-		}else{
-			return res
-		}
-	}
-}
-```
-
-**参数说明**
-
-| 字段     | 类型   | 必填 | 默认值 | 说明                                            |
-| -------- | ------ | ---- | ------ | ----------------------------------------------- |
-| scene    | String | 是   | -      | 类型，用于防止不同功能的验证码混用              |
-| captcha  | String | 是   | -      | 验证码                                          |
-| deviceId | String | -    | -      | 设备 id，如果不传，将自动从 uniCloud 上下文获取 |
-
-**响应参数**
-
-| 字段    | 类型   | 说明               |
-| ------- | ------ | ------------------ |
-| errCode    | Number | 错误码，0 表示成功 |
-| errMsg | String | 详细信息           |
-
-`注意：`
-
-- 若提示验证码失效，请重新获取
-- 如果为了更小的代码体积，不想使用本方法，也可以直接查库校验
-
-
-## 错误码
-**已过期，uni-captcha 0.3.0起，返回值均已符合[uniCloud响应体规范](https://uniapp.dcloud.io/uniCloud/cf-functions.html#resformat)**
-
-_详细信息请查看 message 中查看_
-
-|  模块	| 模块码| 错误代码	|        错误信息			|
-| :----:| :----:| :------:	| :---------------------:	|
-| 验证码|  100	|    01		| （10001）验证码生成失败	|
-|		|		|    02		| （10002）验证码校验失败	|
-|		|		|    03		| （10003）验证码刷新失败	|
\ No newline at end of file
+下载地址：[https://ext.dcloud.net.cn/plugin?id=4048](https://ext.dcloud.net.cn/plugin?id=4048)
+
+GitCode 仓库：[https://gitee.com/dcloud/uni-captcha](https://gitee.com/dcloud/uni-captcha)
+
+## 用途说明
+主要起到人机校验或其他限制调用的作用，如：
+- 防止机器冒充人类做暴力破解
+- 防止大规模在线注册滥用服务
+- 防止滥用在线批量操作
+- 防止信息被大量采集聚合
+
+常见的业务场景有：
+- 注册环节：防止无效垃圾注册，从源头进行管理
+- 登录环节：防止撞库攻击、暴力破解，保障用户数据
+- 短信防刷：减少短信接口被刷情况，减少企业不必要成本
+- 互动环节：防止批量垃圾互动信息，破坏用户UGC内容生态
+- 激励领取：防止被批量褥羊毛
+
+## 组成部分
+1. 数据表：[opendb-verify-codes](https://gitee.com/dcloud/opendb/blob/master/collection/opendb-verify-codes/collection.json)，用于存储验证码相关数据
+2. 公共模块：`uni-captcha`，集成获取、刷新、校验验证码
+3. 云对象：`uni-captcha-co`，集成获取验证码的api
+4. 云端一体组件：`uni-captcha`和`uni-popup-captcha`，集成创建、刷新、显示验证码
+
+## 目录结构@catalogue
+<pre v-pre="" data-lang="">
+    <code class="lang-" style="padding:0">
+├─uni_modules                              			存放[uni_module](/uni_modules)规范的插件。
+│	└─uni-captcha
+│		├─uniCloud
+│		│	├─cloudfunctions						云函数目录
+│		│	│	├─common							公共模块目录
+│		│	│	│	└─uni-captcha					uni-captcha公共模块
+│		│	│	└─uni-captcha-co					集成调用uni-captcha方法的云对象
+│		│	└─database
+│		│	 	├─opendb-verify-codes.schema.json	验证码数据表
+│		│		└─db_init.json						初始化数据库文件
+│		└─components								组件目录
+│			├─uni-captcha					   		 
+│			│	└─uni-captcha.vue					普通验证码组件
+│			└─uni-popup-captcha				  		
+│				└─uni-popup-captcha.vue				弹出式验证码组件
+    </code>
+</pre>
+
+## 原理时序
+1. 客户端，向服务端请求某一应用场景的验证码。提示：这里用场景值`scene`，表示应用场景，用于防止不同功能的验证码混用，如：`login`、`pay`
+2. 服务端，创建验证码，即：向数据表`opendb-verify-codes`中创建状态为待验证的验证码记录（作废同一个设备id和场景值的旧验证码记录），并返回格式为base64的图形验证码资源数据。提示：这里的数据表，状态字段名：`state`用`0`表示待验证，用`2`表示已作废。
+3. 客户端，得到验证码图片，用户识别后输入验证码的值与表单数据一起提交至服务端
+4. 服务端，云函数或clientDB action中校验验证码，决定是否执行业务逻辑。如果验证码错误则返回错误信息，客户端再重复步骤1-3。提示：验证验证码，可以使用封装好的公共模块的`verify`方法[详情](#校验验证码@verify)，也可以直接查库校验。
+
+以上即完整的流程。
+如果在前端表单页面中，使用本插件封装好的云端一体组件，并配置组件的属性场景值`scene`，即等价于如上步骤1-3；
+
+本插件已集成使用示例，使用HBuilderX导入示例项目体验；另外你也可以参考插件在[uni-starter](https://ext.dcloud.net.cn/plugin?id=5057)中的应用。
+
+## 云端一体组件介绍
+内置调用`uni-captcha-co`云对象集成创建/刷新验证码，组件支持双向数据绑定。
+
+### 验证码配置（可选）：
+
+参数说明：
+
+| 字段			| 类型		| 默认值	| 说明															|
+| ------------	| -------	| -------	| ------------------------------------------------------------	|
+| width			| Number	| 150		| 图片宽度														|
+| height		| Number	| 40		| 图片高度														|
+| background	| String	| #FFFAE8	| 验证码背景色，设置空字符`''`不使用背景颜色					|
+| size			| Number	| 4			| 验证码长度，最多 6 个字符										|
+| noise			| Number	| 4			| 验证码干扰线条数												|
+| color			| Boolean	| false		| 字体是否使用随机颜色，当设置`background`后恒为`true`			|
+| fontSize		| Number	| 40		| 字体大小														|
+| ignoreChars	| String	| 			| 忽略哪些字符													|
+| mathExpr		| Boolean	| false		| 是否使用数学表达式											|
+| mathMin		| Number	| 1			| 表达式所使用的最小数字										|
+| mathMax		| Number	| 9			| 表达式所使用的最大数字										|
+| mathOperator	| String	| 			| 表达式所使用的运算符，支持 `+`、`-`。不传则随机使用				|
+| expiresDate	| Number	| 180		| 验证码过期时间(s)							|
+| scene			| Object	| 			| 根据场景值配置（版本号：0.6.0+ 支持）							|
+
+配置路径：[unicloud配置中心](https://ext.dcloud.net.cn/plugin?id=4425)，`uni-config-center`->`uni-captcha`->`config.json`
+示例：
+```
+	{
+		"width":150,
+		"height":40,
+		"background":"#FFFAE8",
+		"size":4,
+		"noise":4,
+		"color":false,
+		"fontSize":40,
+		"ignoreChars":"",
+		"mathExpr":false,
+		"mathMin":1,
+		"mathMax":9,
+		"mathOperator":"",
+		"expiresDate":180,
+		"scene":{
+			"login":{
+				"mathExpr":true	 	//该配置会覆盖根节点的值，表示scene的值为login时，验证码使用数学表达式
+			},
+			"register":{
+				"expiresDate":60,	 //该配置会覆盖根节点的值，表示scene的值为login时，验证码过期时间为60秒
+			}
+		}
+	}
+```
+
+注意：`uni-config-center`不支持注释，如果直接复制配置示例代码，要将注释删除
+
+**替换字体：**
+路径：`/uni_modules/uni-captcha/uniCloud/cloudfunctions/common/uni-captcha/fonts/font.ttf`。
+请保证字体格式为 `.ttf` 且包含 `ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+-` 字符
+
+
+**已过期的配置**（版本号：0.6.0+ 已不再支持此方式 ）：
+
+在云对象`uni-captcha-co`中配置，路径：`/uni_modules/uni-captcha/uniCloud/cloudfunctions/uni-captcha-co/config.js`->`image-captcha` 云对象`uni-captcha-co`中的配置，优先级大于在`unicloud配置中心`的配置
+
+### 普通验证码组件
+**组件名：uni-captcha**
+
+组件遵从[easycom组件规范](https://uniapp.dcloud.io/component/#easycom%E7%BB%84%E4%BB%B6%E8%A7%84%E8%8C%83)
+
+使用示例：
+```html
+<template>
+	<uni-captcha scene="场景值" v-model="验证码的值"></uni-captcha>
+</template>
+```
+#### Props:
+| 字段         | 类型    | 必填 | 默认值  | 说明                                                         |
+| ------------ | ------- | ---- | ------- | ------------------------------------------------------------ |
+| scene        | String  | 是   | -       | 使用场景值，用于防止不同功能的验证码混用，如：`login`、`pay` |
+| value/v-model| String  | -    | -       | 验证码的值 |
+
+
+### 弹出式验证码组件
+**组件名：uni-popup-captcha**
+
+组件遵从[easycom组件规范](https://uniapp.dcloud.io/component/#easycom%E7%BB%84%E4%BB%B6%E8%A7%84%E8%8C%83)
+
+验证码实现人机校验等作用的同时，降低了用户体验。为了提升用户体验：绝大部分情况下，验证码应当是非常态的，当接口被高频调用的情况下才需要。
+另外验证码会使得我们的前端界面设计变得复杂。所以弹出式验证码组件，应需而生。
+
+#### 使用示例：
+```html
+<template>
+	<uni-popup-captcha ref="popup-captcha" @confirm="verifyCaptcha" :scene="formData.scene" v-model="formData.captcha"></uni-popup-captcha>
+	<button @click="openPopupCaptcha" >显示弹出式验证码</button>
+</template>
+<script>
+	export default {
+		data() {
+			return {
+				formData:{
+					captcha:"",
+					scene:"test"
+				}
+			}
+		},
+		methods: {
+			verifyCaptcha(){
+				const uniCaptchaCo = uniCloud.importObject("uni-captcha-demo")
+				uniCaptchaCo.verifyCaptcha(this.formData).then(e=>{
+					uni.showToast({
+						title: e.errMsg,
+						icon: 'none'
+					});
+				})
+			},
+			openPopupCaptcha(){
+				this.$refs['popup-captcha'].open()
+			}
+		}
+	}
+</script>
+```
+#### Props:
+| 字段         | 类型    | 必填 | 说明                                                         |
+| ------------ | ------- | ---- | ------------------------------------------------------------ |
+| scene        | String  | 是   | 使用场景值，用于防止不同功能的验证码混用，如：`login`、`pay` |
+| value/v-model| String  | -    | 验证码的值 |
+
+#### Events
+| 字段			| 类型		|   说明														|
+| ------------	| -------	|----------------	|
+| confirm		| Function	|  点击确定按钮事件	|
+
+
+## 公共模块
+- 云端一体组件`uni-captcha`和`uni-popup-captcha`，已经集成公共模块的获取验证码`create`和刷新验证码`refresh`接口。
+- 引入公共模块请参考[云函数公用模块](https://uniapp.dcloud.net.cn/uniCloud/cf-common)
+
+### 获取验证码@create
+用于新的验证码记录（使用云端一体组件的用户可以忽略）
+
+示例：
+```js
+//引入公共模块
+const uniCaptcha = require('uni-captcha')
+module.exports = {
+	async createCaptcha({scene}) {
+		return await uniCaptcha.create({
+			scene,
+			width:100,
+			height:44
+		});
+	}
+}
+```
+
+**参数说明**
+
+| 字段         | 类型    | 必填 | 默认值  | 说明                                                         |
+| ------------ | ------- | ---- | ------- | ------------------------------------------------------------ |
+| scene        | String  | 是   | -       | 使用场景值，用于防止不同功能的验证码混用，如：`login`、`pay` |
+| deviceId     | String  | -    | -       | 设备 id，如果不传，将自动从 uniCloud 上下文获取              |
+| uniPlatform  | String	 | -	| -		  | uni-app 运行平台 												|
+| width        | Number  | -    | 150     | 图片宽度                                                     |
+| height       | Number  | -    | 40      | 图片高度                                                     |
+| background   | String  | -    | #FFFAE8 | 验证码背景色，设置空字符`''`不使用背景颜色                   |
+| size         | Number  | -    | 4       | 验证码长度，最多 6 个字符                                    |
+| noise        | Number  | -    | 4       | 验证码干扰线条数                                             |
+| color        | Boolean | -    | false   | 字体是否使用随机颜色，当设置`background`后恒为`true`         |
+| fontSize     | Number  | -    | 40      | 字体大小                                                     |
+| ignoreChars  | String  | -    | ''      | 忽略哪些字符                                                 |
+| mathExpr     | Boolean | -    | false   | 是否使用数学表达式                                           |
+| mathMin      | Number  | -    | 1       | 表达式所使用的最小数字                                       |
+| mathMax      | Number  | -    | 9       | 表达式所使用的最大数字                                       |
+| mathOperator | String  | -    | ''      | 表达式所使用的运算符，支持 `+`、`-`。不传则随机使用            |
+| expiresDate  | Number  | -    | 180     | 验证码过期时间(s)                                            |
+
+**注意：**
+- **自`uni-captcha 0.3.0`起，支持在[unicloud配置中心](https://ext.dcloud.net.cn/plugin?id=4425)`uni-config-center`->`uni-captcha`->`config.json`中配置参数默认值**
+- 如果想替换字体，请保证字体格式为 `.ttf` 且包含 `ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+-` 字符
+
+
+**响应参数**
+
+| 字段          | 类型   | 说明                |
+| ------------- | ------ | ------------------- |
+| errCode          | Number | 错误码，0 表示成功  |
+| errMsg       | String | 详细信息            |
+| captchaBase64 | String | 验证码：base64 格式 |
+
+
+### 刷新验证码@refresh
+作废相同设备id和场景值的验证码记录，并创建新的验证码记录（使用云端一体组件的用户可以忽略）
+
+示例：
+```js
+//引入公共模块
+const uniCaptcha = require('uni-captcha')
+const db = uniCloud.database();
+const verifyCodes = db.collection('opendb-verify-codes')
+module.exports = {
+	async refreshCaptcha({scene}) {
+		let res = await verifyCodes.where({scene,deviceId,state:0}).limit(1).get()
+		if(res.data.length){
+			return await uniCaptcha.refresh({
+				scene,
+				width:100,
+				height:44
+			});
+		}else{
+			return {
+				errCode: "uni-captcha-refresh-fail",
+				errMsg: '未找到相同设备id和场景值的有效验证码记录'
+			}
+		}
+	}
+}
+```
+
+**参数说明**
+
+| 字段     | 类型   | 必填 | 默认值 | 说明                                            |
+| -------- | ------ | ---- | ------ | ----------------------------------------------- |
+| scene    | String | 是   | -      | 类型，用于防止不同功能的验证码混用              |
+| deviceId | String | -    | -      | 设备 id，如果不传，将自动从 uniCloud 上下文获取 |
+
+**响应参数**
+
+| 字段          | 类型   | 说明                |
+| ------------- | ------ | ------------------- |
+| errCode          | Number | 错误码，0 表示成功  |
+| errMsg       | String | 详细信息            |
+| captchaBase64 | String | 验证码：base64 格式 |
+
+`注意：`
+
+- 支持传入 create 方法的所有参数，如果不传，则自动按照 deviceId 匹配上次生成时的配置生成新的验证码
+
+
+### 校验验证码@verify
+用于验证用户输入的验证码是否正确
+
+```js
+const uniCaptcha = require('uni-captcha')
+module.exports = {
+	async verify({scene,captcha}) {
+		let res = await uniCaptcha.verify({scene,captcha})
+		if(res.code == 0){
+			//...这里写你的业务逻辑
+		}else{
+			return res
+		}
+	}
+}
+```
+
+**参数说明**
+
+| 字段     | 类型   | 必填 | 默认值 | 说明                                            |
+| -------- | ------ | ---- | ------ | ----------------------------------------------- |
+| scene    | String | 是   | -      | 类型，用于防止不同功能的验证码混用              |
+| captcha  | String | 是   | -      | 验证码                                          |
+| deviceId | String | -    | -      | 设备 id，如果不传，将自动从 uniCloud 上下文获取 |
+
+**响应参数**
+
+| 字段    | 类型   | 说明               |
+| ------- | ------ | ------------------ |
+| errCode    | Number | 错误码，0 表示成功 |
+| errMsg | String | 详细信息           |
+
+`注意：`
+
+- 若提示验证码失效，请重新获取
+- 如果为了更小的代码体积，不想使用本方法，也可以直接查库校验
+
+
+## 错误码
+**已过期，uni-captcha 0.3.0起，返回值均已符合[uniCloud响应体规范](https://uniapp.dcloud.io/uniCloud/cf-functions.html#resformat)**
+
+_详细信息请查看 message 中查看_
+
+|  模块	| 模块码| 错误代码	|        错误信息			|
+| :----:| :----:| :------:	| :---------------------:	|
+| 验证码|  100	|    01		| （10001）验证码生成失败	|
+|		|		|    02		| （10002）验证码校验失败	|
+|		|		|    03		| （10003）验证码刷新失败	|
-- 
GitLab