科技

Yii2結合Workerman的websocket

WebSocket Yii · 發表 2018-09-10 11:41:19

摘要： 1、安裝workerman composer require workerman/workerman 2、啟動workerman 建立commands/WorkermanWebSocketController.php檔案建立actionIndex()函式，用來啟動，...

1、安裝workerman

composer require workerman/workerman

2、啟動workerman

建立commands/WorkermanWebSocketController.php檔案

建立actionIndex()函式，用來啟動，程式碼如下

public function actionIndex()
{
if ('start' == $this->send) {
try {
$this->start($this->daemon);
} catch (\Exception $e) {
$this->stderr($e->getMessage() . "\n", Console::FG_RED);
}
} else if ('stop' == $this->send) {
$this->stop();
} else if ('restart' == $this->send) {
$this->restart();
} else if ('reload' == $this->send) {
$this->reload();
} else if ('status' == $this->send) {
$this->status();
} else if ('connections' == $this->send) {
$this->connections();
}
}

新增初始化模組

public function initWorker()
{
$ip = isset($this->config['ip']) ? $this->config['ip'] : $this->ip;
$port = isset($this->config['port']) ? $this->config['port'] : $this->port;
$wsWorker = new Worker("websocket://{$ip}:{$port}");

// 4 processes
$wsWorker->count = 4;

// Emitted when new connection come
$wsWorker->onConnect = function ($connection) {
echo "New connection\n";
};

// Emitted when data received
$wsWorker->onMessage = function ($connection, $data) {
// Send hello $data
$connection->send('hello ' . $data);
};

// Emitted when connection closed
$wsWorker->onClose = function ($connection) {
echo "Connection closed\n";
};
}

新增啟動模組

/**
 * workman websocket start
 */
public function start()
{
$this->initWorker();
// 重置引數以匹配Worker
global $argv;
$argv[0] = $argv[1];
$argv[1] = 'start';
if ($this->daemon) {
$argv[2] = '-d';
}

// Run worker
Worker::runAll();
}

新增停止模組

/**
 * workman websocket stop
 */
public function stop()
{
$this->initWorker();
// 重置引數以匹配Worker
global $argv;
$argv[0] = $argv[1];
$argv[1] = 'stop';
if ($this->gracefully) {
$argv[2] = '-g';
}

// Run worker
Worker::runAll();
}

新增重啟模組

/**
 * workman websocket restart
 */
public function restart()
{
$this->initWorker();
// 重置引數以匹配Worker
global $argv;
$argv[0] = $argv[1];
$argv[1] = 'restart';
if ($this->daemon) {
$argv[2] = '-d';
}

if ($this->gracefully) {
$argv[2] = '-g';
}

// Run worker
Worker::runAll();
}

新增過載模組

/**
 * workman websocket reload
 */
public function reload()
{
$this->initWorker();
// 重置引數以匹配Worker
global $argv;
$argv[0] = $argv[1];
$argv[1] = 'reload';
if ($this->gracefully) {
$argv[2] = '-g';
}

// Run worker
Worker::runAll();
}

新增狀態模組

/**
 * workman websocket status
 */
public function status()
{
$this->initWorker();
// 重置引數以匹配Worker
global $argv;
$argv[0] = $argv[1];
$argv[1] = 'status';
if ($this->daemon) {
$argv[2] = '-d';
}

// Run worker
Worker::runAll();
}

新增連結數模組

/**
 * workman websocket connections
 */
public function connections()
{
$this->initWorker();
// 重置引數以匹配Worker
global $argv;
$argv[0] = $argv[1];
$argv[1] = 'connections';

// Run worker
Worker::runAll();
}

3、前端呼叫

<script>
// Create WebSocket connection.
const ws = new WebSocket('ws://{{ app.request.hostName }}:2347/'); // 這裡是獲取的網站的域名，測試的時候可以改為自己的本地的ip地址

// Connection opened
ws.addEventListener('open', function (event) {
ws.send('Hello Server!');
});

