workerman源码分析之启动过程

原文   http://www.cnblogs.com/CpNice/p/4714182.html

PHP一直以来以草根示人，它简单，易学，被大量应用于web开发，非常可惜的是大部分开发都在简单的增删改查，或者加上pdo，redis等客户端甚至分布式，以及规避语言本身的缺陷。然而这实在太委屈PHP了。记得有一次问walker，PHP能做什么？他说：什么都能做啊！当时我就震惊了，这怎么可能。。。直到后来一直看workerman源码，发现PHP原来有很多不为大家所知的诸多用法，包括多进程（还有线程）、信号处理、namespace等等一大堆特点。而workerman正是这些很少被使用特性（或者说扩展）的集大成者，如果非要说它的缺点，那就是PHP的缺点了，当然PHP的优点它全占了~而且PHP7发布在即，workerman必将得到更多的优化，搭配HHVM更是叼的不行。

workerman

版本：3.1.8（linux）

模型：GatewayWorker（Worker模型可与之类比）

注：只贴出讲解部分代码，出处以文件名形式给出，大家可自行查看

workerman最初只开发了Linux版本，win是后来增加的，基于 命令行模式运行(cli）。

多进程模型

工作进程，Master、Gateway和Worker，Gateway主要用于处理IO事件，保存客户端链接状态，将数据处理请求发送给Worker等工作，Worker则是完全的业务逻辑处理，前者为IO密集型，后者为计算密集型，它们之间通过网络通信，Gateway和Worker两两间注册通信地址，所以非常方便的进行分布式部署，如果业务处理量大可以单纯的增加Worker服务。

它们有一个负责监听的父进程（Master），监听子进程状态，发送 signal 给子进程，接受来自终端的命令、信号等工作。父进程可以说是整个系统启动后的入口。

启动命令解析

既然以命令模式（cli）运行（注意与 fpm 的区别，后者处理来自网页端的请求），就必然有一个启动脚本解析命令，譬如说3.x版本（之前默认为daemon）新增一个 -d 参数，以表示守护进程运行，解析到该参数设置 self::$daemon = true, 随后fork子进程以脱离当前进程组，设置进程组组长等工作。这里有两个非常重要的参数 $argc 和 $argc，前者表示参数个数，后者为一个数组，保存有命令的所有参数，比如：sudo php start.php start -d，$argv就是 array( [0]=>start.php, [1]=>start, [2]=>-d )，而解析主要用到$argv。

启动主要执行下面步骤：

1. 包含 自动加载器 Autoloader ，加载各 Application 下启动文件;
2. 设置 _appInitPath 根目录；
3. 解析，初始化参数，执行相应命令。

下面是具体实现（workerman/worker.php）:

1     public static function parseCommand()
 2     {
 3         // 检查运行命令的参数
 4         global $argv;
 5         $start_file = $argv[0]; 
 6 
 7         // 命令
 8         $command = trim($argv[1]);
 9         
10         // 子命令，目前只支持-d
11         $command2 = isset($argv[2]) ? $argv[2] : '';
12         
13         // 检查主进程是否在运行
14         $master_pid = @file_get_contents(self::$pidFile);
15         $master_is_alive = $master_pid && @posix_kill($master_pid, 0);
16         if($master_is_alive)
17         {
18             if($command === 'start')
19             {
20                 self::log("Workerman[$start_file] is running");
21             }
22         }
23         elseif($command !== 'start' && $command !== 'restart')
24         {
25             self::log("Workerman[$start_file] not run");
26         }
27         
28         // 根据命令做相应处理
29         switch($command)
30         {
31             // 启动 workerman
32             case 'start':
33                 if($command2 === '-d')
34                 {
35                     Worker::$daemonize = true;
36                 }
37                 break;
38             // 显示 workerman 运行状态
39             case 'status':
40                 exit(0);
41             // 重启 workerman
42             case 'restart':
43             // 停止 workeran
44             case 'stop':
45                 // 想主进程发送SIGINT信号，主进程会向所有子进程发送SIGINT信号
46                 $master_pid && posix_kill($master_pid, SIGINT);
47                 // 如果 $timeout 秒后主进程没有退出则展示失败界面
48                 $timeout = 5;
49                 $start_time = time();
50                 while(1)
51                 {
52                     // 检查主进程是否存活
53                     $master_is_alive = $master_pid && posix_kill($master_pid, 0);
54                     if($master_is_alive)
55                     {
56                         // 检查是否超过$timeout时间
57                         if(time() - $start_time >= $timeout)
58                         {
59                             self::log("Workerman[$start_file] stop fail");
60                             exit;
61                         }
62                         usleep(10000);
63                         continue;
64                     }
65                     self::log("Workerman[$start_file] stop success");
66                     // 是restart命令
67                     if($command === 'stop')
68                     {
69                         exit(0);
70                     }
71                     // -d 说明是以守护进程的方式启动
72                     if($command2 === '-d')
73                     {
74                         Worker::$daemonize = true;
75                     }
76                     break;
77                 }
78                 break;
79             // 平滑重启 workerman
80             case 'reload':
81                 exit;
82         }
83     }

walker代码注释已经非常详尽，下面有几点细节处：

• 检查主进程是否存活：17行的逻辑与操作，如果主进程PID存在情况下，向该进程发送信号0，实际上并没有发送任何信息，只是检测该进程（或进程组）是否存活，同时也检测当前用户是否有权限发送系统信号；
• 为什么主进程PID会保存？系统启动后脱离当前terminal运行，如果要执行关闭或者其他命令，此时是以另外的一个进程执行该命令，如果我们连进程PID都不知道，那该向谁发信号呢？！所以主进程PID必须保存起来，而且主进程负责监听其他子进程，所以它是我们继续操作的入口。

Worker::runAll()

php的socket编程其实和C差不多，后者对socket进行了再包裹，并提供接口给php，在php下网络编程步骤大大减少。譬如： stream_socket_server 和 stream_socket_client 直接创建了server/client socke（php有两套socket操作函数）。wm则大量使用了前者，启动过程如下（注释已经非常详尽）：

1     public static function runAll()
 2     {
 3         // 初始化环境变量
 4         self::init();
 5         // 解析命令
 6         self::parseCommand();
 7         // 尝试以守护进程模式运行
 8         self::daemonize();
 9         // 初始化所有worker实例，主要是监听端口
10         self::initWorkers();
11         //  初始化所有信号处理函数
12         self::installSignal();
13         // 保存主进程pid
14         self::saveMasterPid();
15         // 创建子进程（worker进程）并运行
16         self::forkWorkers();
17         // 展示启动界面
18         self::displayUI();
19         // 尝试重定向标准输入输出
20         self::resetStd();
21         // 监控所有子进程（worker进程）
22         self::monitorWorkers();
23     }

下面还是只说该过程的关键点：

1. 初始化环境变量，例如设置主进程名称、日志路径，初始化定时器等等；
2. 解析命令行参数，主要用到 $argc 和 $argc 用法同C语言；
3. 生成守护进程，以脱离当前终端（两年前大部分认为PHP无法做daemon，其实这是个误区！其实PHP在linux的进程模型很稳定，现在wm在商业的应用已经非常成熟，国内某公司每天处理几亿的连接，用于订单、支付调用，大家可以打消顾虑了）；
4. 初始化所有worker实例（注意，这里是在主进程做的，只是生成了一堆 server 并没有设置监听，多进程模型是在子进程做的监听，即IO复用）；
5. 为主进程注册信号处理函数；
6. 保存主进程PID，当系统运行后，我们在终端查看系统状态或者执行关闭、重启命令，是通过主进程进行通信，所以需要知道主进程PID，我们知道在终端下敲入一个可执行命令，实则是在当前终端下新建一个子进程来执行，所以我们需要得知主进程PID，以向WM主进程发送SIGNAL，这时信号处理函数捕获该信号，并通过回调方式执行。
7. 创建子进程，设置当前进程用户(root)。在多进程模型中，两给子进程，分别监听不同的server地址，我们在主进程只是创建server并没有设置监听，也没有生成指定数目的server，原因在于，我们在一个进程多次创建同一个 socket， woker数目其实就是 socket 数量，也就是该 socket 的子进程数目，否则会报错；
8. 在子进程中，将 server socket 注册监听事件，用到一个扩展 Event ，可以实现IO复用，并注册数据读取回调，同时也可注册socket连接事件回调；
9. 输入输出重定向；
10. 主进程监听子进程状态，在一个无限循环中调用 pcntl_signal_dispatch() 函数，用于捕获子进程退出状态，该函数会一直阻塞，直到有子进程退出时才触发；

至此，一个完整的启动过程大致处理完成，然后 server 会一直运行，一直等待 socket 连接事件，等待数据可读可写事件，通过事先注册的处理函数，就能完整的处理整个网络过程。

结束语

其实网络编程过程大致都差不多，这些都有标准答案，每个语言实现的大致过程基本相同，当然类似 golang 的 goroutine 另说。。。需要了解应用层协议(如果可能，需要手动解包和封包)，网络模型，TCP/UDP，进程间通信，IO复用等等，当然最重要的是会 debug。。。自己动手尝试写一个简单的 server 就会遇到很多无法遇见的坑，所以纸上得来终觉浅，绝知此事要躬行。