JS模块化编程以及AMD、CMD规范、Webpack

2023-02-17 13:55:12 浏览数 (1)

提示

由于CommonJS和AMD都十分流行，但似乎缺少一个统一的规范。于是，UMD(通用模块规范)出现了，它可以同时支持这两种风格。

虽然这个模式的写法比较难看，但是，它同时兼容了AMD和CommonJS，而且还支持老式的全局变量规范。

什么是JS模块化

先想一想，为什么模块很重要？

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

因为有了模块，我们就可以更方便地使用别人的代码，想要什么功能，就加载什么模块。

但是，这样做有一个前提，那就是大家必须以同样的方式编写模块，否则你有你的写法，我有我的写法，岂不是乱了套！考虑到Javascript模块现在还没有官方规范，这一点就更重要了。

CommonJS和AMD。

在CommonJS中，有一个全局性方法require()，用于加载模块。假定有一个数学模块math.js，就可以像下面这样加载。

代码语言：javascript复制
var math = require('math');

然后，就可以调用模块提供的方法：

代码语言：javascript复制
var math = require('math');
math.add(2,3); // 5

但是，由于一个重大的局限，使得CommonJS规范不适用于浏览器环境。还是上一节的代码，如果在浏览器中运行，会有一个很大的问题。

第二行math.add(2, 3)，在第一行require('math')之后运行，因此必须等math.js加载完成。也就是说，如果加载时间很长，整个应用就会停在那里等。

这对服务器端不是一个问题，因为所有的模块都存放在本地硬盘，可以同步加载完成，等待时间就是硬盘的读取时间。但是，对于浏览器，这却是一个大问题，因为模块都放在服务器端，等待时间取决于网速的快慢，可能要等很长时间，浏览器处于"假死"状态。

因此，浏览器端的模块，不能采用"同步加载"（synchronous），只能采用"异步加载"（asynchronous）。这就是AMD规范诞生的背景。

AMD是"Asynchronous Module Definition"的缩写，意思就是"异步模块定义"。它采用异步方式加载模块，模块的加载不影响它后面语句的运行。所有依赖这个模块的语句，都定义在一个回调函数中，等到加载完成之后，这个回调函数才会运行。

AMD也采用require()语句加载模块，但是不同于CommonJS，它要求两个参数：

代码语言：javascript复制
require([module], callback);

第一个参数[module]，是一个数组，里面的成员就是要加载的模块；第二个参数callback，则是加载成功之后的回调函数。如果将前面的代码改写成AMD形式，就是下面这样：

代码语言：javascript复制
require(['math'], function (math) {
     math.add(2, 3);
});

math.add()与math模块加载不是同步的，浏览器不会发生假死。所以很显然，AMD比较适合浏览器环境。把指定的代码限定在了某个作用域内，在全局作用域内只有一个提供调用的对象（如common.js通过引入的模块）。

目前，主要有两个Javascript库实现了AMD规范：require.js和curl.js。本系列的第三部分，将通过介绍require.js，进一步讲解AMD的用法，以及如何将模块化编程投入实战。

原文：http://www.ruanyifeng.com/blog/2012/11/require_js.html

require.js的用法

最早的时候，所有Javascript代码都写在一个文件里面，只要加载这一个文件就够了。后来，代码越来越多，一个文件不够了，必须分成多个文件，依次加载。下面的网页代码，相信很多人都见过。

代码语言：javascript复制
<script src="1.js"></script>
<script src="2.js"></script>
<script src="3.js"></script>
<script src="4.js"></script>
<script src="5.js"></script>
<script src="6.js"></script>

这段代码依次加载多个js文件。

这样的写法有很大的缺点。首先，加载的时候，浏览器会停止网页渲染，加载文件越多，网页失去响应的时间就会越长；其次，由于js文件之间存在依赖关系，因此必须严格保证加载顺序（比如上例的1.js要在2.js的前面），依赖性最大的模块一定要放到最后加载，当依赖关系很复杂的时候，代码的编写和维护都会变得困难。

require.js的诞生，就是为了解决这两个问题：

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

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

require.js的加载

使用require.js的第一步，是先去官方网站下载最新版本，下载后，假定把它放在js子目录下面，就可以加载了。

