## 安裝
首先使用`Composer`安裝`think-captcha`擴展包:
~~~
composer require topthink/think-captcha
~~~
>[danger] 驗證碼庫需要開啟Session才能生效。
## 使用
擴展包內定義了一些常見用法方便使用,可以滿足大部分常用場景,以下示例說明。
在模版內添加驗證碼的顯示代碼
~~~
<div>{:captcha_img()}</div>
~~~
或者
~~~
<div><img src="{:captcha_src()}" alt="captcha" /></div>
~~~
> 上面兩種的最終效果是一樣的,根據需要調用即可。
然后使用框架的內置驗證功能(具體可以參考驗證章節),添加`captcha`驗證規則即可
~~~
$this->validate($data,[
'captcha|驗證碼'=>'require|captcha'
]);
~~~
如果沒有使用內置驗證功能,則可以調研內置的函數手動驗證
~~~
if(!captcha_check($captcha)){
// 驗證失敗
};
~~~
如果是多應用模式下,你需要自己注冊一個驗證碼的路由。
```
Route::get('captcha/[:config]','\\think\\captcha\\CaptchaController@index');
```
## 配置
`Captcha`類帶有默認的配置參數,支持自定義配置。這些參數包括:
| 參數 | 描述 | 默認 |
| --- | --- | --- |
| codeSet | 驗證碼字符集合 | 略 |
| expire | 驗證碼過期時間(s) | 1800 |
| math| 使用算術驗證碼 | false |
| useZh | 使用中文驗證碼 | false |
| zhSet | 中文驗證碼字符串 | 略 |
| useImgBg | 使用背景圖片 | false |
| fontSize | 驗證碼字體大小(px) | 25 |
| useCurve | 是否畫混淆曲線 | true |
| useNoise | 是否添加雜點 | true |
| imageH | 驗證碼圖片高度,設置為0為自動計算 | 0 |
| imageW | 驗證碼圖片寬度,設置為0為自動計算 | 0 |
| length | 驗證碼位數 | 5 |
| fontttf | 驗證碼字體,不設置是隨機獲取 | 空 |
| bg | 背景顏色 | \[243, 251, 254\] |
| reset | 驗證成功后是否重置 | true |
直接在應用的`config`目錄下面的`captcha.php`文件中進行設置即可,例如下面的配置參數用于輸出4位數字驗證碼。
```
return [
'length' => 4,
'codeSet' => '0123456789',
];
```
## 自定義驗證碼
如果需要自己獨立生成驗證碼,可以調用`Captcha`類(`think\captcha\facade\Captcha`)操作。
在控制器中使用下面的代碼進行驗證碼生成:
~~~
<?php
namespace app\index\controller;
use think\captcha\facade\Captcha;
class Index
{
public function verify()
{
return Captcha::create();
}
}
~~~
然后訪問下面的地址就可以顯示驗證碼:
~~~
http://serverName/index/index/verify
~~~
輸出效果如圖

通常可以給驗證碼地址注冊路由
~~~
Route::get('verify','index/verify');
~~~
在模板中就可以使用下面的代碼顯示驗證碼圖片
~~~
<div><img src="{:url('index/verify')}" alt="captcha" /></div>
~~~
可以用`Captcha`類的`check`方法檢測驗證碼的輸入是否正確,
~~~
// 檢測輸入的驗證碼是否正確,$value為用戶輸入的驗證碼字符串
$captcha = new Captcha();
if( !$captcha->check($value))
{
// 驗證失敗
}
~~~
或者直接調用封裝的一個驗證碼檢測的函數`captcha_check`
~~~
// 檢測輸入的驗證碼是否正確,$value為用戶輸入的驗證碼字符串
if( !captcha_check($value ))
{
// 驗證失敗
}
~~~
如果你需要生成多個不同設置的驗證碼,可以使用下面的配置方式:
```
<?php
return [
'verify'=>[
'codeSet'=>'1234567890'
]
];
```
使用指定的配置生成驗證碼:
~~~
return Captcha::create('verify');
~~~
默認情況下,驗證碼的字體是隨機使用擴展包內 `think-captcha/assets/ttfs`目錄下面的字體文件,我們可以指定驗證碼的字體,例如:
修改或新建配置文件如下:
```
<?php
return [
'verify'=>[
'fontttf'=>'1.ttf'
]
];
```
~~~
return Captcha::create('verify');
~~~
> 默認的驗證碼字符已經剔除了易混淆的`1l0o`等字符
- 序言
- 基礎
- 安裝
- 開發規范
- 目錄結構
- 配置
- 架構
- 請求流程
- 架構總覽
- 入口文件
- 多應用模式
- URL訪問
- 容器和依賴注入
- 服務
- 門面
- 中間件
- 事件
- 路由
- 路由定義
- 變量規則
- 路由地址
- 路由參數
- 路由中間件
- 路由分組
- 資源路由
- 注解路由
- 路由綁定
- 域名路由
- MISS路由
- 跨域請求
- URL生成
- 控制器
- 控制器定義
- 基礎控制器
- 空控制器
- 資源控制器
- 控制器中間件
- 請求
- 請求對象
- 請求信息
- 輸入變量
- 請求類型
- HTTP頭信息
- 偽靜態
- 參數綁定
- 請求緩存
- 響應
- 響應輸出
- 響應參數
- 重定向
- 文件下載
- 數據庫
- 連接數據庫
- 分布式數據庫
- 查詢構造器
- 查詢數據
- 添加數據
- 更新數據
- 刪除數據
- 查詢表達式
- 鏈式操作
- where
- table
- alias
- field
- strict
- limit
- page
- order
- group
- having
- join
- union
- distinct
- lock
- cache
- cacheAlways
- comment
- fetchSql
- force
- partition
- failException
- sequence
- replace
- extra
- duplicate
- procedure
- 聚合查詢
- 分頁查詢
- 時間查詢
- 高級查詢
- 視圖查詢
- JSON字段
- 子查詢
- 原生查詢
- 獲取查詢參數
- 查詢事件
- 獲取器
- 事務操作
- 存儲過程
- 數據集
- 數據庫驅動
- 模型
- 定義
- 模型字段
- 新增
- 更新
- 刪除
- 查詢
- 查詢范圍
- JSON字段
- 獲取器
- 修改器
- 搜索器
- 數據集
- 自動時間戳
- 只讀字段
- 軟刪除
- 類型轉換
- 模型輸出
- 模型事件
- 模型關聯
- 一對一關聯
- 一對多關聯
- 遠程一對多
- 遠程一對一
- 多對多關聯
- 多態關聯
- 關聯預載入
- 關聯統計
- 關聯輸出
- 虛擬模型
- 視圖
- 模板變量
- 視圖過濾
- 模板渲染
- 模板引擎
- 視圖驅動
- 錯誤和日志
- 異常處理
- 日志處理
- 調試
- 調試模式
- Trace調試
- SQL調試
- 變量調試
- 遠程調試
- 驗證
- 驗證器
- 驗證規則
- 錯誤信息
- 驗證場景
- 路由驗證
- 內置規則
- 表單令牌
- 注解驗證
- 雜項
- 緩存
- Session
- Cookie
- 多語言
- 上傳
- 命令行
- 啟動內置服務器
- 查看版本
- 自動生成應用目錄
- 創建類庫文件
- 清除緩存文件
- 生成數據表字段緩存
- 生成路由映射緩存
- 輸出路由定義
- 自定義指令
- Debug輸出級別
- 擴展庫
- 數據庫遷移工具
- Workerman
- think助手工具庫
- 驗證碼
- Swoole
- 附錄
- 助手函數
- 升級指導
- 更新日志