PHP生成二维码【endroid/qr-code 4.x】

1. 前言

---

packagist 传送门: endroid/qr-code - Packagist

使用该扩展前，先确认其 PHP 版本要求，endroid/qr-code 4.x 需要 PHP 版本 7.4+

使用前需要检查下是否启用了 gd2 扩展，对于 endroid/qr-code 版本选择，参考扩展包文档对 PHP 版本的要求

2. 安装扩展

---

执行 composer 命令安装 endroid/qr-code 扩展

1. composer require endroid/qr-code

会生成如下目录结构内容

1. ├─vendor
2. │ ├─autoload.php
3. │ ├─ ...
4. ├─composer.json
5. ├─composer.lock

如果当前项目架构没有基于任何框架，只需要引入 composer 的自动加载文件即可

如果当前项目是基于 ThinkPHP，Laravel 等主流框架，这些框架都支持 composer，执行安装扩展包命令后可以直接使用

1. require 'vendor/autoload.php';

3. 生成二维码

---

使用 Builder 生成器:

1. use Endroid\QrCode\Builder\Builder;
2. use Endroid\QrCode\Encoding\Encoding;
3. use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelHigh;
4. use Endroid\QrCode\Label\Alignment\LabelAlignmentCenter;
5. use Endroid\QrCode\Label\Font\NotoSans;
6. use Endroid\QrCode\RoundBlockSizeMode\RoundBlockSizeModeMargin;
7. use Endroid\QrCode\Writer\PngWriter;
9. $result = Builder::create()
10. ->writer(new PngWriter())
11. ->writerOptions([])
12. // 二维码文本
13. ->data('https://www.itqaq.com')
14. // 内容编码
15. ->encoding(new Encoding('UTF-8'))
16. // 容错等级(越高二维码越密集)
17. ->errorCorrectionLevel(new ErrorCorrectionLevelHigh())
18. // 二维码内容区域大小
19. ->size(300)
20. // 二维码内容外边距大小
21. ->margin(10)
22. // 二维码内容圆形块尺寸模型
23. ->roundBlockSizeMode(new RoundBlockSizeModeMargin())
24. // 二维码中间区域logo图片
25. ->logoPath(__DIR__ . '/3.png')
26. ->logoResizeToWidth(100)
27. ->logoResizeToHeight(100)
28. // 二维码下方文字
29. ->labelText('长按识别二维码')
30. ->labelFont(new NotoSans(20))
31. ->labelAlignment(new LabelAlignmentCenter())
32. // 验证读取器(默认情况下禁用)
33. ->validateResult(false)
34. // 执行生成器
35. ->build();

不使用 Builder 生成器:

1. use Endroid\QrCode\Color\Color;
2. use Endroid\QrCode\Encoding\Encoding;
3. use Endroid\QrCode\ErrorCorrectionLevel\ErrorCorrectionLevelLow;
4. use Endroid\QrCode\QrCode;
5. use Endroid\QrCode\Label\Label;
6. use Endroid\QrCode\Logo\Logo;
7. use Endroid\QrCode\RoundBlockSizeMode\RoundBlockSizeModeMargin;
8. use Endroid\QrCode\Writer\PngWriter;
10. $writer = new PngWriter();
11. $qrCode = QrCode::create('https://www.itqaq.com')
12. // 内容编码
13. ->setEncoding(new Encoding('UTF-8'))
14. // 容错等级
15. ->setErrorCorrectionLevel(new ErrorCorrectionLevelLow())
16. // 内容区域大小
17. ->setSize(300)
18. // 内容区域外边距
19. ->setMargin(10)
20. // 内容圆形块尺寸模型
21. ->setRoundBlockSizeMode(new RoundBlockSizeModeMargin())
22. // 内容颜色
23. ->setForegroundColor(new Color(0, 0, 0))
24. // 背景颜色
25. ->setBackgroundColor(new Color(255, 255, 255));
26. // 二维码logo logo
27. $logo = Logo::create(__DIR__ . '/3.png')
28. ->setResizeToWidth(50);
29. // 二维码下方文字 label
30. $label = Label::create('Label')
31. ->setTextColor(new Color(255, 0, 0));
32. // 生成二维码数据对象(后面两个参数都是可选的)
33. $result = $writer->write($qrCode, $logo, $label);

实际开发中，使用最多的是根据一串普通文本生成字符串，所以我将代码做了简化，方便以后快速使用

1. use Endroid\QrCode\QrCode;
2. use Endroid\QrCode\Writer\PngWriter;
3. use Endroid\QrCode\Encoding\Encoding;
5. $qrCode = QrCode::create('https://www.itqaq.com')
6. // 内容编码
7. ->setEncoding(new Encoding('UTF-8'))
8. // 内容区域大小
9. ->setSize(200)
10. // 内容区域外边距
11. ->setMargin(10);
12. // 生成二维码数据对象
13. $result = (new PngWriter)->write($qrCode);

4. 输出二维码

---

以下是三种输出二维码的方式，根据项目场景选择合适的方式即可

1. // 直接输出在浏览器中
2. // ob_end_clean(); //处理在TP框架中显示乱码问题
3. // header('Content-Type: ' . $result->getMimeType());
4. // echo $result->getString();
6. // 将二维码图片保存到本地服务器
7. // $result->saveToFile(__DIR__ . '/qrcode.png');
9. // 返回 base64 格式的图片
10. $dataUri = $result->getDataUri();
11. echo "<img src='{$dataUri}'>";
12. https://www.lengleng.net