Laravel學(xué)習(xí)筆記之Core Concepts in Guzzle Package——Strea

singerye 發(fā)布于2019-06-27 14:43 / 625人閱讀

摘要：使用了來表示該，該接口也是對的抽象，暴露了一些常用方法判斷是否滿足要求的方法的讀寫相關(guān)操作獲取元數(shù)據(jù)方法操作指針相關(guān)方法等等。本篇主要學(xué)習(xí)下相關(guān)使用。后續(xù)還會分享相關(guān)使用，到時(shí)見。

說明：本文主要學(xué)習(xí)guzzlehttp/guzzle package的使用，該package提供了一套發(fā)送HTTP請求API，就像phpunit package, mockery package, symfony package, monolog package, league/filesystem package一樣，是一個(gè)經(jīng)常被使用的package，也是Laravel框架的一個(gè)重要依賴之一。AWS SDK for PHP也是把該package作為一個(gè)基礎(chǔ)package來使用，以后也想就AWS SDK for PHP做一些個(gè)人分享，對AWS開發(fā)感興趣的可以參看官方文檔AWS SDK for PHP，并且AWS提供了官方認(rèn)證考試：初級開發(fā)者證書AWS Certified Developer Associate,高級DevOps工程師證書AWS Certified DevOps Engineer Professional，感興趣可以參考官網(wǎng)：AWS Certification。學(xué)習(xí)Laravel不僅僅需要學(xué)習(xí)框架的使用和源碼，也需要學(xué)習(xí)這些常用package的使用，這些優(yōu)秀的package提供了很多代碼設(shè)計(jì)思想和架構(gòu)概念，這對提高個(gè)人設(shè)計(jì)代碼時(shí)的能力大有裨益。

本小篇主要學(xué)習(xí)下Guzzle package的Stream概念和使用，如果對Guzzle package不是很了解可以看下官網(wǎng)Guzzle。

Streams

一次HTTP請求是由起始行、消息頭、消息體組成的，消息體(payloads)可以是很小或者很大，如果使用字符串來存儲消息體的話，對于很大的消息體如一個(gè)大文件，用字符串存儲就會很消耗內(nèi)存，所以對于大消息體就需要使用Stream來表示。Guzzle使用了PsrHttpMessageStreamInterface來表示該Stream Objects，該接口也是對PHP Streams的抽象，暴露了一些常用方法：判斷stream是否滿足要求的方法,isReadable(), isWriable(), isSeekable();stream的讀寫相關(guān)操作,read(), write(), close();獲取元數(shù)據(jù)方法,getMetadata(), getSize();stream操作指針相關(guān)方法,rewind(), tell(), eof(), seek(),等等。

在psr/http-message package中提供了如下接口：PsrHttpMessageStreamInterface, PsrHttpMessageRequestInterface, PsrHttpMessageServerRequestInterface, PsrHttpMessageResponseInterface, PsrHttpMessageMessageInterface, PsrHttpMessageUriInterface, PsrHttpMessageUploadedFileInterface。而guzzle/psr7 package提供了這些接口對應(yīng)的實(shí)現(xiàn)：GuzzleHttpPsr7Stream, GuzzleHttpPsr7Request, GuzzleHttpPsr7ServerRequest, GuzzleHttpPsr7Response, GuzzleHttpPsr7Message, GuzzleHttpPsr7Uri, GuzzleHttpPsr7UploadedFile。

本篇主要學(xué)習(xí)下GuzzleHttpPsr7Stream相關(guān)使用。

Creating Streams

構(gòu)造一個(gè)stream最好方式是使用GuzzleHttpPsr7stream_for，該方法可以接收string, resources from open(), object implements __toString() or PsrHttpMessageStreamInterface, callables, iterators，寫一個(gè)PHPUnit測試看下stream的創(chuàng)建，爆綠燈：

// tests/Guzzle/StreamTest.php
namespace AppTestsGuzzle;

class StreamTest extends TestCase
{
    public function testCreatingStringStream()
    {
        /** @var GuzzleHttpPsr7Stream $stream */
        $stream = GuzzleHttpPsr7stream_for("Laravel is a stream.");

        $this->assertEquals("Laravel is a stream.", $stream);

        $stream = GuzzleHttpPsr7stream_for("Laravel is a stream.");

        $this->assertEquals("Laravel", $stream->read(7));
        $this->assertEquals(" is a stream.", $stream->getContents());
        $this->assertEquals(true, $stream->eof());
        $this->assertEquals(20, $stream->tell());
    }
}

// tests/Guzzle/TestCase.php
namespace AppTestsGuzzle;

use AppTestsTestCase as BaseCase;

abstract class TestCase extends BaseCase
{
}

還可以把iterator作為參數(shù)來構(gòu)造stream，PHPUnit測試爆綠燈:

    public function testCreatingIteratorStream()
    {
        $generator = function ($num) {
            for ($i = 0; $i < $num; $i++) {
                yield "laravel.";
            }
        };

        $stream = GuzzleHttpPsr7stream_for($generator(3));

        $this->assertEquals("laravel.laravel.laravel.", $stream->read(24));
    }

還可以把一個(gè)resource作為參數(shù)來構(gòu)造stream，PHPUnit測試爆綠燈：

    public function testResourceStreamMetadata()
    {
        $resource = fopen(storage_path("/logs/laravel.log"), "r");
        $stream   = GuzzleHttpPsr7stream_for($resource);

        $this->assertEquals(storage_path("/logs/laravel.log"), $stream->getMetadata("uri"));
        $this->assertTrue($stream->isReadable());
        $this->assertFalse($stream->isWritable());
        $this->assertTrue($stream->isSeekable());
    }

Stream Decorators

Guzzle也提供了一些Stream Decorators來修飾stream handlers，這些Decorators主要包括以下幾種：

AppendStream

BufferStream

CachingStream

DroppingStream

FnStream

InflateStream

LazyOpenStream

LimitStream

NoSeekStream

PumpStream

這里僅僅以GuzzleHttpPsr7AppendStream為例說明下Stream Decorator的使用，其他的Decorator可以參考官網(wǎng)。AppendStream修飾器顧名思義就是可以讀取多個(gè)stream并拼接成一個(gè)stream，PHPUnit測試爆綠燈：

    public function testAppendStream()
    {
        $stream1       = GuzzleHttpPsr7stream_for("Laravel");
        $stream2       = GuzzleHttpPsr7stream_for(" is ");
        $stream3       = GuzzleHttpPsr7stream_for("great!!!");
        $append_stream = new GuzzleHttpPsr7AppendStream([$stream1, $stream2]);

        $append_stream->addStream($stream3);

        $this->assertEquals("Laravel is great!!!", $append_stream);
    }

總結(jié)：學(xué)習(xí)Guzzle Package的使用是必要的，該package經(jīng)常作為一個(gè)重要依賴被其他package使用，比如AWS SDK for PHP就嚴(yán)重使用該package來做HTTP請求。后續(xù)還會分享Guzzle Package相關(guān)使用，到時(shí)見。

RightCapital招聘Laravel DevOps