workerman結合laravel開發線上聊天應用

逍遙俠發表於2018-10-26

專案背景：

最近由於公司的業務需求，需要用到聊天功能。而且有比較多的個性化需求需要定製。之前使用別人的聊天元件是基於微擎的。如果要移植到普通的H5在邏輯修改還有定製上存在比較多的困難。為此只能克服困難，自己搭建一個吧

什麼是Workerman？

Workerman是一款開源高效能非同步PHP socket即時通訊框架。支援高併發，超高穩定性，被廣泛的用於手機app、移動通訊，微信小程式，手遊服務端、網路遊戲、PHP聊天室、硬體通訊、智慧家居、車聯網、物聯網等領域的開發。支援TCP長連線，支援Websocket、HTTP等協議，支援自定義協議。擁有非同步Mysql、非同步Redis、非同步Http、MQTT物聯網客戶端、非同步訊息佇列等眾多高效能元件。

開始實戰吧！

1.第一步我們先把workerman裡需要用到的擴充套件composer下來吧

"workerman/gateway-worker": "^3.0",
"workerman/gatewayclient": "^3.0",
"workerman/workerman": "^3.5",複製程式碼

2.第二步我們到官方網站把demo全部下載下來，然後放到我們專案中的目錄

圖片中我就把整個專案都放在了HTTP/Controller/Workerman中。

3.第三步我們需要把把以下3個檔案的引用部分修改為以下。不然會報路徑錯誤

start_businessworker，start_gateway，start_register

require_once __DIR__ . '/../../../../../vendor/autoload.php';複製程式碼

4.修改完成後我們就可以在liunx直接執行對應的啟動檔案

php start.php start -d

如果你是在window下就雙擊start_for_win.bat執行複製程式碼

5.執行成功後，你就應該可以看到以下的介面

到此我們搭建基於workerman的通訊環境就已經完成。接下來我們就可以根據自己的專案需求進行開發。在此向大家重點說明。我們所有的聊天是邏輯都在目錄中的Events.php進行修改。

---------------------------------華麗分割線---------------------------------------------------

下面我給大家貼一下我編寫的部分份程式碼。

Event.php

<?php
/**
 * This file is part of workerman.
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the MIT-LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @author walkor<walkor@workerman.net>
 * @copyright walkor<walkor@workerman.net>
 * @link http://www.workerman.net/
 * @license http://www.opensource.org/licenses/mit-license.php MIT License
 */

/**
 * 用於檢測業務程式碼死迴圈或者長時間阻塞等問題
 * 如果發現業務卡死，可以將下面declare開啟（去掉//註釋），並執行php start.php reload
 * 然後觀察一段時間workerman.log看是否有process_timeout異常
 */
//declare(ticks=1);

/**
 * 聊天主邏輯
 * 主要是處理 onMessage onClose
 */
use \GatewayWorker\Lib\Gateway;

class Events
{
    /**
     * 作者:何志偉
     * 當客戶端連線上來的時候
     * 建立時間：2018/10/25
     * @param $client_id 此ID為gatewayworker 自動生成ID
     */
    public static function onConnect($client_id)
    {
        Gateway::sendToClient($client_id, json_encode(array(
            'type'      => 'init',
            'client_id' => $client_id
        )));
    }


