jQuery逆引きリファレンス

jQuery逆引きリファレンス

jQuery1.x/2.xで作成したアプリをjQuery 3に対応させるには?

2016年8月15日

2016年6月、jQuery 3.0が正式リリースされた。今後は、従来バージョンのjQueryを使った既存のサイト/ページを、最新のバージョン3に徐々に移行していこう。移行ライブラリ「jQuery Migration」を使った方法を解説する。

  • このエントリーをはてなブックマークに追加

 2006年8月に1.0がリリースされてから10年となる2016年6月、メジャーバージョンアップとなるjQuery 3.0がリリースされました。従来、jQueryでは以下のバージョンが並行して開発されていました。

  • 1.x: 互換性重視(Internet Explorer 8以前もサポート)
  • 2.x: 軽量化優先(モダンブラウザーのみをサポート)

 しかし、マイクロソフトがInternet Explorer 8以前のサポートを終了したことで、新しいjQuery 3では以下のモダンブラウザーのみをサポートすることになります。

  • Chrome/Firefox/Edge/Safari: 最新安定版と、その1つ前のバージョン
  • Internet Explorer: 9以上
  • Opera: 最新安定版のみ
  • Android(標準ブラウザー): 4.0以上
  • iOS(Safari): 7以上

 jQuery 3のリリースに伴い、今後はjQuery 1.x/2.x系についても新機能の追加などは行われませんので注意してください。セキュリティフィックスは当面継続されるようですが、今後の開発では、対応すべきブラウザーとも相談しながら、徐々にjQuery 3に移行していくべきでしょう。

[Note]jQuery 3の構成

 jQuery 3では、従来のProduction版(圧縮版)、Development版(非圧縮版)に加えて、Slim版が提供されます。

  • Production版: https://code.jquery.com/jquery-3.0.0.min.js
  • Development版: https://code.jquery.com/jquery-3.0.0.js
  • Slim版: https://code.jquery.com/jquery-3.0.0.slim.min.js

 Slim版は、本来のjQueryからAjax、Effect、また、非推奨となった機能を除外して、サイズを低減したバージョンです。Production版の85KBytesに対して、Slim版は68KBytesとなります。

jQuery 3への移行

 jQuery 3はメジャーバージョンアップということで、(限定的であるとはいえ)破壊的な変更がいくつかなされています。以下に、主な変更点をまとめます*1

  • Strictモードのサポート
  • 非推奨のloadunloaderrorを削除(=onメソッドで代替)
  • 非推奨のcontextselectorメソッドを削除
  • readyイベントリスナーの非同期化
  • $.isNumericメソッドの動作変更
  • ECMAScript 2015のfor...ofループへの対応
  • カスタムセレクターの高速化

 実際、jQueryの公式ブログ(英語)でも「Despite the 3.0 version number, we anticipate that these releases shouldn't be too much trouble when it comes to upgrading existing code.」(3.0というバージョン番号にもかかわらず、われわれは既存のコードをアップグレードした際にもさほどのトラブルはないだろうと考えている)と述べられており、これまでのアプリが致命的に影響を被る状況は少ないでしょう。しかし、それでもメジャーバージョンアップともなれば思わぬトラブルの発生が気になるところ。そこで、jQueryでは、スムーズにjQuery 3に移行できるよう、jQuery Migrationと呼ばれる移行ライブラリを提供しています。

 jQuery Migrationを利用するには、以下のようにページでjQuery Migrateをインポートするだけです。jQuery MigrateはjQueryのプラグインなので、jQuery⇒jQuery Migrateの順でインポートしなければなりません。

HTML
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8" />
<title>jQuery TIPS</title>
</head>
<body>
<div id="list">
  <a href="http://re.buildinsider.net/web/jqueryref/index/icon.s.png">
    jQuery</a>
  <a href="http://re.buildinsider.net/web/angularjstips/index/icon.s.png">
    AngularJS</a>
  <a href="http://re.buildinsider.net/web/reacttips/index/icon.s.png">
    React</a>
</div>
<hr />
<img id="result"  />
<script src="https://code.jquery.com/jquery-3.0.0.min.js"></script>
<!--jQuery Migrateを有効化-->
<script src="https://code.jquery.com/jquery-migrate-3.0.0.min.js"></script>
<script>
$(function() {
  // 画像を取得できない場合はデフォルトの画像を表示
  $('#result').error(function() {
    $(this).attr('src', 'no_image.gif');
  })
  // 初期状態では最初のリンク先画像を表示
  .attr('src', $('#list a:first').attr('href'));

  // リンククリック時にhref属性の内容を<img>要素に反映
  $('#list a').click(function(e) {
    $('#result').attr('src', $(this).attr('href'));
    e.preventDefault(); // デフォルトの挙動をキャンセル
  });
});
</script>
</body>
</html>
jQuery Migrateを使ったコード(migrate.html)

「no_image.gif」ファイルは、こちらからダウンロードして同じ階層のフォルダーに配置しておく。

