文章目录
概要
PHPQRCode 是一个用 PHP 语言编写的用于生成二维码(QR Code)的库。它提供了简单而有效的方式来创建各种类型的二维码,这些二维码可以包含文本、网址、电话号码等多种信息。
一、phpqrcode 介绍
1.1 功能特点
1.1.1生成多种类型信息的二维码
可以轻松地将网址生成为二维码。例如,如果你有一个公司网站的产品页面链接,如http://www.0971ad.com/list/7.html,使用 PHPQRCode 可以快速生成一个二维码,用户通过扫描这个二维码就能直接访问该页面。
能够把文本信息(如一段简短的消息、详细说明等)编码到二维码中。比如,活动主办方可以将活动的时间、地点等详细信息生成二维码,供参与者扫描获取。
也支持对电话号码、电子邮件地址等联系方式进行二维码编码。这对于企业的宣传材料很有用,扫描二维码就可以直接拨打电话或者发送邮件。
1.1.2 高度自定义
可以调整二维码的尺寸。通过设置相关参数,你可以生成小到用于名片,大到用于海报展示的二维码。例如,你可以将二维码的大小设置为 100x100 像素用于在移动应用界面展示,也可以设置为 500x500 像素用于在广告展板上使用。
能够控制二维码的纠错级别。纠错级别从低到高分为 L、M、Q、H 四个等级。L 级别的纠错能力最低,但可以存储更多的数据;H 级别的纠错能力最高,适合在二维码可能会被部分损坏(如标签有污渍、磨损等情况)的应用场景。比如,在工业环境中,标签容易受到油污、刮擦等情况影响,使用高纠错级别的二维码(如 H 级)可以确保数据的准确读取。
还可以设置二维码的颜色等外观属性。例如,你可以将二维码的前景色设置为公司品牌色,背景色设置为白色,使其与公司的品牌形象一致。
1.1.3 易于集成
作为一个 PHP 库,它可以很方便地集成到现有的 PHP 项目中。无论是简单的网站应用,还是复杂的 Web 应用程序框架(如 Laravel、Yii 等),只要项目中需要生成二维码的功能,都可以通过引入 PHPQRCode 库来实现。
它不需要复杂的配置和依赖其他大型软件环境,对于初学者和有经验的开发者来说,都是一个容易上手的工具。
1.2 使用示例
以下是一个简单的示例代码,用于生成一个包含文本信息 “Hello, World!” 的二维码:
<?php
// 引入PHPQRCode库文件
require('phpqrcode/qrlib.php');
// 数据内容
$data = 'Hello, World!';
// 生成二维码的文件名
$filename = 'qrcode.png';
// 生成二维码的路径(这里假设在当前目录下)
$path = './';
// 调用函数生成二维码
QRcode::png($data, $path.$filename);
?>
在这个示例中,首先通过require函数引入了phpqrcode/qrlib.php文件,这个文件包含了生成二维码的核心函数。然后定义了要编码的数据 d a t a ,以及生成二维码的文件名 data,以及生成二维码的文件名 data,以及生成二维码的文件名filename和路径$path。最后,使用QRcode::png函数生成了一个 PNG 格式的二维码并保存到指定的路径下。
1.3 局限性
1.3.1 性能方面
在高并发场景下,如果频繁生成二维码,可能会占用较多的服务器资源。因为生成二维码的过程涉及到复杂的编码和图形绘制操作,对于性能较差的服务器可能会导致响应时间变长。
1.3.2 功能拓展性
相比一些商业的二维码生成工具,它可能在一些高级功能上有所缺失。例如,它可能没有专门的数据分析功能,无法统计二维码的扫描次数、扫描位置等信息。如果项目需要这些高级功能,可能需要额外开发或者寻找其他更复杂的解决方案。
二、思路分析
2.1 下载PHPQRCode库
首先,你需要从官方渠道或可靠的代码仓库获取PHPQRCode库文件。你可以在其官方网站(如果有的话)或者一些知名的开源代码平台(如GitHub)上查找。一般来说,它包含了一个或多个PHP文件,其中关键的文件是qrlib.php,这个文件包含了生成二维码的主要函数。
2.2 将库文件放置在项目目录中
把下载好的PHPQRCode库文件放在你的PHP项目的合适目录下。例如,你可以创建一个名为QrcodeService.php的文件,然后将库文件放在这个文件夹中。
2.3 在PHP文件中引入库文件
在需要使用PHPQRCode库来生成二维码的PHP文件(如index.php)中,使用require或include语句来引入qrlib.php文件。例如:
use Endroid\QrCode\QrCode;
这里的路径libraries/phpqrcode/qrlib.php是根据你放置库文件的实际位置来确定的。如果库文件和使用它的PHP文件在同一目录下,路径可以直接写成require(‘qrlib.php’);
2.4 检查PHP环境配置
确保你的PHP环境已经正确安装和配置。PHPQRCode库一般依赖于基本的PHP图形处理功能。在一些Linux系统中,你可能需要安装gd库(这是一个用于处理图像的PHP扩展)来支持二维码图像的生成。
对于Ubuntu系统,你可以使用以下命令安装gd库相关的PHP扩展:
sudoapt-getinstallphp-gd
安装完成后,需要重启Web服务器(如Apache或Nginx),使gd扩展生效。在使用PHP-fpm(与Nginx配合)的情况下,需要重新加载PHP-fpm服务,例如:
sudoservicephp7.4-fpmreload(这里假设你使用的是PHP7.4版本)
2.5 开始使用库生成二维码
引入库文件并确保环境配置正确后,就可以使用PHPQRCode库来生成二维码了。QRcode::png函数用于生成一个PNG格式的二维码图像并保存到指定的位置。
三、实例操作
-
重点都在下面 😄😄😄😄😄
-
以下是小编实战项目中的操作步骤,说到实战项目,小编是一名草根程序员,擅长 开发语言php、java、vue(前后端都会一些),擅长的应用有:OA办公系统、业务审批系统、网站建设、小程序开发;这里给大家分享下小编做过的两个开源项目(如果对您有用,欢迎收藏关注,以备不时之需!):
工程项目OA管理系统 :https://gitee.com/xnqysabout/ry-vue-flowable-xgjava cms 网站管理系统: https://gitee.com/xnqysabout/RuoYi-fast-cms
-
虽然小编做得不够优雅,但应用系统跑起来,给客户正常使用是没问题的,包括他们提出扩展需求也是 ok 的,废话就不啰嗦了,进入正题:
3.1 安装 qrcode 库
用composer 安装endroid/qrode ,进入项目根目录,安装完成会在vendor目录下面,注意:PHP版本 要求 7.1+
composer require endroid/qrcode
3.2 封装为服务Service文件
小编是基于 thinkcmf5.1 使用的 qrcode,service 文件目录创建在了/app/portal/service/QrcodeService.php,代码就毫无保留的分享给大家
<?php
namespace app\portal\service;
use Endroid\QrCode\ErrorCorrectionLevel;
use Endroid\QrCode\LabelAlignment;
use Endroid\QrCode\QrCode;
class QrcodeService
{
protected $_qr;
protected $_encoding = 'UTF-8'; // 编码类型
protected $_size = 300; // 二维码大小
protected $_logo = false; // 是否需要带logo的二维码
protected $_logo_url = '/upload/portal/20241115/aba16d91b478866c27fa.png'; // logo图片路径
protected $_logo_size = 80; // logo大小
protected $_title = false; // 是否需要二维码title
protected $_title_content = '二维码'; // title内容
protected $_generate = 'display'; // display-直接显示 writefile-写入文件
protected $_file_name = './'; // 写入文件路径
const MARGIN = 10; // 二维码内容相对于整张图片的外边距
const WRITE_NAME = 'png'; // 写入文件的后缀名
const FOREGROUND_COLOR = ['r' => 0, 'g' => 0, 'b' => 0, 'a' => 0]; // 前景色
const BACKGROUND_COLOR = ['r' => 255, 'g' => 255, 'b' => 255, 'a' => 0]; // 背景色
public function __construct($config)
{
isset($config['generate']) && $this->_generate = $config['generate'];
isset($config['encoding']) && $this->_encoding = $config['encoding'];
isset($config['size']) && $this->_size = $config['size'];
isset($config['logo']) && $this->_logo = $config['logo'];
isset($config['logo_url']) && $this->_logo_url = $config['logo_url'];
isset($config['logo_size']) && $this->_logo_size = $config['logo_size'];
isset($config['title']) && $this->_title = $config['title'];
isset($config['title_content']) && $this->_title_content = $config['title_content'];
isset($config['file_name']) && $this->_file_name = $config['file_name'];
}
/**
* 生成二维码
* @param $content //需要写入的内容
* @return array | page input
*/
public function createServer($content)
{
$this->_qr = new QrCode($content);
$this->_qr->setSize($this->_size);
$this->_qr->setWriterByName(self::WRITE_NAME);
$this->_qr->setMargin(self::MARGIN);
$this->_qr->setEncoding($this->_encoding);
$this->_qr->setErrorCorrectionLevel(new ErrorCorrectionLevel(ErrorCorrectionLevel::HIGH)); // 容错率
$this->_qr->setForegroundColor(self::FOREGROUND_COLOR);
$this->_qr->setBackgroundColor(self::BACKGROUND_COLOR);
// 是否需要title
if ($this->_title) {
$this->_qr->setLabel($this->_title_content, 16, null, LabelAlignment::CENTER);
}
// 是否需要logo
if ($this->_logo) {
$this->_qr->setLogoPath($this->_logo_url);
$this->_qr->setLogoWidth($this->_logo_size);
}
$this->_qr->setValidateResult(false);
if ($this->_generate == 'display') {
// 展示二维码
// 前端调用 例:<img src="https://localhost/qr.php?url=base64_url_string">
header('Content-Type: ' . $this->_qr->getContentType());
return $this->_qr->writeString();
} else if ($this->_generate == 'writefile') {
// 写入文件
$file_name = $this->_file_name;
return $this->generateImg($file_name);
} else {
return ['success' => false, 'message' => 'the generate type not found', 'data' => ''];
}
}
/**
* 生成文件
* @param $file_name //目录文件 例: /tmp
* @return array
*/
public function generateImg($file_name)
{
$file_path = $file_name . DIRECTORY_SEPARATOR . uniqid() . '.' . self::WRITE_NAME;
if (!file_exists($file_name)) {
mkdir($file_name, 0777, true);
}
try {
$this->_qr->writeFile($file_path);
$data = [
'url' => $file_path,
'ext' => self::WRITE_NAME,
];
return ['success' => true, 'message' => 'write qrimg success', 'data' => $data];
} catch (\Exception $e) {
return ['success' => false, 'message' => $e->getMessage(), 'data' => ''];
}
}
}
3.3 控制器调用
<?php
namespace app\index\controller;
use think\Queue;
use app\common\services\QrCodeService;
use think\Request;
class Index
{
public function index()
{
// 自定义二维码配置
$config = [
'title' => true, // 是否显示标题
'title_content' => 'test_1',
'logo' => true, // 是否使用logo
'logo_url' => './static/1.jpg',
'logo_size' => 80,
];
// 直接输出
$qr_url = 'http://www.baidu.com?id=' . rand(1000, 9999);
$qr_code = new QrCodeService($config);
$qr_img = $qr_code->createServer($qr_url);
echo $qr_img;
// 写入文件
$qr_url = '这是个测试二维码';
$file_name = './static/qrcode'; // 定义保存目录
$config['file_name'] = $file_name;
$config['generate'] = 'writefile';
$qr_code = new QrCodeService($config);
$rs = $qr_code->createServer($qr_url);
print_r($rs);
exit;
}
}
3.3 效果图演示
logo 的图片有些丑陋,建议做成圆角白色背景的图片,美工方面就不啰嗦了!这样就完美显示了二维码!
小结
在使用 PHPQRCode 的过程中,最深刻的感受之一就是它带来的便捷性和高效性。在开发需要生成二维码功能的应用时,它极大地简化了开发流程。以往,生成二维码可能需要深入了解复杂的编码算法和图形绘制技术,但 PHPQRCode 只需简单地引入库文件和调用相应函数就能快速生成。