EasySwoole 验证码组件

EasySwoole 提供了独立的 验证码组件 ，几行代码即可实现输出一个验证码，支持用户自定义验证码字体

组件要求

  • php: >=7.1
  • ext-gd: *
  • easyswoole/spl: ^1.0

安装方法

composer require easyswoole/verifycode=3.x

仓库地址

easyswoole/verifycode=3.x

基本使用

配置

生成验证码前需要传入 \EasySwoole\VerifyCode\Conf 的对象实例，\EasySwoole\VerifyCode\Conf 类实例化后会有默认配置，无需配置也可生成验证码图片。

下面是 \EasySwoole\VerifyCode\Conf 类提供的相关配置方法。

  1. <?php
  2. // +----------------------------------------------------------------------
  3. // | easySwoole [ use swoole easily just like echo "hello world" ]
  4. // +----------------------------------------------------------------------
  5. // | WebSite: https://www.easyswoole.com
  6. // +----------------------------------------------------------------------
  7. // | Welcome Join QQGroup 853946743
  8. // +----------------------------------------------------------------------
  10. namespace EasySwoole\VerifyCode;
  12. use EasySwoole\Spl\SplBean;
  14. /**
  15.  * 验证码配置文件
  16.  * Class VerifyCodeConf
  17.  * @author  : evalor <master@evalor.cn>
  18.  * @package Vendor\VerifyCode
  19.  */
  20. class Conf extends SplBean
  21. {
  23.     public $charset   = '1234567890AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz'; // 字母表
  24.     public $useCurve  = false;         // 混淆曲线
  25.     public $useNoise  = false;         // 随机噪点
  26.     public $useFont   = null;          // 指定字体
  27.     public $fontColor = null;          // 字体颜色
  28.     public $backColor = null;          // 背景颜色
  29.     public $imageL    = null;          // 图片宽度
  30.     public $imageH    = null;          // 图片高度
  31.     public $fonts     = [];            // 额外字体
  32.     public $fontSize  = 25;            // 字体大小
  33.     public $length    = 4;             // 生成位数
  34.     public $mime      = MIME::PNG;     // 设置类型
  35.     public $temp      = '/tmp';  // 设置缓存目录
  37.     public function setTemp($temp){
  38.         if (!is_dir($temp)) mkdir($temp,0755) && chmod($temp,0755);
  39.         $this->temp = $temp;
  40.     }
  42.     /**
  43.      * 设置图片格式
  44.      * @param $MimeType
  45.      * @author : evalor <master@evalor.cn>
  46.      * @return Conf
  47.      */
  48.     public function setMimeType($MimeType)
  49.     {
  50.         $allowMime = [ MIME::PNG, MIME::GIF, MIME::JPG ];
  51.         if (in_array($MimeType, $allowMime)) $this->mime = $MimeType;
  52.         return $this;
  53.     }
  55.     /**
  56.      * 设置字符集
  57.      * @param string $charset
  58.      * @return Conf
  59.      */
  60.     public function setCharset($charset)
  61.     {
  62.         is_string($charset) && $this->charset = $charset;
  63.         return $this;
  64.     }
  66.     /**
  67.      * 开启混淆曲线
  68.      * @param bool $useCurve
  69.      * @return Conf
  70.      */
  71.     public function setUseCurve($useCurve = true)
  72.     {
  73.         is_bool($useCurve) && $this->useCurve = $useCurve;
  74.         return $this;
  75.     }
  77.     /**
  78.      * 开启噪点生成
  79.      * @param bool $useNoise
  80.      * @return Conf
  81.      */
  82.     public function setUseNoise($useNoise = true)
  83.     {
  84.         is_bool($useNoise) && $this->useNoise = $useNoise;
  85.         return $this;
  86.     }
  88.     /**
  89.      * 使用自定义字体
  90.      * @param string $useFont
  91.      * @return Conf
  92.      */
  93.     public function setUseFont($useFont)
  94.     {
  95.         is_string($useFont) && $this->useFont = $useFont;
  96.         return $this;
  97.     }
  99.     /**
  100.      * 设置文字颜色
  101.      * @param array|string $fontColor
  102.      * @return Conf
  103.      */
  104.     public function setFontColor($fontColor)
  105.     {
  106.         if (is_string($fontColor)) $this->fontColor = $this->HEXToRGB($fontColor);
  107.         if (is_array($fontColor)) $this->fontColor = $fontColor;
  108.         return $this;
  109.     }
  111.     /**
  112.      * 设置背景颜色
  113.      * @param null $backColor
  114.      * @return Conf
  115.      */
  116.     public function setBackColor($backColor)
  117.     {
  118.         if (is_string($backColor)) $this->backColor = $this->HEXToRGB($backColor);
  119.         if (is_array($backColor)) $this->backColor = $backColor;
  120.         return $this;
  121.     }
  123.     /**
  124.      * 设置图片宽度
  125.      * @param int|string $imageL
  126.      * @return Conf
  127.      */
  128.     public function setImageWidth($imageL)
  129.     {
  130.         $this->imageL = intval($imageL);
  131.         return $this;
  132.     }
  134.     /**
  135.      * 设置图片高度
  136.      * @param null $imageH
  137.      * @return Conf
  138.      */
  139.     public function setImageHeight($imageH)
  140.     {
  141.         $this->imageH = intval($imageH);
  142.         return $this;
  143.     }
  145.     /**
  146.      * 设置字体集
  147.      * @param array|string $fonts
  148.      * @return Conf
  149.      */
  150.     public function setFonts($fonts)
  151.     {
  152.         if (is_string($fonts)) array_push($this->fonts, $fonts);
  153.         if (is_array($fonts) && !empty($fonts)) {
  154.             if (empty($this->fonts)) {
  155.                 $this->fonts = $fonts;
  156.             } else {
  157.                 array_merge($this->fonts, $fonts);
  158.             }
  159.         }
  160.         return $this;
  161.     }
  163.     /**
  164.      * 设置字体尺寸
  165.      * @param int $fontSize
  166.      * @return Conf
  167.      */
  168.     public function setFontSize($fontSize)
  169.     {
  170.         $this->fontSize = intval($fontSize);
  171.         return $this;
  172.     }
  174.     /**
  175.      * 设置验证码长度
  176.      * @param int $length
  177.      * @return Conf
  178.      */
  179.     public function setLength($length)
  180.     {
  181.         $this->length = intval($length);
  182.         return $this;
  183.     }
  185.     /**
  186.      * 获取配置值
  187.      * @param $name
  188.      * @author : evalor <master@evalor.cn>
  189.      * @return mixed
  190.      */
  191.     public function __get($name)
  192.     {
  193.         return $this->$name;
  194.     }
  196.     /**
  197.      * 十六进制转RGB
  198.      * @param $hexColor
  199.      * @author : evalor <master@evalor.cn>
  200.      * @return array
  201.      */
  202.     function HEXToRGB($hexColor)
  203.     {
  204.         $color = str_replace('#', '', $hexColor);
  205.         if (strlen($color) > 3) {
  206.             $rgb = array(
  207.                 hexdec(substr($color, 0, 2)),
  208.                 hexdec(substr($color, 2, 2)),
  209.                 hexdec(substr($color, 4, 2))
  210.             );
  211.         } else {
  212.             $color = $hexColor;
  213.             $r = substr($color, 0, 1) . substr($color, 0, 1);
  214.             $g = substr($color, 1, 1) . substr($color, 1, 1);
  215.             $b = substr($color, 2, 1) . substr($color, 2, 1);
  216.             $rgb = array(
  217.                 hexdec($r),
  218.                 hexdec($g),
  219.                 hexdec($b)
  220.             );
  221.         }
  222.         return $rgb;
  223.     }
  224. }

