39、利用正则表达式进行内容格式化：Markdown 转 HTML 实现

最新推荐文章于 2025-12-02 15:15:42 发布

java5

最新推荐文章于 2025-12-02 15:15:42 发布

阅读量9

点赞数

CC 4.0 BY-SA版权

分类专栏： PHP与MySQL实战精讲文章标签： Markdown HTML 正则表达式

本文链接：https://blog.youkuaiyun.com/java5/article/details/155472008

PHP与MySQL实战精讲专栏收录该内容

40 篇文章 ¥499.90

订阅专栏¥69.90

会员秒杀 ¥9.9 重磅福利

超级会员免费看

利用正则表达式进行内容格式化：Markdown 转 HTML 实现

1. 引言

在处理文本内容时，常常需要将纯文本格式转换为 HTML 格式，以实现丰富的文本展示效果。我们可以借助 PHP 中的正则表达式函数来完成这一任务，尤其是 preg_replace 函数，它能帮助我们精准匹配文本中的特定格式，并将其替换为合适的 HTML 标签。

2. preg_replace 函数介绍

preg_replace 函数与 preg_match 类似，它接受一个正则表达式和一个字符串作为输入，尝试在字符串中匹配该正则表达式。此外，它还接受另一个字符串，用于将匹配到的内容替换掉。其语法如下：

$newString = preg_replace($regExp, $replaceWith, $oldString);

其中， $regExp 是正则表达式， $replaceWith 是用于替换匹配内容的字符串， $oldString 是原始字符串。函数会返回替换后的新字符串，并存储在 $newString 中。

3. 创建 Markdown 转换类

为了实现 Markdown 到 HTML 的转换，我们创建一个名为 Markdown 的类，并将其放置在 Ninja 命名空间中：

namespace Ninja;
class Markdown {
    private $string;
    public function __construct($markDown) {
        $this->string = $markDown;
    }
    public function toHtml() {
        // convert $this->string to HTML
        return $html;
    }
}

我们支持的纯文本格式是 John Gruber 创建的 Markdown 的简化形式。Markdown 是一种用于网页编写的文本到 HTML 的转换工具，它允许用户使用易读易写的纯文本格式编写内容，然后将其转换为结构有效的 XHTML 或 HTML。

4. 处理强调文本

在 Markdown 中，可以通过在文本前后添加一对星号（ * ）或下划线（ _ ）来强调文本。我们将使用正则表达式将这些标记替换为  和  标签。
- 处理下划线标记 ：
- 正则表达式： /_([^_]+)_/
- 解释：
- / ：正则表达式的起始和结束标记。
- _ ：匹配一个下划线字符。
- ([^_]+) ：括号用于捕获匹配的内容， [^_] 表示匹配除下划线以外的任意字符， + 表示匹配一个或多个这样的字符。
- _ ：匹配第二个下划线，标记斜体文本的结束。
- 代码示例：

$text = preg_replace('/_([^_]+)_/', '<em>$1</em>', $text);

处理星号标记 ：
- 正则表达式： /\*([^\*]+)\*/
- 解释：由于星号在正则表达式中有特殊含义，需要使用反斜杠进行转义。
- 代码示例：

$text = preg_replace('/\*([^\*]+)\*/', '<em>$1</em>', $text);

处理强强调文本 ：
- Markdown 还支持通过在文本前后添加一对双下划线（ __ ）或双引号（ ** ）来创建强强调（  标签）。
- 正则表达式：
 - 双下划线： /__(.+?)__/s
 - 双引号： /\*\*(.+?)\*\*/s
- 解释：
 - s 模式修饰符确保点号（ . ）能匹配包括换行符在内的任意字符。
 - +? 表示非贪婪匹配，即尽可能少地匹配字符，以避免一次性匹配过多内容。
- 代码示例：

$text = preg_replace('/__(.+?)__/s', '<strong>$1</strong>', $text);
$text = preg_replace('/\*\*(.+?)\*\*/s', '<strong>$1</strong>', $text);

注意事项 ：在处理强调文本时，必须先将双下划线和双引号转换为  标签，再将单下划线和单星号转换为  标签。

5. 处理段落和换行

用户在输入内容时，通常会使用回车键来创建段落。我们将单个换行符视为换行标记（   ），双换行符视为新段落标记（  ）。
- 处理不同操作系统的换行符 ：
- Windows 使用 \r\n 表示换行，Mac 过去使用 \r ，现在和 Linux 都使用 \n 。
- 代码示例：

// Convert Windows (\r\n) to Unix (\n)
$text = preg_replace('/\r\n/', "\n", $text);
// Convert Macintosh (\r) to Unix (\n)
$text = preg_replace('/\r/', "\n", $text);

转换段落和换行 ：

// Paragraphs
$text = '<p>' . preg_replace('/\n\n/', '</p><p>', $text) . '</p>';
// Line breaks
$text = preg_replace('/\n/', '<br>', $text);

优化建议 ：可以使用 str_replace 函数替代 preg_replace 来处理换行符，因为 str_replace 更高效，无需应用复杂的正则表达式规则。

