## 安裝
首先使用`Composer`安裝`think-captcha`擴展包:
~~~
composer require topthink/think-captcha
~~~
> 驗證碼庫需要開啟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`等字符
- 搭建ThinkPHP6的開發環境
- 配置ThinkPHP6
- 必要的基礎知識(basic)
- MVC開發模式
- 控制器(controller)
- 數據庫(database)
- 模型(model)
- 模型關聯(relation)
- 視圖(view)
- Session
- Cookie
- 緩存(cache)
- 上傳(upload)
- 驗證器(validate)
- 驗證碼(captcha)
- 命令行(command)
- 服務器部署(deploy)
- 數據備份(backup)
- 數據同步(synchronization)
- 訂閱服務(subscribe)
- PHP 易混淆知識點
- 助手函數
- MySQL規范
- Redis 規范
- office插件 phpoffice
- 拼音插件 pinyin
- 日期插件 datetime
- 消息插件 amqp
- 產品部署環境的搭建
- PDF 等雜項處理
- 文件上傳
- 常用擴展
- flc/dysms
- 使用示例 ①
- 使用示例 ②
- qiniu/php-sdk
- 簡介
- 使用示例
- 使用示例 2 ②
- liliuwei/thinkphp-jump
- 擴展介紹
- 下載擴展
- 使用方法
- topthink/think-captcha
- 安裝擴展
- 驗證碼顯示
- 更換驗證碼
- 驗證碼校驗
- 驗證碼配置
- 自定義驗證碼
- phpoffice/phpspreadsheet
- 數據寫入表格
- 讀取表格數據
- topthink/think-queue
- 安裝
- 自定義函數
- 任務類
- 帶有日志的任務類