配置方法

需要对验证码进行自定义配置可以使用上文提到的组件提供的 \EasySwoole\VerifyCode\Conf 类进行动态配置。

  1. use EasySwoole\VerifyCode\Conf;
  2. $Conf = new Conf();

设置字符集合

可以自定义验证码生成时使用的字符集合，设置后从集合中随机选取，不设置则从 [0-9A-Za-z] 中随机选取

  1. $Conf->setCharset('123456ABCD');

设置背景色

设置验证码的背景颜色，不设置则默认使用白色，支持使用完整 HEX、缩写 HEX 和 RGB 值设置

  1. $Conf->setBackColor('#3A5FCD');
  2. $Conf->setBackColor('CCC');
  3. $Conf->setBackColor([30, 144, 255]);

设置文字颜色

设置验证码的文字颜色，不设置则随机生成一个颜色，支持使用完整 HEX、缩写 HEX 和 RGB 值设置

  1. $Conf->setFontColor('#3A5FCD');
  2. $Conf->setFontColor('CCC');
  3. $Conf->setFontColor([30, 144, 255]);

设置混淆

支持两种混淆方式，默认两种混淆都是关闭的，需要手动开启

  1. // 开启或关闭混淆曲线
  2. $Conf->setUseCurve();
  3. // 开启或关闭混淆噪点
  4. $Conf->setUseNoise();