    /**
     * 有訊息時
     * @param int $client_id
     * @param mixed $message
     */
    public static function onMessage($client_id, $message)
    {
        // debug
        echo "client:{$_SERVER['REMOTE_ADDR']}:{$_SERVER['REMOTE_PORT']} gateway:{$_SERVER['GATEWAY_ADDR']}:{$_SERVER['GATEWAY_PORT']}  client_id:$client_id session:".json_encode($_SESSION)." onMessage:".$message."\n";

        // 客戶端傳遞的是json資料
        $message_data = json_decode($message, true);
        if(!$message_data)
        {
            return ;
        }

        // 根據型別執行不同的業務
        switch($message_data['type'])
        {
            // 客戶端迴應服務端的心跳
            case 'pong':
                return;
            // 客戶端登入 message格式: {type:login, name:xx, room_id:1} ，新增到客戶端，廣播給所有客戶端xx進入聊天室
            case 'login':
                // 判斷是否有房間號
                if(!isset($message_data['room_id']))
                {
                    throw new \Exception("\$message_data['room_id'] not set. client_ip:{$_SERVER['REMOTE_ADDR']} \$message:$message");
                }

                // 把房間號暱稱放到session中
                $room_id = $message_data['room_id'];
                $client_name = htmlspecialchars($message_data['client_name']);
                $_SESSION['room_id'] = $room_id;
                $_SESSION['client_name'] = $client_name;


                // 獲取房間內所有使用者列表
                $clients_list = Gateway::getClientSessionsByGroup($room_id);
                foreach($clients_list as $tmp_client_id=>$item)
                {
                    $clients_list[$tmp_client_id] = $item['client_name'];
                }
//                $clients_list[$client_id] = $client_name;

                // 轉播給當前房間的所有客戶端，xx進入聊天室 message {type:login, client_id:xx, name:xx}
                $new_message = array('type'=>$message_data['type'], 'client_id'=>$client_id, 'client_name'=>htmlspecialchars($client_name), 'time'=>date('Y-m-d H:i:s'),'to'=>$message_data['to'],'room_id'=>$message_data['room_id'],
                    'from'=>$message_data['from'],'tag'=>$message_data['tag']);
                Gateway::sendToGroup($room_id, json_encode($new_message));
                Gateway::joinGroup($client_id, $room_id);

                // 給當前使用者傳送使用者列表
                $new_message['client_list'] = $clients_list;
                Gateway::sendToCurrentClient(json_encode($new_message));
                return;

            // 客戶端發言 message: {type:say, to_client_id:xx, content:xx}
            case 'say':
                // 非法請求
                if(!isset($_SESSION['room_id']))
                {
                    throw new \Exception("\$_SESSION['room_id'] not set. client_ip:{$_SERVER['REMOTE_ADDR']}");
                }
                $room_id = $_SESSION['room_id'];
                $client_name = $_SESSION['client_name'];

                // 私聊
//                if($message_data['to_client_id'] != 'all')
//                {
//                    $new_message = array(
//                        'type'=>'say',
//                        'from_client_id'=>$client_id,
//                        'from_client_name' =>$client_name,
//                        'to_client_id'=>$message_data['to_client_id'],
//                        'content'=>"<b>對你說: </b>".nl2br(htmlspecialchars($message_data['content'])),
//                        'time'=>date('Y-m-d H:i:s'),
//                    );
//                    Gateway::sendToClient($message_data['to_client_id'], json_encode($new_message));
//                    $new_message['content'] = "<b>你對".htmlspecialchars($message_data['to_client_name'])."說: </b>".nl2br(htmlspecialchars($message_data['content']));
//                    return Gateway::sendToCurrentClient(json_encode($new_message));
//                }

                $new_message = array(
                    'type'=>'say',
                    'from_client_id'=>$client_id,
                    'from_client_name' =>$client_name,
                    'to_client_id'=>'all',
                    'content'=>nl2br(htmlspecialchars($message_data['content'])),
                    'time'=>date('Y-m-d H:i:s'),

                );
                return Gateway::sendToGroup($room_id ,json_encode($new_message));
        }
    }
    /**
     * 當客戶端斷開連線時
     * @param integer $client_id 客戶端id
     */
    public static function onClose($client_id)
    {
        // debug
        echo "client:{$_SERVER['REMOTE_ADDR']}:{$_SERVER['REMOTE_PORT']} gateway:{$_SERVER['GATEWAY_ADDR']}:{$_SERVER['GATEWAY_PORT']}  client_id:$client_id onClose:''\n";

        // 從房間的客戶端列表中刪除
        if(isset($_SESSION['room_id']))
        {
            $room_id = $_SESSION['room_id'];
            $new_message = array('type'=>'logout', 'from_client_id'=>$client_id, 'from_client_name'=>$_SESSION['client_name'], 'time'=>date('Y-m-d H:i:s'));
            Gateway::sendToGroup($room_id, json_encode($new_message));
        }
    }

}複製程式碼

客戶端頁面

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>與{{$to->name}}的對話</title>
    <script type="text/javascript" src="{{asset('js')}}/swfobject.js"></script>
    <script type="text/javascript" src="{{asset('js')}}/web_socket.js"></script>
    <script type="text/javascript" src="{{asset('js')}}/jquery.min.js"></script>
    <link href="{{asset('css')}}/jquery-sinaEmotion-2.1.0.min.css" rel="stylesheet">
    <link href="{{asset('css')}}/bootstrap.min.css" rel="stylesheet">
    <link href="{{asset('css')}}/style.css" rel="stylesheet">
    <script type="text/javascript" src="{{asset('js')}}/jquery-sinaEmotion-2.1.0.min.js"></script>

    {{--<script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>--}}