// Listen for messages
ws.addEventListener('message', function (event) {
console.log('Message from server ', event.data);
});

setTimeout(function() {
ws.send('ssssss');
}, 10000);

</script>

4、config引數配置

修改console.php並新增如下程式碼

'controllerMap' => [
'workerman-web-socket' => [
'class' => 'app\commands\WorkermanWebSocketController',
'config' => [
'ip' => '127.0.0.1',
'port' => '2346',
'daemonize' => true,
],
],
],

5、nginx配置

為什麼會用 nginx，我們正常部署上線是不可能直接使用ip的，這個戶存在安全隱患，最好是繫結一個域名

server {
charset utf-8;
client_max_body_size 128M;

listen 2347;

server_name www.gowhich.com; # 這裡改為自己的域名

access_log/xxx.workerman.access.log; # 換成自己伺服器的nginx日誌路徑
error_log/xxx.workerman.error.log; # 換成自己伺服器的nginx日誌路徑

location / {
proxy_pass http://127.0.0.1:2346; # 代理2346 也可以根據專案配置為自己的埠

proxy_set_header X-Real-IP $remote_addr;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
}
}

重新nginx

nginx -s relad 或者 sudo nginx -s reload

然後將第3步的程式碼加入自己做的檢視中，如果沒有問題的話，websocket啟動後就能正常通訊了。

6、啟動workerman websocket

// 啟動
./yii workerman-web-socket -s start -d

如果沒有問題的話會得到類似如下的結果

$ ./yii workerman-web-socket -s start -d
Workerman[workerman-web-socket] start in DAEMON mode
----------------------- WORKERMAN -----------------------------
Workerman version:3.5.13PHP version:7.1.16
------------------------ WORKERS -------------------------------
userworkerlistenprocesses status
durbannonewebsocket://127.0.0.1:23464[OK] 
----------------------------------------------------------------
Input "php workerman-web-socket stop" to stop. Start success.

7、其他

commands/WorkermanWebSocketController.php 完整程式碼如下

<?php
/**
 * WorkmanWebSocket 服務相關
 */

namespace app\commands;

use Workerman\Worker;
use yii\console\Controller;
use yii\helpers\Console;

/**
 *
 * WorkermanWebSocket
 *
 * @author durban.zhang <[email protected]>
 */

class WorkermanWebSocketController extends Controller
{
public $send;
public $daemon;
public $gracefully;

// 這裡不需要設定，會讀取配置檔案中的配置
public $config = [];
private $ip = '127.0.0.1';
private $port = '2346';

public function options($actionID)
{
return ['send', 'daemon', 'gracefully'];
}

public function optionAliases()
{
return [
's' => 'send',
'd' => 'daemon',
'g' => 'gracefully',
];
}

public function actionIndex()
{
if ('start' == $this->send) {
try {
$this->start($this->daemon);
} catch (\Exception $e) {
$this->stderr($e->getMessage() . "\n", Console::FG_RED);
}
} else if ('stop' == $this->send) {
$this->stop();
} else if ('restart' == $this->send) {
$this->restart();
} else if ('reload' == $this->send) {
$this->reload();
} else if ('status' == $this->send) {
$this->status();
} else if ('connections' == $this->send) {
$this->connections();
}
}

public function initWorker()
{
$ip = isset($this->config['ip']) ? $this->config['ip'] : $this->ip;
$port = isset($this->config['port']) ? $this->config['port'] : $this->port;
$wsWorker = new Worker("websocket://{$ip}:{$port}");

// 4 processes
$wsWorker->count = 4;

// Emitted when new connection come
$wsWorker->onConnect = function ($connection) {
echo "New connection\n";
};

// Emitted when data received
$wsWorker->onMessage = function ($connection, $data) {
// Send hello $data
$connection->send('dddd hello ' . $data);
};

// Emitted when connection closed
$wsWorker->onClose = function ($connection) {
echo "Connection closed\n";
};
}

/**
* workman websocket start
*/
public function start()
{
$this->initWorker();
// 重置引數以匹配Worker
global $argv;
$argv[0] = $argv[1];
$argv[1] = 'start';
if ($this->daemon) {
$argv[2] = '-d';
}

// Run worker
Worker::runAll();
}

/**
* workman websocket restart
*/
public function restart()
{
$this->initWorker();
// 重置引數以匹配Worker
global $argv;
$argv[0] = $argv[1];
$argv[1] = 'restart';
if ($this->daemon) {
$argv[2] = '-d';
}

if ($this->gracefully) {
$argv[2] = '-g';
}

// Run worker
Worker::runAll();
}

/**
* workman websocket stop
*/
public function stop()
{
$this->initWorker();
// 重置引數以匹配Worker
global $argv;
$argv[0] = $argv[1];
$argv[1] = 'stop';
if ($this->gracefully) {
$argv[2] = '-g';
}

// Run worker
Worker::runAll();
}

/**
* workman websocket reload
*/
public function reload()
{
$this->initWorker();
// 重置引數以匹配Worker
global $argv;
$argv[0] = $argv[1];
$argv[1] = 'reload';
if ($this->gracefully) {
$argv[2] = '-g';
}

// Run worker
Worker::runAll();
}

/**
* workman websocket status
*/
public function status()
{
$this->initWorker();
// 重置引數以匹配Worker
global $argv;
$argv[0] = $argv[1];
$argv[1] = 'status';
if ($this->daemon) {
$argv[2] = '-d';
}

// Run worker
Worker::runAll();
}

/**
* workman websocket connections
*/
public function connections()
{
$this->initWorker();
// 重置引數以匹配Worker
global $argv;
$argv[0] = $argv[1];
$argv[1] = 'connections';

// Run worker
Worker::runAll();
}
}

