推薦一個 PHP 網路請求外掛 Guzzle

在寫後臺程式碼時，避免不了需要與其他第三方介面互動，如向服務號下發模板訊息，有時可能需要下發超過 10 萬條。這時不得不考慮使用非同步和「多執行緒」的網路請求。

今天向 PHP 工程師們推薦一個 Guzzle 外掛。

Guzzle

Guzzle 是一個 PHP 的 HTTP 客戶端，用來輕而易舉地傳送請求，並整合到我們的 WEB 服務上。

介面簡單：構建查詢語句、POST 請求、分流上傳下載大檔案、使用 HTTP cookies、上傳 JSON 資料等等。

傳送同步或非同步的請求均使用相同的介面。

使用 PSR-7 介面來請求、響應、分流，允許你使用其他相容的 PSR-7 類庫與 Guzzle 共同開發。

抽象了底層的 HTTP 傳輸，允許你改變環境以及其他的程式碼，如：對 cURL與 PHP 的流或 socket 並非重度依賴，非阻塞事件迴圈。

中介軟體系統允許你建立構成客戶端行為。

摘自 Guzzle 官網介紹：
guzzle-cn.readthedocs.io/zh_CN/lates…

安裝 Guzzle

本文結合 Laravel 專案介紹 Guzzle 基本使用，所以使用 composer 來安裝 Guzzle 再適合不過了，而且 Guzzle 官網也推薦使用 composer 來安裝。

composer require guzzlehttp/guzzle:~6.0

// 或者

php composer.phar require guzzlehttp/guzzle:~6.0複製程式碼

如何安裝 Composer，可以看看我之前的文章
d.laravel-china.org/docs/5.5/in…

傳送簡單的 POST 請求

訪問第三方介面，基本上都是 POST 請求為主。如你想做一個簡單的智慧聊天工具，這時候可以藉助圖靈機器人 API，傳送一個 POST 請求獲取自動回答內容，直接上程式碼：

<?php

namespace App\Http\Controllers;

use GuzzleHttp\Client;
use Illuminate\Http\Request;

class GuzzleUseController extends Controller {

    public function tuling(Request $request) {
        $params = [
            'key' => '*****',
            'userid' => 'yemeishu'
        ];

        $params['info'] = $request->input('info', '你好嗎');

        $client = new Client();
        $options = json_encode($params, JSON_UNESCAPED_UNICODE);
        $data = [
            'body' => $options,
            'headers' => ['content-type' => 'application/json']
        ];

        // 傳送 post 請求
        $response = $client->post('http://www.tuling123.com/openapi/api', $data);

        $callback = json_decode($response->getBody()->getContents());

        return $this->output_json('200', '測試圖靈機器人返回結果', $callback);
    }
}複製程式碼

Guzzle client->post 函式還是很簡單的，只需要訪問的介面，和請求的引數，引數中主要包含：body、headers、query等，具體可參考

guzzle-cn.readthedocs.io/zh_CN/lates…

測試下：

注：圖靈機器人還是很智慧的，根據相同的 userid 能夠識別上下文，做到智慧聊天的。

傳送非同步的 POST 請求

在 PHP 開發中主要是「程式導向」式的開發方式，但請求第三方介面時，有時候並不需要等待第三方介面返回結果才繼續執行。如使用者購買成功時，我們需要向簡訊介面，傳送一個 post 請求，由簡訊平臺傳送一條簡訊給使用者，告知使用者支付成功了，因為這類「提醒訊息」屬於「額外的附加功能」，並不需要在使用者支付時「知道」有沒有傳送提醒成功。

這時候可以使用 Guzzle 的非同步請求功能，直接看程式碼：