参考：http://www.ruanyifeng.com/blog/2012/11/require_js.html

ES6的模块化

import、<script type="module"></script>

Webpack

webpack它解决的最重要的问题就是这样一个问题，我们用写后端语言的方式写前端的代码，webpack可以做到动态的把后端的代码变成浏览器能够读懂的代码。即把后端代码前端化。这是最主要的。

参考：https://www.jianshu.com/p/fb479435eba0

Require.js的使用

Require提供的全局变量和方法：

define  是用来定义一个模块，只有实现了模块定义的JS文件才支持被require加载。

代码语言：javascript复制
define([可选模块名],function() {
    function query(selector,context) {
             //成员变量...
             //成员方法（闭包）
    }  
    return query;   //把query函数对象暴露出去，作为唯一的调用接口。
});

模块定义时如果指定了模块名称，这个模块就是有主的；否则就是无主的。

加载有命名的模块，例如require.config设置paths时jquery模块名必须设置jquery，如果设置成其他的，加载时会提示jquery没有定义。

require 加载依赖模块，并执行加载完后的回调函数（加载模块后会执行模块里的代码，返回值可作为回调函数的参数提供调用）;它的参数必须是一个数组。

代码语言：javascript复制
//require(JS模板文件路径 / 定义的别名，加载成功的回调函数) ; 
require(["a"]，function(){ 
    alert("load finished");  
});

//未定义config，加载页面目录下的a.js

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

代码语言：javascript复制
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");  
    })
})

通过paths的配置会使我们的模块名字更精炼，paths还有一个重要的功能，就是可以配置多个路径，如果远程cdn库没有加载成功，可以加载本地的库；

代码语言：javascript复制
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模块的输出变量，如果你依赖多个模块，可以依次写入多个参数来使用：

代码语言：javascript复制
require(["jquery","underscore"],function($, _){
    $(function(){
        _.each([1,2,3],alert);
    })
})

如果某个模块不输出变量值，则没有，所以尽量将输出的模块写在前面，防止位置错乱引发误解

config的其他用法，定义模块加载的根路径

代码语言：javascript复制
require.config({
    baseUrl : "js"
})

全局配置

代码语言：javascript复制
<script data-main="js/main" src="js/require.js"></script>

加载 requirejs 脚本的 script 标签加入了data-main属性，这个属性指定的 js 将在加载完 require.js 后处理，我们把require.config的配置加入到data-main后，就可以使每一个页面都使用这个配置，然后页面中就可以直接使用require来加载所有的短模块名；config可以在该js中定义；同时可作为程序的执行入口；

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

依赖非AMD规范的模块如果没用define(...) 定义模块，比如hello.js：

代码语言：javascript复制
function sayHello() {
     alert("hello");
}

我们要使用shim ，将某个依赖中的某个全局变量暴露给requirejs，当作这个模块本身的引用。

代码语言：javascript复制
requirejs.config({
  baseUrl: '/js',
  paths: {
    hello: 'hello' //设置模块路径
  },
  shim: {
    hello: {
       //deps:[], deps表示当前模块的依赖模块
       exports: 'sayHello'
     } //设置模块要暴露的变量
  }
});
 
requirejs(['hello'], function(sayHello) {
  sayHello();
});

如果要同时暴露多个变量，要用init函数。exports和init如果同时存在，会忽略exports。

比如hello.js改成如下：

代码语言：javascript复制
function sayHello1() {
  alert("hello");
}
function sayHello2() {
  alert("hello");
}
代码语言：javascript复制
requirejs.config({
  baseUrl: '/js',
  paths: {
    hello: 'hello' //设置模块路径
  },
  shim: {
    hello: {
        init: function() {
	    return {
	        sayHello1: sayHello1,
	        sayHello2: sayHello2
	    }
	}
    }
  }
});
 
requirejs(['hello'], function(hello) {
  hello.sayHello1();
});

使用问题总结

  1. 引入require.js后，后续的js文件通过script标签加载时会出现无法正常使用的情况。
  2. 对于不知道是否遵守了amd标准的模块，可引入后打印一下，看一下引入后传递的是什么。
jquery javascript 编程算法

0 人点赞