【requirejs】JS模块化工具requirejs教程

时间 2019-11-08

原文原文链接

初识requirejs

随着网站功能逐渐丰富，网页中的js也变得愈来愈复杂和臃肿，原有经过script标签来导入一个个的js文件这种方式已经不能知足如今互联网开发模式，咱们须要团队协做、模块复用、单元测试等等一系列复杂的需求。javascript

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

requirejs能带来什么好处

官方对requirejs的描述：前端

RequireJS is a JavaScript file and module loader. It is optimized for in-browser use, but it can be used in other JavaScript environments, like Rhino and Node. Using a modular script loader like RequireJS will improve the speed and quality of your code.java

大体意思：jquery

在浏览器中能够做为js文件的模块加载器，也能够用在Node和Rhino环境，balabala...。这段话描述了requirejs的基本功能"模块化加载"，什么是模块化加载？咱们要从以后的篇幅中一一解释ajax

先来看一段常见的场景，经过示例讲解如何运用requirejsapi

正常编写方式

index.html:数组

<!DOCTYPE html>
<html>
    <head>
        <script type="text/javascript" src="a.js"></script>
    </head>
    <body>
      <span>body</span>
    </body>
</html>

a.js:浏览器

function fun1(){
  alert("it works");
}

fun1();

可能你更喜欢这样写服务器

(function(){
    function fun1(){
      alert("it works");
    }

    fun1();
})()

第二种方法使用了块做用域来申明function防止污染全局变量，本质仍是同样的，当运行上面两种例子时不知道你是否注意到，alert执行的时候，html内容是一片空白的，即<span>body</span>并未被显示，当点击肯定后，才出现，这就是JS阻塞浏览器渲染致使的结果。

requirejs写法

固然首先要到requirejs的网站去下载js -> requirejs.org
index.html:

<!DOCTYPE html>
<html>
    <head>
        <script type="text/javascript" src="require.js"></script>
        <script type="text/javascript">
            require(["a"]);
        </script>
    </head>
    <body>
      <span>body</span>
    </body>
</html>

a.js:

define(function(){
    function fun1(){
      alert("it works");
    }

    fun1();
})

浏览器提示了"it works"，说明运行正确，可是有一点不同，此次浏览器并非一片空白，body已经出如今页面中，目前为止能够知道requirejs具备以下优势：

防止js加载阻塞页面渲染
使用程序调用的方式加载js，防出现以下丑陋的场景

<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.js解决了两个问题：

　　（1）实现js文件的异步加载，避免网页失去响应；

　　（2）管理模块之间的依赖性，便于代码的编写和维护。

基本知识

基本API

require会定义三个变量：define,require,requirejs，其中require === requirejs，通常使用require更简短

define 从名字就能够看出这个api是用来定义一个模块
require 加载依赖模块，并执行加载完后的回调函数

前一篇中的a.js：

define(function(){
    function fun1(){
      alert("it works");
    }

    fun1();
})

经过define函数定义了一个模块，而后再页面中使用：

require(["js/a"]);

来加载该模块(注意require中的依赖是一个数组，即便只有一个依赖，你也必须使用数组来定义)，require API的第二个参数是callback，一个function，是用来处理加载完毕后的逻辑，如：

require(["js/a"],function(){
    alert("load finished");
})
require()异步加载模块，浏览器不会失去响应；它指定的回调函数，只有前面的模块都加载成功后，才会运行，解决了依赖性的问题。

加载文件

以前的例子中加载模块都是本地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，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

在使用requirejs时，加载模块时不用写.js后缀的，固然也是不能写后缀
上面例子中的callback函数中发现有$参数，这个就是依赖的jquery模块的输出变量，若是你依赖多个模块，能够依次写入多个参数来使用：

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

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

全局配置

上面的例子中重复出现了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 将在加载完 require.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.config({
    baseUrl : "js"
})

第三方模块

经过require加载的模块通常都须要符合AMD规范即便用define来申明模块，具体来讲，AMD规范就是模块必须采用特定的define()函数来定义。若是一个模块不依赖其余模块，那么能够直接定义在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);
})

插件形式的非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({...});
    })
})

requireJS使用步骤

一、引入requireJS

nuget下载requirejs，在body中经过<script>引入

