CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールする

2022/02/23 2022/02/26

CakePHP4、CakePHP3のCSS、JavaScript、画像のブラウザへのキャッシュの設定方法

ブラウザが CSS、JavaScript、画像をキャッシュする仕組み

　
ブラウザは、表示している Webサイトで使われている CSSや JavaScript、画像をキャッシュして Webサイトの表示を高速化しようとします。
　
そのため、場合によってはサーバの CSSや JavaScript、画像が更新されていてもブラウザがキャッシュしている情報が使用されて、Webサイトが正しく表示、処理されない場合があります。
　
そんな時は、キャッシュをクリアして強制リロードするために「Ctrl＋F5」などをするわけですが、Webサイトを利用しているすべてのユーザがキャッシュに対する理解があるわけではないため、CSSや JavaScript、画像が更新されたら、ブラウザのキャッシュも更新してほしいと思うでしょう。
　
　

CakePHP4にはブラウザのキャッシュを更新する仕組みが実装されている

　
そんなキャッシュを更新する機能が CakePHP4には実装されているのですが、デフォルトでは使用しない設定になっています。
ですが、個人的にはほとんどの場合は常に更新する設定にしておく方がいいだろうと思います。
　
　
ちなみに、記事では「CakePHP4」と記載していますが、「CakePHP3」でも全く同じ機能が実装されています。
「CakePHP4」のところを「CakePHP3」と読み替えても問題ありません。デフォルトの設定も同じです。
　
　

CakePHP4のブラウザのキャッシュを指定する設定方法

/config/app.php を編集

　
/config/app.php
の 90行目前後を、下記の通り「'timestamp' => 'force',」とします。
　

    // デフォルトの設定
    'Asset' => [
        //'timestamp' => true,
        // 'cacheTime' => '+1 year'
    ],

    // 強制的にリロードする設定
    'Asset' => [
        'timestamp' => 'force',
        //'timestamp' => true,
        // 'cacheTime' => '+1 year'
    ],

// デフォルトの設定

