制作記事 Web制作マークアップphpcronっぽいことをPHPでjsonとして実装する

cronっぽいことをPHPでjsonとして実装する

外部のAPIを利用する際、リクエスト回数が制限されることがある。また、リクエスト回数が制限され、かつ毎日更新をルールとする外部のAPIもある。

そんなときは、cronを利用することで、都度リクエストせずにあらかじめ設定した時間ごとに定期的にデータ保存して、それを参照することができる。
たとえば12時間ごとに外部APIを参照して、その結果をファイルやデータベースに保存するイメージ。
さらに、cronを利用するメリットは外部サービス側の負荷を気にすることがないので、ページ読み込み速度の改善につながる。

ちなみに、cronを利用せず、サーバー側でキャッシュして、たとえば12時間ごとにキャッシュをクリアする方法も考えられるが、レンタルサーバーでは細かく設定できるケースはほぼない。また自前サーバーやAWSやGCPのようなクラウドサービスで実装しようとしても、思わぬセキュリティホールを作りかねないので、専門的な知識がなかったり、サーバーサイド側を極めたいのでなければ、サーバーキャッシュについての深追いは避けた方が無難だろう。

前置きが長くなった。ここから本題。

cronっぽい、とは?

cronっぽいとはどういうことか。たとえば、12時間ごとに外部APIを参照してファイル保存するcronを用意したとする。これとほぼ同じことをできるようにすることだ。

実装イメージ

ページ参照した際。

1. 外部APIを参照してコピーしたファイルがあるか?
Yes → 2-1
No → 2-2

2-1 ファイルの更新日時がしかるべき時間内(ページを参照した時間に直近の0/12時の間)であるか?
Yes → 3
No → 2-2

2-2 外部APIを参照する。その結果、データ取得に成功したか?
Yes → ファイルに保存して、3
No → エラー処理

3 データを参照する

これで、cronっぽいことができるわけだが、あらためて、cronとcronっぽいことの違いはなんだろうか。

cronとの違い

cronは、設定した時間ごとに自動処理される。一方、cronっぽい処理はあくまでページ参照されないと処理されない。極端に言えば、何日も放置されたページであれば、外部APIを参照して保存したファイルは、次にページ閲覧されるまで更新されないままとなる。

言葉を書き連ねたが、百聞は一見にしかず。
実例を紹介する。

InstagramグラフAPIを使って、実践してみる

それでは、InstagaramグラフAPIを使って実践した動画を用意したので、よかったらご覧ください。

ポイントは「日時比較」

ファイルを保存した更新日時と定期的に実行したい日時を比較して、ファイル保存を有効にするか、それとも外部APIを参照して新たにファイルを保存するか判断することだ。

具体例を考えてみる。

前提:12時間ごとに情報を更新したいとする。
そしてページにアクセスした日時が15時だったとする。

仮説1:保存ファイルの更新日時がその日の13時だった場合
→ 保存ファイルを参照する

仮説2: 保存ファイルの更新日時がその日の11時だった場合
→ 保存ファイルは古いため、もう一度外部APIに最新情報を参照してファイル保存する

全体のソースコード

いろいろ改善できるポイントはあるのだが、最低限のソースコードということで紹介。近々、もう少しブラッシュアップした動画か記事を用意しようと思う。

補足1)phpで実装しているが、jsonとして認識するようにしている。
補足2) リクエストURL($instagram_request_url)のIDとアクセストークンは別途書き換えが必要。IDとアクセストークンの取得方法についての記事はコチラを参考にしてください。
Instagram API を使ってインスタに投稿した画像データを取得する

<?php
// jsonファイルとして認識する
header("Content-Type: application/json; charset=utf-8");
// 有効なjsonファイルが存在するかのboolean
$is_file = false;
// ディレクトリがない場合は、ディレクトリを作成する
$json_dir = __DIR__.'/data';
if (!is_dir($json_dir)) {
  mkdir($json_dir);
}
// jsonファイルのパス
$json_file = $json_dir.'/instagram.json';
// jsonファイルがすでに存在しているか判別する
if (file_exists($json_file)) {
  // ファイルアクセス時の時間(時のみ)
  $current_hour = (+date('H'));
  // 0時と12時にcronが実行するような振る舞い
  switch (true) {
    case ($current_hour < 12):
      $check_hour = 0;
      break;
    default:
      $check_hour = 12;
  }
  // jsonファイルの更新日時が、cron時間より後か判別する
  if (filemtime($json_file) > mktime($check_hour, 0, 0, date('m'), date('d'), date('Y'))) {
    // jsonファイルを呼び出す
    $instagram_api_data = file_get_contents($json_file);
    // jsonファイルの呼び出しに成功したか判別する
    if ($instagram_api_data !== false) {
      $is_file = true;
    }
  }
}
// jsonファイルが存在しない、もしくはjsonファイルが古い場合
if ($is_file === false) {
  // InstagramグラフAPIを参照する
  $instagram_request_url = 'https://graph.facebook.com/v9.0/{ID}/media/?fields=media_url&access_token=EAAN...';
  // InstagramグラフAPIのデータを取得する
  $instagram_api_data = file_get_contents($instagram_request_url);
  // InstagramグラフAPIのデータを取得できたか判別する
  if ($instagram_api_data !== false) {
    file_put_contents($json_file, $instagram_api_data);
  } else {
    $instagram_api_data = '{}';
  }
}
// データを返却する
echo $instagram_api_data;

ディレクトリ構成

ディレクトリ構成としては、上記ソースコードをindex.phpとした場合

┗ index.php
┗ data/instagram.php (← index.phpを実行すると、条件に合致すると自動生成されるファイル)

余談

本題とは関係ないが、InstagaramグラフAPIで取得したデータの中には、IDとアクセストークンが含まれている場合がある。セキュリティ的に、これらの情報は外部から閲覧できないようにするほうが望ましいので、本来であればファイル保存する前にIDとアクセストークンの情報は含まないようにケアしたい。