swoole研究之reload（重启）

对reload如何正确重启做一期分析

#swoole重启相关信息整理
###Swoole 如何正确的重启服务
在我们**修改了 PHP** 代码后经常需要重启服务让代码生效，一台繁忙的后端服务器随时都在处理请求，如果管理员通过 **kill** 进程方式来**终止 / 重启**服务器程序，可能导致刚好代码执行到一半终止，没法保证整个业务逻辑的完整性。

**Swoole** 提供了柔性终止 / 重启的机制，管理员只需要向 **Server** 发送特定的信号或者调用 **reload** 方法，工作进程就可以结束，并重新拉起。具体请参考 **reload()**

#####但有几点要注意：

> - 首先要注意新修改的代码必须要在 **OnWorkerStart** 事件中重新载入才会生效，比如某个类在 **OnWorkerStart** 之前就通过 **composer** 的 **autoload** 载入了就是不可以的。

> - 其次 **reload** 还要配合这两个参数 **max_wait_time** 和 **reload_async**，设置了这两个参数之后就能实现异步安全重启。

> - 如果没有此特性，**Worker** 进程收到重启信号或达到 **max_request** 时，会立即停止服务，这时 **Worker** 进程内可能仍然有事件监听，这些异步任务将会被丢弃。设置上述参数后会先创建新的 **Worker**，旧的 **Worker** 在完成所有事件之后自行退出，即 **reload_async**。

> - 如果旧的 **Worker** 一直不退出，底层还增加了一个定时器，在约定的时间 (**max_wait_time** 秒) 内旧的 **Worker** 没有退出，底层会强行终止，并会产生一个 **WARNING** 报错。

------------

####Reload 有效范围

**Reload** 操作只能重新载入 **Worker** 进程启动后加载的 **PHP** 文件，使用 **get_included_files** 函数来列出哪些文件是在 **WorkerStart** 之前就加载的 **PHP** 文件，在此列表中的 **PHP** 文件，即使进行了 **reload** 操作也无法重新载入。要关闭服务器重新启动才能生效。

```
$serv->on('WorkerStart', function(Swoole\Server $server, int $workerId) {
    var_dump(get_included_files()); //此数组中的文件表示进程启动前就加载了，所以无法reload
});
```

#####APC/OpCache

如果 **PHP** 开启了 **APC/OpCache**，**reload** 重载入时会受到影响，有 2 种解决方案

打开 **APC/OpCache** 的 **stat** 检测，如果发现文件更新 **APC/OpCache** 会自动更新 **OpCode**
在 **onWorkerStart** 中加载文件（**require**、**include** 等函数）之前执行 **apc_clear_cache** 或 **opcache_reset** 刷新 **OpCode** 缓存

#####注意：

> - 平滑重启只对 **onWorkerStart** 或 **onReceive** 等在 **Worker** 进程中 **include/require** 的 PHP 文件有效
-**Server** 启动前就已经 **include/require** 的 PHP 文件，**不能通过**平滑重启重新加载
- 对于 **Server** 的配置即 **$serv->set()** 中传入的参数设置，**必须**关闭 / 重启整个 **Server** 才可以重新加载
-**Server** 可以监听一个内网端口，然后可以接收远程的控制命令，去重启所有 **Worker** 进程

------------
####reload_async
> 设置异步重启开关。【默认值：**true**】

设置异步重启开关。设置为 **true** 时，将启用异步安全重启特性，**Worker** 进程会等待异步事件完成后再退出。详细信息请参见 如何正确的重启服务

**reload_async** 开启的主要目的是为了保证 服务重载时，协程 或 异步 任务能正常结束。
```
$server->set([
  'reload_async' => true
]);
```
######协程模式

> 在 **4.x ** 版本中开启 **enable_coroutine** 时，底层会额外增加一个协程数量的检测，当前无任何协程时进程才会退出，开启时即使 **reload_async => false** 也会强制打开 **reload_async**。

------------

####max_wait_time
> 设置 **Worker** 进程收到停止服务通知后最大等待时间【**默认值：3**】设置 Worker 进程收到停止服务通知后最大等待时间【默认值：3】

经常会碰到由于 **worker** 阻塞卡顿导致 **worker** 无法正常 **reload**, 无法满足一些生产场景，例如发布代码热更新需要 **reload** 进程。所以，我们加入了进程重启超时时间的选项。详细信息请参见 **如何正确的重启服务**

######提示

> 管理进程收到重启、关闭信号后或者达到 **max_request** 时，管理进程会重起该 worker 进程。分以下几个步骤：

> - 底层会增加一个 (**max_wait_time**) 秒的定时器，触发定时器后，检查进程是否依然存在，如果是，会强制杀掉，重新拉一个进程。
需要在 **onWorkerStop** 回调里面做收尾工作，需要在 **max_wait_time** 秒内做完收尾。
依次向目标进程发送 **SIGTERM** 信号，杀掉进程。