'Asset' => [

//'timestamp' => true,

// 'cacheTime' => '+1 year'

// 強制的にリロードする設定

'Asset' => [

'timestamp' => 'force',

//'timestamp' => true,

// 'cacheTime' => '+1 year'

表示される HTML

　
この設定をすることで、例えば cssのリンク情報が下記のように変更されます。
　

 <!-- デフォルトの表示 -->
 <link rel="stylesheet" href="/css/login.css"/>

 <!-- 強制的にリロードする際の表示 -->
 <link rel="stylesheet" href="/css/login.css?1645536142"/>

　
　
「login.css」に続く「1645536142」は、「login.css」のファイルの更新日時（タイムスタンプ）の UnixTimeです。
　
ブラウザは「/css/login.css?1645536142」全体がファイル名として認識します。
「login.css」ファイルを更新すると「1645536142」の部分が変更されるため、ブラウザは「login.css?1645536142」ではなくなったと認識して再読み込みを実行する、という仕組みになっています。
　
　
この設定をしておかないと、「login.css」を変更してもブラウザが「login.css」を再読み込みしてくれるかどうかはブラウザ次第になってしまうため、サイトの運営者が望む状況になっていない場合も発生するわけです。
　
　

CakePHP4 の asset の設定による動作

　
というわけで、ほとんどの場合は「'timestamp' => 'force',」としておくべきだと思います。
　
「'timestamp' => 'force',」としても、ページを表示するたびに毎回 CSSや JavaScript、画像を再読み込みするようになるわけではありません。ファイルが更新された日時を表示するため、更新日時が変わらない限り再読み込みはされません。その点は安心です。
ですが、ページを表示する際に、CSSや JavaScript、画像の更新日時を取得して、それを付与して HTMLを生成する、という処理になりますので、その処理の分だけ若干処理が増えてはいます。
　
　

CakePHP4で /config/app.phpの assetの設定の詳細

　
CSSや JavaScript、画像のキャッシュをする、しないの設定は下記の 3つあります。
　

    // デフォルトの設定
    'Asset' => [
        'timestamp' => 'force',
        //'timestamp' => true,
        //'timestamp' => false,
    ],

// デフォルトの設定

'Asset' => [

'timestamp' => 'force',

//'timestamp' => true,

//'timestamp' => false,

　
　
「false」はデフォルトの設定です。
「timestamp」を指定しないときは「false」が設定されているものとして、下記のように何も付与しない状態で cssが読み込まれます。
　

 <!-- デフォルトの表示 -->
 <link rel="stylesheet" href="/css/login.css"/>

1 2	<!-- デフォルトの表示 --> <link rel="stylesheet" href="/css/login.css"/>

　
　
「true」と「'force'」の場合は、下記のように読み込むファイル名に加えて、ファイルの更新日時の UnixTimeが編集されます。
　

 <!-- 強制的にリロードする際の表示 -->
 <link rel="stylesheet" href="/css/login.css?1645536142"/>

1 2	<!-- 強制的にリロードする際の表示 --> <link rel="stylesheet" href="/css/login.css?1645536142"/>

　
　
「true」と「'force'」の違いは、「true」は「debug」モードが「true」の場合のみ付与します。
「'force'」の場合は「debug」モードに関係なく常に付与します。
　
「'force'」を指定するときの注意点としては、「force」は文字列ですので「'（シングルクォート）」「"（ダブルクォート）」のどちらかで囲む必要があります。（「true」「false」は「Boolean」ですので「'」などで囲む必要はありません。）
　
ちなみに、「force」を「'」などで囲まなくても「Notice」は出力されますが、タイムスタンプを編集する処理は正しく動作はします。
　
　
「debug」モードは、開発環境では「true」にして、本番環境では「false」にしていることが多いと思いますので、「'timestamp' => true,」は（変更する頻度が高い）開発環境では付与する、と言い換えてもいいでしょう。
　
　
でも、本番環境こそ Webサイトを使うユーザの行動を規定できないわけですので、サーバ側で強制的にキャッシュを書き換えるような設定にしておくべきだと思います。
　
　
CakePHP4　Cookbook　構成設定
https://book.cakephp.org/4/ja/development/configuration.html#general-configuration
　
CakePHP3　Cookbook　構成設定
https://book.cakephp.org/3/ja/development/configuration.html#id4
　
　

CakePHP4でキャッシュする時間を設定

キャッシュする時間「max-age」「Expire」を設定する方法

　
前項で紹介した「timestamp」では、ファイルの更新日時の UnixTimeを付与するか、しないかの設定でしたが、ブラウザにキャッシュする時間を設定する「cacheTime」を設定することもできます。
　

    'Asset' => [
         'cacheTime' => '+1 year'
    ],

'Asset' => [

'cacheTime' => '+1 year'

　
　
上記のように「cacheTime」をキーとしてキャッシュする時間を設定します。
デフォルトでは「+1 day（1日）」が設定されています。
　
上記の例では「+1 year」が設定されていますので、「1年」ということになります。
　
設定は、下記の PHPの strtotime関数の書式で設定します。
https://www.php.net/manual/ja/function.strtotime.php
　
　
また、HTTP ヘッダー Cache-Control の max-age と HTTP ヘッダーの Expire について確認したい場合は下記のページなどが参考になるかと思います。
https://developer.mozilla.org/ja/docs/Web/HTTP/Headers/Cache-Control
https://developer.mozilla.org/ja/docs/Web/HTTP/Headers/Expires

- CakePHP 3.x 4.x 5.x CakePHP3, CakePHP4

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法

CakePHP4のコマンド（シェル）に対して、環境変数を指定して実行する方法を解説。LinuxとWindows上のXAMPPとでは記述方法が異なるため、Windowsのsetコマンドについても詳細解説。

: Windows環境の XAMPPを利用して CakePHPの開発する際の注意点

WindowsベースにXAMPPで環境を構築しCakePHP4を利用したWebシステムを構築する際は、大文字と小文字の違いを意識する必要がある。LinuxベースのWebサーバに移動させたときに不具合で動作しないこともある。

: CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法

CakePHP4でテンプレートやレイアウトファイルをデフォルトから変更する場合は「render()」を使用するが、記述場所はできるだけコントローラー内の最後の方に書く方がいい。

: CakePHP4のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつ、テンプレートファイル、設定情報ファイルの場所とそれらをカスタマイズする方法を説明します。

: CakePHP3のビューで受取ったテーブルのオブジェクトを連想配列に変換する方法

コントローラーからビューに送ったテーブルのオブジェクトを連想配列に変換し、ビューの中で自由に使えるようにするメソッド「toArray()」の解説。連想配列に変換できれば利用度アップ！

: CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。

CakePHP3でajaxを利用する処理の実装方法を解説。プルダウンを変更するとデータベースの値を取得し検索結果の内容を変更するというような処理を想定。CakePHP3.6以降の CSRF対策対応済。

: CakePHP4で定数の設定と呼び出し方法の解説（defineとConfigure）

CakePHP4で定数を設定、使用する方法を解説。定数定義はdefineとConfigureを使用する方法を解説。また、bootstrap.phpに直接記述する方法と別のファイルにする方法を解説。

: CakePHP 2.3　Search Pluginで検索処理　その７queryを使って日付の範囲検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で queryを使って日付の範囲検索の方法です。

: CakePHP3でテーブルにカラム（項目）を追加したときに変更するポイントのまとめ

CakePHP3でシステム開発をする際、途中でカラムを追加した場合に何を変更すればいいかを確認。カラムを追加する前後で Bakeした結果を比較し、変更になった点をリストアップした。

: CakePHP4系、CakePHP5系のexists()でカラムを指定して値の有無をチェックする方法解説

CakePHP4、5で指定したカラムに特定の値に該当のレコードの有無をチェックするにはexists()を使う。単純にカラムを指定する方法から複数条件をand、orで探すこともできる。