├── .gitignore ├── composer.json ├── tests └── demo.php ├── README.md ├── src └── Thread.php └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /vendor/ 2 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "fingerqin/phpthread", 3 | "type": "library", 4 | "license": "MIT", 5 | "authors": [ 6 | { 7 | "name": "fingerQin", 8 | "email": "753814253@qq.com" 9 | } 10 | ], 11 | "minimum-stability": "dev", 12 | "require": { 13 | "php": ">=5.6.0" 14 | }, 15 | "autoload": { 16 | "psr-4": { 17 | "PHPProcess\\": "src/" 18 | } 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /tests/demo.php: -------------------------------------------------------------------------------- 1 | isExit($startTimeTsp); // 循环操作时调用。主要为了避免平滑重启时子进程运行异常导致业务中断。 28 | } 29 | } 30 | } 31 | 32 | // 执行多线程业务处理. 33 | $objThread = Start::getInstance(2); // 2 个子进程。 34 | $objThread->setChildOverNewCreate(true); 35 | // 子进程运行 60 秒自动退出重启新的子进程。一般建议每天重启一次。 36 | $objThread->setRunDurationExit(60); 37 | $objThread->start(); -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # 说明 2 | PHP 以 pcntl 与 posix 两个扩展实现的 PHP 多进程工具。简单实用，方便一些轻量级的后台任务实现并发处理。而 pcntl 与 posix 只有 *unix 环境支持。也就是说 windows 系统不支持。 3 | 4 | # 使用 5 | 1. 使用 composer 安装即可。 6 | ``` 7 | $ composer require fingerqin/phpthread 1.0 8 | ``` 9 | 10 | 2. 示例 11 | `start.php` 12 | 13 | ``` 14 | isExit($startTimeTsp); // 循环操作时调用。主要为了避免平滑重启时子进程运行异常导致业务中断。 35 | } 36 | } 37 | } 38 | 39 | // 执行多线程业务处理. 40 | $objThread = Start::getInstance(2); // 2 个子进程。 41 | $objThread->setChildOverNewCreate(true); 42 | // 子进程运行 60 秒自动退出重启新的子进程。一般建议每天重启一次。 43 | $objThread->setRunDurationExit(60); 44 | $objThread->start(); 45 | ``` 46 | 47 | ## 启动 ## 48 | ``` 49 | php start.php 50 | ``` 51 | 52 | 后台启动 53 | ``` 54 | nohup php start.php & 55 | ``` 56 | 57 | 默认日志是写入用户目录的 nohup.log 58 | 59 | 也可以使用 `Supervisor` 进程管理工具实现进程的监控与重启。 60 | 61 | 62 | ## 结合其他框架使用 ## 63 | 在具体的框架业务类中继承 Thread 类，实现其 run() 方法。然后运行就可以了。 64 | 65 | ## 注意 ## 66 | 1) 请确定安装了 pcntl 和 posix 扩展。 67 | 2) 请确保是在 Cli 模式运行。 68 | 69 | ## 平滑重启 ## 70 | ``` 71 | // 只需要 kill 掉主进程的 PID 即可实现子进程平常重启。 72 | $kill -9 PID 73 | ``` 74 | -------------------------------------------------------------------------------- /src/Thread.php: -------------------------------------------------------------------------------- 1 | 0) { 48 | self::$instance->threadNum = $threadNum; 49 | } 50 | return self::$instance; 51 | } 52 | 53 | /** 54 | * 启动脚本. 55 | */ 56 | final public function start() 57 | { 58 | if (function_exists('pcntl_fork')) { 59 | $this->masterPid = posix_getpid(); 60 | $this->registerSignal(); 61 | 62 | while(true) { 63 | $this->childCount++; 64 | // 如果当前子进程数量小于等于允许的进程数量或允许子进程结束新开子进程的情况则执行。 65 | if (($this->childCount <= $this->threadNum) || $this->isNewCreate) { 66 | $pid = pcntl_fork(); 67 | if ($pid == -1) { 68 | exit('could not fork'); 69 | } else if ($pid > 0) { 70 | $this->pushChildProcessId($pid); 71 | // 直到当前进程数量达到指定的数量就阻塞主进程。直到有子进程退出。 72 | if ($this->childCount >= $this->threadNum) { 73 | // 如果已经达到指定的进程数量,则挂起当前主进程。直到有子进程退出才执行此 74 | pcntl_wait($status); 75 | // 如果不需要生成新的子进程，则等待最后一个进程执行完毕就退出。 76 | if (!$this->isNewCreate && $this->childCount == $this->threadNum) { 77 | exit(0); 78 | } 79 | } 80 | } else { 81 | $childProcessNum = $this->childCount % $this->threadNum; 82 | $startTimeTsp = time(); 83 | $this->run($this->threadNum, $childProcessNum, $startTimeTsp); 84 | exit(0); 85 | } 86 | } 87 | } 88 | exit(0); 89 | } 90 | } 91 | 92 | /** 93 | * 设置子进程运行多久自动退出。 94 | * 95 | * @param int $runDurationExit 运行时长。单位（分）。0 代表子进程无时间限制。 96 | * 97 | * @return void 98 | */ 99 | final public function setRunDurationExit($runDurationExit) 100 | { 101 | $this->runDurationExit = $runDurationExit; 102 | } 103 | 104 | /** 105 | * 检测主进程是否存活。 106 | * 107 | * @return bool 108 | */ 109 | final public function detectMasterProcessAlive() 110 | { 111 | if (posix_kill($this->masterPid, 0)) { 112 | return true; 113 | } else { 114 | return false; 115 | } 116 | } 117 | 118 | /** 119 | * 子进程检测是否需要退出。 120 | * 121 | * -- 根据父进程状态决定是否退出。 122 | * -- 如果子进程退出不再生成新的子进程。则子进程不限定运行时间。 123 | * 124 | * @param int $startTimeTsp 子进程启动时间戳。 125 | * 126 | * @return boolean 127 | */ 128 | final protected function isExit($startTimeTsp) 129 | { 130 | // [1] 运行超过指定时长则退出。 131 | if ($this->isNewCreate && $this->runDurationExit > 0) { 132 | $diffTime = time() - $startTimeTsp; 133 | if ($diffTime >= $this->runDurationExit * 60) { 134 | exit(0); 135 | } 136 | } 137 | // [2] 主进程退出则退出。 138 | $status = $this->detectMasterProcessAlive(); 139 | if (!$status) { 140 | exit(0); 141 | } 142 | } 143 | 144 | /** 145 | * 保存当前进程 ID 信息。 146 | * 147 | * @param int $pid 子进程 ID。 148 | * @return void 149 | */ 150 | final protected function pushChildProcessId($pid) 151 | { 152 | $num = $this->detectChildProcessAlive(); 153 | if ($num > 0) { 154 | // 说明此子进程是后续有子进程退出之后替换之前进程用。 155 | self::$childProcess[$num] = $pid; 156 | } else { 157 | // 说明此子进程还是初始化的子进程。 158 | self::$childProcess[] = $pid; 159 | } 160 | } 161 | 162 | /** 163 | * 检测当前保存的子进程存活情况。 164 | * 165 | * -- 当存在死亡进程，则返回已死亡进程的子进程 ID 编号。 166 | * 167 | * @return int 168 | */ 169 | final protected function detectChildProcessAlive() 170 | { 171 | foreach (self::$childProcess as $num => $pid) { 172 | // 使用 posix_kill 需要当前进程所有者与被检测 $pid 所有者是同一个或者当前进程所有者拥有足够的权限。 173 | if (!posix_kill($pid, 0)) { 174 | return $num; 175 | } else { 176 | return 0; 177 | } 178 | } 179 | } 180 | 181 | /** 182 | * 设置子进程结束之后是否创建新的子进程。 183 | * 184 | * @param bool $isNewCreate true or false 185 | * @return void 186 | */ 187 | final public function setChildOverNewCreate($isNewCreate) 188 | { 189 | $this->isNewCreate = $isNewCreate; 190 | } 191 | 192 | /** 193 | * 获取进程数。 194 | */ 195 | final public function getThreadNum() 196 | { 197 | return $this->threadNum; 198 | } 199 | 200 | /** 201 | * 父进程注册信号。 202 | * 203 | * @return void 204 | */ 205 | final public function registerSignal() 206 | { 207 | pcntl_signal(SIGTERM, [$this, 'signalHandler']); 208 | pcntl_signal(SIGHUP, [$this, 'signalHandler']); 209 | pcntl_signal(SIGUSR1, [$this, 'signalHandler']); 210 | pcntl_signal(SIGCHLD, [$this, 'signalHandler']); 211 | } 212 | 213 | /** 214 | * 信号处理器。 215 | * 216 | * @param int $signo 信号量。 217 | * 218 | * @return void 219 | */ 220 | final public function signalHandler($signo) 221 | { 222 | switch ($signo) { 223 | case SIGTERM: // 进程退出。 224 | case SIGHUP: // 重启进程。 225 | case SIGUSR1: 226 | case SIGCHLD: 227 | default: 228 | break; 229 | } 230 | } 231 | 232 | /** 233 | * 设置进程数。 234 | * 235 | * @param int $num 进程数量。 236 | * @return void 237 | */ 238 | final public function setThreadNum($num) 239 | { 240 | $this->threadNum = $num; 241 | } 242 | 243 | /** 244 | * 抽象的业务方法。 245 | * 246 | * @param int $threadNum 进程数量。 247 | * @param int $num 子进程编号。 248 | * @param int $startTimeTsp 子进程启动时间戳。 249 | * 250 | * @return void 251 | */ 252 | abstract public function run($threadNum, $num, $startTimeTsp); 253 | } 254 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------