######注意

> v4.4.x 以前默认为 **30** 秒

------------

####max_request
> 设置 **worker** 进程的最大任务数。【默认值：**0** 即不会退出进程】

> 一个 **worker** 进程在处理完超过此数值的任务后将自动退出，进程退出后会释放所有内存和资源

这个参数的主要作用是解决由于程序编码不规范导致的 **PHP** 进程内存泄露问题。**PHP** 应用程序有缓慢的内存泄漏，但无法定位到具体原因、无法解决，可以通过设置 **max_request** 临时解决，需要找到内存泄漏的代码并修复，而不是通过此方案，可以使用 **Swoole Tracker** 发现泄漏的代码。

######提示

> 达到 **max_request** 不一定马上关闭进程，参考 **max_wait_time**。
**SWOOLE_BASE** 下，达到 **max_request** 重启进程会导致客户端连接断开。
当 **worker** 进程内发生致命错误或者人工执行 **exit** 时，进程会自动退出。**master** 进程会重新启动一个新的 **worker** 进程来继续处理请求当 **worker** 进程内发生致命错误或者人工执行 **exit** 时，进程会自动退出。**master** 进程会重新启动一个新的 **worker** 进程来继续处理请求

------------

####类 / 函数重复定义
新手非常容易犯这个错误，由于 **Swoole** 是常驻内存的，所以加载类 / 函数定义的文件后不会释放。因此引入类 / 函数的 php 文件时必须要使用 **include_once** 或 **require_once**，否则会发生 **cannot redeclare function/class** 的致命错误。

------------

