欢迎您的光临,本博所发布之文章皆为作者亲测通过,如有错误,欢迎通过各种方式指正。由于本站位于香港虚拟主机,故速度比较慢。

文摘  Workerman——高性能PHP socket 服务框架入门

PHP框架 网络 230 0评论

一、什么是Workerman


Workerman是一款开源高性能异步PHP socket即时通讯框架。支持高并发,超高稳定性,被广泛的用于手机app、移动通讯,微信小程序,手游服务端、网络游戏、PHP聊天室、硬件通讯、智能家居、车联网、物联网等领域的开发。 支持TCP长连接,支持Websocket、HTTP等协议,支持自定义协议。拥有异步Mysql、异步Redis、异步Http、MQTT物联网客户端、异步消息队列等众多高性能组件。


Workerman的目标是让PHP开发者更容易的开发出基于socket的高性能的应用服务,而不用去了解PHP socket以及PHP多进程细节。 Workerman本身是一个PHP多进程服务器框架,具有PHP进程管理以及socket通信的模块,所以不依赖php-fpm、nginx或者apache等这些容器便可以独立运行。


Workerman是一款纯PHP开发的开源高性能的PHP socket 服务框架。


Workerman不是重复造轮子,它不是一个MVC框架,而是一个更底层更通用的socket服务框架,你可以用它开发tcp代理、梯子代理、做游戏服务器、邮件服务器、ftp服务器、甚至开发一个php版本的redis、php版本的数据库、php版本的nginx、php版本的php-fpm等等。Workerman可以说是PHP领域的一次创新,让开发者彻底摆脱了PHP只能做WEB的束缚。


实际上Workerman类似一个PHP版本的nginx,核心也是多进程+Epoll+非阻塞IO。Workerman每个进程能维持上万并发连接。由于本身常住内存,不依赖Apache、nginx、php-fpm这些容器,拥有超高的性能。同时支持TCP、UDP、UNIXSOCKET,支持长连接,支持Websocket、HTTP、WSS、HTTPS等通讯协以及各种自定义协议。拥有定时器、异步socket客户端、异步Mysql、异步Redis、异步Http、异步消息队列等众多高性能组件。


官网:https://www.workerman.net/ 

官方文档:http://doc.workerman.net/ 

GatewayWorker2.x 3.x 手册:http://doc2.workerman.net/ 

官方视频教程:http://video.workerman.net/ 


GitHub地址:https://github.com/walkor/workerman/ 

Fork on Github:https://github.com/walkor/workerman 

下载ZIP压缩文件:https://www.workerman.net/download/workermanzip 

更多下载地址:https://www.workerman.net/download 


选择Workerman还是GatewayWorker

·  如果你的项目是长连接并且需要客户端与客户端之间通讯,建议使用GatewayWorker。

·  短连接或者不需要客户端与客户端之间通讯的项目建议使用Workerman。

·  GatewayWorker不支持UDP监听,所以UDP服务请选择Workerman。

·  如果你是一个有多进程socket编程经验的人,喜欢定制自己的进程模型,可以选择Workerman。


Workerman特性

·  支持HHVM

·  使用PHP开发

·  支持PHP多进程/多线程(多线程版本)

·  标准输入输出重定向

·  支持毫秒定时器

·  支持基于事件的异步编程

·  守护进程化

·  支持TCP/UDP

·  支持多端口监听

·  接口上支持各种应用层协议

·  支持libevent事件轮询库,支持高并发

·  支持服务平滑重启

·  支持PHP文件更新检测及自动加载

·  支持PHP长连接

·  支持以指定用户运行子进程

·  支持telnet远程控制

·  高性能


更多特性:https://www.workerman.net/features 


二、Workerman安装


1.环境要求


Windows用户

workerman从3.5.3版本开始已经能够同时支持linux系统和windows系统。

1、需要PHP>=5.3.3,并配置好PHP的环境变量。

2、Windows版本的Workerman不依赖任何扩展。

3、安装使用以及注意事项参见这里


====本页面以下只适用于Linux用户,Windows用户请忽略。 ====


Linux用户(含Mac OS)

Linux用户只能使用Linux版本的Workerman。

1、安装PHP>=5.3.3,并安装了pcntl、posix扩展

2、建议安装event或者libevent扩展,但不是必须的(注意event扩展需要PHP>=5.4)


Linux环境检查脚本

Linux用户可以运行以下脚本检查本地环境是否满足WorkerMan要求

curl -Ss http://www.workerman.net/check.php | php

如果脚本中全部提示ok,则代表满足WorkerMan运行环境

注意:检测脚本中没有检测event扩展或者libevent扩展,如果并发连接数大于1024建议安装event扩展或者libevent扩展,安装方法参见下一节)


