PHPackages                             isszz/think-scaptcha - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. isszz/think-scaptcha

ActiveLibrary[Utility & Helpers](/categories/utility)

isszz/think-scaptcha
====================

thinkphp8 SVG验证码，兼容tp6

v0.0.4(2y ago)4102[1 issues](https://github.com/isszz/think-scaptcha/issues)MITPHPPHP >=8.0.0

Since Jul 26Pushed 2y ago1 watchersCompare

[ Source](https://github.com/isszz/think-scaptcha)[ Packagist](https://packagist.org/packages/isszz/think-scaptcha)[ RSS](/packages/isszz-think-scaptcha/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (4)Dependencies (1)Versions (5)Used By (0)

[![](demo.png)](demo.png)

think-scaptcha
==============

[](#think-scaptcha)

> 使用`PHP`生成`SVG`格式的验证码
> 需要`PHP`大于`8.0`
> 支持`thinkphp6`以及`thinkphp8`
> 现已支持缓存字形，提高了在字体文件过大，导致生成验证码过慢的问题

 [![Minimum PHP Version](https://camo.githubusercontent.com/e8223ac675b6f9feddec95a806a57528e8009d21035aca7c0650e6006fa81c36/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d3e3d382e302d3838393242462e737667)](https://packagist.org/packages/isszz/think-scaptcha) [![Minimum Thinkphp Version](https://camo.githubusercontent.com/2bc52c123b7ec544298bd4aa257f4efb62df5ce49bfa1f6fdfadc2e20cfad61a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7468696e6b7068702d3e3d362e782d3838393242462e737667)](https://packagist.org/packages/isszz/think-scaptcha) [![Stable Version](https://camo.githubusercontent.com/b055d36aa63bfd519568c719c2ca4efd955b44243a8722bf3e04e191a1b279ca/68747470733a2f2f706f7365722e707567782e6f72672f6973737a7a2f7468696e6b2d73636170746368612f762f737461626c65)](https://packagist.org/packages/isszz/think-scaptcha) [![Total Downloads](https://camo.githubusercontent.com/56887e0bdc26eab3bea2ed94ddc8a3cea96e450f1b48d523208169b8db96840a/68747470733a2f2f706f7365722e707567782e6f72672f6973737a7a2f7468696e6b2d73636170746368612f646f776e6c6f616473)](https://packagist.org/packages/isszz/think-scaptcha) [![License](https://camo.githubusercontent.com/b85344351ca67180c69164fbaba214d16e045577b8cb031648e7890c5820853c/68747470733a2f2f706f7365722e707567782e6f72672f6973737a7a2f7468696e6b2d73636170746368612f6c6963656e7365)](https://packagist.org/packages/isszz/think-scaptcha)

避坑
--

[](#避坑)

- 非token模式，务必开启session中间件，验证如果一直提示错误时，注意cookie的作用域，因为tp的sessionID是存储到cookie的，所以cookie作用域配置有问题也会导致无法正确验证
- 每个文字首次载入时还是需要读取字体，所以在使用英文，数字的情况缓存下来还是挺快的，因为文字种类比较少，能很快缓存下来
- 如果自行配置`char`为中文，使用中文验证码时，请务必确认所使用字体包含该汉字
- 建议生产环境尽量使用缓存后的字形，提高生成验证码的速度

安装
--

[](#安装)

```
composer require isszz/think-scaptcha
```

> 如果需要添加字体，放入tp根目录下config/fonts目录即可，更改配置fontName=字体文件名

配置
--

[](#配置)

```
return [
    'type' => null, // 单独的配置项
    'cache' => true, // 是否启用字形缓存
    'api' => false, // 是否是API模式
    // 设置为1时不管验证对错, 都会删除存储凭证，若验证失败则需要刷新一次验证码
    // 设置为0时, 直到验证输入正确时, 才删除存储凭证，也就是允许试错
    // 非API模式或者未配置token机制，则需要设置2才能让验证码为一次性
    'disposable' => 0,
    'width' => 150, // 宽度
    'height' => 50, // 高度
    'noise' => 5, // 干扰线条的数量
    'inverse' => false, // 反转颜色
    'color' => true, // 文字是否随机色
    'background' => '', // 验证码背景色
    'size' => 4, // 验证码字数
    'ignoreChars' => '', // 验证码字符中排除
    'fontSize' => 52, // 字体大小
    'char' => 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789', // 预设随机字符
    'math' => '', // 运算模式：1=加法，2=减法，3=乘法，4=除法，或非1=4，则随机四种
    'mathMin' => 1, // 用于计算的最小值
    'mathMax' => 9, // 用于计算的最大值
    'fontName' => 'Comismsh.ttf', // 用于验证码的字体, 字体文件需要放置根目录config/fonts/目录下面

    // API模式，使用token机制，使用这里的配置后API会携带一个token，在验证时需要携带token和输入的code进行验证
    /*'token' => [
        // 也可以自定义\app\common\libs\MyStore::class,
        // 自带可选：cache，redis，session；
        // 建议使用redis或者cache（tp自带缓存），session会牵扯跨域
        'store' => 'cache',
        'expire' => 300,
        // 不配置时会获取tp的cache->redis驱动实例
        'redis' => [
            'host' => '127.0.0.1',
            'port' => 6379,
            'password' => '',
            'select' => 1,
            'timeout' => 0,
        ],
    ],*/

    // 单独的配置, 会覆盖上面的配置
    'test' => [
        'noise' => 3,
        'color' => false,
        'char' => '0123456789',
        // 'token' => null,
    ],
];
```

#### 支持的url参数配置

[](#支持的url参数配置)

`url`配置参数优先级最高

```
/scaptcha/t/单独的配置名
         /m/运算模式：1=加法，2=减法，3=乘法，4=除法，或随机四种
         /w/宽度
         /h/高度
         /s/字体大小
         /l/非运算模式时，文字数量
         /n/干扰线条数量
         /c/文字是否随机色
         /b/背景颜色
         /d/一次性验证码（忽略对错），非API模式需要设置2
         /cs/api模式输出格式1=svg，2=base64
         /rt/禁用缓存字形，生产模式不建议禁用
         /reset/删除已缓存字形，不建议在生产模式一直加在url参数中，否则字形缓存无效，字体文件超过3MB会比较慢
```

使用方法
----

[](#使用方法)

`composer`安装后可直接访问`/scaptcha`路径访问验证码，默认获取的是json格式:

```
{
    'code': 0,
    'msg': 'success',
    'token': '8SOy2KSfcSVIP7qTogFCLvLZb9tj5eTB', // API模式，使用token机制否则返回null
    'svg': 'data:image/svg+xml,.../%3E%3C/svg%3E',
}
```

访问`/scaptcha/svg`时获取到的是可渲染的svg：

```

```

非必要情况，可使用组件自己注册的路由地址使用

### 快捷助手函数

[](#快捷助手函数)

tp模板文件中使用

```

{:scaptcha_img(['l' => 3], 'J_captcha')}
```

或者

```

 5,
    ]);
?>

```

如果是API方式调用

```
[$token, $image] = scaptcha_api([
    'noise' => 3, // 3条干扰线
    'color' => false, // 灰色模式
    'char' => '0123456789', // 数字验证码
]);

// 或指定单独的配置，第二个参数用于选择生成的格式false=svg，true=base64
[$token, $image] = scaptcha_api('test', true);
```

### 若需要自行在控制器输出验证码🌰

[](#若需要自行在控制器输出验证码)

```
class Captcha
{
    /**
     * 获取验证码, 用于api
    */
    public function index()
    {
        return json([
            'code' => 0,
            'data' => scaptcha(),
            'msg' => 'success',
        ]);
    }

    /**
     * 直接显示svg验证码
    */
    public function svg()
    {
        $content = scaptcha();

        return response($content, 200, ['Content-Length' => strlen($content)])->contentType('image/svg+xml');
    }

    /**
     * 验证输入验证码是否正确|输出json
    */
    public function check($code, string|null $token = null)
    {
        $json = [
            'code' => 0,
            'msg' => 'success',
            'data' => null,
        ];

        if(!scaptcha_check($code, $token)) {
            $json['code'] = 1;
            $json['msg'] = 'error';
        }

        return json($json);
    }
}
```

验证
--

[](#验证)

使用组件注册的验证地址验证

```
/scaptcha/check/code/xxx
// 或者
/scaptcha/check?code=xxx
// 如果是API模式
/scaptcha/check/code/输入验证码/token/接口返回的token字段
/scaptcha/check?code=输入验证码&token=接口返回的token字段

// 返回
{
    'code': 0, // 0=验证成；1=验证失败；2=未提交验证码；3=验证码组件报错，请issue
    'msg': 'success',
}
```

使用组件注册好的验证器规则，在控制器中验证

```
$this->validate($data, [
    'scaptcha|验证码' => 'require|scaptcha'
]);
```

或者手动验证

```
if(!scaptcha_check($code)) {
    // 验证失败
}
```

本组件基于以下开源库
----------

[](#本组件基于以下开源库)

- php字体库: [PhenX/php-font-lib](https://github.com/PhenX/php-font-lib)
- svg-captcha nodejs版: [lichaozhy/svg-captcha](https://github.com/lichaozhy/svg-captcha)

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance15

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

4

Last Release

1018d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/69a944bc69c24c6b069b99b047f791b359844dbc71a42404fbfd6ef3b484c05f?d=identicon)[isszz](/maintainers/isszz)

---

Top Contributors

[![isszz](https://avatars.githubusercontent.com/u/2878463?v=4)](https://github.com/isszz "isszz (19 commits)")

### Embed Badge

![Health badge](/badges/isszz-think-scaptcha/health.svg)

```
[![Health](https://phpackages.com/badges/isszz-think-scaptcha/health.svg)](https://phpackages.com/packages/isszz-think-scaptcha)
```

###  Alternatives

[topthink/think-captcha

captcha package for thinkphp

132934.4k68](/packages/topthink-think-captcha)[topthink/think-worker

workerman extend for thinkphp

202227.2k9](/packages/topthink-think-worker)[yunwuxin/think-cron

计划任务

17416.2k](/packages/yunwuxin-think-cron)[zzstudio/think-addons

The ThinkPHP6 Addons Package

1518.6k](/packages/zzstudio-think-addons)[topthink/think-annotation

Annotation For ThinkPHP

4831.5k8](/packages/topthink-think-annotation)[liliuwei/thinkphp-jump

适用于thinkphp6.0的跳转扩展

2874.4k1](/packages/liliuwei-thinkphp-jump)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)