# 在 Laravel 中使用 Workerman GatewayWorker 進行 socket 長連接通訊和TCP文件傳輸 初次接觸[GatewayWorker框架](http://doc2.workerman.net/)，先閱讀示例：Linux系統快速開始（從一個精簡的聊天demo開始）。查看文件目錄結構 ~~~ GatewayWorker ├── Applications // 這里是所有開發者應用項目 │ └── YourApp // 其中一個項目目錄，目錄名可以自定義 │ ├── Events.php // 開發者只需要關注這個文件 │ ├── start_gateway.php // gateway進程啟動腳本，包括端口號等設置 │ ├── start_businessworker.php // businessWorker進程啟動腳本 │ └── start_register.php // 注冊服務啟動腳本 │ ├── start.php // 全局啟動腳本，此腳本會依次加載Applications/項目/start_*.php啟動腳本 │ └── vendor // GatewayWorker框架和Workerman框架源碼目錄，此目錄開發者不用關心 ~~~ 在 Laravel 框架中使用，有兩種方式： * 方式一：根據示例，復制`Applications`目錄下的文件，到 Laravel 框架到`app`目錄下，可以自定義新目錄，并且修改*start.php*文件中的相應的加載位置。 * 方式二：使用 Laravel 框架提供的`php artisan`命令工具來做啟動。把`start.php`、`start_gateway.php`、`start_register.php`、`start_businessworker.php`四個文件內容，合并在一起。 ### 我選的是第二種， 第一種情況下 workerman 里面我用不了laravel 代碼，不知道是什么原因，所以我只直接使用第二種。 ## 1、安裝 GatewayWorker ~~~ composer require workerman/gateway-worker composer require workerman/gatewayclient ~~~ ## 2、創建 Workerman 啟動文件 創建一個 artisan 命令行工具來啟動 Socket 服務端，在`app/Console/Commands`目錄下建立命令行文件。 ~~~ php artisan make:command GatewayworkerCommand ~~~ app/Console/Commands/GatewayworkerCommand 內容如下： ~~~ <?php namespace App\Console\Commands; use Illuminate\Console\Command; use Illuminate\Support\Facades\Log; use Workerman\Worker; use GatewayWorker\Gateway; use GatewayWorker\Register; use GatewayWorker\BusinessWorker; use App\Gatewayworker\Events; class GatewayworkerCommand extends Command { /** 命令 php artisan workerman start * @var string */ protected $signature = 'Workerman {action} {--d}'; protected $description = 'Start a Workerman server'; public function __construct() { parent::__construct(); } public function handle() { global $argv; if (!in_array($action = $this->argument('action'), ['start', 'stop', 'restart', 'status'])) { $this->error('Error Arguments'); exit; } $argv[0] = 'Workerman'; $argv[1] = $action; $argv[2] = $this->option('d') ? '-d' : '';//該參數是以daemon（守護進程）方式啟動 $this->startRun(); } public function startRun(){ $this->startGateWay(); $this->startBusinessWorker(); $this->startRegister(); Worker::$pidFile = '/www/wwwroot/admin/vendor/workerman/'.$this->worker_name.'.pid'; Worker::runAll(); } private function startBusinessWorker() { $worker = new BusinessWorker(); $worker->name = 'BusinessWorker'; $worker->count = 2; $worker->registerAddress = '127.0.0.1:1236'; $worker->eventHandler = Events::class; } private function startGateWay() { $context = array( 'ssl' => array( // 使用絕對路徑 'local_cert' => '/www/wwwroot/admin/app/ssl/server.pem' , 'local_pk' => '/www/wwwroot/admin/app/ssl/server.key' , 'verify_peer' => false, 'allow_self_signed' => true ) ); //$gateway = new Gateway("tcp://0.0.0.0:5901"); $gateway = new Gateway("websocket://0.0.0.0:5901", $context ); $gateway->transport = 'ssl'; $gateway->name = 'Gateway'; $gateway->count = 2; $gateway->lanIp = '127.0.0.1'; $gateway->registerAddress = '127.0.0.1:1236'; // 心跳間隔 $gateway->pingInterval = 10; // 發給客戶端你的心跳數據 $gateway->pingData = '{"type":"ping"}'; } private function startRegister() { new Register('text://0.0.0.0:1236'); } } ~~~ ## 3、創建事件監聽文件 創建一個*app/Gatewayworker/Events.php*文件來監聽處理 workman 的各種事件。 ~~~ <?php namespace App\Gatewayworker; use App\Models\User; use GatewayWorker\Lib\Gateway; use Illuminate\Support\Facades\Log; use Illuminate\Support\Facades\Storage; use Workerman\Timer; class Events { static $fp = ""; /*$fp = fopne()*/ static $i = 0; /*循環次數*/ public static function onWorkerStart($businessWorker) { // echo "onWorkerStart\r\n"; } public static function onConnect($client_id) { // 連接到來后，定時30秒關閉這個鏈接，需要30秒內發認證并刪除定時器阻止關閉連接的執行 $auth_timer_id = Timer::add(10, function($client_id){ Gateway::closeClient($client_id); }, array($client_id), false); Gateway::updateSession($client_id, array('auth_timer_id' => $auth_timer_id)); /*客戶端連接到時候觸發*/ Gateway::sendToClient($client_id, json_encode([ 'type' =>'init', 'client_id' => $client_id, ])); } public static function onMessage($client_id, $data) { $_SESSION = Gateway::getSession($client_id); /*驗證用戶*/ /*第一次進入的用戶*/ if (!isset($_SESSION['token'])) { $data = json_decode($data, true); /*驗證token，其他屬性是否合法*/ if (!isset($data['token'])) { self::gateSend($client_id, 'socket已斷開', 'error'); Gateway::closeClient($client_id); } else { // 認證成功，刪除 30關閉連接定 的時器 $_SESSION['token'] = $data['token']; $_SESSION['file_name'] = $data['file_name']; $_SESSION['file_size'] = $data['file_size']; $_SESSION['service_type'] = $data['service_type']; Timer::del($_SESSION['auth_timer_id']); self::gateSend($client_id, '連接成功'); } }else{ /*第二次直接發送文件*/ if ($data == 'pong'){ return ; } $file_patch = 'temp/file_trans'; /*public下面的文件存儲目錄*/ $fileSize = self::saveFile($file_patch, $data); /*file_put end*/ if ($fileSize >= $_SESSION['file_size']){ Log::info('客戶端發送的:'. $_SESSION['file_size']); Log::info('我計算的:'. $fileSize); $file = asset($file_patch.'/'.$_SESSION['file_name']); usleep(100000); self::closeFile(); self::gateSend($client_id,'文件上傳成功','success',['progress'=>100,'file'=>$file]); Gateway::closeClient($client_id); }else{ $progress = (int) floor(number_format($fileSize / $_SESSION['file_size'] * 100)); self::gateSend($client_id,'文件上傳中','success',['progress'=>$progress]); } } } public static function onClose($client_id) { self::gateSend($client_id,'tcp連接斷開','error'); } /** * @param $client_id * @param $msg * @param $status * @param $options * @return void */ public static function gateSend($client_id, $msg = '', $status = 'success', $options = []){; Gateway::sendToClient($client_id, json_encode( array_merge([ 'message' => $msg, 'status' => $status ],$options) )); } /** * @param $file_patch * @param $content * @return false|int */ private static function saveFile($file_patch = '', $content){ $file_patch = public_path($file_patch); is_dir($file_patch) or mkdir($file_patch); $save_patch = $file_patch . '/' . $_SESSION['file_name']; /*一次打開多次寫入*/ if (self::$i == 0){ if (is_file($save_patch)) @unlink($save_patch); self::$fp = fopen($save_patch,'a'); /*寫入方式打開，將文件指針指向文件末尾進行寫入，如果文件不存在則嘗試創建之*/ } $file_data = $content; //$length = file_put_contents($save_patch, $file_data, FILE_APPEND); fwrite(self::$fp, $file_data); self::$i++; /*文件大小計算*/ $file = $file_patch . '/' . $_SESSION['file_name']; return filesize($file); } } ~~~ ## 4、開啟服務 在命令行里面執行，支持的命令有`start|stop|restart|status`，其中`--d`的意思是 daemon 模式，后臺守護進程。 ~~~ php artisan workerman start ~~~ ~~~ Workerman[artisan] start in DEBUG mode -------------------------------------------- WORKERMAN --------------------------------------------- Workerman version:4.0.20 PHP version:8.0.12 --------------------------------------------- WORKERS ---------------------------------------------- proto user worker listen processes status tcp root Gateway websocket://0.0.0.0:5901 2 [OK] tcp root BusinessWorker none 4 [OK] tcp root Register text://0.0.0.0:1236 1 [OK] ---------------------------------------------------------------------------------------------------- Press Ctrl+C to stop. Start success. onWorkerStart onWorkerStart onWorkerStart onWorkerStart ~~~ ## 5、在瀏覽器中測試 為了websocket 測試第三步Events.php重新配置 ~~~ <?php namespace App\Gatewayworker; use GatewayWorker\Lib\Gateway; class Events { public static function onWorkerStart($businessWorker) { echo "onWorkerStart\r\n"; } public static function onConnect($client_id) { Gateway::sendToClient($client_id, json_encode(['type' => 'onConnect', 'client_id' => $client_id])); echo "onConnect\r\n"; } public static function onWebSocketConnect($client_id, $data) { echo "onWebSocketConnect\r\n"; } public static function onMessage($client_id, $message) { Gateway::sendToClient($client_id, json_encode(['type' => 'onMessage', 'client_id' => $client_id, 'name' => json_decode($message)->name])); echo "onMessage\r\n"; } public static function onClose($client_id) { echo "onClose\r\n"; } } ~~~ 注意：這里是websocket情況下瀏覽器才輸出,websocket 測試，注意第二步的,我的域名是https，所以我設置了https證書 ~~~ $gateway = new Gateway("websocket://0.0.0.0:5901", $context ); $gateway->transport = 'ssl'; ~~~ 用 chrome 瀏覽器打開此 Laravel 框架建設的網站，打開控制臺（快捷鍵按F12）。在*Console*里輸入： ~~~ var ws = new WebSocket("wss://127.0.0.1:5901"); ws.onopen = function(e) { ws.send('{"name":"one","user_id":"111"}'); ws.send('{"name":"two","user_id":"222"}'); }; ws.onmessage = function(e) { console.log("收到服務端的消息：" + e.data); }; ws.onclose = function(e) { console.log("服務已斷開" ); } ~~~  成功！ 以下微信小程序tcp傳輸測試 pages/index/index.js ~~~ const tcp = wx.createTCPSocket(); const fs = wx.getFileSystemManager() let file = 'tts.mp3' const filePath = '/'+file; Page({ onLoad() { this.handle(); }, handle(){ tcp.connect({address: 'translate.api.ulunix.cn', port: 5901}) tcp.onMessage((res) => { let unit8Arr = new Uint8Array(res.message) let encodedString = String.fromCharCode.apply(null, unit8Arr) let decodedString = decodeURIComponent(escape((encodedString))) let res_data = JSON.parse(decodedString) console.log(res_data) if(res_data.type =='init'){ let uid = 45; fs.getFileInfo({ filePath: filePath, // 獲取的臨時或本地文件路徑 success(res) { console.log(res.size); let data = {'token':uid,'file_name':file,'service_type':'file_trans','file_size':res.size}; tcp.write(JSON.stringify(data)) }, fail(err){ console.log(err); } }) } if(res_data.type =='ping'){ tcp.write('pong') } }) tcp.onError((res) => { console.log(res); }) tcp.onClose((res) => { console.log(res); }) }, //點擊以后開始傳輸 tcp(){ fs.readFile({ filePath: filePath, // 獲取的臨時或本地文件路徑 success(resd) { tcp.write(resd.data) }, }) } }) ~~~