设置字体

默认验证码类已经带有 6 种字体，如果需要增加自己的字体库来提高识别难度，或者指定使用的字体，可以进行如下设置，注意字体路径需要使用绝对路径，即文件的完整路径

  1. // 增加单个字体传入路径字符串
  2. $Conf->setFonts('path/to/file.ttf');
  3. // 增加多个字体传入路径的数组
  4. $Conf->setFonts(['path/to/file1.ttf', 'path/to/file2.ttf']);
  5. // 指定生成使用的字体文件
  6. $Conf->setUseFont('path/to/file.ttf');

其他设置

可以指定验证码图片宽高，字体大小，随机生成的验证码位数等

  1. // 设置验证码图片的宽度
  2. $Conf->setImageWidth(400);
  3. // 设置验证码图片的高度
  4. $Conf->setImageHeight(200);
  5. // 设置生成字体大小
  6. $Conf->setFontSize(30);
  7. // 设置生成验证码位数
  8. $Conf->setLength(4);

链式调用

为了更流畅的进行设置，所有的配置项均支持链式调用

  1. $Conf = new Conf();
  2. $Conf->setUseNoise()->setUseCurve()->setFontSize(30);

可以使用上方的动态配置，将设置好的配置类传入给验证码类。

  1. $Conf = new \EasySwoole\VerifyCode\Conf();
  2. $Conf->setFontSize(30);
  3. $VCode = new \EasySwoole\VerifyCode\VerifyCode($Conf);

如果配置比较多，也需要全站统一验证码配置，可以将验证码的配置放入配置文件，在生成时读取配置，验证码的配置类继承自 \EasySwoole\Spl\SplBean，可以在设置好后使用配置类的 toArray 方法直接获得配置数组，实例化验证码时，读取数组重新生成 \EasySwoole\VerifyCode\Conf 类即可。

验证码生成

\EasySwoole\VerifyCode\VerifyCode 验证码操作类，如果不传入 \EasySwoole\VerifyCode\Conf 实例，则自动实例化一个 \EasySwoole\VerifyCode\Conf 实例。

  1. <?php
  2. $config = new \EasySwoole\VerifyCode\Conf([
  3.     // 以下配置均为可选配置，用户可根据需求自行配置
  4.     # 'charset'  => '1234567890AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz', # 设置验证码字符集合，默认为 数字 + 大小写字母
  5.     # 'useCurve'  => false, # 设置不开启 混淆曲线，默认不开启
  6.     # 'useNoise'  => false, # 设置不开启 随机噪点，默认不开启
  7.     # 'useFont'   => null,  # 设置验证码使用的字体，默认随机获取内置字体
  8.     # 'fontColor' => null,  # 设置 字体颜色，默认随机获取，支持使用完整 HEX，缩写 HEX 和 RGB 值设置
  9.     # 'backColor' => null,  # 设置 背景颜色，默认白色，支持使用完整 HEX，缩写 HEX 和 RGB 值设置
  10.     # 'imageL'    => null,  # 设置 验证码宽度，默认 162.5px
  11.     # 'imageH'    => null,  # 设置 验证码高度，默认 50px
  12.     # 'fonts'     => [],    # 设置 验证码可能使用的字体集合，默认组件内置支持 5 种
  13.     # 'fontSize'  => 25,    # 设置 验证码字体大小，默认 25px
  14.     # 'length'    => 4,     # 设置 验证码位数，默认 4 位
  15. ]);
  17. # 使用方法单独配置 和 上述在构造函数中配置 等价
  18. // 设置验证码长度为 4 【其他配置方法请看上文 \EasySwoole\VerifyCode\Conf 类】
  19. # $config->setLength(4);
  21. $code = new \EasySwoole\VerifyCode\VerifyCode($config);
  22. $code->DrawCode();// 生成验证码，返回一个 \EasySwoole\VerifyCode\Result 对象

验证码结果类

验证码结果类，由 VerifyCode 验证码操作类调用 DrawCode() 方法时创建并返回。

