thinkphp 5.0整合phpsocketio完整攻略，繞坑

李益達發表於2019-02-16
PHP

使用環境： thinkphp5.0

專案需求

前端下單，後臺接受，並立即做出提示。例如：美團外賣，客戶端下單成功後，商家端就會立即有接單語音提示。

開發環境

  • thinkphp5.0
  • phpsocketio

(由於需要啟動socket服務，所以需在能夠滿足shell的環境下使用)

socketio 優勢

這裡只是我的觀點，畢竟沒有怎麼深入研究socketio，所以只是淺顯的一點總結：

  • 減小伺服器IO負載
  • 長連線比ajax輪詢靠譜
  • 服務穩定，支援動態

初略的看了一下，記憶體佔用很小，而且只有1個程式，根據官方報導來說1個程式也能容納1W人次的高併發，所以，對於我的專案來說，已經綽綽有餘

官方文件

https://github.com/walkor/php…

開始開發

安裝 phpsocketio

首先cd到thinkphp的專案根目錄。使用以下命令

composer require workerman/phpsocket.io

( 這裡composer不做解釋，如果有什麼問題，度娘一下，應該能夠解決 )

安裝好以後，vendor資料夾下面應該就有一個workerman的資料夾，如果存在，就恭喜你，已經安裝完畢了

服務入口檔案

回到專案根目錄，新建socketio.php，開始編輯

#!/usr/bin/env php
<?php
define(`APP_PATH`, __DIR__ . `/application/`);
define(`BIND_MODULE`,`socketio/Server/index`);
// 載入框架引導檔案
require __DIR__ . `/thinkphp/start.php`;

這裡只要寫好就OK。後續的所有東西，可以忽略他的存在

建立服務控制器

上一步的socketio.php檔案裡面，模組繫結到了`socketio/Server/index`，這裡就需要我們手動建立了。為了能理解，我用目錄展示

├─application           應用目錄
│  ├─socketio           新建立目錄
│  │  ├─controller      
│  │  │  ├─Server.php   啟動檔案

Server.php

入口檔案只是繫結到了這個控制器，所以這個是整個socketio的核心。

<?php
/*
 * (c) U.E Dream Development Studio
 *
 * Author: 李益達 - Ekey.Lee <ekey.lee@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace appsocketiocontroller;

require_once VENDOR_PATH . "workerman/phpsocket.io/src/autoload.php";

use PHPSocketIOSocketIO;
use WorkermanWorker;

class Server
{

    public function index()
    {
        $io = new SocketIO(8080);//socket的埠
        $io->on(`workerStart`, function () use ($io) {
            $inner_http_worker = new Worker(`http://0.0.0.0:5880`);//這裡IP不用改變，用的內網通訊，埠不能與socket埠想通
            $inner_http_worker->onMessage = function ($http_connection, $data) use ($io) {
                
                $io->emit(`new_msg`, `44444`);//這裡寫了固定資料，請根據自己專案需求去做調整，不懂這裡的可以看看官方文件，很清楚
                $http_connection->send(`ok`);
            };
            $inner_http_worker->listen();
        });

        // 當有客戶端連線時
        $io->on(`connection`, function ($socket) use ($io) {
            // 定義chat message事件回撥函式
            $socket->on(`chat message`, function ($msg) use ($io) {
                // 觸發所有客戶端定義的chat message from server事件
                $io->emit(`chat message from server`, $msg);
            });
        });

        Worker::runAll();
    }
}

建立API 觸發socketio

同樣你可以在socketio下面新建一個API控制器，這裡僅供測試

 public function api()
    {
        // 推送的url地址，使用自己的伺服器地址
        $push_api_url = "http://0.0.0.0:5880";//這裡同樣不需要更改IP。只是埠一定需要和server.php onworker的一樣
        $post_data = array(
           "type" => "publish",
           "content" => "這個是推送的測試資料",
        );
        $ch = curl_init ();
        curl_setopt ( $ch, CURLOPT_URL, $push_api_url );
        curl_setopt ( $ch, CURLOPT_POST, 1 );
        curl_setopt ( $ch, CURLOPT_HEADER, 0 );
        curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1 );
        curl_setopt ( $ch, CURLOPT_POSTFIELDS, $post_data );
        curl_setopt ($ch, CURLOPT_HTTPHEADER, array("Expect:"));
        $return = curl_exec ( $ch );
        curl_close ( $ch );
        var_export($return);
    }

現在有了server服務端，API觸發端，接下來就需要顯示出來了，就是我們的前端

前端

現在要寫的就是，商家端收到的提示。之前寫的server服務端提供phpsocketio監控與socket服務，API提供事件觸發，也就是有人下單後的觸發，下單作為事件去觸發伺服器socket，讓他回應到前端

程式碼開始前請注意：這裡的埠和域名比較的繞

 <script src=`//cdn.bootcss.com/socket.io/1.3.7/socket.io.js`></script>
  <script>
            // 連線服務端
            var socket = io(`http://xxxx.com:8080`);//這裡請填寫你的域名，外網，埠為socket埠
          // 後端推送來訊息時
            socket.on(`new_msg`, function (msg) {//這裡的new_msg請一定要注意，官方文件都寫的是content，但是後端傳送的自定義是new_msg，後端定義成new_msg，前端卻接受content的欄位。所以是接受不了的
                swal({ title: "包廂點餐提醒", text: "哆啦a夢包廂有新訂單" })
                //console.log("收到訊息：" + msg);
            });

</script>

以上有兩個我之前出問題的地方

  • 埠與域名：域名是外網的域名，當然是需要和你的socket服務在同一個IP下面，即：你的socket部署在114.114.114.114的IP下面。這個域名就必須是在114.114.114.114的IP下面。埠則是後端服務裡面new SocketIO的埠了。
  • socket.on()文件裡面都是socket.on(`content`,function(msg){....})，但是可以看我們Server.php裡面$io->emit(`new_msg`, ``);這裡自定義的事件明明叫做new_msg，但是卻被寫成了content，可能是本人眼拙，沒有看清楚，但是也提醒一下，這裡確實要注意回撥事件名

部署完畢開始執行

現在所有的檔案就算是部署好了，進入伺服器管理，開啟shell。cd到專案根目錄。然後執行

php socketio.php start
php socketio.php start 啟動
php socketio.php stop 停止
php socketio.php restart 重啟
php socketio.php status 當前服務狀態

總結

這次只作為工作總結，因為時間緊迫我也沒有好好去研究socketio的更多東西，可能有些地方有紕漏，但是我100%保證這是本人親自測試，所提到的坑點，都是我一步一步踩過去的。如果有說錯的歡迎指教 ^_^

相關文章