</head>
<style>
    #sinaEmotion {
        z-index: 999;
        width: 373px;
        padding: 10px;
        display: none;
        font-size: 12px;
        background: #fff;
        overflow: hidden;
        position: absolute;
        border: 1px solid #e8e8e8;
        top: 100px;
        left: 542.5px;
    }
</style>
<body onload="connect();" style="margin: auto; text-align: center;">
<div style="margin: auto;">
    <div style="border: 1px solid red; height: 40px; width: 500px; margin: auto;">
        {{--對話視窗頭部--}}
        <div>
            <div style="width: 80px; height: 40px; border: 1px solid blue; float: left">
                <img src="{{$to->heading}}" width="80px" height="40px">
            </div>
            <div style="width: 150px; height: 40px; border: 1px solid blue; float: left">
                {{$to->name}}
            </div>
        </div>
        {{--//對話視窗內容--}}
        <div class="content" style="width: 500px; height: 400px; border: 1px solid green; margin-top: 40px; overflow-y: auto">
            {{--對方的頭像與文字--}}
            {{--<div style="min-height: 50px;margin-top: 10px;">--}}
                {{--<div style="width: 50px;height: 50px; border: 1px solid red;  margin-left:10px; float: left">--}}
                    {{--<img src="{{$to->heading}}" width="50px" height="50px">--}}
                {{--</div>--}}
                {{--<div style="border: 1px solid red; float: left;  min-height: 50px" >dsadsadsadsadsa</div>--}}
            {{--</div>--}}
            {{--我的頭像與文字--}}
            {{--<div style= "min-height:50px;margin-top: 10px;">--}}
                {{--<div style="width: 50px;height: 50px; border: 1px solid red;  margin-left:10px; float: right">--}}
                    {{--<img src="{{$from->heading}}" width="50px" height="50px">--}}
                {{--</div>--}}
                {{--<div style="border: 1px solid red; float: right;  min-height: 50px" >dsadsadsadsadsa</div>--}}
            {{--</div>--}}
        </div>
        {{--對話傳送視窗--}}
        <form onsubmit="return onSubmit(); return false;" id="ajaxfrom">
            <input type="hidden" name="to" value="{{$to->id}}">
            <input type="hidden" name="from" value="{{$from->id}}">
            <input type="hidden" name="room_id" value="{{$room}}">
            <input type="hidden" name="tag" value="{{$tag}}">
            <textarea id="textarea" name="content" class="Input_text" style="margin: 0px; width: 501px; height: 213px;"></textarea>
            <div class="say-btn">
                <input type="button" class="btn btn-default face pull-left" value="表情" />
                <button type="submit" class="btn btn-default">發表</button>
            </div>
        </form>
        房間號{{$room}}
    </div>
</div>

</body>
</html>
<script type="text/javascript">
    if (typeof console == "undefined") {    this.console = { log: function (msg) {  } };}
    // 如果瀏覽器不支援websocket，會使用這個flash自動模擬websocket協議，此過程對開發者透明
    WEB_SOCKET_SWF_LOCATION = "/swf/WebSocketMain.swf";
    // 開啟flash的websocket debug
    WEB_SOCKET_DEBUG = true;
    var ws, name, client_list={};
    var to_client_id="";

    // 連線服務端初始化函式
    function connect() {
        // 建立websocket 屆時可以替換為對應的伺服器地址
        ws = new WebSocket("ws://"+document.domain+":7272");
        // 當socket連線開啟時，輸入使用者名稱
        ws.onopen = onopen;
        // 當有訊息時根據訊息型別顯示不同資訊
        ws.onmessage = onmessage;
        //當連線丟失時，呼叫連線方法嘗試重新連線
        ws.onclose = function() {
            console.log("連線關閉，定時重連");
            connect();
        };
        //當操作報錯時，返回異常錯誤
        ws.onerror = function() {
            console.log("出現錯誤");
        };

        //傳送ajax獲取當前房間的通話記錄
        $.post("/get_record", { "room":"{{$room}}" },
            function(msg){
                $.each(msg,function (v,k) {
                    console.log(k);
                    //判斷
                    if(k.tag!="{{$tag}}"){
                        $(".content").append(
                            '<div style="min-height: 50px;margin-top: 10px;">' +
                            '<div style="width: 50px;height: 50px; border: 1px solid red;  margin-left:10px; float: left">'+
                            '<img src="{{$to->heading}}" width="50px" height="50px">'+
                            '</div>'+
                            '<div style="border: 1px solid red; float: left;  min-height: 50px" >'+k.content+'</div>'+
                            '<div>'
                        ).parseEmotion();
                    }else{
                        $(".content").append(
                            '<div style="min-height: 50px;margin-top: 10px;">' +
                            '<div style="width: 50px;height: 50px; border: 1px solid red;  margin-left:10px; float: right">'+
                            '<img src="{{$from->heading}}" width="50px" height="50px">'+
                            '</div>'+
                            '<div style="border: 1px solid red; float: right;  min-height: 50px" >'+k.content+'</div>'+
                            '<div>'
                        ).parseEmotion();
                    }
                })
            });
    }

    // 連線建立時傳送登入資訊
    function onopen()
    {
        var login_data='{"type":"login","client_name":"{{$from->name}}","room_id":"{{$room}}","to":"{{$to->id}}","from":"{{$from->id}}","tag":"{{$tag}}"}';

        ws.send(login_data);
        console.log('登入成功')
    }

    // 服務端發來訊息時
    function onmessage(e)
    {
        var data = JSON.parse(e.data);
        switch(data['type']){
            // 服務端ping客戶端心跳
            case 'ping':
                ws.send('{"type":"pong"}');
                break;
            // 登入 更新使用者列表
            case 'login':
                //講需要的傳送ID儲存到本地to_client_id變數中
                for(var p in data['client_list']){
                    to_client_id=p;
                }
                console.log(to_client_id);
                break;
            // 發言
            case 'say':
                console.log(data);
                say(data['from_client_id'], data['from_client_name'], data['content'], data['time']);
                break;
            // 使用者退出 更新使用者列表
            case 'logout':
                console.log(data);
                break;
            case 'init':
                //此處可以傳送ajax用於繫結不同的使用者ID和client
                console.log(data);
                break;

        }
    }

    // 提交對話
    function onSubmit() {
        //先檢查當前的對話是否超過20條記錄數
        var count=true;
        //傳送ajax獲取當前房間的通話記錄
        $.ajax({
            url: "/check_count",
            type: "post",
            async:false,
            // cache: false,
            // contentType: false,
            // processData: false,
            data:{
            'room':"1",
            },
            success: function (msg) {
                if(msg>10){
                    alert('當前的對話已經超過次數，請購買對應服務')
                    count=false;
                }
            }

        });


        if(count){
            var neirong=$("#textarea").val().replace(/"/g, '\\"').replace(/\n/g,'\\n').replace(/\r/g, '\\r');
            //ajax先把對應的內容傳送到後臺錄入,回撥成功後才把資訊傳送
            var fm=$("#ajaxfrom")[0];
            var formData = new FormData(fm);
            $.ajax({
                url: "/record",
                type: "post",
                cache: false,
                contentType: false,
                processData: false,
                data: formData,
                beforeSend:function(){

                },
                success: function (msg) {

                    if(msg.code=="0"){
                        ws.send('{"type":"say","to_client_id":"all","to_client_name":"{{$to->name}}","content":"'+neirong+'"}');
                        //清空文字框內容
                        $("#textarea").val("");
                        //強制定位游標
                        $("#textarea").focus();
                    }else{

                    }

                }

            });
        }

        return false;


    }



    // 發言
    function say(from_client_id, from_client_name, content, time){
        //判斷當前的使用者名稱稱與傳送訊息的名稱是否一致
        if( "{{$from->name}}" == from_client_name){
            $(".content").append(
                '<div style="min-height: 50px;margin-top: 10px;">' +
                '<div style="width: 50px;height: 50px; border: 1px solid red;  margin-left:10px; float: right">'+
                '<img src="{{$from->heading}}" width="50px" height="50px">'+
                '</div>'+
                '<div style="border: 1px solid red; float: right;  min-height: 50px" >'+content+'</div>'+
                '<div>'
            ).parseEmotion();
        }else{
            $(".content").append(
                '<div style="min-height: 50px;margin-top: 10px;">' +
                '<div style="width: 50px;height: 50px; border: 1px solid red;  margin-left:10px; float: left">'+
                '<img src="{{$to->heading}}" width="50px" height="50px">'+
                '</div>'+
                '<div style="border: 1px solid red; float: left;  min-height: 50px" >'+content+'</div>'+
                '<div>'
            ).parseEmotion();
        }

        // $("#dialog").append('<div class="speech_item"><img src="http://lorempixel.com/38/38/?'+from_client_id+'" class="user_icon" /> '+from_client_name+' <br> '+time+'<div style="clear:both;"></div><p class="triangle-isosceles top">'+content+'</p> </div>').parseEmotion();
    }
    $(function(){
        //全域性使用者ID
        select_client_id = 'all';

        //如果傳送的使用者有變化則對應的使用者ID進行替換
        $("#client_list").change(function(){
            select_client_id = $("#client_list option:selected").attr("value");
        });
        //表情選擇
        $('.face').click(function(event){
            $(this).sinaEmotion();
            event.stopPropagation();
        });
    });

    // document.write('<meta name="viewport" content="width=device-width,initial-scale=1">');
    $("textarea").on("keydown", function(e) {
        //按enter鍵自動提交
        if(e.keyCode === 13 && !e.ctrlKey) {
            e.preventDefault();
            $('form').submit();
            return false;
        }

        // 按ctrl+enter組合鍵換行
        if(e.keyCode === 13 && e.ctrlKey) {
            $(this).val(function(i,val){
                return val + "\n";
            });
        }
    });

</script>
複製程式碼

這兩個程式碼片段其實就是主要執行的核心片段。其他框架的自帶引數需要各位自己去根據文件去除錯優化。到此基於workerman的聊天用於功能demo已經搭建完畢。

Laravel 整合 workerman 做聊天室
2019-12-12
Laravel
laravel 結合JWT開發API
2018-08-28
LaravelJWTAPI
基於 Vue3 開發的 Lumen IM 線上聊天應用
2023-11-19
Vue
基於 Vue2.0 開發的 Lumen IM 線上聊天應用
2020-12-30
Vue
Lumen/Laravel 整合 GatewayWorker (Workerman)，實現簡單的聊天系統.
2019-03-11
LaravelGateway
開源專案：採用 Laravel 編寫的一個聊天應用 Laravel-Chat
2018-10-08
Laravel
[記錄]利用workerman在laravel中實現網頁聊天室
2021-04-19
Laravel網頁
聊天室應用開發實踐（一）
2019-03-20
thinkphp5.0+workerman聊天室demo
2019-05-11
PHP
基於 WebRTC 與 Webcam 開發一個聊天應用
2019-03-13
Web
WEB例項：開發一個聊天室應用
2018-09-11
Web
基於Laravel 5.4 開發單頁應用
2019-02-16
Laravel
Laravel5.5 + Vue 開發單頁應用
2018-03-23
LaravelVue
Laravel + connmix 開發分散式 WebSocket 聊天室
2022-05-06
Laravel分散式Web
使用 Laravel Sail 新增和開發 Laravel Octane 應用（相容 Debug）
2022-03-15
LaravelAI
5個開源聊天應用程式
2011-09-06
Workerman + laravel8 + vue-element-admin 擼了一個內網穿透應用
2020-11-20
LaravelVue內網穿透
使用 Socket.io 和 React 開發一個聊天應用
2022-12-28
React
Laravel Octane Workerman 擴充套件包
2021-12-14
Laravel套件
用 React 結合 SAP UI5 Web Components 來開發 SAP Fiori 應用
2022-07-22
ReactUIWeb
聊天室應用開發實踐（二）：實現基於 Web 的聊天室
2019-04-10
Web
打造一個window桌面應用：線上聊天對話機器人
2021-07-21
機器人
社交IM聊天軟體開發app,區塊鏈技術應用落地開發方案
2019-12-21
APP區塊鏈
結合 Laravel 實現檔案（PDF、world、Excel 之類）線上預覽？
2020-10-14
LaravelExcel
forsage智慧合約開發技術應用流程
2020-08-22
Laravel+Swoole 完成一個簡單的線上聊天室
2017-10-02
Laravel
區塊鏈聊天通訊直播系統開發app,區塊鏈應用開發方案
2019-12-11
區塊鏈APP
基於vue開發的線上付費課程應用
2019-03-04
Vue
XPages 開發實踐：開發基於 XPages 的複合應用程式
2010-08-16
laravel框架應用和composer擴充套件包開發
2018-07-18
Laravel框架套件
在Lotus Notes 8 中開發複合應用
2008-07-18
在 Lotus Notes 8 中開發複合應用
2009-04-13
輕鬆部署 Laravel 應用 | 《開篇》
2019-03-04
Laravel
Laravel 8+ LayIM 3.8 + GatewayWorker 開發的網頁聊天系統
2021-02-15
LaravelGateway網頁
CNNIC：線上線下相結合促進線上教育各領域迅速發展
2017-02-03
CNN
java開發一個應用的總結
2013-06-22
Java
C#開發一應用的總結
2013-06-26
C#
永續合約搭建,交易所開發方案,區塊鏈應用開發
2019-11-26
區塊鏈