在require.js 加载完毕时，会自动去加载配置文件 main.js。

二、基本参数配置

//main.js

require.config({

baseUrl:’’, //定义基准目录

paths:{ //key/value，key=模块id（本身定义），value=js文件名(不须要.js)

}

})

三、定义模块

咱们之后所编写的代码或者是某段功能，都是要放在一个个定义好的模块中。
下面是requireJS定义模块的方法格式：

define([id,deps,] callback);

ID:模块的ID，默认的即是文件名，通常无需使用者本身手动指定。
deps:当前模块全部依赖的模块数组，数组的每一个数组元素即是模块名或者叫模块ID。
callback:模块的回调方法，用于保存模块具体的功能与代码，而这个回调函数又接收一个或者多个参数，这些参数会与模块数组的每一个数组元素一一对应，即每一个参数保存的是对应模块返回值。

返回结果能够是一个对象，也能够是一个函数。

方式：return

根据 define() 使用时参数数量的不一样，能够定义如下几种模块类型：

一、简单键值对

当所要定义的模块没有任何依赖也不具备任何的功能，只是单纯的返回一组键值对形式的数据时，即可以直接将要返回的数据对象写在 define方法中：

//define1.js

//模块定义1，无依赖无功能函数

define({

    'color': 'red',

    'size': '13px',

    'width': '100px'

});

这种只为保存数据的模块，咱们称之为“值对”模块

使用（加载模块）

//app.js

//配置

require.config({

    baseUrl: 'Scripts/',

    paths: {

        "jquery": "jquery-3.3.1",

        "define1": "app/define1",

        "define2": "app/define2",

        "define3": "app/define3",

    }

})

//加载模块1

require(['define1'], function (define1) {

    for (var prop in define1) {

        if (define1.hasOwnProperty(prop)) {

            console.log('key =' + prop + ' and value = ' + define1[prop]);

        }

    }  

})

二、非依赖的函数式定义

若是一个模块没有任何的依赖，只是单纯的执行一些操做，那么即可以直接将函数写在 define方法中

//define2.js

//模块定义2，无依赖 但功能函数,返回一个对象

define(function () {

    return {

        'color': 'red',

        'size': '13px',

    }

})

使用（加载模块）

require(['define1', 'define2'], function (define1, define2) {

    console.log("define1");

    for (var prop in define1) {

        if (define1.hasOwnProperty(prop)) {

            console.log('key =' + prop + ' and value = ' + define1[prop]);

        }

    }

    console.log("define2");

    for (var prop in define2) {

        if (define2.hasOwnProperty(prop)) {

            console.log('key =' + prop + ' and value = ' + define2[prop]);

        }

    }

})

三、依赖的函数式定义

这种带有依赖的函数式模块定义，也是咱们平时经常使用到的，

//define3.js

//模块定义3，依赖的函数式定义  但功能函数,返回一个对象

define(['jquery','define2'],function ($,define2) {

    obj= {

        'color': 'red',

        'size': '13px',

    }

    $(function () {

        console.log(obj.color);

        console.log(define2.size);

    })

   // console.log(define2.size);  //放这里 会在一开始就输出，

})

使用（加载模块）

//app.js

//配置

require.config({

    baseUrl: 'Scripts/',

    paths: {

        "jquery": "jquery-3.3.1",

        "define1": "app/define1",

        "define2": "app/define2",

        "define3": "app/define3",

    }

})

require(['define1', 'define2', 'define3'], function (define1, define2, define3) {

    console.log("define1");

    for (var prop in define1) {

        if (define1.hasOwnProperty(prop)) {

            console.log('key =' + prop + ' and value = ' + define1[prop]);

        }

    }

    console.log("define2");

    for (var prop in define2) {

        if (define2.hasOwnProperty(prop)) {

            console.log('key =' + prop + ' and value = ' + define2[prop]);

        }

    }

    console.log("define3");

})

四、载入模块

格式require(deps,[callback]);

deps:所要载入的模块数组。
callback:模块载入后执行的回调方法。

模块以前由于有依赖，故不用载入全部模块，载入一个的时候，会自动载入其所依赖的模块（这个定义模块里面有依赖关系）

callBcak定义和定义模块时的回调函数相似。。

更多参考：
阮一峰 require.js的用法
RequireJS中文网