Symfony5集成Mercure实时通信教程

有志者，事竟成！如果你在学习文章，那么本文《Symfony 5集成Mercure实时通信配置与问题排查》，就很适合你！文章讲解的知识点主要包括，若是你对本文感兴趣，或者是想搞懂其中某个知识点，就请你继续往下看吧~

Mercure实时通信服务概述

Mercure是一个开放、高效且可靠的实时更新协议，它允许服务器向连接的客户端推送数据更新。在Symfony应用中集成Mercure，可以轻松实现聊天、通知、实时仪表盘等功能。本教程将指导您完成Mercure与Symfony 5的配置与部署，并解决常见的访问问题。

1. Mercure Hub的安装与Symfony集成

首先，您需要下载并运行Mercure Hub服务器，并在Symfony项目中安装Mercure Bundle。

1.1 下载并解压Mercure Hub

根据您的操作系统，从Mercure的GitHub发布页下载对应的Mercure Hub二进制文件。例如，对于Windows 10系统，您可以下载 mercure_0.13.0_Windows_arm64.zip。下载后，将其解压到一个方便的位置。

1.2 安装Symfony Mercure Bundle

在您的Symfony项目根目录下，通过Composer安装Mercure Bundle：

composer require symfony/mercure

此命令将安装必要的依赖，并可能生成或修改您的 config/packages/mercure.yaml 配置文件。

2. 配置Mercure环境变量

Mercure Bundle需要一些环境变量来知道如何与Mercure Hub通信。这些配置通常放在项目的 .env 文件中。

打开您的 .env 文件，并添加或修改以下配置：

# .env

# See https://symfony.com/doc/current/mercure.html#configuration
# The URL of the Mercure hub, used by the app to publish updates (can be a local URL)
MERCURE_URL=https://127.0.0.1:8000/.well-known/mercure
# The public URL of the Mercure hub, used by the browser to connect
MERCURE_PUBLIC_URL=https://127.0.0.1:8000/.well-known/mercure
# The secret used to sign the JWTs
MERCURE_JWT_SECRET="!ChangeMe!"
###< symfony/mercure-bundle ###

重要提示：

• MERCURE_URL 是Symfony应用用于发布更新到Mercure Hub的内部URL。
• MERCURE_PUBLIC_URL 是客户端（浏览器）连接Mercure Hub的公共URL。
• MERCURE_JWT_SECRET 是用于签署JSON Web Token (JWT) 的密钥。在生产环境中，请务必将其更改为强随机字符串，并确保与Mercure Hub启动时使用的密钥一致。

3. 启动Mercure Hub服务器

配置完成后，您需要启动Mercure Hub服务器。在Windows PowerShell中，您可以使用以下命令：

$env:MERCURE_PUBLISHER_JWT_KEY='!ChangeMe!'; $env:MERCURE_SUBSCRIBER_JWT_KEY='!ChangeMe!'; .\mercure.exe run -config Caddyfile.dev

命令解析：

• $env:MERCURE_PUBLISHER_JWT_KEY 和 $env:MERCURE_SUBSCRIBER_JWT_KEY：设置Mercure Hub用于发布和订阅的JWT密钥。这些密钥必须与您在 .env 文件中配置的 MERCURE_JWT_SECRET 匹配，否则发布或订阅将失败。
• .\mercure.exe run -config Caddyfile.dev：运行Mercure Hub。Caddyfile.dev 是Mercure Hub默认提供的一个开发环境配置，它通常配置Mercure在特定端口（如8000）上运行，并处理TLS证书。

成功启动后，您会在PowerShell中看到类似以下的日志输出：

2021/11/16 01:39:58.029 INFO    http    server is listening only on the HTTPS port but has no TLS connection policies; adding one to enable TLS {"server_name": "srv0", "https_port": 443}
...
2021/11/16 01:39:58.135 INFO    http    enabling automatic TLS certificate management   {"domains": ["localhost"]}
...
2021/11/16 01:39:58.143 INFO    serving initial configuration

这些日志表明Mercure Hub（由Caddy提供支持）已成功启动，并监听了HTTPS端口，并为 localhost 域名启用了自动TLS证书管理。

4. 验证Mercure Hub访问

Mercure Hub服务器运行后，您可以通过浏览器尝试访问其公共端点来验证其是否正常工作。

常见错误： 许多初学者会尝试访问 https://localhost/.well-known/mercure。然而，根据我们 .env 中的配置以及 Caddyfile.dev 的默认设置，Mercure Hub通常不会在默认的HTTPS端口（443）上运行，而是在自定义端口（如8000）上运行。因此，直接访问 https://localhost/.well-known/mercure 会导致“Not Found”错误，这通常是由Apache或Nginx等其他Web服务器在443端口上响应导致的。

正确访问方式： 您应该使用在 .env 中 MERCURE_PUBLIC_URL 所指定的端口来访问Mercure Hub。在本例中，正确的URL是：

https://localhost:8000/.well-known/mercure

在浏览器中访问此URL，如果Mercure Hub配置正确并正在运行，您将不会看到“Not Found”错误，而是可能会看到一个空白页面或一个指示Mercure端点已就绪的响应（取决于Mercure Hub的版本和具体配置）。这表明Mercure Hub已成功启动并可通过该URL访问。

5. 注意事项与故障排除

• 端口一致性： 确保 .env 中的 MERCURE_URL 和 MERCURE_PUBLIC_URL 所指定的端口（例如 8000）与Mercure Hub实际监听的端口一致。这个端口通常由 Caddyfile.dev 或您自定义的Caddy配置决定。
• JWT密钥匹配： 启动Mercure Hub时设置的 MERCURE_PUBLISHER_JWT_KEY 和 MERCURE_SUBSCRIBER_JWT_KEY 必须与 .env 中的 MERCURE_JWT_SECRET 完全一致。
• 防火墙： 确保您的防火墙没有阻止Mercure Hub监听的端口（例如8000）。
• 其他Web服务器冲突： 如果您在同一台机器上运行了Apache或Nginx等其他Web服务器，它们可能会占用默认的80或443端口。确保Mercure Hub使用的端口没有被其他服务占用。
• Caddyfile： Caddyfile.dev 是Mercure Hub默认使用的Caddy服务器配置文件。了解其内容有助于调试端口和域名配置问题。

总结

通过遵循上述步骤，您应该能够成功在Symfony 5项目中配置、启动并访问Mercure实时通信服务。解决Mercure Hub访问问题的关键在于确保所有配置中的URL和端口都保持一致，特别是 MERCURE_PUBLIC_URL 与浏览器实际访问的URL必须匹配。一旦Mercure Hub正常运行，您就可以开始在Symfony应用中利用其强大的实时推送功能了。

今天带大家了解了的相关知识，希望对你有所帮助；关于文章的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~