topthink/think-swoole 扩展包的使用 之 Task

本想自己适配的，奈何keng貌似不少，所以果断选择官方提供的包来适配233。。。

默认条件：thinkphp5.1.*版本下，且安装了swoole扩展

主要演示：task 任务的投递

友情提示：在swoole启动框架时，需注意静态变量的使用，会常驻内存（比如单例的变量），... 无图言卵，我么的口号是有图有真相(搞事)

以下是swoole下单例模式发送邮件：

请看收件人， 图一给 994xxx@qq.com发送邮件; 图二给 159xxx@qq.com 发送邮件，其收件人却有两（包含图一中的账号）。

找寻原因： 

由于使用的是单例模式邮件发送，其$phpmail对象只实例化一次 ，图一当添加收件人时 $shouJianRen[ ] = 994xxx@qq.com 结束；图二给 159xxx@qq.com 发送邮件，由于$phpmail对象不会再次实例化 也就是此时他的属性 $shouJianRen 已不再是空值，继而会继续叠加第二个收件人，所以也就造成了第二次给 159xxx@qq.com发送时会有两个收件人。 

 

以下开始正文。。。

一、安装

composer require topthink/think-swoole=2.0.*

二、使用

如果你要运行 swoole 的 http 服务器来启动 thinkPHP框架，执行

php think swoole

默认启动完成后，会在0.0.0.0:9501启动一个HTTP Server，可以直接访问当前的应用。

swoole的参数可以在应用配置目录下的 swoole.php 里面配置，配置详情见 thinkPHP官网

扩展中定义了 onWorkerStart和 onRequest事件回调方法（如果不熟悉请不要随意替换），如果你需要自定义swoole的事件回调方法，可以在配置文件中使用闭包定义。

以下是我的配置（自定义了task任务回调）：

use app\common\lib\utils\Task;
use think\facade\Env;
use think\facade\Log;

// +----------------------------------------------------------------------
// | Swoole设置 php think swoole命令行下有效
// +----------------------------------------------------------------------
return [
    // 扩展自身配置
    'host'                  => '0.0.0.0', // 监听地址
    'port'                  => 9501, // 监听端口
    'mode'                  => '', // 运行模式 默认为SWOOLE_PROCESS
    'sock_type'             => '', // sock type 默认为SWOOLE_SOCK_TCP
    'server_type'           => 'http', // 服务类型 支持 http websocket
    'app_path'              => '', // 应用地址 如果开启了 'daemonize'=>true 必须设置（使用绝对路径）
    'file_monitor'          => false, // 是否开启PHP文件更改监控（调试模式下自动开启）
    'file_monitor_interval' => 2, // 文件变化监控检测时间间隔（秒）
    'file_monitor_path'     => [], // 文件监控目录 默认监控application和config目录

    // 可以支持swoole的所有配置参数
    'pid_file'              => Env::get('runtime_path') . 'swoole.pid',
    'log_file'              => Env::get('runtime_path') . 'swoole.log',
    'document_root'         => Env::get('root_path') . 'public',
    'enable_static_handler' => true,
    'timer'                 => true,//是否开启系统定时器
    'interval'              => 500,//系统定时器 时间间隔
    'task_worker_num'       => 1,//swoole 任务工作进程数量

    /**
     * 自定义投递任务
     * @param swoole_server $serv
     * @param int $taskId
     * @param int $srcWorkerId
     * @param mixed $data
     */
    'Task' => function($serv, $taskId, $srcWorkerId, $data){
        $taskObj = new Task();
        $classMethods = get_class_methods(Task::class);
        if (!in_array($data['method'], $classMethods)) {
            return 'method:'.$data['method'].' not find in'.Task::class;
        }
        return call_user_func_array([$taskObj, $data['method']], $data['params']);
    },
    /**
     * onTask事件中没有调用finish方法或者return结果，worker进程不会触发onFinish
     * @Param swoole_server $serv
     * @param int $taskId 任务的ID
     * @param string $data 任务处理的结果内容
     */
    'Finish' => function ($serv, $taskId, $data) {
//        echo 'taskId:' . $taskId . PHP_EOL;
        echo 'Finished:' . $data;
        Log::record($data);
    }
];

实现任务的投递两种方法实现

Index控制器中：

<?php

namespace app\index\controller;

use app\common\lib\task\SmsTask;
use app\common\lib\utils\Tool;use think\Controller;
use think\Request;

class Index extends Controller
{
    public function sendSms(Request $request)
    {
        $result = $this->validate($request->post(), ['mobile' => 'require|mobile']);
        if (true !== $result) {
            return Tool::json('', $result, 250);
        }
        $mobile = $request->post('mobile');

        // 1、使用topthink/swoole自带的任务投递方式，传递参数必须是对象或者swoole回调函数
//        $smsObj = new SmsTask($mobile);
//        app('swoole')->task($smsObj);
//        app('swoole')->task($smsObj);

        // 2、自定义任务投递方式
        app('swoole')->task(Tool::taskParam('sendSms', (array)$mobile));

        return Tool::json('', '短信发送成功');
    }

SmsTask.php

使用系统默认的回调模板，

且投递的参数必须是对象或者swoole回调函数，

投递任务后默认会执行 run()方法或者swoole回调函数

<?php

namespace app\common\lib\task;

use Fairy\SmsSender;
use think\facade\Config;
use think\swoole\template\Task;

/**
 * 使用 topthink/swoole 自带的Task任务
 * Class SmsTask
 * @package app\common\lib\task
 */
class SmsTask extends Task
{
    private $mobile;

    public function initialize($args)
    {
        // TODO: Implement initialize() method.
        $this->mobile = $args[0];
    }

    public function run($serv, $taskId, $fromWorkerId)
    {
        // TODO: Implement run() method.
        $smsObj = SmsSender::getInstance(Config::get('mail.'));
        $bool = $smsObj->send($this->mobile);
        if ($bool) {
            return 'send sms to ' . $this->mobile . ' success';
        } else {
            return $smsObj->getError();
        }
    }
}

Task.php

配合swoole.php中自定义的 task 回调函数使用

<?php

namespace app\common\lib\utils;

use Fairy\SmsSender;use think\facade\Config;

/**
 * 异步任务类
 * Class Task
 * @package app\common\lib\utils
 */
class Task
{
    /**
     * 异步发送短信
     * @param $mobile
     * @return mixed|string
     * @throws \ErrorException
     */
    public function sendSms($mobile)
    {
        $smsObj = SmsSender::getInstance(Config::get('sms.'));
        $bool = $smsObj->send($mobile);
        if ($bool) {
            return 'send sms to ' . $mobile . ' success';
        } else {
            return 'send sms to ' . $mobile . ' failed: ' . $smsObj->getError();
        }
    }
}

异步发送短信执行流程（拿自定义的task来举例）：

1. 配置swoole.php的自定义task函数
2. 访问控制器 index/index/index 下的 sendSms() 方法 会投递一个任务，传递一些参数给task，此时接口数据已返回且短信发送任务也已投递
3. task回调，也就是执行 swoole.php 中的配置的 task 函数
4. 执行 finish 回调
5. 打完收工，你学会了吗

参考：

https://www.kancloud.cn/manual/thinkphp5_1/675277

https://github.com/top-think/think-swoole/tree/v2.0.17

https://www.imooc.com/article/31751