<h1 id="h1-swoole-"><a name="swoole重启相关信息整理" class="reference-link"></a>swoole重启相关信息整理</h1><h3 id="h3-swoole-"><a name="Swoole 如何正确的重启服务" class="reference-link"></a>Swoole 如何正确的重启服务</h3>在我们修改了 PHP 代码后经常需要重启服务让代码生效，一台繁忙的后端服务器随时都在处理请求，如果管理员通过 kill 进程方式来终止 / 重启服务器程序，可能导致刚好代码执行到一半终止，没法保证整个业务逻辑的完整性。
Swoole 提供了柔性终止 / 重启的机制，管理员只需要向 Server 发送特定的信号或者调用 reload 方法，工作进程就可以结束，并重新拉起。具体请参考 reload()
<h5 id="h5--"><a name="但有几点要注意：" class="reference-link"></a>但有几点要注意：</h5><blockquote>
<ul>
<li>首先要注意新修改的代码必须要在 OnWorkerStart 事件中重新载入才会生效，比如某个类在 OnWorkerStart 之前就通过 composer 的 autoload 载入了就是不可以的。
</li><li>其次 reload 还要配合这两个参数 max_wait_time 和 reload_async，设置了这两个参数之后就能实现异步安全重启。
</li><li>如果没有此特性，Worker 进程收到重启信号或达到 max_request 时，会立即停止服务，这时 Worker 进程内可能仍然有事件监听，这些异步任务将会被丢弃。设置上述参数后会先创建新的 Worker，旧的 Worker 在完成所有事件之后自行退出，即 reload_async。
</li><li>如果旧的 Worker 一直不退出，底层还增加了一个定时器，在约定的时间 (max_wait_time 秒) 内旧的 Worker 没有退出，底层会强行终止，并会产生一个 WARNING 报错。
</li></ul>
</blockquote>
<hr>
<h4 id="h4-reload-"><a name="Reload 有效范围" class="reference-link"></a>Reload 有效范围</h4>Reload 操作只能重新载入 Worker 进程启动后加载的 PHP 文件，使用 get_included_files 函数来列出哪些文件是在 WorkerStart 之前就加载的 PHP 文件，在此列表中的 PHP 文件，即使进行了 reload 操作也无法重新载入。要关闭服务器重新启动才能生效。
<pre><code>$serv-&gt;on('WorkerStart', function(Swoole\Server $server, int $workerId) {
 var_dump(get_included_files()); //此数组中的文件表示进程启动前就加载了，所以无法reload
});
</code></pre><h5 id="h5-apc-opcache"><a name="APC/OpCache" class="reference-link"></a>APC/OpCache</h5>如果 PHP 开启了 APC/OpCache，reload 重载入时会受到影响，有 2 种解决方案
打开 APC/OpCache 的 stat 检测，如果发现文件更新 APC/OpCache 会自动更新 OpCode 在 onWorkerStart 中加载文件（require、include 等函数）之前执行 apc_clear_cache 或 opcache_reset 刷新 OpCode 缓存
<h5 id="h5--"><a name="注意：" class="reference-link"></a>注意：</h5><blockquote>
<ul>
<li>平滑重启只对 onWorkerStart 或 onReceive 等在 Worker 进程中 include/require 的 PHP 文件有效 -Server 启动前就已经 include/require 的 PHP 文件，不能通过平滑重启重新加载</li><li>对于 Server 的配置即 $serv-&gt;set() 中传入的参数设置，必须关闭 / 重启整个 Server 才可以重新加载 -Server 可以监听一个内网端口，然后可以接收远程的控制命令，去重启所有 Worker 进程</li></ul>
</blockquote>
<hr>
<h4 id="h4-reload_async"><a name="reload_async" class="reference-link"></a>reload_async</h4><blockquote>
设置异步重启开关。【默认值：true】
</blockquote>
设置异步重启开关。设置为 true 时，将启用异步安全重启特性，Worker 进程会等待异步事件完成后再退出。详细信息请参见 如何正确的重启服务
reload_async 开启的主要目的是为了保证 服务重载时，协程 或 异步 任务能正常结束。
<pre><code>$server-&gt;set([
 'reload_async' =&gt; true
]);
</code></pre><h6 id="h6-u534Fu7A0Bu6A21u5F0F"><a name="协程模式" class="reference-link"></a>协程模式</h6><blockquote>
在 4.x 版本中开启 enable_coroutine 时，底层会额外增加一个协程数量的检测，当前无任何协程时进程才会退出，开启时即使 reload_async =&gt; false 也会强制打开 reload_async。
</blockquote>
<hr>
<h4 id="h4-max_wait_time"><a name="max_wait_time" class="reference-link"></a>max_wait_time</h4><blockquote>
设置 Worker 进程收到停止服务通知后最大等待时间【默认值：3】设置 Worker 进程收到停止服务通知后最大等待时间【默认值：3】
</blockquote>
经常会碰到由于 worker 阻塞卡顿导致 worker 无法正常 reload, 无法满足一些生产场景，例如发布代码热更新需要 reload 进程。所以，我们加入了进程重启超时时间的选项。详细信息请参见 如何正确的重启服务
<h6 id="h6-u63D0u793A"><a name="提示" class="reference-link"></a>提示</h6><blockquote>
管理进程收到重启、关闭信号后或者达到 max_request 时，管理进程会重起该 worker 进程。分以下几个步骤：
<ul>
<li>底层会增加一个 (max_wait_time) 秒的定时器，触发定时器后，检查进程是否依然存在，如果是，会强制杀掉，重新拉一个进程。 需要在 onWorkerStop 回调里面做收尾工作，需要在 max_wait_time 秒内做完收尾。 依次向目标进程发送 SIGTERM 信号，杀掉进程。</li></ul>
</blockquote>
<h6 id="h6-u6CE8u610F"><a name="注意" class="reference-link"></a>注意</h6><blockquote>
v4.4.x 以前默认为 30 秒
</blockquote>
<hr>
<h4 id="h4-max_request"><a name="max_request" class="reference-link"></a>max_request</h4><blockquote>
设置 worker 进程的最大任务数。【默认值：0 即不会退出进程】
一个 worker 进程在处理完超过此数值的任务后将自动退出，进程退出后会释放所有内存和资源
</blockquote>
这个参数的主要作用是解决由于程序编码不规范导致的 PHP 进程内存泄露问题。PHP 应用程序有缓慢的内存泄漏，但无法定位到具体原因、无法解决，可以通过设置 max_request 临时解决，需要找到内存泄漏的代码并修复，而不是通过此方案，可以使用 Swoole Tracker 发现泄漏的代码。
<h6 id="h6-u63D0u793A"><a name="提示" class="reference-link"></a>提示</h6><blockquote>
达到 max_request 不一定马上关闭进程，参考 max_wait_time。 SWOOLE_BASE 下，达到 max_request 重启进程会导致客户端连接断开。 当 worker 进程内发生致命错误或者人工执行 exit 时，进程会自动退出。master 进程会重新启动一个新的 worker 进程来继续处理请求当 worker 进程内发生致命错误或者人工执行 exit 时，进程会自动退出。master 进程会重新启动一个新的 worker 进程来继续处理请求
</blockquote>
<hr>
<h4 id="h4--"><a name="类 / 函数重复定义" class="reference-link"></a>类 / 函数重复定义</h4>新手非常容易犯这个错误，由于 Swoole 是常驻内存的，所以加载类 / 函数定义的文件后不会释放。因此引入类 / 函数的 php 文件时必须要使用 include_once 或 require_once，否则会发生 cannot redeclare function/class 的致命错误。
<hr>

swoole研究之reload（重启）

热门文章

置顶推荐

最近访客