下面是 \EasySwoole\VerifyCode\Result 类的具体实现，可获取创建验证码之后得到相关结果。

  1. <?php
  2. // +----------------------------------------------------------------------
  3. // | easySwoole [ use swoole easily just like echo "hello world" ]
  4. // +----------------------------------------------------------------------
  5. // | WebSite: https://www.easyswoole.com
  6. // +----------------------------------------------------------------------
  7. // | Welcome Join QQGroup 853946743
  8. // +----------------------------------------------------------------------
  10. namespace EasySwoole\VerifyCode;
  12. /**
  13.  * 验证码结果类
  14.  * Class Result
  15.  * @author : evalor <master@evalor.cn>
  16.  * @package easySwoole\VerifyCode
  17.  */
  18. class Result
  19. {
  20.     private $captchaByte;  // 验证码图片
  21.     private $captchaMime;  // 验证码类型
  22.     private $captchaCode;  // 验证码内容
  23.     private $createTime;
  25.     function __construct($Byte, $Code, $Mime)
  26.     {
  27.         $this->captchaByte = $Byte;
  28.         $this->captchaMime = $Mime;
  29.         $this->captchaCode = $Code;
  30.         $this->createTime = time();
  31.     }
  33.     function getCreateTime():int
  34.     {
  35.         return $this->createTime;
  36.     }
  38.     function getCodeHash($code = null,$time = null)
  39.     {
  40.         if(!$code){
  41.             $code = $this->captchaCode;
  42.         }
  43.         if(!$time){
  44.             $time = $this->createTime;
  45.         }
  46.         return substr(md5($code.$time),8,16);
  47.     }
  49.     /**
  50.      * 获取验证码图片
  51.      * @author : evalor <master@evalor.cn>
  52.      * @return mixed
  53.      */
  54.     function getImageByte()
  55.     {
  56.         return $this->captchaByte;
  57.     }
  59.     /**
  60.      * 返回图片Base64字符串
  61.      * @author : evalor <master@evalor.cn>
  62.      * @return string
  63.      */
  64.     function getImageBase64()
  65.     {
  66.         $base64Data = base64_encode($this->captchaByte);
  67.         $Mime = $this->captchaMime;
  68.         return "data:{$Mime};base64,{$base64Data}";
  69.     }
  71.     /**
  72.      * 获取验证码内容
  73.      * @author : evalor <master@evalor.cn>
  74.      * @return mixed
  75.      */
  76.     function getImageCode()
  77.     {
  78.         return $this->captchaCode;
  79.     }
  81.     /**
  82.      * 获取Mime信息
  83.      * @author : evalor <master@evalor.cn>
  84.      */
  85.     function getImageMime()
  86.     {
  87.         return $this->captchaMime;
  88.     }
  89. }

使用示例

  1. <?php
  2. /**
  3.  * Created by PhpStorm.
  4.  * User: Apple
  5.  * Date: 2018/11/12 0012
  6.  * Time: 16:30
  7.  */
  9. namespace App\HttpController;
  10. use EasySwoole\Http\AbstractInterface\Controller;
  11. use EasySwoole\VerifyCode\Conf;
  13. class VerifyCode extends Controller
  14. {
  15.     function index()
  16.     {
  17.         // 配置验证码
  18.         $config = new Conf();
  19.         $code = new \EasySwoole\VerifyCode\VerifyCode($config);
  21.         // 生成验证码
  22.         $drawCode = $code->DrawCode();
  24.         // 获取生成的验证码内容字符串 string(4) "0rnh"
  25.         // 可存储起来和用户输入的验证码比对
  26.         $codeStr = $drawCode->getImageCode();
  28.         // 设置响应文件内容类型
  29.         $this->response()->withHeader('Content-Type','image/png');
  31.         // 向客户端输出验证码图片
  32.         $this->response()->write($drawCode->getImageByte());
  33.     }
  35.     function getBase64()
  36.     {
  37.         // 配置验证码
  38.         $config = new Conf();
  39.         $code = new \EasySwoole\VerifyCode\VerifyCode($config);
  41.         // 生成验证码
  42.         $drawCode = $code->DrawCode();
  44.         // 获取生成的验证码内容字符串 string(4) "0rnh"
  45.         // 可存储起来和用户输入的验证码比对
  46.         $codeStr = $drawCode->getImageCode();
  48.         // 向客户端输出验证码的 base64 编码，前端可用来生成图片
  49.         $this->response()->write($drawCode->getImageBase64());
  50.     }
  51. }