// Convert Windows (\r\n) to Unix (\n)
$text = str_replace("\r\n", "\n", $text);
// Convert Macintosh (\r) to Unix (\n)
$text = str_replace("\r", "\n", $text);
// Paragraphs
$text = '<p>' . str_replace("\n\n", '</p><p>', $text) . '</p>';
// Line breaks
$text = str_replace("\n", '<br>', $text);

6. 处理超链接

在 Markdown 中，超链接的格式为 [链接文本](链接 URL) 。我们可以使用正则表达式将其转换为 HTML 链接。
- 正则表达式 ： /\[([^\]]+)]$(.+)$/i
- 解释：
- / ：正则表达式的起始和结束标记。
- \[ ：匹配一个左方括号。
- ([^\]]+) ：捕获链接文本， [^\]] 表示匹配除右方括号以外的任意字符， + 表示匹配一个或多个这样的字符。
- ]$ ：匹配右方括号和左括号。
- (.+) ：捕获链接 URL， + 表示匹配一个或多个任意字符。
- $ ：匹配右括号。
- /i ：表示不区分大小写。
- 代码示例 ：

$text = preg_replace(
    '/\[([^\]]+)]\(([-a-z0-9._~:\/?#@!$&\'()*+,;=%]+)\)/i',
    '<a href="$2">$1</a>',
    $text
);

7. 完整的 Markdown 转换类

将上述处理逻辑整合到 Markdown 类的 toHtml 方法中，完整代码如下：

namespace Ninja;
class Markdown
{
    private $string;
    public function __construct($markDown)
    {
        $this->string = $markDown;
    }
    public function toHtml()
    {
        // convert $this->string to HTML
        $text = htmlspecialchars($this->string, ENT_QUOTES, 'UTF-8');
        // strong (bold)
        $text = preg_replace('/__(.+?)__/s', '<strong>$1</strong>', $text);
        $text = preg_replace('/\*\*(.+?)\*\*/s', '<strong>$1</strong>', $text);
        // emphasis (italic)
        $text = preg_replace('/_([^_]+)_/', '<em>$1</em>', $text);
        $text = preg_replace('/\*([^\*]+)\*/', '<em>$1</em>', $text);
        // Convert Windows (\r\n) to Unix (\n)
        $text = str_replace("\r\n", "\n", $text);
        // Convert Macintosh (\r) to Unix (\n)
        $text = str_replace("\r", "\n", $text);
        // Paragraphs
        $text = '<p>' . str_replace("\n\n", '</p><p>', $text) . '</p>';
        // Line breaks
        $text = str_replace("\n", '<br>', $text);
        // [linked text](link URL)
        $text = preg_replace(
            '/\[([^\]]+)]\(([-a-z0-9._~:\/?#@!$&\'()*+,;=%]+)\)/i',
            '<a href="$2">$1</a>',
            $text
        );
        return $text;
    }
}

8. 在模板中使用 Markdown 类

我们可以在输出笑话文本的模板 jokes.html.php 中使用 Markdown 类：

<div class="jokelist">
    <ul class="categories">
        <?php foreach ($categories as $category): ?>
            <li><a href="/joke/list?category=<?=$category->id?>"><?=$category->name?></a></li>
        <?php endforeach; ?>
    </ul>
    <div class="jokes">
        <p><?=$totalJokes?> jokes have been submitted to the Internet Joke Database.</p>
        <?php foreach ($jokes as $joke): ?>
            <blockquote>
                <?php
                $markdown = new Ninja\Markdown($joke->joketext);
                echo $markdown->toHtml();
                ?>
                (by <a href="mailto:<?=htmlspecialchars($joke->getAuthor()->email, ENT_QUOTES, 'UTF-8'); ?>"><?=htmlspecialchars($joke->getAuthor()->name, ENT_QUOTES, 'UTF-8'); ?></a> on
                <?php
                $date = new DateTime($joke->jokedate);
                echo $date->format('jS F Y');
                ?>)
                <?php if ($user): ?>
                    <?php if ($user->id == $joke->authorId || $user->hasPermission(\Ijdb\Entity\Author::EDIT_JOKES)): ?>
                        <a href="/joke/edit?id=<?=$joke->id?>">Edit</a>
                    <?php endif; ?>
                    <?php if ($user->id == $joke->authorId || $user->hasPermission(\Ijdb\Entity\Author::DELETE_JOKES)): ?>
                        <form action="/joke/delete" method="post">
                            <input type="hidden" name="id" value="<?=$joke->id?>">
                            <input type="submit" value="Delete">
                        </form>
                    <?php endif; ?>
                <?php endif; ?>
            </blockquote>
        <?php endforeach; ?>
    </div>
</div>

9. 总结

通过使用 preg_replace 函数和正则表达式，我们可以方便地将 Markdown 格式的文本转换为 HTML 格式，实现丰富的文本展示效果。同时，注意避免在正则表达式中使用双引号字符串，以免引起不必要的麻烦。在处理不同操作系统的换行符时，使用 str_replace 函数可以提高效率。

