hyperf/docs/zh-cn/utils.md

48 lines
1.7 KiB
Markdown
Raw Normal View History

2019-06-04 19:29:07 +08:00
# 辅助类
Hyperf 提供了大量便捷的辅助类,这里会列出一些常用的好用的,不会列举所有,可自行查看 [hyperf/utils](https://github.com/hyperf/utils) 组件的代码获得更多信息。
2019-06-04 19:29:07 +08:00
## 协程辅助类
### Hyperf\Utils\Coroutine
2019-06-04 19:30:50 +08:00
该辅助类用于协助进行协程相关的判断或操作。
2019-06-04 19:29:07 +08:00
2019-06-04 19:30:50 +08:00
#### id(): int
2019-06-04 19:29:07 +08:00
通过静态方法 `id()` 获得当前所处的 `协程 ID`,如当前不处于协程环境下,则返回 `-1`
2019-06-04 19:30:50 +08:00
#### create(callable $callable): int
2019-06-04 19:29:07 +08:00
通过静态方法 `create(callable $callable)` 可创建一个协程,还可以通过全局函数 `co(callable $callable)``go(callable $callable)` 达到同样的目的,该方法是对 `Swoole` 创建协程方法的一个封装,区别在于不会抛出未捕获的异常,未捕获的异常会通过 `Hyperf\Contract\StdoutLoggerInterface``warning` 等级输出。
2019-06-04 19:30:50 +08:00
#### inCoroutine(): bool
2019-06-04 19:29:07 +08:00
通过静态方法 `inCoroutine()` 判断当前是否处于协程环境下。
### Hyperf\Context\Context
2019-06-04 19:29:07 +08:00
用于处理协程上下文,本质上是对 `Swoole\Coroutine::getContext()` 方法的一个封装,但区别在于这里兼容了非协程环境下的运行。
2020-04-14 09:41:12 +08:00
### Hyperf\Utils\Coordinator\CoordinatorManager
该辅助类用于指挥协程等待事件发生。
```php
<?php
use Hyperf\Coordinator\CoordinatorManager;
use Hyperf\Coordinator\Constants;
use Hyperf\Coroutine\Coroutine;
2020-04-14 09:41:12 +08:00
2020-04-14 14:12:31 +08:00
Coroutine::create(function() {
// 所有OnWorkerStart事件回调完成后唤醒
CoordinatorManager::until(Constants::WORKER_START)->yield();
2020-04-14 09:41:12 +08:00
echo 'worker started';
// 分配资源
2020-04-14 14:12:31 +08:00
// 所有OnWorkerExit事件回调完成后唤醒
CoordinatorManager::until(Constants::WORKER_EXIT)->yield();
2020-04-14 09:41:12 +08:00
echo 'worker exited';
// 回收资源
});
```