public function sms(Request $request) {
        $code = $request->input('code');
        $client = new Client();
        $sid = '9815b4a2bb6d5******8bdb1828644f2';
        $time = '20171029173312';
        $token = 'af8728c8bc*******12019c680df4b11c';

        $sig =  strtoupper(md5($sid.$token.$time));

        $auth = trim(base64_encode($sid . ":" . $time));

        $params = ['templateSMS' => [
                'appId' => '12b43**********0091c73c0ab',
                'param' => "coding01,$code,30",
                'templateId' => '3***3',
                'to' => '17689974321'
            ]
        ];
        $options = json_encode($params, JSON_UNESCAPED_UNICODE);
        $data = [
            'query' => [
                'sig' => $sig
            ],
            'body' => $options,
            'headers' => [
                'content-type' => 'application/json',
                'Authorization' => $auth
            ]
        ];

        // 傳送 post 請求
        $promise = $client->requestAsync('POST', 'https://api.ucpaas.com/2014-06-30/Accounts/9815b4a2bb6d5******8bdb1828644f2/Messages/templateSMS', $data);

        $promise->then(
            function (ResponseInterface $res) {
                Log::info('---');
                Log::info($res->getStatusCode() . "\n");
                Log::info($res->getBody()->getContents() . "\n");
            },
            function (RequestException $e) {
                Log::info('-__-');
                Log::info($e->getMessage() . "\n");
            }
        );
        $promise->wait();

        return $this->output_json('200', '測試簡訊 api', []);
    }複製程式碼

先返回介面資料：

然後再輸出 Log：

[2017-10-29 09:53:14] local.INFO: ---  
[2017-10-29 09:53:14] local.INFO: 200

[2017-10-29 09:53:14] local.INFO: {"resp":{"respCode":"000000","templateSMS":{"createDate":"20171029175314","smsId":"24a93f323c9*****8608568"}}}複製程式碼

最後收到簡訊資訊：

傳送多執行緒非同步 POST 請求

「傳送多執行緒非同步 POST 請求」在很多場合中使用到的，如：雙十一快到了，可以做一些回饋老使用者的活動，這是就需要批量的向老使用者推送一條模板訊息，告訴使用者參與哪些活動的。這時候就需要用到多執行緒非同步請求微信公眾號介面。

直接上程式碼：

public function send($templateid, $openid, $url, $data) {
        $client = $this->bnotice->getHttp()->getClient();

        $requests = function ($open_ids) use ($templateid, $url, $data) {
            foreach($open_ids as $v){
                try {
                    yield $this->bnotice
                        ->template($templateid)
                        ->to($v)
                        ->url($url)
                        ->data($data)
                        ->request();
                } catch(Exception $e) {
                    Log::error('sendtemplate:'.$e->getMessage());
                }
            }
        };

        $pool = new Pool($client, $requests($openid), [
            'concurrency' => 16,
            'fulfilled' => function ($response, $index) {
            },
            'rejected' => function ($reason, $index) {
            },
        ]);

        $promise = $pool->promise();

        $promise->wait();
    }複製程式碼

其中 request 方法：

public function request($data = [])
    {
        $params = array_merge([
            'touser' => '',
            'template_id' => '',
            'url' => '',
            'topcolor' => '',
            'miniprogram' => [],
            'data' => [],
        ], $data);

        $required = ['touser', 'template_id'];

        foreach ($params as $key => $value) {
            if (in_array($key, $required, true) && empty($value) && empty($this->message[$key])) {
                throw new InvalidArgumentException("Attribute '$key' can not be empty!");
            }

            $params[$key] = empty($value) ? $this->message[$key] : $value;
        }

        $params['data'] = $this->formatData($params['data']);

        $this->message = $this->messageBackup;

        $options = json_encode ( $params,  JSON_UNESCAPED_UNICODE);
        $data = [
            'query' => [
                'access_token' => $this->getAccessToken()->getToken()
            ],
            'body' => $options,
            'headers' => ['content-type' => 'application/json']
        ];
        return function() use ($data) {
            return $this->getHttp()->getClient()->requestAsync('POST', $this::API_SEND_NOTICE, $data);
        };
    }複製程式碼

Guzzle 多執行緒非同步請求原型函式，使用 GuzzleHttp\Pool 物件

use GuzzleHttp\Pool;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;

$client = new Client();

$requests = function ($total) {
    $uri = 'http://127.0.0.1:8126/guzzle-server/perf';
    for ($i = 0; $i < $total; $i++) {
        yield new Request('GET', $uri);
    }
};

$pool = new Pool($client, $requests(100), [
    'concurrency' => 5,
    'fulfilled' => function ($response, $index) {
        // this is delivered each successful response
    },
    'rejected' => function ($reason, $index) {
        // this is delivered each failed request
    },
]);

// Initiate the transfers and create a promise
$promise = $pool->promise();

// Force the pool of requests to complete.
$promise->wait();複製程式碼

總結

有了 Guzzle，極大方便了我們併發非同步請求第三方介面。如果時間允許，我們可以看看 Guzzle 原始碼，看看是如何實現的。