Requirejs初识

Posted 2020-06-30

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Requirejs初识相关的知识，希望对你有一定的参考价值。

随着网站功能的逐渐丰富，网页中js也越来越多，以往通过script标签引入的方式已经逐渐不能够满足互联网开发模式，因此requirejs可以为我们提供两种解决思路：

　　1 模块化组织JS

　　2 异步加载JS文件

　　有了这两种解决办法，能有效的帮助我们解决前端代码库的组织难题。

下面通过一个例子简单入门：

index.html

<!DOCTYPE html>
<html>
    <head>
        <script type="text/javascript" src="require.js"></script>
		<script>
		
			require.config({
				paths:{
					"jquery":["http://libs.baidu.com/jquery/2.0.3/jquery","js/jquery-1.11.3"],
					"a":"js/a"
				}
			})
		
			require(["jquery","a"],function($){
				$(function(){
					alert("load finished");
				})
				
			});
		</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>

上述例子中，a.js中通过define函数定义了一个模块，然后在页面中使用

require(["a"])

来加载该模块(注意require中的依赖是一个数组，即使只有一个依赖，你也必须使用数组来定义)，requir API的第二个参数是callback，一个function，是用来处理加载完毕后的逻辑，如上面的例子，加载完a.js后执行 alert("load finished");

上文index.html中的require.config，require.config是用来配置模块加载位置，简单点说就是给模块起一个更短更好记的名字，比如将百度的jquery库地址标记为jquery，这样在require时只需要写["jquery"]就可以加载该js，本地的js我们也可以这样配置；通过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="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.config({
    baseUrl : "js"
})

加载非规范的模块

理论上，require.js加载的模块，必须是按照AMD规范、用define()函数定义的模块。但是实际上，虽然已经有一部分流行的函数库（比如jQuery）符合AMD规范，更多的库并不符合。那么，require.js是否能够加载非规范的模块呢？

回答是可以的。

这样的模块在用require()加载之前，要先用require.config()方法，定义它们的一些特征。

举例来说，underscore和backbone这两个库，都没有采用AMD规范编写。如果要加载它们的话，必须先定义它们的特征。

require.config({
　　　　shim: {

　　　　　　‘underscore‘:{
　　　　　　　　exports: ‘_‘
　　　　　　},
　　　　　　‘backbone‘: {
　　　　　　　　deps: [‘underscore‘, ‘jquery‘],
　　　　　　　　exports: ‘Backbone‘
　　　　　　}
　　　　}
　　});

require.config()接受一个配置对象，这个对象除了有前面说过的paths属性之外，还有一个shim属性，专门用来配置不兼容的模块。具体来说，每个模块要定义（1）exports值（输出的变量名），表明这个模块外部调用时的名称；（2）deps数组，表明该模块的依赖性。

比如，jQuery的插件可以这样定义：

　shim: {
　　　　‘jquery.scroll‘: {
　　　　　　deps: [‘jquery‘],
　　　　　　exports: ‘jQuery.fn.scroll‘
　　　　}
　　}

require.js插件

require.js还提供一系列插件，实现一些特定的功能。

domready插件，可以让回调函数在页面DOM结构加载完成后再运行。

require([‘domready!‘], function (doc){
　　　　// called once the DOM is ready
　　});

text和image插件，则是允许require.js加载文本和图片文件。

　define([
　　　　‘text!review.txt‘,
　　　　‘image!cat.jpg‘
　　　　],

　　　　function(review,cat){
　　　　　　console.log(review);
　　　　　　document.body.appendChild(cat);
　　　　}
　　);

类似的插件还有json和mdown，用于加载json文件和markdown文件。

以上是关于Requirejs初识的主要内容，如果未能解决你的问题，请参考以下文章

转JS模块化工具requirejs教程：初识requirejs

JS模块化规范AMD之RequireJS

RequireJS和AMD规范

requireJS，browserify 和 webpack

Requirejs初识

RequireJS和AMD规范