JavaScript中模块化工具require.js

时间 2019-11-11

标签 javascript 模块化工具 require.js require 栏目 JavaScript 繁體版

原文原文链接

什么是require.js?javascript

RequireJS是一个很是小巧的JavaScript模块载入框架，是AMD规范最好的实现者之一。它还同时能够和其余的框架协同工做，使用RequireJS必将使您的前端代码质量得以提高。html

使用require.js带来的好处前端

一、防止JavaScript加载阻塞页面渲染（由于它遵循AMD【异步模块加载机制】规范）；java

二、使用程序调用的方式加载js，防止出现以下丑陋的场景：jquery

<script type="text/javascript" src="a.js"></script>
<script type="text/javascript" src="b.js"></script>
<script type="text/javascript" src="c.js"></script>
<script type="text/javascript" src="d.js"></script>
<script type="text/javascript" src="e.js"></script>
<script type="text/javascript" src="f.js"></script>
<script type="text/javascript" src="g.js"></script>
<script type="text/javascript" src="h.js"></script>
<script type="text/javascript" src="i.js"></script>
<script type="text/javascript" src="j.js"></script>

开始使用require.jsajax

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8" />
        <title></title>
    </head>
    <body>
        <p>AMD test</p>
        <script type="text/javascript" src="js/require.js" data-main = "./main.js"></script>
    </body>
</html>


//main.js(和html同个文件夹)
require(['./js/a.js'],function(a){
    var date = new Date();
    a.printDate(date);
})

//a.js
define(['./a-util.js'],function(aUtil){
    var a = {
        printDate:function(date){
            console.log(aUtil.aGetFormatDate(date));
        }
    }
    return a;
})

//a-util.js
define(['./util.js'],function(util){
    var aUtil = {
        aGetFormatDate:function(date){
            return util.getFormatDate(date,2);
        }
    }
    return aUtil;
})

//util.js
define(function(){
    var util = {
        getFormatDate:function(date,type){
            if(type === 1){
                return "2017-11-09";
            }else{
                return "2017年11月9日";
            }
        }
    }
    return util;
})

require.js中的基本API服务器

require会定义三个变量：框架

define 用来定义一个模块；jquery插件

require 加载依赖模块，并执行加载完后的回调函数。require API的第二个参数是callback，一个function，是用来处理加载完毕后的逻辑，如：异步

require(["js/a"],function(){
    alert("load finished");
})

requirejs，其中require === requirejs，通常使用require更简短。

require.js加载文件

以前的例子中加载模块都是本地js，可是大部分状况下网页须要加载的JS可能来自本地服务器、其余网站或CDN，这样就不能经过这种方式来加载了，咱们以加载一个jquery库为例：

require.config({
    paths : {
        "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery"]   
    }
})
require(["jquery","js/a"],function($){
    $(function(){
        alert("load finished");  
    })
})

require.config是用来配置模块加载位置，简单点说就是给模块起一个更短更好记的名字，好比将百度的jquery库地址标记为jquery，这样在require时只须要写["jquery"]就能够加载该js，本地的js咱们也能够这样配置：

require.config({
    paths : {
        "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery"],
        "a" : "js/a"   
    }
})
require(["jquery","a"],function($){
    $(function(){
        alert("load finished");  
    })
})

经过paths的配置会使咱们的模块名字更精炼，paths还有一个重要的功能，就是能够配置多个路径，若是远程cdn库没有加载成功，能够加载本地的库，如：

require.config({
    paths : {
        "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery", "js/jquery"],
        "a" : "js/a"   
    }
})
require(["jquery","a"],function($){
    $(function(){
        alert("load finished");  
    })
})

这样配置后，当百度的jquery没有加载成功后，会加载本地js目录下的jquery

使用require.js注意事项

一、在使用requirejs时，加载模块时不用写.js后缀的，固然也是不能写后缀；

二、上面例子中的callback函数中发现有$参数，这个就是依赖的jquery模块的输出变量，若是你依赖多个模块，能够依次写入多个参数来使用：

require(["jquery","underscore"],function($, _){
    $(function(){
        _.each([1,2,3],alert);
    })
})

三、若是某个模块不输出变量值，则没有，因此尽可能将输出的模块写在前面，防止位置错乱引起误解。

require.js全局配置

上面的例子中重复出现了require.config配置，若是每一个页面中都加入配置，必然显得十分不雅，requirejs提供了一种叫"主数据"的功能，咱们首先建立一个main.js：

require.config({
    paths : {
        "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery", "js/jquery"],
        "a" : "js/a"   
    }
})

而后在页面中使用下面的方式来使用requirejs：

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

加载requirejs脚本的script标签加入了data-main属性，这个属性指定的js将在加载完reuqire.js后处理，咱们把require.config的配置加入到data-main后，就可使每个页面都使用这个配置，而后页面中就能够直接使用require来加载全部的模块名。

data-main还有一个重要的功能，当script标签指定data-main属性时，require会默认的将data-main指定的js为根路径，是什么意思呢？如上面的data-main="js/main"设定后，咱们在使用require(['jquery'])后(不配置jquery的paths)，require会自动加载js/jquery.js这个文件，而不是jquery.js，至关于默认配置了。

require.js第三方模块

经过require加载的模块通常都须要符合AMD规范即便用define来申明模块，可是部分时候须要加载非AMD规范的js，这时候就须要用到另外一个功能：shim，shim解释起来也比较难理解，shim直接翻译为"垫"，其实也是有这层意思的，目前主要用在如下两个地方。

1. 非AMD模块输出，将非标准的AMD模块"垫"成可用的模块，例如：在老版本的jquery中，是没有继承AMD规范的，因此不能直接require["jquery"],这时候就须要shim，好比我要是用underscore类库，可是他并无实现AMD规范，那咱们能够这样配置：

require.config({
    shim: {
        "underscore" : {
            exports : "_";
        }
    }
})

这样配置后，咱们就能够在其余模块中引用underscore模块：

require(["underscore"], function(_){
    _.each([1,2,3], alert);
})

2.插件形式的非AMD模块，咱们常常会用到jquery插件，并且这些插件基本都不符合AMD规范，好比jquery.form插件，这时候就须要将form插件"垫"到jquery中：

require.config({
    shim: {
        "underscore" : {
            exports : "_";
        },
        "jquery.form" : {
            deps : ["jquery"]
        }
    }
})

也能够简写为：

require.config({
    shim: {
        "underscore" : {
            exports : "_";
        },
        "jquery.form" : ["jquery"]
    }
})

这样配置以后咱们就可使用加载插件后的jquery了

require.config(["jquery", "jquery.form"], function($){
    $(function(){
        $("#form").ajaxSubmit({...});
    })
})