web-dev-qa-db-ja.com

requireJSとjQueryを一緒に使用するにはどうすればよいですか？

RequireJSを使用したいのですが、jQueryを使用しています。私は最新のjQueryバージョンを使用していないため、requireJSとjQueryの組み合わせバージョンを使用したくありません。 requireJSを使用する最良の方法は何ですか？

jqueryrequirejs
81
Naor

それも私の正確な質問です！また、古いjQueryを使用する必要がありますが、より「伝統的な」javascriptライブラリも使用する必要があります。それを行うための最良のテクニックは何ですか？ （気にしない場合は、質問をより広くするために編集する場合があります。）ここで学んだことは次のとおりです。

RequireJSの作成者であるJames Burkeは、 RequireJSとjQueryファイルを組み合わせた利点 について説明しました。あなたは2つのものを得ます。

  1. モジュールjqueryが使用可能であり、それがjQueryオブジェクトです。これは安全です：

    _// My module depends on jQuery but what if $ was overwritten?
define(["jquery"], function($) {
  // $ is guaranteed to be jQuery now */
})
_

  2. jQueryは、require()またはdefine()の前にすでにロードされています。すべてのモジュールはjQueryの準備ができていることが保証されています。 jQueryは基本的に最初にロードするようにハードコードされているため、_require/order.js_プラグインも必要ありません。

私にとって、＃2はあまり役に立ちません。ほとんどの実際のアプリケーションには、many_.js_ファイルがあり、must正しい順序でロードされます。 SammyまたはUnderscore.jsが必要になるとすぐに、RequireJSとjQueryを組み合わせたファイルは役に立ちません。

私の解決策は、「order」プラグインを使用して従来のスクリプトをロードする単純なRequireJSラッパーを作成することです。

例

アプリにこれらのコンポーネントがある（依存関係により）と仮定します。

  • 私のアプリ、greatapp
    • greatappはカスタムjqueryに依存しています（古いバージョンを使用する必要があります）
    • greatappは、my_sammy（SammyJSと、使用する必要があるすべてのプラグイン）に依存しています。これらは順番に並んでいる必要があります
      1. my_sammyはjqueryに依存しています（SammyJSはjQueryプラグインです）
      2. my_sammyはsammy.jsに依存しています
      3. my_sammyはsammy.json.jsに依存しています
      4. my_sammyはsammy.storage.jsに依存します
      5. my_sammyはsammy.mustache.jsに依存しています

私の考えでは、_.js_で終わる上記のものはすべて「伝統的な」スクリプトです。 _.js_のないものはすべてRequireJSプラグインです。重要なのは、高レベルのもの（greatapp、my_sammy）はモジュールであり、より深いレベルでは、従来の_.js_ファイルにフォールバックすることです。

起動中

すべては、RequireJSに起動方法を指示するブータから始まります。

_<html>
  <head>
    <script data-main="js/boot.js" src="js/require.js"></script>
  </head>
</html>
_

_js/boot.js_には、設定とアプリケーションの起動方法のみを入れます。

_require( // The "paths" maps module names to actual places to fetch the file.
         // I made modules with simple names (jquery, sammy) that will do the hard work.
         { paths: { jquery: "require_jquery"
                  , sammy : "require_sammy"
                  }
         }

         // Next is the root module to run, which depends on everything else.
       , [ "greatapp" ]

         // Finally, start my app in whatever way it uses.
       , function(greatapp) { greatapp.start(); }
       );
_

主な用途

_greatapp.js_には、通常の外観のモジュールがあります。

