開発者ドキュメント

Ubuntu20.04でNginxのヘッダーモジュールを使用してブラウザキャッシュを実装する方法

getdocs

著者はCOVID-19救済基金を選択し、 Write forDOnationsプログラムの一環として寄付を受け取りました。

序章

Webサイトの読み込みが速いほど、訪問者が滞在する可能性が高くなります。 ウェブサイトが画像でいっぱいで、バックグラウンドでロードされたスクリプトによって実行されるインタラクティブなコンテンツである場合、ウェブサイトを開くことは簡単な作業ではありません。 これは、サーバーから1つずつ多くの異なるファイルを要求することで構成されます。 これらのリクエストの量を最小限に抑えることは、Webサイトを高速化する1つの方法です。

Webサイトのパフォーマンスを向上させる1つの方法は、ブラウザキャッシングです。 ブラウザのキャッシュは、サーバーに何度も要求する代わりに、ダウンロードしたファイルのローカルバージョンを再利用できることをブラウザに通知します。 これを行うには、ブラウザに動作方法を指示する新しいHTTP応答ヘッダーを導入する必要があります。

Nginxのヘッダーモジュールは、ブラウザのキャッシュを実現するのに役立ちます。 このモジュールを使用して任意のヘッダーを応答に追加できますが、その主な役割はキャッシュヘッダーを適切に設定することです。 このチュートリアルでは、Nginxのヘッダーモジュールを使用してブラウザのキャッシュを実装します。

前提条件

このチュートリアルに従うには、次のものが必要です。

ステップ1—テストファイルの作成

このステップでは、デフォルトのNginxディレクトリにいくつかのテストファイルを作成します。 後でこれらのファイルを使用して、Nginxのデフォルトの動作を確認し、ブラウザーのキャッシュが機能していることをテストします。

ネットワーク上で提供されるファイルの種類を推測するために、Nginxはファイルの内容を分析しません。 それは法外に遅いでしょう。 代わりに、ファイル拡張子を検索して、ファイルのMIMEタイプを判別します。これはその目的を示します。

この動作のため、テストファイルの内容は関係ありません。 ファイルに適切な名前を付けることで、たとえば、完全に空のファイルの1つが画像で、もう1つがスタイルシートであるとNginxを騙して考えることができます。

名前の付いたファイルを作成します test.html デフォルトのNginxディレクトリで truncate. この拡張機能は、それがHTMLページであることを示します。

  1. sudo truncate -s 1k /var/www/html/test.html

同じ方法でさらにいくつかのテストファイルを作成しましょう：1つ jpg 画像ファイル、1つ css スタイルシート、および1つ js JavaScriptファイル：

  1. sudo truncate -s 1k /var/www/html/test.jpg

  2. sudo truncate -s 1k /var/www/html/test.css

  3. sudo truncate -s 1k /var/www/html/test.js

次のステップは、作成したばかりのファイルを使用して、新規インストールでキャッシュ制御ヘッダーを送信することに関してNginxがどのように動作するかを確認することです。

ステップ2—デフォルトの動作を確認する

デフォルトでは、すべてのファイルのデフォルトのキャッシュ動作は同じです。 これを調べるために、手順1で作成したHTMLファイルを使用しますが、これらのテストは任意のサンプルファイルで実行できます。

それでは、 test.html ブラウザが応答をキャッシュする時間に関する情報が提供されます。 次のコマンドは、ローカルのNginxサーバーからファイルを要求し、応答ヘッダーを表示します。

  1. curl -I http://localhost/test.html

いくつかのHTTP応答ヘッダーが表示されます。

Output: Nginx response headers
HTTP/1.1 200 OK
Server: nginx/1.18.0 (Ubuntu)
Date: Tue, 02 Feb 2021 19:03:21 GMT
Content-Type: text/html
Content-Length: 1024
Last-Modified: Tue, 02 Feb 2021 19:02:58 GMT
Connection: keep-alive
ETag: "6019a1e2-400"
Accept-Ranges: bytes