以下是处理 Markdown 文本的流程图：

graph TD;
    A[输入 Markdown 文本] --> B[转换 HTML 实体];
    B --> C[处理强强调文本];
    C --> D[处理强调文本];
    D --> E[处理换行符];
    E --> F[处理段落];
    F --> G[处理超链接];
    G --> H[输出 HTML 文本];

通过以上步骤，我们可以轻松地将 Markdown 文本转换为 HTML 文本，为网页内容的展示提供更多的可能性。

利用正则表达式进行内容格式化：Markdown 转 HTML 实现

10. 正则表达式使用注意事项

在使用正则表达式时，有一些重要的注意事项需要牢记，以下是详细说明：
- 避免使用双引号字符串 ：在编写正则表达式时，建议使用单引号字符串。因为双引号字符串会进行自动变量替换，这可能会与正则表达式的特殊字符转义规则冲突，导致不必要的错误。例如， "\n" 在双引号字符串中表示换行符，而在正则表达式中 /\n/ 表示匹配换行符。如果使用双引号字符串表示正则表达式，需要写成 "/\\n/" ，增加了复杂性。而单引号字符串 '/\n/' 则不会有这个问题，因为 \n 在单引号字符串中没有特殊含义。
- 特殊字符转义 ：正则表达式中有许多特殊字符，如 * 、 + 、 ? 等，它们具有特殊的含义。如果需要匹配这些字符本身，需要使用反斜杠进行转义。例如，要匹配星号 * ，需要写成 \* 。

11. 代码优化建议

为了提高代码的性能和可维护性，我们可以对代码进行一些优化：
- 使用 str_replace 替代 preg_replace ：当处理简单的字符串替换时，如处理不同操作系统的换行符，使用 str_replace 函数比 preg_replace 更高效。因为 str_replace 不需要应用复杂的正则表达式规则，执行速度更快。
- 代码封装和复用 ：将常用的功能封装成函数或类，提高代码的复用性。例如，将 Markdown 转换逻辑封装在 Markdown 类中，可以在多个地方重复使用。

12. 常见问题及解决方案

13. 实际应用案例

以下是一个实际应用案例，展示如何在一个简单的 PHP 项目中使用 Markdown 类：

<?php
require_once 'Markdown.php';

$markdownText = "**这是强强调文本**\n*这是强调文本*\n\n这是一个段落。\n这是另一个段落。\n\n[链接文本](https://example.com)";
$markdown = new Ninja\Markdown($markdownText);
$htmlText = $markdown->toHtml();

echo $htmlText;
?>

在这个案例中，我们首先引入了 Markdown.php 文件，然后创建了一个 Markdown 对象，并将 Markdown 文本传递给它。最后，调用 toHtml 方法将 Markdown 文本转换为 HTML 文本并输出。

14. 技术拓展

除了上述介绍的基本功能，还可以对 Markdown 转换进行拓展：
- 支持更多 Markdown 语法 ：如列表、代码块、标题等。可以通过编写更多的正则表达式来匹配这些语法，并将其转换为相应的 HTML 标签。
- 集成到框架中 ：将 Markdown 类集成到现有的 PHP 框架中，如 Laravel、Symfony 等，方便在项目中使用。

15. 总结回顾

通过本文的介绍，我们学习了如何使用正则表达式和 preg_replace 函数将 Markdown 格式的文本转换为 HTML 格式。具体步骤如下：
1. 创建 Markdown 类，封装 Markdown 转换逻辑。
2. 处理强调文本，包括斜体和强强调。
3. 处理段落和换行，将不同操作系统的换行符统一转换为 Unix 格式。
4. 处理超链接，将 Markdown 链接转换为 HTML 链接。
5. 注意正则表达式的使用注意事项，避免使用双引号字符串。
6. 对代码进行优化，提高性能和可维护性。

以下是整个 Markdown 转换过程的详细步骤流程图：

graph LR
    classDef startend fill:#F5EBFF,stroke:#BE8FED,stroke-width:2px
    classDef process fill:#E5F6FF,stroke:#73A6FF,stroke-width:2px
    classDef decision fill:#FFF6CC,stroke:#FFBC52,stroke-width:2px

    A([开始]):::startend --> B(输入 Markdown 文本):::process
    B --> C(转换 HTML 实体):::process
    C --> D{是否有强强调文本?}:::decision
    D -- 是 --> E(处理强强调文本):::process
    D -- 否 --> F(处理强调文本):::process
    E --> F
    F --> G{是否有不同换行符?}:::decision
    G -- 是 --> H(处理换行符):::process
    G -- 否 --> I(处理段落):::process
    H --> I
    I --> J{是否有超链接?}:::decision
    J -- 是 --> K(处理超链接):::process
    J -- 否 --> L(输出 HTML 文本):::process
    K --> L
    L --> M([结束]):::startend

通过掌握这些知识和技巧，我们可以在实际项目中灵活运用，为网页内容的展示提供更多的可能性，实现丰富多样的文本格式。