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

最近の記事

項目”Clipy”は開いているため、ゴミ箱に入れることができません。←アンインストールしようとしたときの話し

Clipyが超絶便利そうだったので、macOS Big Sur にインストール&再起動して使ってみた。ところが、command + c を複数の箇所で行い、c・・・

徒然なままに

setTimeout は requestAnimationFrame に変えるべき?

requestAnimationFrame をはじめて見たので調べていたら、setTimeout や setInterval は requestAnimati・・・

JavaScript

書籍「小さなチーム、大きな仕事」からピックアップ

6年ぶりに読み返したが、今なおハッとさせられることが多く見つかる。 この本で忘れないようにしたい項目をピックアップするだけでも役に立ちそ・・・

起業向け情報

書籍「完全網羅 起業成功マニュアル」からピックアップ

この記事では、以前に読んだ際に付箋を付けていたが、その部分だけを備忘録としてピックアップするため、本の要約ではない。実際は、何倍も濃い内容で、練・・・

起業向け情報

書籍「はじめの一歩を踏み出そう」から気になったフレーズをピックアップ

もう一回、全部読み返したいところだが、書籍がありすぎるので、当時付箋紙をつけていたところだけをピックアップ。書籍内ではより具体的な説明があるので・・・

起業向け情報

書籍「起業して3年以上「続く人」と「ダメな人」の習慣」からフレーズ・ピックアップ

この記事でメモしたのは、6年前に独立したときに読んだ箇所に付箋紙をつけていたところで、本の中の一部。起業家資質かどうか知る意味で読んでも面白いと・・・

起業向け情報

書籍「金持ち父さんの起業する前に読む本」を読んで

従業員という働き方ではない道を選ぶ前に読んでおきたい本。独立するときに読んだが、そのときに付箋紙がたくさん付いていたので、その部分を備忘録として・・・

起業向け情報

大きなインパクトを世界に与え続けてきた企業=ビジョナリー・カンパニーに学ぶ

この記事は、名著「ビジョナリー・カンパニー」から見直したいと思った箇所を備忘録として書き記す。 十二の崩れた神話 下記は、ビジョナ・・・

起業向け情報

ビジョナリー・カンパニーの基本理念

この記事は、名著「ビジョナリー・カンパニー」にて、実際のビジョナリー・カンパニーの基本理念が紹介されていたので抜粋。基本理念をつくる上での参考に・・・

起業向け情報

書籍「腕のいいデザイナーが必ずやっている仕事のルール125」には共感要素しかない

書籍では、それぞれの項目について、補足テキストがあるのだが、これがうなずきポイントだらけ。またページレイアウトやタイトルデザイン、写真の選択・・・

デザイン思考

人気の記事

iOS Safariで絶対配置(position:fixed)して惰性スクロールしてもロックしない、フリーズ回避方法

iPhoneやiPadで position: fixed; で絶対配置したエリア内をスクロールするとき、最上部をより上にスクロールしようとしたり、最下部をより・・・

JavaScript2021年4月28日

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

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

WordPress2018年10月11日

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

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

API2021年2月22日

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

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

JavaScript2017年7月19日

iframeの高さを自動調整する

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

JavaScript2015年3月17日

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

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

WordPress2019年2月11日

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

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

Illustorator2018年2月2日

配列の重複を削除する

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

JavaScript2020年12月14日

favicon.icoをWordPressの管理画面からアップロードできない→ wp-config.php を一時的に修正

いつもは直接アップロードしているので気にしていなかったが、WordPress管理画面のメニュー「メディア」からfavicon.icoをアップロードしようとした・・・

WordPress2020年8月4日

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

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

MAMP2015年2月3日

コメントありの記事

えっ!?Yahooの検索結果から遷移しようとしたら全く違うサイトにリダイレクトされてしまった...

「>前田さん コメントありがとうございます。 環境は分かりかねますが、修正したいファイルのパーミッションを604や644に変更すると書き込みできるようになりま・・・」

お仕事・制作日記

Sony Eマウント フルサイズ対応のカメラレンズを収集するページを作ってみた

「レンズ情報追加しました 150-600mm F5-6.3 DG DN OS | Sports 超望遠レンズ。一本は持ってみたい!」

お仕事・制作日記

記事の投稿IDなどの投稿者(ユーザー)情報を取得する方法 → get_the_author_meta

「アバターを取得する「get_avatar」についても追記しました!」

WordPress

jQueryでformを操る【nameの値を取得する/クリアする】

「「値をクリアする」を追加しました。チェックボックスやラジオボタンの値を何も選択していない状態に戻すときについて触れています。」

JavaScript

iframeの高さを自動調整する

「>匿名さん コメントありがとうございます。 サンプルでは、beforeは何も処理していないので期待する表示にならない、で正解です。 クリックした後が、対応・・・」

JavaScript

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

「コメントに嬉しいお言葉、ありがとうございます!」

API

MAMPでMySQL Serverが突然起動しなくなった時 → ログファイル削除

「(匿名)さん コメントありがとうございます。何も設定変更していないのに、それまで使用できていたサーバーが突然使えなくなるのは辛いですよね、、。 ここで紹介したや・・・」

MAMP

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

「コメントありがとうございます! そもそもできるかはわかりませんが、ソースを書き換える必要はあります。 下記記事などが参考になるかもしれません。 illustra・・・」

Illustorator

05_各種キーワードツール

「公開から14年振りの更新w デッドリンクを削除しました。ツール系は「SEO対策に役立つ便利ツール」に集約します。」

SEO

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

「「特定の「タイプ」に関連付けられた投稿を表示する場合」を一つの場合を追記し、複数の場合と分けました。」

WordPress

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