最後から2番目の行に ETag ヘッダー。要求されたファイルのこの特定のリビジョンの一意の識別子が含まれます。 前を実行した場合 curl コマンドを繰り返し実行すると、まったく同じものが見つかります ETag 価値。

Webブラウザを使用する場合、 ETag 値は保存され、サーバーに返送されます。 If-None-Match ブラウザが同じファイルを再度要求する場合（たとえば、ページを更新する場合）にヘッダーを要求します。

次のコマンドを使用して、コマンドラインでこれをシミュレートできます。 必ず変更してください ETag このコマンドの値は、 ETag 前の出力の値：

  1. curl -I -H 'If-None-Match: "6019a1e2-400"' http://localhost/test.html

これで、応答が異なります。

Output: Nginx response headers
HTTP/1.1 304 Not Modified
Server: nginx/1.18.0 (Ubuntu)
Date: Tue, 02 Feb 2021 19:04:09 GMT
Last-Modified: Tue, 02 Feb 2021 19:02:58 GMT
Connection: keep-alive
ETag: "6019a1e2-400"

今回、Nginxは 304 NotModifiedで応答します。 ネットワーク経由でファイルを再度送信することはありません。 代わりに、ローカルでダウンロード済みのファイルを再利用できることをブラウザに通知します。

これはネットワークトラフィックを減らすので便利ですが、優れたキャッシュパフォーマンスを達成するには十分ではありません。 の問題 ETag つまり、ブラウザは常にサーバーにリクエストを送信して、キャッシュされたファイルを再利用できるかどうかを尋ねます。 サーバーがファイルを再送信する代わりに304で応答したとしても、要求を行って応答を受信するのに時間がかかります。

次のステップでは、headersモジュールを使用してキャッシュ制御情報を追加します。 これにより、ブラウザはサーバーに明示的に要求することなく、一部のファイルをローカルにキャッシュします。

ステップ3—Cache-ControlおよびExpiresヘッダーの構成

に加えて ETag ファイル検証ヘッダーには、2つのキャッシュ制御応答ヘッダーがあります。 Cache-Control と Expires. Cache-Control は新しいバージョンであり、より多くのオプションがあります Expires また、キャッシュの動作をより細かく制御したい場合は、一般的に便利です。

これらのヘッダーが設定されている場合、要求されたファイルを再度要求することなく、一定期間（永久を含む）ローカルに保持できることをブラウザーに通知できます。 ヘッダーが設定されていない場合、ブラウザは常にサーバーにファイルを要求し、 200OKまたは304NotModifiedの応答を期待します。

ヘッダーモジュールを使用して、これらのHTTPヘッダーを設定できます。 ヘッダーモジュールはコアNginxモジュールです。つまり、使用するために個別にインストールする必要はありません。

ヘッダーモジュールを追加するには、でデフォルトのNginx構成ファイルを開きます。 nano またはお気に入りのテキストエディタ：

  1. sudo nano /etc/nginx/sites-available/default

を見つける server 構成ブロック：

/ etc / nginx / sites-available / default
. . .
# Default server configuration
#