workerman websocket支援的其他命令

重啟

$ ./yii workerman-web-socket -s restart -d
Workerman[workerman-web-socket] restart 
Workerman[workerman-web-socket] is stopping ...
Workerman[workerman-web-socket] stop success
----------------------- WORKERMAN -----------------------------
Workerman version:3.5.13PHP version:7.1.16
------------------------ WORKERS -------------------------------
userworkerlistenprocesses status
durbannonewebsocket://127.0.0.1:23464[OK] 
----------------------------------------------------------------
Input "php workerman-web-socket stop" to stop. Start success.

過載

$ ./yii workerman-web-socket -s reload
Workerman[workerman-web-socket] reload

狀態

$ ./yii workerman-web-socket -s status -g
Workerman[workerman-web-socket] status 
----------------------------------------------GLOBAL STATUS----------------------------------------------------
Workerman version:3.5.13PHP version:7.1.16
start time:2018-09-10 11:22:15run 0 days 0 hours
load average: 1.79, 2, 2event-loop:\Workerman\Events\Swoole
1 workers4 processes
worker_nameexit_statusexit_count
none012
----------------------------------------------PROCESS STATUS---------------------------------------------------
pidmemorylisteningworker_nameconnections send_fail timerstotal_request qpsstatus
82834Mwebsocket://127.0.0.1:2346 none00000[idle]
82844Mwebsocket://127.0.0.1:2346 none00000[idle]
82854Mwebsocket://127.0.0.1:2346 none00000[idle]
82864Mwebsocket://127.0.0.1:2346 none00000[idle]
----------------------------------------------PROCESS STATUS---------------------------------------------------
Summary16M--00000[Summary]

連線數

 ./yii workerman-web-socket -s connections
Workerman[workerman-web-socket] connections 
--------------------------------------------------------------------- WORKERMAN CONNECTION STATUS --------------------------------------------------------------------------------
PIDWorkerCIDTransProtocolipv4ipv6Recv-QSend-QBytes-RBytes-WStatusLocal AddressForeign Address

我這裡暫時連線的，所以沒有連線的資訊

停止

$ ./yii workerman-web-socket -s stop
Workerman[workerman-web-socket] stop 
Workerman[workerman-web-socket] is stopping ...
Workerman[workerman-web-socket] stop success

來源：GoWhich