LaravelのHttpファサードを拡張して利用するライブラリ
基本的な機能はLaravel HTTPクライアントと同じ、その他いくつかの機能追加
$ composer require KSuzuki2016/laravel-http-client
google-chromeとかgoogle-chrome-stableあたりが入ってれば大丈夫
sudo wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
sudo sh -c 'echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
sudo apt-get update
sudo apt-get install -y google-chrome-stable
現状で利用可能なバーションは70
から73
のバージョン限定
php artisan dusk:chrome-driver 70
<?php
return [
'binPath' => env('HTTP_CLIENT_CHROME_PATH') ,
/*
|--------------------------------------------------------------------------
| Http Request Driver
|--------------------------------------------------------------------------
| dusk is alias for dusk-chrome
|
| Drivers: "guzzle", "dusk" , "dusk-chrome"
|
*/
'default' => env('HTTP_CLIENT_DRIVER', 'guzzle') ,
'http_facade_overwrite' => env('HTTP_FACADE_OVERWRITE', false ) ,
];
manager
クラスからクライアントドライバを呼び出して使うかhttp-client
を呼び出す
HTTP_FACADE_OVERWRITE
にtrue
が設定されていればHttpファサードを上書きする
<?php
use KSuzuki2016\HttpClient\DriverManager ;
$manager = app(KSuzuki2016\HttpClient\DriverManager::class) ;
$manager->driver('dusk')->get('URL') ;
// 又は
$manager = app('http-client') ;
$manager->get('URL') ;
HTTP_CLIENT_CHROME_PATH
に設定したディレクトリ内のドライバを利用
HTTP_CLIENT_CHROME_PATH="/vagrant/vendor/ksuzuki2016/laravel-http-client/bin"
response
にcrawler
とstacks
を追加
crawler
はSymfony\Component\DomCrawler\Crawlerを返す
stacks
は配列を返す
<?php
use KSuzuki2016\HttpClient\DriverManager ;
$manager = app(KSuzuki2016\HttpClient\DriverManager::class) ;
$manager->driver('dusk')->get('URL')->crawler() ;
$manager->driver('dusk')->get('URL')->stacks() ;
2021.3.27 schema
を追加
<script type="application/ld+json">...</script>
のデータを取得してCollectionとして返す
<?php
use KSuzuki2016\HttpClient\DriverManager ;
$manager = app(KSuzuki2016\HttpClient\DriverManager::class) ;
$manager->get('URL')->schema() ;
javascriptの実行が可能
browserCallback
に設定
<?php
use KSuzuki2016\HttpClient\DriverManager ;
$manager = app(KSuzuki2016\HttpClient\DriverManager::class) ;
$manager->driver('dusk')->browserCallback( new BrowserMacro )->get('URL') ;
戻り値はレスポンスヘッダーのstacks
に格納される
<?php
namespace HttpClient\Macros;
use KSuzuki2016\HttpClient\Drivers\ChromeBrowser;
class TestMacro
{
/**
* @param ChromeBrowser $browser
* @return void|string|null
*/
public function __invoke(ChromeBrowser $browser)
{
// Browser Macro
}
}
マクロ実行中に発生したエラーログはレスポンスヘッダーのerrors
に格納されます
$response->header('errors');
/*
unknown error: Runtime.evaluate threw exception: SyntaxError: Unexpected identifier
(Session info: headless chrome=87.0.4280.66)
(Driver info: chromedriver=70.0.3538.97 (d035916fe243477005bc95fe2a5778b8f20b6ae1),platform=Linux 4.15.0-96-generic x86_64) screenshot path to screen
*/
レスポンスに対して処理を行う
responseObserver
に設定
<?php
use KSuzuki2016\HttpClient\DriverManager ;
$manager = app(KSuzuki2016\HttpClient\DriverManager::class) ;
$manager->driver('dusk')
->responseObserver( new ResponseLogObserver )
->responseObserver( new ResponseObserver )
->get('URL') ;
ResponseObserverInterface
を実装して作成するかResponseObserver
を継承する
連続したObserverの処理を止めたい場合はgetObservation
からfalse
を返却する
successful
とfailed
のから返却されたHttpClientResponse
で次の処理を行う(返却しなければオリジナルの値を使う)
<?php
namespace KSuzuki2016\HttpClient\Logging;
use KSuzuki2016\HttpClient\Contracts\ResponseObserver;
use KSuzuki2016\HttpClient\Http\Client\HttpClientResponse;
class ResponseLogObserver extends ResponseObserver
{
public function successful(HttpClientResponse $response)
{
// 処理を書く
}
public function failed(HttpClientResponse $response)
{
// ResponseObserverを継承していれば
// 以降の処理を止める場合にbreakObservationを呼び出して停止可能
$this->breakObservation();
}
}
ResponseObserver等で値の変更が可能
シンプルな例
public function successful(HttpClientResponse $response)
{
$stacks = array_merge( $response->stacks() , $response->json() ) ;
$response->setStacks( $stacks ) ;
}
値を変更して次の処理へ渡す場合return
で返却
public function successful(HttpClientResponse $response)
{
return $response->setJson( 'key' , 'new value' ) ;
}
stubからひな形を作成できます
Browser Macroのひな形を作成
$ php artisan make:http:macro CustomMacro
Response Observerのひな形を作成
$ php artisan make:http:Observer CustomObserver
パラメーターを設定したPendingRequest
を呼び出す為のクラス
<?php
namespace App\HttpClients ;
use KSuzuki2016\HttpClient\Contracts\HttpClientRequest;
class MobileClient extends HttpClientRequest
{
/**
* observer brawserCallback の設定等を行う場合
* プロパティでも設定可能
* @property HttpClientFactory app
*
* サービスプロバイダの bindings の様な設定も可能
* @property array observers
* @property array macros
*/
protected $headers = [
'user-agent' => 'Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.91 Mobile Safari/537.36'
] ;
}
$client = new MobileClient ;
$client->get('http://...') ;
// ResponseObserver BrowserMacro の利用
$client->observe( ResponseObserver )->macro( BrowserMacro )->get('http://...') ;
// デバッグを行う場合
$client->debug()->get('http://...') ;