server {
    listen 80 default_server;
    listen [::]:80 default_server;

. . .

ここに次の2つの新しいセクションを追加します。 server ブロック、さまざまなファイルタイプをキャッシュする期間を定義し、その中に1つを定義して、キャッシュヘッダーを適切に設定します。

変更された/etc/ nginx / sites-available / default
. . .
# Default server configuration
#

# Expires map
map $sent_http_content_type $expires {
    default                    off;
    text/html                  epoch;
    text/css                   max;
    application/javascript     max;
    ~image/                    max;
    ~font/                     max;
}

server {
    listen 80 default_server;
    listen [::]:80 default_server;

    expires $expires;
. . .

前のセクション server ブロックは新しいです map ファイルタイプとその種類のファイルをキャッシュする期間の間のマッピングを定義するブロック。

このマップでは、いくつかの異なる設定を使用しています。

注：これらは、Webサイトで使用される最も一般的なMIMEタイプのほんの一例です。 一般的なMIMEタイプサイトでそのようなタイプのより広範なリストに精通し、自分のケースで役立つと思われる他のタイプをマップに追加できます。

サーバーブロック内では、 expires ディレクティブ（ヘッダーモジュールの一部）は、キャッシング制御ヘッダーを設定します。 からの値を使用します $expires マップに設定された変数。 このように、結果のヘッダーはファイルタイプによって異なります。

ファイルを保存して閉じ、終了します。

新しい構成を有効にするには、Nginxを再起動します。

  1. sudo systemctl restart nginx

次に、新しい構成が機能することを確認しましょう。

ステップ4—ブラウザキャッシュのテスト

テストHTMLファイルに対して前と同じリクエストを実行します。

  1. curl -I http://localhost/test.html

今回は反応が異なります。 2つの追加のHTTP応答ヘッダーが表示されます。

Output
HTTP/1.1 200 OK
Server: nginx/1.18.0 (Ubuntu)
Date: Tue, 02 Feb 2021 19:10:13 GMT
Content-Type: text/html
Content-Length: 1024
Last-Modified: Tue, 02 Feb 2021 19:02:58 GMT
Connection: keep-alive
ETag: "6019a1e2-400"
Expires: Thu, 01 Jan 1970 00:00:01 GMT
Cache-Control: no-cache
Accept-Ranges: bytes

The Expires ヘッダーには過去の日付が表示され、 Cache-Control で設定されています no-cache、これは、ファイルの新しいバージョンがあるかどうかを常にサーバーに確認するようにブラウザに指示します（ ETag 以前のようにヘッダー）。

テスト画像ファイルとの応答に違いがあります。

  1. curl -I http://localhost/test.jpg

新しい出力に注意してください。

Output
HTTP/1.1 200 OK
Server: nginx/1.18.0 (Ubuntu)
Date: Tue, 02 Feb 2021 19:10:42 GMT
Content-Type: image/jpeg
Content-Length: 1024
Last-Modified: Tue, 02 Feb 2021 19:03:02 GMT
Connection: keep-alive
ETag: "6019a1e6-400"
Expires: Thu, 31 Dec 2037 23:55:55 GMT
Cache-Control: max-age=315360000
Accept-Ranges: bytes

この場合、 Expires 遠い将来の日付を示し、 Cache-Control 含む max-age 情報。これは、ファイルを秒単位でキャッシュできる時間をブラウザに通知します。 これにより、ダウンロードされた画像を可能な限りキャッシュするようにブラウザに指示されるため、この画像がその後表示されると、ローカルキャッシュが使用され、サーバーにリクエストが送信されなくなります。

結果は両方で同様になるはずです test.js と test.css、JavaScriptファイルとスタイルシートファイルの両方にキャッシュヘッダーも設定されているため。

これは、キャッシュ制御ヘッダーが適切に構成されていることを意味し、ブラウザーのキャッシュによるパフォーマンスの向上とサーバー要求の減少により、Webサイトが恩恵を受けます。 Webサイトのコンテンツに基づいてキャッシュ設定をカスタマイズする必要がありますが、この記事のデフォルトから始めるのが妥当です。

結論

ヘッダーモジュールを使用して、任意のヘッダーを応答に追加できますが、キャッシング制御ヘッダーを適切に設定することは、その最も有用なアプリケーションの1つです。 これにより、特に携帯電話会社のネットワークなど、待ち時間が長いネットワークで、Webサイトユーザーのパフォーマンスが向上します。 また、速度テストを結果に織り込む検索エンジンでより良い結果をもたらす可能性があります。 ブラウザのキャッシュヘッダーを設定することは、GoogleのPageSpeedおよび同様のパフォーマンステストツールからの重要な推奨事項です。

ヘッダーモジュールの詳細については、Nginxの公式ヘッダーモジュールドキュメントをご覧ください。

モバイルバージョンを終了