详细说明


关于PHP-CLI

WorkerMan是基于PHP命令行(PHP-CLI)模式运行的。PHP-CLI与PHP-FPM或者Apache的MOD-PHP是独立的可执行程序,它们之间并不冲突也不会有相互依赖,完全独立。


关于WorkerMan依赖的扩展

1、pcntl扩展

pcntl扩展是PHP在Linux环境下进程控制的重要扩展,WorkerMan用到了其进程创建信号控制定时器进程状态监控等特性。此扩展win平台不支持。


2、posix扩展

posix扩展使得PHP在Linux环境可以调用系统通过POSIX标准提供的接口。WorkerMan主要使用了其相关的接口实现了守护进程化、用户组控制等功能。此扩展win平台不支持。


3、 Event扩展 或者 libevent扩展

libevent扩展(或者event扩展)使得PHP可以使用系统Epoll、Kqueue等高级事件处理机制,能够显著提高WorkerMan在高并发连接时CPU利用率。在高并发长连接相关应用中非常重要。libevent扩展(或者event扩展)不是必须的,如果没安装,则默认使用PHP原生Select事件处理机制。


如何安装扩展

参见安装扩展章节


2.安装说明


WorkerMan实际上就是一个PHP代码包,如果你的PHP环境已经装好,只需要把WorkerMan源代码或者demo下载下来即可运行。


1)windows用户(必读)

从workerman3.5.3版已经可以同时支持windows和linux系统。 windows用户需要配置下php环境变量。php环境变量设置参见这里。


===本页面以下仅适用于Linux环境workerman,windows用户请忽略===


2)Linux系统环境检测

Linux系统可以使用以下脚本测试本机PHP环境是否满足WorkerMan运行要求。 

curl -Ss http://www.workerman.net/check.php | php

上面脚本如果全部显示ok,则代表满足WorkerMan要求,直接到官网下载例子即可运行。

如果不是全部ok,则参考下面文档安装缺失的扩展即可。

注意:检测脚本中没有检测event扩展或者libevent扩展,如果业务并发连接数大于1024必须安装event扩展或者libevent扩展,并且优化Linux内核,扩展安装方法参照下面说明)


3)已有PHP环境安装缺失扩展


· 安装pcntl和posix扩展:

centos系统

如果php是通过yum安装的,则命令行运行 yum install php-process即可安装pcntl和posix扩展。

如果安装失败或者php本身不是用yum安装的请参考手册附录-安装扩展一节中方法三源码编译安装。

debian/ubuntu/mac os系统

参考手册附录-安装扩展一节中方法三源码编译安装。


· 安装event或者libevent扩展:

为了能支持更大的并发连接数,必须安装event扩展或者libevent扩展(二者作用相同,二选一即可),并且优化Linux内核。以Event为例,安装方法如下:


centos系统


1、安装event扩展依赖的libevent-devel包,命令行运行

yum install libevent-devel -y

# php7 用下面命令

#yum install libevent2-devel -y


2、安装event扩展,命令行运行

(event扩展要求PHP>=5.4,PHP5.3用户请安装libevent扩展(libevent扩展同时支持php5.4-5.6),见本页面底部)

pecl install event

注意提示:Include libevent OpenSSL support [yes] : 时输入no回车,

注意提示:PHP Namespace for all Event classes :时输入yes,其它直接敲回车就行

如果安装失败请参考页面底部常见问题或者跳过以下步骤尝试安装libevent扩展,见本页面底部。


3、命令行运行(如果ini文件位置不对,可以通过运行php --ini找到实际加载的ini文件路径)

echo extension=event.so > /etc/php.d/30-event.ini


debian/ubuntu系统安装


1、安装event扩展依赖的libevent-dev包,命令行运行

apt-get install libevent-dev -y

# php7 用下面命令

apt-get install libevent2-dev -y


2、安装event扩展,命令行运行

(注意:event扩展要求PHP>=5.4,PHP5.3用户请安装libevent扩展(libevent扩展同时支持php5.4-5.6),见本页面底部)

pecl install event

注意提示:Include libevent OpenSSL support [yes] : 时输入no回车,

注意提示:PHP Namespace for all Event classes :时输入yes,其它直接敲回车就行

如果安装失败请参考页面底部常见问题或者跳过以下步骤尝试安装libevent扩展,见本页面底部。


3、命令行运行(需要切换到root用户。如果ini文件位置不对,可以通过运行php --ini找到实际加载的ini文件路径)

echo extension=event.so > /etc/php5/cli/conf.d/30-event.ini


mac os 系统安装教程


mac 系统一般作为开发机,不必安装event扩展。


4)全新系统安装(全新安装PHP+扩展)


centos系统安装教程