访问 http://localhost:9501/VerifyCode/index (示例请求地址) 即可看到验证码图片，访问 http://localhost:9501/VerifyCode/getBase64 (示例请求地址) 即可得到验证码图片的 base64 编码结果。

进阶使用

生成二维码图片并返回，然后进行校验。

首先新建一个验证码工具类 \App\Utility\VerifyCodeTools，内容如下所示：

  1. <?php
  2. /**
  3.  * User: luffyQAQ
  4.  * Date: 2019/9/5 15:29
  5.  * Email: <1769360227@qq.com>
  6.  */
  8. namespace App\Utility;
  10. class VerifyCodeTools
  11. {
  12.     const DURATION = 5 * 60;
  14.     // 校验验证码
  15.     public static function checkVerifyCode($code, $time, $hash)
  16.     {
  17.         if ($time + self::DURATION < time()) {
  18.             return false;
  19.         }
  20.         $code = strtolower($code);
  21.         return self::getVerifyCodeHash($code, $time) == $hash;
  22.     }
  24.     // 生成验证码 hash 字符串
  25.     public static function getVerifyCodeHash($code, $time)
  26.     {
  27.         return md5($code . $time);
  28.     }
  29. }

生成验证码及对验证码进行校验。

  1. <?php
  2. /**
  3.  * User: luffyQAQ
  4.  * Date: 2019/9/5 15:29
  5.  * Email: <1769360227@qq.com>
  6.  */
  8. namespace App\HttpController;
  10. use App\Utility\VerifyCodeTools;
  11. use EasySwoole\Http\AbstractInterface\Controller;
  12. use EasySwoole\Http\Message\Status;
  13. use EasySwoole\Utility\Random;
  14. use EasySwoole\VerifyCode\Conf;
  16. class VerifyCode extends Controller
  17. {
  18.     static $VERIFY_CODE_TTL = 120;
  19.     static $VERIFY_CODE_LENGTH = 4;
  21.     // 生成验证码
  22.     public function verifyCode()
  23.     {
  24.         // 配置验证码
  25.         $config = new Conf();
  26.         $code = new \EasySwoole\VerifyCode\VerifyCode($config);
  28.         // 获取随机数(即验证码的具体值)
  29.         $random = Random::character(self::$VERIFY_CODE_LENGTH, '1234567890abcdefghijklmnopqrstuvwxyz');
  30.         // var_dump($random);    string(4) "m02t"
  32.         // 绘制验证码
  33.         $code = $code->DrawCode($random);
  35.         // 获取验证码的 base64 编码及设置验证码有效时间
  36.         $time = time();
  37.         $result = [
  38.             'verifyCode' => $code->getImageBase64(), // 得到绘制验证码的 base64 编码字符串
  39.             'verifyCodeTime' => $time,
  40.         ];
  42.         // 将验证码加密存储在 Cookie 中，方便进行后续验证。用户也可以把验证码保存在 Session 或者 Redis中，方便后续验证。
  43.         $this->response()->setCookie("verifyCodeHash", VerifyCodeTools::getVerifyCodeHash($random, $time), $time + self::$VERIFY_CODE_TTL, '/');
  44.         $this->response()->setCookie('verifyCodeTime', $time, $time + self::$VERIFY_CODE_TTL, '/');
  45.         $this->writeJson(Status::CODE_OK, $result, 'success');
  46.     }
  48.     // 校验验证码
  49.     public function checkVerifyCode()
  50.     {
  51.         $code = $this->request()->getRequestParam('code');
  52.         $verifyCodeHash = $this->request()->getRequestParam('verifyCodeHash');
  53.         $verifyCodeTime = $this->request()->getRequestParam('verifyCodeTime');
  54.         if (!VerifyCodeTools::checkVerifyCode($code, $verifyCodeTime, $verifyCodeHash)) {
  55.             $this->writeJson(Status::CODE_OK, '验证码错误!', []);
  56.         }
  57.         $this->writeJson(Status::CODE_OK, '验证码正确!', []);
  58.     }
  59. }

调用对应的路径接口(即访问 http://localhost:9501/VerifyCode/verifyCode [示例请求地址])，即可实现前台验证码显示。在 http://localhost:9501/VerifyCode/checkVerifyCode [示例请求地址] 接口中传递参数即可校验验证码是否正确。