hyperf| hyperf/guzzle 下载文件问题详解

date: 2019-10-22 02:54:58
title: hyperf| hyperf/guzzle 下载文件问题详解

使用 hyperf/guzzle 遇到下载文件的问题, 过程虽波折, 却颇有意思, 分享给大家.

业务上有一个下载文件的任务, 太简单啦

业务上要下载一个 oss 文件, 假设地址为 oss_url. 先撸一遍 guzzle 的文档

下载需要在 request option 中设置 sink 参数: http://docs.guzzlephp.org/en/stable/request-options.html#sink

$oss_url = 'oss_url';
$file_path = 'xxx';
$client = new \GuzzleHttp\Client([
    'verify' => false,
    'decode_content' => false,
]);
$client->get($oss_url, [
    'sink' => $file_path,
]);

换成 hyperf/guzzle 来写:

// 使用 clientFactory 获取到协程版 client 即可
$container = ApplicationContext::getContainer();
$clientFactory = $container->get(ClientFactory::class);
$client = $clientFactory->create([
    'verify' => false,
    'decode_content' => false,
]);

开心的执行, 剧情按照预期的方向发展~

并没有!!! 下载没反应!!!

下载地址的问题?

使用 curl/wget 等命令行工具验证

wget oss_url
curl -O oss_url

下载地址没问题

文件有 300M, 会不会是超时了?

$client = $clientFactory->create([
    'timeout' => 600, // 超时设置为 10 分钟
    'verify' => false,
    'decode_content' => false,
]);

噗, 还是一样没效果?

翻 hyperf 文档

hyperf/guzzle: https://doc.hyperf.io/#/zh/guzzle

哦, 原来使用 swoole 配置要这样:

<?php
use GuzzleHttp\Client;
use Hyperf\Guzzle\CoroutineHandler;
use GuzzleHttp\HandlerStack;

$client = new Client([
    'base_uri' => 'http://127.0.0.1:8080',
    'handler' => HandlerStack::create(new CoroutineHandler()),
    'timeout' => 5,
    'swoole' => [ // 看这里看这里
        'timeout' => 10,
        'socket_buffer_size' => 1024 * 1024 * 2,
    ],
]);

$response = $client->get('/');

这次应该行了吧 !?

噗, 还是一样没效果.

直接用 guzzle 行不行

$oss_url = 'oss_url';
$file_path = 'xxx';
$client = new \GuzzleHttp\Client([
    'verify' => false,
    'decode_content' => false,
]);
$client->get($oss_url, [
    'sink' => $file_path,
]);

终于看了需要下载的问题. 是时候刷锅一波给 hyperf, 什么渣渣框架, 文件下载居然都不支持.

我们看看锅到底在哪

老规矩, 看源码, 既然是使用 \Hyperf\Guzzle\ClientFactory->create() 新建的, 看看源码涨啥样:

public function create(array $options = []): Client
{
    $stack = null;
    if (Coroutine::getCid() > 0) {
        $stack = HandlerStack::create(new CoroutineHandler());
    }

    $config = array_replace(['handler' => $stack], $options);

    if (method_exists($this->container, 'make')) {
        // Create by DI for AOP.
        return $this->container->make(Client::class, ['config' => $config]);
    }
    return new Client($config);
}

协程环境下使用的 new CoroutineHandler, 来看看庐山真面目(文件有点长, 不要轻言放弃):

// \Hyperf\Guzzle\CoroutineHandler
// 关键在这句, 这里其实是 \Swoole\Coroutine\Http\Client
$client = new Client($host, $port, $ssl);

原来这里用的 \Swoole\Coroutine\Http\Client. 这时候我灵机一动, 会不会是?

来看 swoole 的文档

下载方法在这里: https://wiki.swoole.com/wiki/page/938.html

$host = 'www.swoole.com';
$cli = new \Swoole\Coroutine\Http\Client($host, 443, true);
$cli->set(['timeout' => -1]);
$cli->setHeaders([
    'Host' => $host,
    "User-Agent" => 'Chrome/49.0.2587.3',
    'Accept' => '*',
    'Accept-Encoding' => 'gzip'
]);
$cli->download('/static/files/swoole-logo.svg', __DIR__ . '/logo.svg');

这 api 和 guzzle 完全不一样呀 !!! 坑爹呢这是, 用 swoole + hyperf, 连个文件下载都搞不定 ?!

swoole + hyperf 表示我这么强大, 你居然不会用 !

在 swoole v4.4.6 的版本更新中, 就增加了对 curl hook 的支持, 添加 SWOOLE_HOOK_FLAGS 即可, hyperf v1.1.0 版本中已经提供了支持:

// bin/hyperf.php:11
! defined('SWOOLE_HOOK_FLAGS') && define('SWOOLE_HOOK_FLAGS', SWOOLE_HOOK_ALL);

开启后, swoole 就会无缝将 curl hook 为协程版.

无形加速, 最为致命 !

可是 hyperf/guzzle 默认还是使用的 \Swoole\Coroutine\Http\Client 怎么办? 这就太简单了:

如果你喜欢静态类风格:

<?php

namespace App\Util;

use GuzzleHttp\Client;

class Guzzle
{
    /**
     * @param array $config
     * @return Client
     */
    public static function create(array $config)
    {
        return make(Client::class, ['config' => $config]);
    }
}

如果你喜欢 ClientFactory 风格

<?php

namespace App\Util;

use GuzzleHttp\Client;

class ClientFactory
{
    /**
     * @param array $config
     * @return Client
     */
    public function create(array $config)
    {
        return make(Client::class, ['config' => $config]);
    }
}

写在最后

没事不要乱甩锅, 多问问问题, 多找找原因, 收获就在这不经意间