1、命令行运行(此步骤包含了安装php-cli主程序以及pcntl、posix、libevent库及git程序)

yum install php-cli php-process git gcc php-devel php-pear libevent-devel -y


2、安装event扩展,命令行运行

(注意:event扩展要求PHP>=5.4,PHP5.3用户请安装libevent扩展(libevent扩展也支持php5.4-5.6),见本页面底部)

pecl install event

注意提示:Include libevent OpenSSL support [yes] : 时输入no回车,

注意提示:PHP Namespace for all Event classes :时输入yes,其它直接敲回车就行

如果安装失败请参考页面底部常见问题或者跳过以下步骤3,尝试安装libevent扩展,见本页面底部。


3、命令行运行(此步骤是配置event扩展的ini配置,如果ini文件位置不对,可以通过运行php --ini找到实际加载的ini文件路径)

echo extension=event.so > /etc/php.d/30-event.ini


4、命令行运行(此步骤是通过github下载WorkerMan主程序)

git clone https://github.com/walkor/Workerman


5、参考入门指引--简单开发实例部分写入口文件运行。

或者从官网下载打包好的demo运行。


debian/ubuntu系统安装教程

1、命令行运行(此步骤包含了安装php-cli主程序、libevent库及git程序)

apt-get install php5-cli git gcc php-pear php5-dev libevent-dev -y


2、安装event扩展,命令行运行

(注意:event扩展要求PHP>=5.4,PHP5.3用户请安装libevent扩展(libevent扩展也支持php5.4-5.6),见本页面底部)

pecl install event

注意提示:Include libevent OpenSSL support [yes] : 时输入no回车,

注意提示:PHP Namespace for all Event classes :时输入yes,其它直接敲回车就行

如果安装失败请参考页面底部常见问题或者跳过以下步骤3,尝试安装libevent扩展,见本页面底部。


3、命令行运行(需要切换到root用户。此步骤是配置Event扩展的ini配置,如果ini文件位置不对,可以通过运行php --ini找到实际加载的ini文件路径)

echo extension=event.so > /etc/php5/cli/conf.d/30-event.ini


4、命令行运行(此步骤是通过github下载WorkerMan主程序)

git clone https://github.com/walkor/Workerman


5、参考入门指引--简单开发实例部分写入口文件运行。

或者从官网下载打包好的demo运行。


mac os 系统安装教程

方法1: mac系统自带PHP Cli,但是可能缺少pcntl扩展。

1、参考手册附录-安装扩展一节中方法三源码编译安装pcntl扩展。

2、参考手册附录-安装扩展一节中方法四利用phpize安装event扩展(作为开发机此可省略)。

3、通过http://www.workerman.net/download/workermanzip 下载WorkerMan主程序,或者到官网下载例子运行。


方法2: 通过brew命令安装php及对应扩展

1、命令行运行以下命令安装brew工具(如果已经安装过brew可以跳过此步骤)

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

2、命令行运行以下命令安装php7

brew install php70

3、命令行运行以下命令安装event扩展

brew install php70-event

4、到官网下载例子运行


Event扩展说明

Event扩展不是必须的,当业务需要支撑大于1000的并发连接时,推荐安装Event,能够支持巨大的并发连接。如果业务并发连接比较低,例如1000以下并发连接,则可以不用安装。

如果无法安装Event扩展,可以用libevent扩展代替,注意目前libevent扩展不支持php7,php7用户只能使用Event扩展。


安装libevent扩展方法如下:

注意: 1、libevent扩展也同样依赖libevent库,所以首先需要安装libevent-devel包(并非扩展)。 2、libevent扩展支持php5.3-5.6,目前还不支持php7。php7用户请使用event扩展,php7用户请不要装libevent扩展,否则会出现coredump错误。


centos系统

yum install libevent-devel

pecl install channel://pecl.php.net/libevent-0.1.0 //提示libevent installation [autodetect]: 时按回车

echo extension=libevent.so > /etc/php.d/libevent.ini

如果ini文件位置不对,可以通过运行 php --ini 找到实际加载的ini文件路径


debian/ubuntu系统

apt-get install libevent-dev

pecl install channel://pecl.php.net/libevent-0.1.0 //提示libevent installation [autodetect]: 时按回车

echo extension=libevent.so > /etc/php5/cli/conf.d/libevent.ini

如果ini文件位置不对,可以通过运行 php --ini 找到实际加载的ini文件路径


5)常见问题


1、如果出现如下报错 checking for include/event2/event.h... not found,请先尝试删除libevent-dev(el)库安并装libevent2-dev(el)。 centos系统:yum remove libevent-devel && yum install libevent2-devel debian/ubuntu系统:apt-get remove libevent-dev && apt-get install libevent2-dev