_define(["jquery", "sammy"], function($, Sammy) {
  // At this point, jQuery and SammyJS are loaded successfully.
  // By depending on "jquery", the "require_jquery.js" file will run; same for sammy.
  // Those require_* files also pass jQuery and Sammy to here, so no more globals!

  var start = function() {
    $(document).ready(function() {
      $("body").html("Hello world!");
    })
  }

  return {"start":start};
}
_

従来のファイルを囲むRequireJSモジュールラッパー

_require_jquery.js_：

_define(["/custom/path/to/my/jquery.js?1.4.2"], function() {
  // Raw jQuery does not return anything, so return it explicitly here.
  return jQuery;
})
_

_require_sammy.js_：

_// These must be in order, so use the "order!" plugin.
define([ "order!jquery"
       , "order!/path/to/custom/sammy/sammy-0.6.2-min.js"
       , "order!/path/to/custom/sammy/plugins/sammy.json-0.6.2-min.js"
       , "order!/path/to/custom/sammy/plugins/sammy.storage-0.6.2-min.js"
       , "order!/path/to/custom/sammy/plugins/sammy.mustache-0.6.2-min.js"
       ]

       , function($) {
           // Raw sammy does not return anything, so return it explicitly here.
           return $.sammy;
         }
      );
_
128
JasonSmith

この質問は少なくとも2年前ですが、RequireJS 2.0の問題であることに気付きました（require-jquery.jsはjQuery 1.8.0を使用しますが、最新バージョンは1.8.2です）。

この質問が表示された場合は、require-jquery.jsがrequire.jsとjquery.jsになり、一緒にマッシュされていることに注意してください。 require-jquery.jsを編集し、jQueryパーツを新しいバージョンに置き換えるだけです。

更新（2013年5月30日）：RequireJSにパスとshimが追加されたため、jQueryおよびjQueryプラグインをインポートする新しい方法と、古いメソッドがありますもはや必要ありません 推奨 。現在のメソッドの簡略版は次のとおりです。

requirejs.config({
    "paths": {
      "jquery": "//ajax.googleapis.com/ajax/libs/jquery/2.0.0/jquery.min"
    }
});

define(["jquery"], function($) {
    $(function() {
    });
});

詳細については、 http://requirejs.org/docs/jquery.html を参照してください。

32
Chris

最良のアプローチは、jQueryをRequireJSビルドの外に置くことです。

HTMLにjquery.min.jsを含めるだけです。次に、このようなものでjquery.jsファイルを作成します...

define([], function() {
    return window.$;
});
9
tkdave

JasonSmithの非常に役立つ、おそらくRequireJSのドキュメントよりも役立つことがわかりました。

ただし、個別にAJAX（小さな）定義宣言モジュール（ "require_jquery" "require_sammy"）のリクエストが発生しないように最適化する方法があります。r.jsがそれを行うと思われます。最適化の段階ではありますが、Path、BaseURIシステムと戦わないために、事前にそれを行うことができます。

index.html：

<html>
  <head>
    <script data-main="js/loader.js" src="js/require.js"></script>
  </head>
</html>

loader.js：

// We are going to define( dependencies by hand, inline.
// There is one problem with that through (inferred from testing):
// Dependencies are starting to load (and execute) at the point of declaring the inline
// define, not at the point of require(
// So you may want to nest the inline-defines inside require( 
// this is, in a way, short replacement for Order plug in, but allows you to use
// hand-rolled defines, which the Order plug in, apparently does not allow.

var jQueryAndShims = ['jquery']

if(window.JSON == null){
    jQueryAndShims.Push('json2')
    define(
        'json2'
        , ['js/libs/json2.min.js']
        , function() {
            return window.JSON
        }
    )
}
// will start loading the second we define it.
define(
    'jquery'
    , ['js/libs/jquery_custom.min.js']
    , function() {
        // we just pick up global jQuery here. 
        // If you want more than one version of jQuery in dom, read a more complicated solution discussed in
        // "Registering jQuery As An Async-compatible Module" chapter of
        // http://addyosmani.com/writing-modular-js/
        return window.jQuery 
    }
)

// all inline defines for resources that don't rely on other resources can go here.

// First level require(
// regardless of depends nesting in 'myapp' they will all start downloading 
// at the point of define( and exec whenever they want, 
// async in many browsers. Actually requiring it before the nested require makes
// sure jquery had *executed and added jQuery to window object* before
// all resolved depends (jquery plugins) start firing.
require(jQueryAndShims, function($) {

    // will start loading the second we define it.        
    define(
        'sammy_and_friends'
        , ['jquery','js/libs/jquery_pluginone.min.js','js/libs/jquery_plugintwo.min.js','js/libs/sammy.min.js']
        , function($) {
            // note, all plugins are unaltered, as they are shipped by developers.
            // in other words, they don't have define(.. inside.
            // since they augment global $ (window.jQuery) anyway, and 'jquery' define above picks it up
            // , we just keep on returning it.
            // Sammy is attached to $ as $.sammy, so returning just Sammy makes little sense
            return $
        }
    )

    // second level require - insures that Sammy (and other jQuery plugins) - 'sammy_and_friends' - is
    // loaded before we load Sammy plugins. I normally i would inline all sammy plugins i need 
    // (none, since i use none of them preferring jQuery's direct templating API
    // and no other Sammy plug in is really of value. )  right into sammy.js file. 
    // But if you want to keep them separate:
    require(['sammy_and_friends'], function() {

        // will start loading the second we define it.
        define(
            'sammy_extended'
            , ['sammy_and_friends','js/libs/sammy_pluginone.min.js','js/libs/sammy_plugintwo.min.js']
            , function($) {
                // as defined above, 'sammy_and_friends' actually returns (globall) jQuery obj to which
                // Sammy is attached.  So we continue to return $
                return $
            }
        )
        // will start loading the second we define it.
        define(
            'myapp'
            , ['sammy_extended', 'js/myapplication_v20111231.js'] 
            , function($, myapp_instantiator) {
                // note, myapplication may, but does not have to contain RequireJS-compatible define
                // that returns something. However, if it contains something like 
                // "$(document).ready(function() { ... " already it MAY fire before 
                // it's depends - 'sammy_extended' is fully loaded.
                // Insdead i recommend that myapplication.js returns a generator 
                // (app-object-generating function pointer)
                // that takes jQuery (with all loaded , applied plugins) 
                // The expectation is that before the below return is executed, 
                // all depends are loaded (in order of depends tree)
                // You would init your app here like so:
                return myapp_instantiator($)
                // then "Run" the instance in require( as shown below
            }
        )

        // Third level require - the one that actually starts our application and relies on
        // dependency pyramid stat starts with jQuery + Shims, followed by jQuery plugins, Sammy, 
        // followed by Sammy's plugins all coming in under 'sammy_extended'
        require(['jquery', 'myapp'], function($, myappinstance) {
            $(document).ready(function() {myappinstance.Run()})
        })
    }) // end of Second-level require
}) // end of First-level require

最後に、myapplication.js：

// this define is a double-wrap.
// it returns application object instantiator that takes in jQuery (when it's available) and , then, that
// instance can be "ran" by pulling .Run() method on it.
define(function() {
    // this function does only two things:
    // 1. defines our application class 
    // 2. inits the class and returns it.
    return function($) {
        // 1. defining the class
        var MyAppClass = function($) {
            var me = this
            this._sammy_application = $.sammy(function() {
                this.raise_errors = true
                this.debug = true
                this.run_interval_every = 300
                this.template_engine = null
                this.element_selector = 'body'
                // ..
            })
            this._sammy_application.route(...) // define your routes ets...
            this.MyAppMethodA = function(blah){log(blah)}  // extend your app with methods if you want
            // ...
             // this one is the one we will .Run from require( in loader.js
            this.Run = function() {
                me._sammy_application.run('#/')
            }
        }
        // 2. returning class's instance
        return new MyAppClass($) // notice that this is INITED app, but not started (by .Run) 
        // .Run will be pulled by calling code when appropriate
    }
})

この構造（RequireJSのOrderプラグインは大まかに置き換えられます（重複しますか？）.

JQueryを個別にロードすることには大きなボーナスもあります（通常100kになります）。サーバーでキャッシュを制御したり、jQueryをブラウザーのlocalStorageにキャッシュしたりできます。ここでAMD-Cacheプロジェクトをご覧ください https://github.com/jensarps/AMD-cache 次にdefine（ステートメントを変更して "cache！"を含める：そしてそれは（永久に:)）ユーザーのブラウザで動かなくなる。

define(
    'jquery'
    , ['cache!js/libs/jquery_old.min.js']
    , function() {
        // we just pick up global jQuery here. 
        // If you want more than one version of jQuery in dom, read a more complicated solution discussed in
        // "Registering jQuery As An Async-compatible Module" chapter of
        // http://addyosmani.com/writing-modular-js/
        return window.jQuery 
    }
)

JQuery 1.7.x +についての注意ウィンドウオブジェクトに自分自身をアタッチしないため、上記は変更されていないjQuery 1.7.x +ファイルでは機能しません。そこで、jquery **。jsをカスタマイズして、閉じる「}）（window）;」の前にこれを含める必要があります。

;window.jQuery=window.$=jQuery

コンソールに「jQuery undefined」エラーが表示される場合、使用しているjQueryバージョンがウィンドウにアタッチされていないことを示しています。

コードライセンス：パブリックドメイン。

開示：上記のJavaScriptは、より詳細な実動コードの言い換え（手作業による刈り込み）であるため、「擬似コード」の匂いがします。上記のコードは動作が保証されておらず、表示どおりに動作することはテストされていません。監査、テストします。セミコロンは、JS仕様ごとに必要ではなく、コードがなくても見栄えがよいため、意図的に省略されています。

3
ddotsenko

Jhsの答えに加えて、README.mdファイルの require-jquery githubページ の最新の指示を参照してください。 jquery/require.jsを組み合わせたファイルを使用する最も単純なアプローチと、別個のjquery.jsを使用する方法の両方について説明します。

1
Paul Beusterien