画像が正しく読み込めなかった場合に代替画像を表示
画像が正しく読み込めなかった場合に代替画像を表示

[React]をクリックするとこのように表示される。

 先述のように、errorイベントはjQuery 3で削除されていますが、jQuery Migrationを利用することで、1.x/2.xと同じく、正しく動作していることが確認できます。ちなみに、太字のコードをコメントアウト(もしくは削除)すると、コードは正しく動作しない――エラーとなることが確認できます。

非推奨コードを検出する

 このように、jQuery Migrationを利用することで、気軽にjQuery 3を導入できますが、もちろん、これはあくまで一時的な措置にすぎません。基本的には、非推奨/削除となったコードは修正し、純粋にjQuery 3が提供している機能だけでアプリが動作していくようにすべきでしょう。

 そして、非推奨/削除されたメソッドを利用しているコードを検出するためにも、jQuery Migrationは利用できます。ただし、その場合、Production版ではなく、Development版を利用してください。先ほどのリストであれば、太字の部分を以下のように書き換えます(「.min.js」を「.js」に)。

HTML
<script src="https://code.jquery.com/jquery-migrate-3.0.0.js"></script>
Development版のjQuery Migrationを利用

 これによって、ブラウザーの開発者ツール(コンソール)に問題となるコードを警告ログとして出力できます。先のサンプルの場合は、「JQMIGRATE: jQuery.fn.error() is deprecated」と表示されます。ログと、その詳細については、以下のページも参照してください。

 あとは、ログを見ながら問題となるコードを修正していくことで、効率的にjQuery 3に対応できます。警告が出なくなったら、jQuery Migrationを外して、jQuery 3単体でも問題なくコードが動作することを確認しておきましょう。

より古いコードのために

 ただし、jQuery 3向けのjQuery Migrationは、1.11.0/2.1.0以前のjQueryには対応していません。その場合は、いったん、jQuery 1.x/2.x系の最新版(執筆時点では1.12.4、2.2.4)に対応するよう、コードを修正していきましょう。

 これには、jQuery 1.x/2.xの最新版を導入した上で、jQuery 1.x/2.x向けのjQuery Migration(Development版)を適用します。

HTML
<script src="https://code.jquery.com/jquery-1.12.4.min.js"></script>
<script src="https://code.jquery.com/jquery-migrate-1.4.1.js"></script>
jQuery MigrationでjQuery 1.x/2.xの最新版に対応

 あとは警告ログが出なくなるまで、既存のコードを修正していきます。警告ログに関する詳細は、以下のページも参照してください。

 修正が完了したら、jQuery Migrationを外してアプリが問題なく動作することを確認します。これでjQuery 1.x/2.xの最新版への対応ができたはずなので、あとは、前項の手順に沿って、jQuery 3への対応を進めます。

 手順として表すと面倒にも感じるかもしれませんが、jQuery 3への移行は一般的にはそれほど難しいことではありません。積極的に移行を進めていきましょう!

処理対象:jQuery 3への移行 カテゴリ:コア
処理対象:jQuery Migrationプラグイン カテゴリ:コア

※以下では、本稿の前後を合わせて5回分(第49回~第53回)のみ表示しています。
 連載の全タイトルを参照するには、[この記事の連載 INDEX]を参照してください。

49. ラジオボタン/チェックボックス/選択ボックスの選択テキストを取得するには?(val)

valメソッドを使って選択テキストを取得する方法を、ラジオボタン/チェックボックス/選択ボックス/リストボックスなどフォーム要素ごとに説明する。

50. フォーム要素に対して値を設定するには?(val)

valメソッドを使ってフォーム要素の値を設定する方法を説明。また、利用上の注意点や、値をクリアする方法、応用例として全てのチェックボックスを選択/解除する方法も示す。

51. 【現在、表示中】≫ jQuery1.x/2.xで作成したアプリをjQuery 3に対応させるには?

2016年6月、jQuery 3.0が正式リリースされた。今後は、従来バージョンのjQueryを使った既存のサイト/ページを、最新のバージョン3に徐々に移行していこう。移行ライブラリ「jQuery Migration」を使った方法を解説する。

52. ページに新たな要素を挿入するには? ― insertBefore/insertAfter/prependTo/appendTo/before/after/prepend/appendメソッド

HTML文字列で要素を作成してから、指定した場所にそれを挿入する方法を解説。また結果は同じになるが少し手順を変えて、指定した場所にHTML文字列で要素を生成する方法を説明する。

53. 既存の要素を別の場所に移動するには? ― insertBefore/insertAfter/prependTo/appendToメソッド

既存の要素を、指定した要素の直前/直後/子要素先頭/子要素末尾の位置に移動する方法を説明する。

イベント情報(メディアスポンサーです)

Twitterでつぶやこう!


Build Insider賛同企業・団体

Build Insiderは、以下の企業・団体の支援を受けて活動しています(募集概要)。

ゴールドレベル

  • 日本マイクロソフト株式会社
  • グレープシティ株式会社