php

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とアクセストークンの情報は含まないようにケアしたい。

最近の記事

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

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

php

Instagram API を使ってインスタに投稿した画像データを取得する

インスタに投稿した画像を自動でホームページでも更新されるようにしたい。もっとも簡単に実現する方法を紹介する。 公式リファレンスInstagram・・・

API

名刺代わりの超絶ミニマムなブランディングページ

このたび、ハンドメイドアクセサリー作家さんのWebサイト制作させていただきました! Sunny Side Accessory(サニーサイド アクセサリー・・・

お仕事・制作日記

案件、承っております

2021年2月現在、案件承っております。とくに短期、週2、3日での外注をお考えでしたら、ぜひご連絡ください。 当方、2015年2月より「シンプルシンプル・・・

お仕事・制作日記

インタラクションデザイン

5年くらい前に購入した書籍「インタラクションデザイン」。この書籍内ではたくさんの事例が紹介されている。残念ながらその多くは現在閲覧することができなくなっていた・・・

デザイン

Advanced Custom Fields 名前を変更して、データも反映させる

WordPressを自作する上でもはや欠かせないプラグインの一つが、「Advanced Custom Fields」。 名前を変更しようと思って、Wor・・・

WordPress

配列の重複を削除する

配列の場合 /** * 配列の重複を削除する * * @param {array} ary* * @return {array} 処理後のary・・・

JavaScript

MAMP を 5.7 から 6.2 にアップデートした

5年以上前と比べると、アップデートが簡単で驚く。とくに記事にするまでもないと思いつつ、一応備忘録。 インストールすると、既存のディレクトリはそのままに別・・・

MAMP

Briefly unavailable for scheduled maintenance. Check back in a minute. → . maintenance を削除

プラグインを更新中に、誤って、違うページにアクセスしまいました。すると、管理画面だけでなく、公開中のすべての画面が「briefly unavailable f・・・

WordPress

GulpでERRが出てテンパった → gyp: No Xcode or CLT version detected! → PostCSS plugin autoprefixer requires PostCSS 8

Gulp。いつもは正常に動いている環境をそのままコピーして再利用するようにしている。そうすることで、案件ごとに毎回環境作りをする手間を省くことができ、何よりG・・・

制作効率化

人気の記事

WP_Queryを使って絞り込み検索するのにコレは便利!

めっちゃ参考になるページを見つけた。 絞り込みをするたびに色々ググっていたが、これがあればほとんどのことが解決できそうな気がする。 参考: これは便利!Word・・・

WordPress

overflowをautoにした要素のスクロール位置を変更する → scrollTop scrollLeft

まずはサンプル。 これは、overflowをautoにした要素のスクロール位置を変更するサンプルです。 これは、overflowをautoにした要素のスクロ・・・

JavaScript

iframeの高さを自動調整する

iframeで呼び出した際、iframe自体はスクロールさせずに高さを取得してiframe全体を表示させます。 サンプル:iframeの高さを自動調整するデモ・・・

JavaScript

http://localhost:8888/ → http://localhost/

http://localhost:8888/ での参照ではなく、http://localhost/ で参照できるようにします。 MAMPの設定を変更する M・・・

MAMP

カウントアップ、カウントダウンするJavaScript

ポイントを使ったり、増やしたりしたときに、結果のポイント数に差し替えるのではなくて、カウントアップしたり、カウントダウンして動的に動かそうと思って作ってみた。・・・

JavaScript

アーカイブページでカスタムフィールドやタクソノミーで絞り込みした状態でリスト表示する

<?php $args = array( 'paged' => 1, 'posts_per_page' => 20, 'post・・・

WordPress

WordPressのカテゴリー一覧ページでカテゴリー名とスラッグを取得する → get_queried_object()

やりたいこと カテゴリー一覧ページで、そのカテゴリー一覧ページに属する記事一覧を取得するためにループさせるのとは別に、タイトルやカテゴリー別にデザインを変・・・

WordPress

イラストレーターでレイヤーごとにPNGで書き出す

【2020年07月13日】 macOS Catalina(10.15.5) / Adobe iLLustrator 2020(24.2.1) にて動作確認済・・・

Illustorator

管理画面のカスタム投稿一覧で並び順を変更する

WordPressの管理画面。「投稿」や「固定ページ」の一覧は、公開日順に並んでいる。ところが、カスタム投稿を追加した場合、公開順ではなく名前順に並んでいること・・・

WordPress

Advanced Custom Fields を使った条件分岐(セレクトボックス、チェックボックス、ラジオボタン、真偽)のテンプレート記述方法

前回、「入力フォームを自由にカスタマイズできる「Advanced Custom Fields」」で基本的なフィールド名を出力方法を紹介したが、今度は条件分岐に関・・・

WordPress

WEB制作マークアップphpcronっぽいことをPHPでjsonとして実装する | シンプルシンプルデザイン