Ext JS 4でクラスシステム導入時に行ってみたいキャッシュバスターの設定
最近、自分が従事しているプロジェクトのウェブアプリケーションでは、Ext JS 4への移行に伴いクラスシステムを導入する流れが来ている。
ちゃんとExt JSの機能どおりにクラスシステムを導入すると、JavaScriptの実行中に動的にクラスファイル(jsファイル)をダウンロードすることになるのだが、そうなるとJavaScriptの動作が途中で止まってしまう。それを懸念する声がプロジェクトから挙がるのも無理はないことである。
現在、プロジェクトのシステムでは、jsファイルおよびcssファイルは、リリース直後では必ずサーバから取得させつつ、それ以降は次のリリースまで取得のリクエストさえさせない、ということを目指している。
リリース直後では当然既存のjsファイルが修正されているかも知れず、変にキャッシュが効いていると画面が正常に動かない。
それでいて、js/cssといった静的ファイルは一度取得してしまえば次のリリースまでは絶対に中身は変わらないため、それまではブラウザ側でキャッシュしてもらった方が断然良いわけである。
Ext JS 4のキャッシュバスターの設定
さて、Ext JS 4でサンプルを作り、jsファイルを動的に読み込む様子を見てみると、リクエストクエリの末尾に「?_dc=現在時刻」のようにブラウザにキャッシュさせないための記述(キャッシュバスター)が施されている。
GET /js/util/Test.js?_dc=1377937899901 HTTP/1.1 →HTTP 200 OK GET /js/util/Test.js?_dc=1377938345882 HTTP/1.1 →HTTP 200 OK GET /js/util/Test.js?_dc=1377939014299 HTTP/1.1 →HTTP 200 OK
これではJavaScriptが動作して動的にjsファイルを読み込む記述があると毎回リクエストが行われ、かつ、毎回200 OKのレスポンスが返され、どうしても動作が遅くなってしまうように思われる。
ここで、このキャッシュバスターをさせないためには、次のようにExt.Loaderのコンフィグを指定する記述を行うことで実現できる。
Ext.Loader.config.disableCaching = false;
http://stackoverflow.com/questions/2047737/removing-dc-parameter-in-ext
こんな感じ。
GET /js/util/Test.js HTTP/1.1 →HTTP 200 OK GET /js/util/Test.js HTTP/1.1 →HTTP 304 Not Modified (そもそもリクエストさえ行わない場合もある) GET /js/util/Test.js HTTP/1.1 →HTTP 304 Not Modified (そもそもリクエストさえ行わない場合もある)
しかし、これでは上述のようにリリース直後に画面が正常に動作しなくなってしまう。
そこで、キャッシュバスターとしてjs/cssファイルに付与するパラメータ「_dc」の値の現在時刻をリリース時に1つ決まる任意の文字列「リリース時刻など」に固定する。
ext-debug.js(Ext JS 4.2.1 版)では、6341行目と6353行目にそのような箇所が見える。
ext-debug.js : 6341行目
(url + '?' + config.disableCachingParam + '=' + Ext.Date.now()) : url;
ext-debug.js : 6353行目
noCacheUrl = url + (config.disableCaching ? ('?' + config.disableCachingParam + '=' + Ext.Date.now()) : ''),
本番リリース時はext-debug.jsではなくext.jsを使用すると思うので、その箇所の記述は上記のどちらも(もう少し絞り込んで)次のような記述に当たる。
"?"+B.disableCachingParam+"="+Ext.Date.now()
リリース直後にのみ効くキャッシュバスターの導入
ここで、この文中の「Ext.Date.now()」をリリース時刻などに置き換えてやれば良い。この処理は本番リリースを行う際に使用するであろうJenkinsなどのCIツール内で行えると良い。別途、この置換を行うスクリプトを用意しておいて、それをデプロイ手順に組み込むのである。
もしCIツールを使用していなかったりする場合は、リリース時の手順の中にそのスクリプトを実行する手順を組み込んでおけば良い。
もちろん「Ext.Date.now()」という文字列をそのまま検索して引っ掛けて「yyyyMMddHHmmss」のような形式のリリース時刻(ビルドorデプロイ時刻)にするとext.jsの他の箇所にも当たってしまうため、上記の記述をそのまま検索対象とし、末尾の「Ext.Date.now()」のみ書き換えることになる。
その他のjs/cssのキャッシュバスター
本記事には直接関係はないが、この「リリース時刻をjs/cssファイルの末尾に付ける」ということは、他のすべてのjs/cssファイルに対してリリース時に行っている。
デプロイ時にhtmlファイルなどを読み込み、js/cssを読み込む記述を見つけたらその末尾にデプロイ時刻を付与しているのである。
我ながらかなり強引な方法であるが、今のところうまく動作している。
他の方法では、jsファイルなどを読み込む記述(scriptタグ)をjspなどに書いて、キャッシュバスターに使用する文字列を日まで(yyyyMMddまで)にしておいたり、リリースバージョンIDのようなものを定義しておいてそれを使用する、という方法があるようである。
この場合は上記のようにリリース物件に文字列置換を行うようなことはしないで済む。
<script type="text/javascript" src="xxx.js<?= versionId ?>"></script>
みたいな感じでくっつけるのである。
しかし、日を使用している場合はリリースを朝一番に行い、誰もその日のyyyyMMddでファイルを取得していないことが条件となりそうである。そうでないとその日一杯はキャッシュ済みのリリース前のファイルを使用してしまいかねない。
Ext JS 4の書籍は次がオススメです。

