Goutte(PHP7)を使ってみる #002

2018年04月17日

はじめに

#001でGoutteをインストール出来たので早速、簡単なサンプルを動かして見ましょう。

html情報の取得

手始めにWikipediaのページをスクレイピングしてみましょう。
以下のようにすればそのページのhtml情報は取ってこれます。

require 'vendor/autoload.php';
use Goutte\Client;

$client = new Client();
$url = 'https://ja.wikipedia.org/';
$crawler = $client->request('GET',$url);
$html = $crawler->html();

print_r($html);

require 'vendor/autoload.php';

use Goutte\Client;

$client = new Client();

$url = 'https://ja.wikipedia.org/';

$crawler = $client->request('GET',$url);

$html = $crawler->html();

print_r($html);

request()でHTTPリクエストして，html()でHTMLを取得すると行った内容です。ちなみにここでtext()を使うとhtmlタグが抜けたテキストがとれます。

requestする際の注意点

日本語.jpなどのマルチバイトドメイン名（IDN）を含む URL は、そのままでは GET（名前解決）に失敗します。事前に Punycode（ピュニコード）へのエンコードが必要です。ついでなので、よさげなエンコード / デコードライブラリもご紹介します。

Punycode – Wikipedia

GitHub – true/php-punycode: A Bootstring encoding of Unicode for Internationalized Domain Names in Applications (IDNA) for PHP

データの一部分を抜き出してみましょう

いよいよ本題です。Goutte の HTML パーサー部分は Symfony の DomCrawler コンポーネントです。クライアントリクエストの戻り値として取得したオブジェクトを操作してページ内のデータを抜き出す(スクレイピング)しくみです。

DOM 要素のテキストを取得

CSS セレクタ形式の filter() メソッドと、XPath 形式の filterXPath() メソッドが使えます。尚、filterXPath() は、以下のように「descendant-or-self::」から始めた方が無難なようです。

// filterXPath() の例
$entry_title = $crawler->filterXPath('descendant-or-self::body/div[1]/h1');

// filter() の例
$entry_title = $crawler->filter('h1.entry-title')->text();

// filterXPath() の例

$entry_title = $crawler->filterXPath('descendant-or-self::body/div[1]/h1');

// filter() の例

$entry_title = $crawler->filter('h1.entry-title')->text();

リクエストやスクレイピングのエラー処理

ページをリクエストする（$client->request）ときやスクレイピングする（filter, filterXPath）ときなどにエラーが発生した場合、各コンポーネントから例外（exception）がスローされます。try ～ catch で適宜、処理する必要があるでしょう。

$client = new Client();
try {
    $crawler = $client->request('GET', 'http://example.com/');
} catch (Exception $ex) {
    error_log(__METHOD__.' Exception was encountered: '.get_class($ex).' '.$ex->getMessage());
}

...

try {
    $links = $crawler->filter('a')->each(function($node) {
        return $node->attr('href');
    });
} catch (Exception $ex) {
    error_log(__METHOD__.' Exception was encountered: '.get_class($ex).' '.$ex->getMessage());
}

$client = new Client();

try {

$crawler = $client->request('GET', 'http://example.com/');

} catch (Exception $ex) {

error_log(__METHOD__.' Exception was encountered: '.get_class($ex).' '.$ex->getMessage());

}

...

try {

$links = $crawler->filter('a')->each(function($node) {

return $node->attr('href');

});

} catch (Exception $ex) {

error_log(__METHOD__.' Exception was encountered: '.get_class($ex).' '.$ex->getMessage());

}

【注意】存在しないセレクタを指定すると停止します

Goutteは存在しない要素をセレクタで指定した場合、エラーを吐いて動作を停止する仕様です。下記のようにcountで必ず要素の有無を確認するようにしましょう。特に長時間かけて大量のページを移動する場合、途中で停止すると再開するのも都度手間がかかります。

要素の存在をチェック

if($crawler->filter('xxx')->count() != 0){
//要素が存在します。
}

if($crawler->filter('xxx')->count() != 0){

//要素が存在します。

}

私の場合、Crawlerオブジェクトから情報を取得する前提ならば下記で対応してます。

(要素が存在しなければnullを代入)

$getText = $crawler->filter('xxx')->count() != 0 ? $crawler->filter('xxx')->text() : null;

1	$getText = $crawler->filter('xxx')->count() != 0 ? $crawler->filter('xxx')->text() : null;

画像をダウンロードしてサーバーの特定のディレクトリに保存する

お馴染みfile_get_contentsを使えば画像を保存できます。

$url = 'http://blog.t-szk.com/wordpress/wp-content/themes/default/images/logo.jpg';
$data = file_get_contents($url);
file_put_contents('./download/dl.jpg',$data);

$url = 'http://blog.t-szk.com/wordpress/wp-content/themes/default/images/logo.jpg';

$data = file_get_contents($url);

file_put_contents('./download/dl.jpg',$data);

フォームを送信する

$loginParamsに送信内容を格納し、リクエスト時に投げる方法のサンプルです。

POST

$loginParams = array(
'email' => 'hoge',
'password' => 'hogehoge'
);
$form = $crawler->filter('form.LoginForm')->form();
$crawler = $client->submit($form, $loginParams);

$loginParams = array(

'email' => 'hoge',

'password' => 'hogehoge'

);

$form = $crawler->filter('form.LoginForm')->form();

$crawler = $client->submit($form, $loginParams);

GET

$loginParams = array(
    'email' => 'dummy@dummy.com',
    'password' => $email
);
$param = "";
foreach ($loginParams as $key => $value) {
    $param .= $key."=".$value.'&';
}
$param = substr($param, 0, -1);
$url = 'https://customer.athome.jp'.$action.'?'.$param;
$crawler = $client->request('GET',$url);

$loginParams = array(

'email' => 'dummy@dummy.com',

'password' => $email

);

$param = "";

foreach ($loginParams as $key => $value) {

$param .= $key."=".$value.'&';

}

$param = substr($param, 0, -1);

$url = 'https://customer.athome.jp'.$action.'?'.$param;

$crawler = $client->request('GET',$url);

※フォーム送信についての注意点は#003で解説します。

【Goutte(PHP7)】フォーム送信に必要な情報を調べる方法 #003

2018-04-17 17:46

はじめにまず、このページの趣旨はGoutteでのフォーム送信のやり方の説明ではなく、フォーム送信時に必要な送信情報を漏れなく洗い出すため方法です。 ※Goutteを使った基本的な...

セレクタを覚えよう

GoutteはCSS、jqueryライクにセレクタが書けるのも魅力の一つです。すべてのバリエーションを覚える必要はありませんが頭の片隅には入れておきましょう。様々なサイトのスクレイピングを続けているとhtmlの構造が古かったり、コード上でスクレイピング対策が施されている場合等、少し工夫しないと取得できない値に出会うと思います。そのようにセレクタの指定の仕方でつまづいた時、助けになるので目は通しておきましょう。

CSSのセレクタとほぼ変わらないのでこちらを参考に

CSS3のセレクタ全42種まとめておさらい使い方リファレンス