我想使用requireJS,我正在使用jQuery。 我不想使用requireJS和jQuery的组合版本,因为我没有使用最新的jQuery版本。 使用requireJS的最佳方式是什么?
答案 0 :(得分:128)
这也是我的确切问题!我还必须使用较旧的jQuery,还有更“传统”的javascript库。这样做的最佳技巧是什么? (如果你不介意,我可以编辑你的问题,使其更广泛。)这是我学到的。
RequireJS作者James Burke解释了advantages of the combined RequireJS + jQuery file。你得到两件事。
模块jquery
可用,它是jQuery对象。这很安全:
// My module depends on jQuery but what if $ was overwritten?
define(["jquery"], function($) {
// $ is guaranteed to be jQuery now */
})
jQuery已经在任何require()
或define()
之前加载。所有模块都保证jQuery已准备就绪。你甚至不需要require/order.js
插件,因为jQuery基本上是硬编码的,首先加载。
对我来说,#2不是很有帮助。大多数真正的应用程序都有许多 .js
个文件,必须以正确的顺序加载 - 悲伤却是真的。只要你需要Sammy或Underscore.js,组合的RequireJS + jQuery文件就无济于事。
我的解决方案是编写简单的RequireJS包装器,使用“订单”插件加载我的传统脚本。
假设我的应用程序具有这些组件(依赖性)。
在我看来,以.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};
}
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;
}
);
答案 1 :(得分:32)
这个问题现在至少已有两年了,但我注意到这仍是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有路径和垫片,有一种新方法可以导入jQuery和jQuery插件,不再需要旧方法,也不需要recommended。这是当前方法的删节版本:
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。
答案 2 :(得分:9)
我发现最好的方法是将jQuery保留在RequireJS构建之外。
只需在HTML中包含jquery.min.js即可。然后,用这样的东西制作一个jquery.js文件......
define([], function() {
return window.$;
});
答案 3 :(得分:3)
发现JasonSmith非常有帮助,可能比RequireJS的文档更有帮助。
但是,有一种方法可以对其进行优化,以避免为(微小的)定义声明模块(“require_jquery”“require_sammy”)提供单独的AJAX请求。我怀疑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插件,但是)允许你修剪AJAX所需的文件数量,为依赖和依赖树的定义添加更多控制。
单独加载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.jQuery=window.$=jQuery
如果你在控制台中有“jQuery undefined”错误,那么你正在使用的标志jQuery版本并没有附加到窗口。
代码许可:公共领域。
披露: 上面的JavaScript有“伪代码”的味道,因为它是更详细的生产代码的释义(手工修剪)。上述代码不保证可以正常工作,并且未按照提供的方式进行测试。审核,测试一下。 分号是故意省略的,因为根据JS规范它们不是必需的,没有它们代码看起来更好。
答案 4 :(得分:1)
除了jhs的回答,请参阅README.md文件中require-jquery github page的最新说明。它涵盖了使用组合jquery / require.js文件的最简单方法,以及如何使用单独的jquery.js。