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

何かお困りではありませんか?

さいごまで記事を読んでいただき、ありがとうございます!
何かお困りなことはありませんか?
当方、ホームページ制作・改修/WordPress構築/Webデザイン/UI・UXデザイン/Webディレクション/広告運用/ブランディング/マーケティング/撮影・レタッチ/動画撮影・編集/プロトタイプ制作、幅広く対応しておりますので、まずはお気軽にご相談いただけると嬉しいです!ご連絡お待ちしております。
Stay Safe.
詳細 » 案件、承っております

最近の記事

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

記事の投稿者(ユーザー)情報を取得するには、これまでは「get_userdata」を使っていたが、IDを取得したいだけなのに、もうちょっとシンプルな方法がある・・・

WordPress

「私たちの働き方とマネジメント」を読んで

数年前に読んだ本。本に付箋紙が大量についていたので、その箇所を読んで発見や共感をピックアップ。 最高のスマート・クリエイティブを惹きつ・・・

起業向け情報

「副業するならカメラマン」を読んで

2019年10月に書いたレビューの転載。 まず、タイトルや帯タイトルにあおられないでほしい。 この本は副業カメラマンになるための・・・

起業向け情報

「やりたいことを全部やってみる」を読んで

2019年9月に書いたレビューがあったので、ここに転載。--- タイトル「やりたいことを全部やってみる ストレスフリーな生き方を叶える・・・

起業向け情報

「世界一やさしいブログxYouTubeの教科書1年生」を読んで

2019年1月に書いたレビュー(2年以上前!)が残っていたので、ここに転載。当時YouTubeをやろうとしていた頃を思い出す。今でもYouTube更新しようと・・・

知識編

「図解モチベーション大百科」を読んで

書籍「図解モチベーション大百科」。主に行動経済学、実験心理学を扱った国内外の文献から、編著者なりの解釈で紹介された本。ここでは備忘録として書・・・

マーケティング・ブランディング

ローカル環境(MAMP)でgmailからメール送信できるようにする

MAMPにWordPressを入れてテストをしていると、ユーザー作成時やら何かとメール送信が必要になるタイミングがる。何も設定をしていないとローカル環境のWo・・・

MAMP

ユーザビリティと機能はどちらが上?

先日、「iOS Safariで絶対配置(position:fixed)して惰性スクロールしてもロックしない、フリーズ回避方法」という記事を書いたときに、エンジ・・・

デザイン思考

ビジネスカードとショップカード

以前にブランディングページを用意させてもらった、Sunny Side Accessory(サニーサイド アクセサリー)さんのビジネスカードとショップカードを制・・・

お仕事・制作日記

DtoC におけるプロモーションと広告運用

公開が2020年7月ということで、もう少しで1年経つのかぁ。「最終回 株式会社北の達人コーポレーション 木下勝寿社長 DMM MARKETING CAMP x・・・

マーケティング・ブランディング

人気の記事

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

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

WordPress

iframeの高さを自動調整する

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

JavaScript

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

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

MAMP

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

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

JavaScript

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

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

JavaScript

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

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

API

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

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

Illustorator

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

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

WordPress

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

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

WordPress

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

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

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

ホーム画面からの起動か判別する

「コメントありがとうございます。 この記事で紹介している機能は、記事内のサンプル「ホーム画面からの起動か判別する」というリンクをクリックすることで確認できます。 ・・・」

JavaScript

Javascriptでカレンダーを作ってみた

「JWOLさん> 祝日名を追加されるとのこと、いいですね!コメント&参考にしていただきありがとうございます!」

JavaScript

WordPressで記事の数を取得する → wp_count_posts() か found_posts

「絞り込み検索した場合の記事数の取得方法を追記しました。 $my_query->found_posts;」

WordPress

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