在 Laravel API 中实现 WebSocket：配置与连接指南

理解 Laravel 中的 WebSocket 实现

在 laravel 生态系统中，实现实时通信通常依赖于 beyondcode/laravel-websockets 包作为 websocket 服务器，并结合 laravel echo 库在前端进行连接和事件监听。当遇到连接 websocket 服务器返回 404 错误时，这通常不是服务器未运行，而是客户端（laravel echo）的配置与服务器实际部署地址或认证端点不匹配所致，尤其是在前端与后端分离部署的情况下。

核心问题：跨域与配置不匹配

用户遇到的 404 错误，最常见的原因是 Laravel Echo 尝试连接的 WebSocket 主机或端口，以及用于认证的 authEndpoint 未正确配置。当前端应用（例如运行在 localhost:3000）尝试连接后端 Laravel API（运行在 localhost:8000）上的 WebSocket 服务器（可能运行在 localhost:6001）时，这些地址差异必须在客户端配置中明确指出。

配置 Laravel Echo 连接 WebSocket 服务器

Laravel Echo 是一个强大的 JavaScript 库，用于订阅频道和监听 Laravel 事件。要正确连接到 beyondcode/laravel-websockets 服务器，需要对 Echo 实例进行精确配置。以下是关键参数的详细说明及示例：

import Echo from 'laravel-echo';
import Pusher from 'pusher-js'; // 即使使用 laravel-websockets，也需要引入 pusher-js

window.Pusher = Pusher;

const echoInstance = new Echo({
    broadcaster: 'pusher', // 广播器类型，laravel-websockets 兼容 Pusher 协议
    key: import.meta.env.VITE_PUSHER_APP_KEY, // 在 .env 文件中定义的 Pusher 应用 key
    wsHost: window.location.hostname, // WebSocket 服务器的主机地址，通常是后端 API 的 IP 或域名
    wsPort: 6001, // WebSocket 服务器的端口，laravel-websockets 默认端口为 6001
    wssPort: 6001, // 如果使用 WSS (Secure WebSockets)，则指定 WSS 端口
    forceTLS: false, // 如果 wsHost 不使用 HTTPS，设置为 false
    disableStats: true, // 禁用向广播服务发送统计信息
    enabledTransports: ['ws', 'wss'], // 优先使用 WebSocket 传输，防止回退到 XHR Polling
    authEndpoint: 'http://localhost:8000/broadcasting/auth', // 认证路由的完整 URL
    // cluster: 'mt1', // 如果使用 Pusher 官方服务，则需要指定 cluster
});

// 示例：监听频道
echoInstance.private('App.Models.User.' + userId)
    .notification((notification) => {
        console.log(notification.type);
    });

关键配置参数解析：

冬瓜配音

AI在线配音生成器

66

查看详情

• broadcaster: 'pusher': 尽管使用的是 laravel-websockets，但它兼容 Pusher 协议，因此广播器类型仍设置为 pusher。
• key: import.meta.env.VITE_PUSHER_APP_KEY: 这是在 Laravel 后端 .env 文件中配置的 PUSHER_APP_KEY。前端需要获取此值。
• wsHost: 这是 WebSocket 服务器实际运行的主机地址。如果你的 Laravel API 运行在 api.example.com，那么 wsHost 就应该是 api.example.com。如果是在本地开发，且后端运行在 localhost，则可以是 localhost 或 127.0.0.1。
• wsPort: 这是 WebSocket 服务器监听的端口。laravel-websockets 默认使用 6001。确保此端口在服务器防火墙中是开放的。
• authEndpoint: 这是解决 404 问题的关键之一。 Laravel Echo 在订阅私有或存在频道时，会向此端点发送认证请求。如果前端和后端运行在不同的域或端口，你需要提供 Laravel 认证路由的完整 URL。例如，如果你的 Laravel API 运行在 http://localhost:8000，那么 authEndpoint 就应该是 http://localhost:8000/broadcasting/auth。绝对不能只写 /broadcasting/auth，否则浏览器会尝试在前端应用的当前域下查找此路由。
• enabledTransports: ['ws', 'wss']: 明确指定只使用 WebSocket 或 Secure WebSocket 传输方式。这可以防止 Echo 在连接失败时回退到效率较低的 XHR Polling 方式。

注意事项与故障排除

1. 确保 WebSocket 服务器正在运行： 在 Laravel 项目根目录执行 php artisan websockets:serve 命令。确保此命令在后台持续运行，或使用 Supervisor 等工具进行进程管理。
2. 后端 .env 配置：
   • BROADCAST_DRIVER=pusher
   • PUSHER_APP_ID, PUSHER_APP_KEY, PUSHER_APP_SECRET 必须正确配置。
   • APP_URL 必须正确设置为你的 Laravel API 的基础 URL，因为 authEndpoint 可能会隐式依赖它。
3. 防火墙设置： 确保 WebSocket 服务器监听的端口（例如 6001）在服务器防火墙中是开放的，允许外部连接。
4. CORS 配置： 如果你的前端应用与 Laravel API 部署在完全不同的域名下，你需要配置 Laravel 的 CORS 策略，允许前端域名访问你的 API 路由（包括 /broadcasting/auth 和 WebSocket 连接）。可以使用 barryvdh/laravel-cors 包进行配置。
5. 浏览器开发者工具：
   • 检查网络请求：在浏览器的开发者工具中，查看 WebSocket 连接（ws:// 或 wss://）是否成功建立。
   • 查看控制台错误：Laravel Echo 或 Pusher.js 可能会输出有用的错误信息。
   • 检查 /broadcasting/auth 请求：查看对认证端点的 XHR 请求是否成功（状态码 200），以及是否有任何认证失败的错误。

总结

在 Laravel API 中实现 WebSocket 功能，关键在于正确配置 Laravel Echo 客户端，使其能够准确找到并连接到 WebSocket 服务器，并通过正确的 authEndpoint 完成认证。尤其是在前端与后端分离部署的环境中，wsHost、wsPort 和 authEndpoint 的完整且准确的配置是避免 404 错误和建立稳定实时连接的基石。通过遵循上述指南并仔细检查每一步，你将能够成功地在 Laravel 应用中集成强大的 WebSocket 功能。

以上就是在 Laravel API 中实现 WebSocket：配置与连接指南的详细内容，更多请关注php中文网其它相关文章！