使用PHP+Swoole实现的网页即时聊天工具：PHPWebIM

Posted 2020-07-02 西糊涂炒番茄

使用php+Swoole实现的网页即时聊天工具

• 全异步非阻塞Server，可以同时支持数百万TCP连接在线

• 同时支持websocket+comet2种兼容协议，可用于所有种类的浏览器包括IE

• 拥有完整的UI界面

• 支持单聊/群聊/组聊等功能

• 支持发送表情

• 支持永久保存聊天记录

• 基于Server PUSH的即时内容更新，登录/登出/状态变更/消息等会内容即时更新

  最新的版本已经可以原生支持IE系列浏览器了，基于Http长连接

  安装

  swoole扩展

  pecl install swoole

  swoole框架

  composer install

  运行

  将client目录配置到nginx/Apache的虚拟主机目录中，使client/index.html可访问。修改client/config.js中，IP和端口为对应的配置。

  php webim_server.php

  详细部署说明

  1.安装composer(php依赖包工具)

  curl -sS https://getcomposer.org/installer | php mv composer.phar /usr/local/bin/composer

  注意：如果未将php解释器程序设置为环境变量PATH中，需要设置。因为composer文件第一行为#!/usr/bin/env php，并不能修改。更加详细的对composer说明：http://blog.csdn.net/zzulp/article/details/18981029

  2.composer install

  切换到PHPWebIM项目目录，执行指令composer install，如很慢则

  composer install --prefer-dist

  3.Ningx/Apache配置（这里未使用swoole_framework提供的Web AppServer）

  nginx

  server {     listen       80;     server_name  im.swoole.com;     index index.shtml index.html index.htm index.php;     root  /path/to/PHPWebIM/client;     location ~ .*\.(php|php5)?$     {         fastcgi_pass  127.0.0.1:9000;         fastcgi_index index.php;         include fastcgi.conf;     }     access_log  /Library/WebServer/nginx/logs/im.swoole.com  access; }

  apache

  <VirtualHost *:80>     DocumentRoot "path/to/PHPWebIM/client"     ServerName im.swoole.com     AddType application/x-httpd-php .php     <Directory />         Options Indexes FollowSymLinks         AllowOverride None         Require all granted         DirectoryIndex index.php     </Directory> </VirtualHost>

  4.修改配置PHPWebIM/config.php

  $config[‘server‘] = array(     //监听的HOST     ‘host‘ => ‘0.0.0.0‘,     //监听的端口     ‘port‘ => ‘9503‘,     //WebSocket的URL地址，供浏览器使用的     ‘url‘ => ‘ws://127.0.0.1:9503‘, );

  • server.host server.port 项为WebIM服务器即WebSocket服务器的IP与端口，其他选择项根据具体情况修改
  • server.url对应的就是服务器IP或域名以及websocket服务的端口，这个就是提供给浏览器的WebSocket地址
  • webim.data_dir用于修改聊天记录存储的目录，必须有可写权限

  5.启动WebSocket服务器

  php PHPWebIM/webim_server.php

  IE浏览器不支持WebSocket，需要使用FlashWebSocket模拟，请修改flash_policy.php中对应的端口，然后启动flash_policy.php。

  php PHPWebIM/flash_policy.php

  6.绑定host与访问聊天窗口（可选）

  如果URL直接使用IP:PORT，这里不需要设置。

  vi /etc/hosts

  增加

  127.0.0.1 im.swoole.com

  用浏览器打开：http://im.swoole.com

  快速了解项目架构

  1.目录结构

  + PHPWebIM   |- webim_server.php //WebSocket协议服务器   |- config.php // swoole运行配置   |+ swoole.ini // WebSocket协议实现配置   |+ client     |+ static     |- config.js // WebSocket client配置     |- index.html // 登录界面     |- main.html // 聊天室主界面   |+ data // 运行数据   |+ log // swoole日志及WebIM日志   |+ src // WebIM 类文件储存目录     |+ Store       |- File.php // 默认用内存tmpfs文件系统(linux /dev/shm)存放天着数据，如果不是linux请手动修改$shm_dir       |- Redis.php // 将聊天数据存放到Redis     |- Server.php // 继承实现WebSocket的类，完成某些业务功能   |+ vendor // 依赖包目录

  2.Socket Server与Socket Client通信数据格式

  如：登录

  Client发送数据

  {"cmd":"login","name":"xdy","avatar":"http://tp3.sinaimg.cn/1586005914/50/5649388281/1"}

  Server响应登录

  {"cmd":"login", "fd": "31", "name":"xdy","avatar":"http://tp3.sinaimg.cn/1586005914/50/5649388281/1"}

  可以看到cmd属性，client与server发送时数据都有指定，主要是用于client或者server的回调处理函数。

  3.需要理清的几种协议或者服务的关系

  http协议：超文本传输协议。单工通信，等着客户端请求之后响应。

  WebSocket协议：是HTML5一种新的协议，它是实现了浏览器与服务器全双工通信。服务器端口与客户端都可以推拉数据。

  Web服务器：此项目中可以用基于Swoole的App Server充当Web服务器，也可以用传统的nginx/apache作为web服务器

  Socket服务器：此项目中浏览器的WebSocket客户端连接的服务器，swoole_framework中有实现WebSocket协议PHP版本的服务器。

  WebSocket Client：实现html5的浏览器都支持WebSocket对象，如不支持此项目中有提供flash版本的实现。