0

0

告别繁琐的短代码解析:如何使用thunderer/shortcode轻松构建强大的富文本功能

WBOY

WBOY

发布时间:2025-08-16 12:02:57

|

537人浏览过

|

来源于php中文网

原创

可以通过一下地址学习composer学习地址

当富文本遇到“正则地狱”:一个开发者真实的痛点

想象一下,你正在为你的新社区平台构建一个帖子发布功能。用户希望能够使用

[b]粗体[/b]
[url=http://example.com]链接[/url]
甚至
[quote author="张三"]引用内容[/quote]
这样的语法来美化他们的帖子。作为开发者,你当然不能直接允许用户输入原始html,因为那会带来巨大的安全隐患。于是,bbcode 或自定义短代码成了你的首选。

然而,当你开始动手实现解析逻辑时,噩梦便开始了。你需要编写复杂的正则表达式来匹配各种标签,处理它们的属性,解析标签内的内容,还要考虑标签的正确闭合、嵌套关系,以及如何优雅地处理错误或恶意输入。一个不小心,就可能导致页面布局错乱,甚至被注入恶意脚本。每次新增一个短代码,都意味着可能要修改一大段正则代码,测试成本高昂,维护更是让人头秃。我曾为此投入了大量时间,却依然无法保证解析的完美无缺和绝对安全。

thunderer/shortcode
:PHP短代码解析的救星

幸运的是,PHP生态系统中有Composer这个强大的包管理工具,它为我们带来了无数优秀的第三方库,其中就包括

thunderer/shortcode
。这个库正是为了解决上述短代码解析的痛点而生,它提供了一个先进、灵活且高性能的短代码(BBCode)解析器和处理引擎。

thunderer/shortcode
将短代码处理过程分解为几个清晰的模块:

  • 解析器(Parsers):负责从文本中识别并提取短代码,将它们转换为结构化的对象。
  • 处理器(Processors):结合解析器和处理器,将短代码对象转换为最终的HTML或其他输出。
  • 处理器(Handlers):定义了每个短代码(如
    [b]
    [url]
    )应该如何被转换。
  • 事件(Events):允许你在处理流程中的关键点插入自定义逻辑,提供更精细的控制。
  • 序列化器(Serializers):支持将短代码对象序列化为文本、XML、JSON或YAML格式,方便存储和传输。

如何使用 Composer 引入并解决问题

使用

thunderer/shortcode
非常简单,首先通过Composer将其引入你的项目:

composer require thunderer/shortcode=^0.7

安装完成后,你就可以开始享受它带来的便利了。

让我们以一个常见的需求为例:创建一个

[hello name="某人"]
短代码,用于在文本中插入个性化的问候语。

<?php

require 'vendor/autoload.php'; // 引入 Composer 自动加载文件

use Thunder\Shortcode\HandlerContainer\HandlerContainer;
use Thunder\Shortcode\Parser\RegularParser;
use Thunder\Shortcode\Processor\Processor;
use Thunder\Shortcode\Shortcode\ShortcodeInterface;
use Thunder\Shortcode\ShortcodeFacade; // 推荐使用 Facade 简化操作

// 1. 定义处理器:告诉库如何处理 'hello' 短代码
$handlers = new HandlerContainer();
$handlers->add('hello', function (ShortcodeInterface $s) {
    // 从短代码对象中获取 'name' 参数
    $name = $s->getParameter('name');
    return sprintf('Hello, %s!', htmlspecialchars($name)); // 注意对输出进行转义,防止XSS
});

// 2. 创建处理器实例,并传入解析器和处理器集合
// 推荐使用 ShortcodeFacade,它封装了常用配置,更易用
$facade = new ShortcodeFacade();
$facade->addHandler('hello', function (ShortcodeInterface $s) {
    $name = $s->getParameter('name');
    return sprintf('Hello, %s!', htmlspecialchars($name));
});

// 3. 处理包含短代码的文本
$text = '
    <div class="greeting">[hello name="Thomas"]</div>
    <p>这是一段普通文本。</p>
    <div class="greeting">[hello name="Peter"]</div>
    <p>欢迎来到我的网站!</p><div class="aritcle_card flexRow">
                                                        <div class="artcardd flexRow">
                                                                <a class="aritcle_card_img" href="/ai/2155" title="AI小聚"><img
                                                                                src="https://img.php.cn/upload/ai_manual/000/000/000/175680303065491.png" alt="AI小聚"  onerror="this.onerror='';this.src='/static/lhimages/moren/morentu.png'" ></a>
                                                                <div class="aritcle_card_info flexColumn">
                                                                        <a href="/ai/2155" title="AI小聚">AI小聚</a>
                                                                        <p>一站式多功能AIGC创作平台,支持AI绘画、AI视频、AI聊天、AI音乐</p>
                                                                </div>
                                                                <a href="/ai/2155" title="AI小聚" class="aritcle_card_btn flexRow flexcenter"><b></b><span>下载</span> </a>
                                                        </div>
                                                </div>
';

echo $facade->process($text);

/*
输出结果:
    <div class="greeting">Hello, Thomas!</div>
    <p>这是一段普通文本。</p>
    <div class="greeting">Hello, Peter!</div>
    <p>欢迎来到我的网站!</p>
*/

通过这个简单的例子,你可以看到,我们不再需要编写复杂的正则表达式来匹配

[hello]
标签,也不需要手动提取
name
参数。
thunderer/shortcode
替我们完成了这些繁琐的工作,我们只需要关注短代码的业务逻辑(即
handler
函数内部的逻辑)。

更多高级特性与实际应用效果

thunderer/shortcode
的强大远不止于此:

  • 灵活的配置:你可以控制短代码的嵌套深度,处理迭代次数,甚至自定义短代码的语法(比如使用
    [[tag]]
    而不是
    [tag]
    )。
  • 内置处理器:它提供了一系列开箱即用的处理器,如
    UrlHandler
    (将
    [url]
    转换为链接)、
    EmailHandler
    (转换为邮件链接)、
    WrapHandler
    (用于
    [b]
    [i]
    等标签的包裹)。这极大地加速了常见功能的开发。
  • 事件机制:如果你需要更细粒度的控制,比如过滤某些短代码,或者在短代码替换前后执行特定操作,事件机制能满足你的需求。例如,你可以轻松实现一个
    [raw]
    短代码,确保其内部内容不被进一步解析。
  • 多种解析器:库提供了
    RegularParser
    (功能最全,支持复杂嵌套)、
    RegexParser
    (速度更快,适用于简单场景)和
    WordpressParser
    (兼容WordPress短代码)等,你可以根据项目需求选择最合适的。
  • 序列化与反序列化:如果你的短代码内容需要存储到数据库或通过API传输,
    thunderer/shortcode
    可以方便地将短代码对象序列化为JSON、XML等格式,方便数据的持久化和交换。

实际应用效果:

引入

thunderer/shortcode
后,我的项目开发效率得到了显著提升。我不再需要为短代码解析而焦头烂额,可以将更多精力投入到核心业务逻辑的实现上。代码结构变得更加清晰和模块化,每个短代码都有自己的处理逻辑,易于维护和扩展。最重要的是,由于库本身经过了严格的测试和优化,它能更好地处理各种边缘情况和恶意输入,大大提升了应用程序的健壮性和安全性。用户体验也随之优化,他们可以轻松地使用各种短代码来丰富内容,而我们则无需担心背后复杂的解析问题。

总而言之,如果你正在处理或计划在PHP项目中引入短代码(BBCode)功能,那么

thunderer/shortcode
绝对是你不容错过的利器。它将你从繁琐的底层解析工作中解放出来,让你能够更专注于构建功能强大、用户友好的应用。强烈推荐你尝试一下!

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

162

2023.12.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

457

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

547

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

335

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

531

2023.06.20

正则表达式不包含
正则表达式不包含

正则表达式,又称规则表达式,,是一种文本模式,包括普通字符和特殊字符,是计算机科学的一个概念。正则表达式使用单个字符串来描述、匹配一系列匹配某个句法规则的字符串,通常被用来检索、替换那些符合某个模式的文本。php中文网给大家带来了有关正则表达式的相关教程以及文章,希望对大家能有所帮助。

258

2023.07.05

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

766

2023.07.05

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

37

2026.03.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二十四期_PHP8编程
第二十四期_PHP8编程

共86课时 | 3.5万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 2.6万人学习

第二十三期_PHP编程
第二十三期_PHP编程

共93课时 | 7.5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号