README

Laravel 用于异步服务 WebSocket 的库。
通过简单的接口构建您的应用程序，并通过组合不同的组件重用您的应用程序，而无需更改其代码。

Laravel WebSocket

Socket - TCP 连接上的全双工通信协议，用于在浏览器和 web 服务器之间实时交换消息。

WebSocket 设计用于在浏览器和 web 服务器中实现，但也可以用于任何客户端或服务器应用程序。

WebSocket 协议 - 基于 TCP 协议的独立协议。它使浏览器和网站之间的交互更加紧密，促进了互动内容的传播和实时游戏的创建。

安装 Laravel WebSocket

安装包

$ composer require orchid/socket

编辑 config/app.php 服务提供者： (Laravel < 5.5)

Orchid\Socket\Providers\SocketServiceProvider::class

结构

php artisan vendor:publish

用法

创建

要创建新的监听器，您需要

php artisan make:socket MyClass

在 app/HTTP/Socket/Listener 文件夹中创建模板 Web 监听器 socket

创建后，需要建立位于 routes/socket.php 的路由

//routing is based on an Symfony Routing Component
$socket->route('/myclass', new MyClass, ['*']);

要启动 web-socket，请使用以下命令

php artisan socket:serve

常见问题解答

JavaScript

在 JavaScript 中连接 WebSocket

var socket = new WebSocket("ws://");

socket.onopen = function() {
  alert("The connection is established.");
};

socket.onclose = function(event) {
  if (event.wasClean) {
    alert('Connection closed cleanly');
  } else {
    alert('Broken connections'); 
  }
  alert('Key: ' + event.code + ' cause: ' + event.reason);
};

socket.onmessage = function(event) {
  alert("The data " + event.data);
};

socket.onerror = function(error) {
  alert("Error " + error.message);
};


//To send data using the method socket.send(data).

//For example, the line:
socket.send("Hello");

授权

安装唯一数字 socket 和 session 的 Laravel 示例

public function onOpen(ConnectionInterface $conn)
{
    $this->clients->attach($conn);
    
    //take user id
    $userId = $this->getUserFromSession($conn);
    
    //Create a list of users connected to the server
    array_push($this->userList, $userId);
    
    //We tell everything that happened
    echo "New connection! user_id = ({$userId})\n";
}

public function getUserFromSession($conn)
{
    // Create a new session handler for this client
    $session = (new SessionManager(App::getInstance()))->driver();
    
    // Get the cookies
    $cookies = $conn->WebSocket->request->getCookies();
    
    // Get the laravel's one
    $laravelCookie = urldecode($cookies[Config::get('session.cookie')]);
    
    // get the user session id from it
    $idSession = Crypt::decrypt($laravelCookie);
    
    // Set the session id to the session handler
    $session->setId($idSession);
    
    // Bind the session handler to the client connection
    $conn->session = $session;
    $conn->session->start();
    
    //We take the user from a session
    $userId = $conn->session->get(Auth::getName());
    return $userId;
}

Nginx 代理

    map $http_upgrade $connection_upgrade {
        default upgrade;
        '' close;
    }

    upstream websocket {
        server you-web-site.com:5300;
    }

    server {
        listen 443;
        location / {
            proxy_pass http://websocket;
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection $connection_upgrade;


                proxy_set_header Host $host;
                proxy_set_header X-Real-IP $remote_addr;
                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
                proxy_set_header X-Forwarded-Proto https;
            proxy_redirect off;
        }
    }

Supervisor

[program:laravel-socket]
process_name=%(program_name)s_%(process_num)02d
command=php /var/www/your-path/artisan socket:serve
autostart=true
autorestart=true
user=root
numprocs=1
redirect_stderr=true
stdout_logfile=/var/www/your-path/storage/logs/socket.log

许可证

MIT 许可证 (MIT)。请参阅许可证文件了解更多信息。

canaan / web-socket

维护者

详情