RequireJs的一些概念和用法

概念

JavaScript语言本身是没有模块化的概念的,但是我们可以借助requirejs这个模块化工具,实现js代码的模块化。requirejs的作用,就是将项目中的代码,都写成模块化的东西,模块之间又可以相互依赖,让整个项目的可读性,可维护性变得更好,同时又减少了全局污染。

在使用requirejs之前,最好了解一下AMD(异步模块定义)规范和CMD规范。我在学习之前并没有去了解他们之间的区别,导致我在学习的过程中非常懵。

AMD规范:https://github.com/amdjs/amdjs-api/wiki/AMD

CMD规范:https://github.com/seajs/seajs/issues/242

目前遵循AMD规范的就是RequireJs,而CMD规范对应的有SeaJs,但AMD规范在写法上也是支持CMD的一些写法的,在这里纠结了一点时间,后边提。

为什么要使用RequireJs

我们在网页中,如果需要加载很的js文件,传统的写法是:

<script src="1.js"></script>

<script src="2.js"></script>

......

在加载js文件的时候,浏览器会停止渲染,将需要加载的文件变得非常多时,浏览器可能就停止响应。其次,当一个a.js文件依赖于另一个b.js文件的时候,需要将b.js文件放在前面,先于a.js加载,当依赖增多时,要处理起来就会很复杂。

RequireJs就是为了解决这些问题的。

一、如何引入RequireJs

去官网下载http://www.requirejs.org/后,假如将require.js文件放在与index.html同级目录的情况下,index.html的script标签按如下方式引入:

<script src="./require.js" defer async="true"></script>

async表示这个也使用异步加载,避免在加载它的时候,网页失去响应,ie浏览器不支持,所以,加个defer属性。

要使用requirejs加载文件,使用data-main属性指定入口文件main.js:

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

二、使用

配置规则

在main.js中,需要指定一些requirejs的配置规则,使用require.config()方法,我们可以对requirejs的规则配置,这个方法以对象的方式接收配置属性。

baseUrl定义加载文件的基准目录,如果不指定的情况下,默认加载上述的index.html所在的目录为根目录。

path属性保存模块的键/值,其中key是模块的名称,value则是模块的地址,不需要添加.js后缀。该地址会与baseuUrl中的基准目录进行拼接,所以,如果不需要拼接的话,使用"/"、“https://”、".js"来规避与baseUrl的拼接规则。

require.config({

    baseUrl: "./js",

    path: {

        jquery: "http://xxx.xxxx.com/js/jquery.min",

        hello: "hello"

    }

})

配置规则的引入方式

requirejs的配置文件有两种方式,一是以<script>标签内嵌到html文件中,另一种则是以js文件加载的方式独立引入。

而独立引入的方式也有两种

以js标签加载外部文件引入:

<script src="require.js"></script>

<script src="config.js"></script>

以data-main属性引入,通过data-main去加载入口文件,会使得baseUrl指向config.js所在文件的目录。

<script data-main="config.js" src=“require.js”></script>

当你的项目足够大时,推荐将入口文件单独配置成一个模块,根据不同的业务去加载不同的配置文件:


RequireJs常用的命令是define和require,define定义模块,require引入模块。

define格式如下

define(id?, dependencies?, factory)

id是模块的名字,是一个可选参数

dependencies是该模块的依赖元素,指定所依赖的列表,是一个数组元素。可以作为参数传递到factory函数中去,当没有指定依赖的话,默认是“require”,"exports","module"。


require格式如下:

require(array,function)

array是依赖的对象的数组,function是一个回调函数,在依赖加载完成后执行。比如,我们可以通过

require("app",function(app) {

    app.method()

})

来引入app模块,并执行app模块里边的方法。对于依赖的模块,AMD推荐依赖前置,CMD推荐依赖就近,依赖前置如下,提前加载好所需要的依赖:


下图采用的是依赖就近的模式,在需要使用的地方,通过require加载对应的模块。

在AMD中,是支持依赖就近的写法的,所以,requirejs中,以上两种方式都能执行。但是,requirejs官方文档中,默认都是采用依赖前置的写法。

你可能可以注意到,define和require这2个api,都可以引入依赖模块,那他们的区别在哪里呢?

define定义的模块可以以return或者export的方式,返回一个模块对象供别的模块调用,而require不需要返回对象。

说道这个return,那么,define的模块是以什么方式返回模块对象呢?请看下边的模块返回值。

模块的返回值

return方式

// 在helo.js中这样子定义一个模块,并返回一个函数

define(function(require, exports, modules) {

    var sayHello = function(params) {

        console(params)

}

    return sayHello

})

// 在index.js中,引入helo.js并运行里边的方法

define(function(require, exports, module) {

        var sayHello = require("helo")

        sayHello.sayHello("hello")

})

exports方式


// 在helo.js中这样子定义一个模块,并通过exports返回一个函数

define(function(require, exports, module) {

    exports.sayHello = function(params) {

        consloe.log(params)

    }

})

// 在index.js中,引入helo.js并运行里边的方法

define(function(require, exports, module) {

        var sayHello = require("helo")

        sayHello.sayHello("hello")

})

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容