2、如果出现如下报错NOTICE: PHP message: PHP Warning: PHP Startup: Unable to load dynamic library '.../event.so' - ..../event.so: undefined symbol: php_sockets_le_socket in Unknown on line 0。 请更改event.so 和socket.so的加载顺序,既在php.ini中将 extension=socket.so 写在 extension=event.so 前面,让socket扩展先加载。


3.启动与停止


注意Workerman启动停止等命令都是在命令行中完成的。

要启动Workerman,首先需要有一个启动入口文件,里面定义了服务监听的端口及协议。可以参考入门指引--简单开发实例部分

这里以workerman-chat为例,它的启动入口为start.php。


启动

以debug(调试)方式启动

php start.php start


以daemon(守护进程)方式启动

php start.php start -d


停止

php start.php stop


重启

php start.php restart


平滑重启

php start.php reload


查看状态

php start.php status


查看连接状态(需要Workerman版本>=3.5.0)

php start.php connections


三、简单的开发实例


实例一、使用HTTP协议对外提供Web服务

创建http_test.php文件(位置任意,能引用到Workerman/Autoloader.php即可,下同)

<?php
use Workerman\Worker;
require_once __DIR__ . '/Workerman/Autoloader.php';
// 创建一个Worker监听2345端口,使用http协议通讯
$http_worker = new Worker("http://0.0.0.0:2345");
// 启动4个进程对外提供服务
$http_worker->count = 4;
// 接收到浏览器发送的数据时回复hello world给浏览器
$http_worker->onMessage = function($connection, $data)
{
    // 向浏览器发送hello world
    $connection->send('hello world');
};
// 运行worker
Worker::runAll();


命令行运行(windows用户用 cmd命令行,下同)

php http_test.php


测试

假设服务端ip为127.0.0.1

在浏览器中访问url http://127.0.0.1:2345


注意: 1、如果出现无法访问的情况,请参照客户端连接失败原因一节排查。 2、服务端是http协议,只能用http协议通讯,用websoket等其它协议无法直接通讯。


实例二、使用WebSocket协议对外提供服务

创建ws_test.php文件

<?php
use Workerman\Worker;
require_once __DIR__ . '/Workerman/Autoloader.php';
// 注意:这里与上个例子不同,使用的是websocket协议
$ws_worker = new Worker("websocket://0.0.0.0:2000");
// 启动4个进程对外提供服务
$ws_worker->count = 4;
// 当收到客户端发来的数据后返回hello $data给客户端
$ws_worker->onMessage = function($connection, $data)
{
    // 向客户端发送hello $data
    $connection->send('hello ' . $data);
};
// 运行worker
Worker::runAll();


命令行运行

php ws_test.php start


测试

打开chrome浏览器,按F12打开调试控制台,在Console一栏输入(或者把下面代码放入到html页面用js运行)

// 假设服务端ip为127.0.0.1
ws = new WebSocket("ws://127.0.0.1:2000");
ws.onopen = function() {
    alert("连接成功");
    ws.send('tom');
    alert("给服务端发送一个字符串:tom");
};
ws.onmessage = function(e) {
    alert("收到服务端的消息:" + e.data);
};

注意: 1、如果出现无法访问的情况,请参照手册常见问题-连接失败一节排查。 2、服务端是websocket协议,只能用websocket协议通讯,用http等其它协议无法直接通讯。


实例三、直接使用TCP传输数据

创建tcp_test.php

<?php
use Workerman\Worker;
require_once __DIR__ . '/Workerman/Autoloader.php';
// 创建一个Worker监听2347端口,不使用任何应用层协议
$tcp_worker = new Worker("tcp://0.0.0.0:2347");
// 启动4个进程对外提供服务
$tcp_worker->count = 4;
// 当客户端发来数据时
$tcp_worker->onMessage = function($connection, $data)
{
    // 向客户端发送hello $data
    $connection->send('hello ' . $data);
};
// 运行worker
Worker::runAll();


命令行运行

php tcp_test.php start


测试:命令行运行 (以下是linux命令行效果,与windows下效果有所不同)

telnet 127.0.0.1 2347
Trying 127.0.0.1...
Connected to 127.0.0.1.
Escape character is '^]'.
tom
hello tom

注意: 1、如果出现无法访问的情况,请参照手册常见问题-连接失败一节排查。 2、服务端是裸tcp协议,用websoket、http等其它协议无法直接通讯。


参考网址:

https://www.workerman.net/workerman 


转载请注明: ITTXX.CN--分享互联网 » Workerman——高性能PHP socket 服务框架入门

最后更新:2018-12-15 01:07:17

赞 (3) or 分享 ()
游客 发表我的评论   换个身份
取消评论

表情
(0)个小伙伴在吐槽