javascript模块化编程从入门到实战

Posted 2021-11-02 lguow

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了javascript模块化编程从入门到实战相关的知识，希望对你有一定的参考价值。

<!DOCTYPE html>
<html lang="zh-cn">
<head>
    <meta charset="UTF-8">
    <title>javascript模块化编程</title>
</head>
<body>
    <p></p>

网页越来越像桌面程序，需要一个团队分工协作、进度管理、单元测试等等......开发者不得不使用软件工程的方法，管理网页的业务逻辑。

Javascript模块化编程，已经成为一个迫切的需求。理想情况下，开发者只需要实现核心的业务逻辑，其他都可以加载别人已经写好的模块。

但是，Javascript不是一种模块化编程语言，它不支持"类"（class），更遑论"模块"（module）了。（正在制定中的ECMAScript标准第六版，将正式支持"类"和"模块"，但还需要很长时间才能投入实用。）

Javascript社区做了很多努力，在现有的运行环境中，实现"模块"的效果。本文总结了当前＂Javascript模块化编程＂的最佳实践，说明如何投入实用。虽然这不是初级教程，但是只要稍稍了解Javascript的基本语法，就能看懂。

<h1>模块就是实现特定功能的一组方法。</h1>
<h2>只要把不同的函数（以及记录状态的变量）简单地放在一起，就算是一个模块。</h2>



    <script>
        /**
         * 第一部分介绍Javascript模块的基本写法
         * */

        //一、原始写法    "污染"了全局变量
        function m1(){}
        function m2(){}
        //二、对象写法    这样的写法会暴露所有模块成员，内部状态可以被外部改写。
        var module = new Object({
            _count : 0,
            m1:function(){},
            m2:function m2(){}
        });
        module.m1();
        module._count = 5;
        //三、立即执行函数写法 外部代码无法读取内部的_count变量。
        var module1 = (function(){
            var _count = 0;
            var m1 = function () {}
            var m2 = function () {
                console.log("我是module1上的m2，很高兴认识你！")
            }
            return {
                m1:m1,
                m2:m2
            }
        })();
        // module1.m2()
        //module1就是Javascript模块的基本写法。下面，再对这种写法进行加工。
        // 四、放大模式 (对原始模块功能的扩展)
        // 如果一个模块很大，必须分成几个部分，或者一个模块需要继承另一个模块
        var module2 = (function(mod){
            mod.m3 = function(){
                console.log("我是module2上的m3，很高兴认识你！")
            }
            return mod;
        })(module1);
        console.log(module2)
        // 五、宽放大模式（Loose augmentation）
        // 在浏览器环境中，模块的各个部分通常都是从网上获取的，有时无法知道哪个部分会先加载。如果采用上一节的写法，第一个执行的部分有可能加载一个不存在空对象，这时就要采用"宽放大模式"。
        var module3 = (function(mod){
            //...
            return mod;
        })(window.module2||{});
        // 六、输入全局变量
        // 独立性是模块的重要特点，模块内部最好不与程序的其他部分直接交互。
        // 为了在模块内部调用全局变量，必须显式地将其他变量输入模块。
        var jQuery = {};
        var module4 = (function(mod){
            //...
        })(jQuery,module3)
        // 这样做除了保证模块的独立性，还使得模块之间的依赖关系变得明显
        /**
         * 第二部分介绍如何规范地使用模块。
         * */
        //七、模块的规范
        // 目前，通行的Javascript模块规范共有两种：CommonJS和AMD。我主要介绍AMD，但是要先从CommonJS讲起。
        // node.js的模块系统，就是参照CommonJS规范实现的。在CommonJS中，有一个全局性方法require()，用于加载模块。

        //八、CommonJS (同步)
        // 假定的一个math.js模块，加载方式如下
        // var math = require(‘math‘);
        // 调用
        // math.add(2,3); //5

        // 九、浏览器环境 AMD(异步)
        //浏览器端的模块，不能采用"同步加载"（synchronous），只能采用"异步加载"（asynchronous）。这就是AMD规范诞生的背景。
        // AMD是"Asynchronous Module Definition"的缩写，意思就是"异步模块定义"。它采用异步方式加载模块，模块的加载不影响它后面语句的运行。所有依赖这个模块的语句，都定义在一个回调函数中，等到加载完成之后，这个回调函数才会运行。

        // AMD也采用require()语句加载模块，但是不同于CommonJS，它要求两个参数：
        // require([module], callback);
        // 第一个参数[module]，是一个数组，里面的成员就是要加载的模块；第二个参数callback，则是加载成功之后的回调函数。如果将前面的代码改写成AMD形式，就是下面这样：
        /**
         * require([module1,module2,...],function(module1,module2,...){
                module1.add(2,3);
            });
         */
        // 目前，主要有两个Javascript库实现了AMD规范：require.js和curl.js。

        /**
         * 第三部分介绍require.js，进一步讲解AMD的用法，以及如何将模块化编程投入实战。
         * */
        // 一、为什么要用require.js？
        // 最早的时候，所有Javascript代码都写在一个文件里面，只要加载这一个文件就够了。后来，代码越来越多，一个文件不够了，必须分成多个文件，依次加载。下面的网页代码，相信很多人都见过。
        /**
         *  <script src="1.js"><//script>
        　　 <script src="2.js"><//script>
        　　 <script src="3.js"><//script>
         缺点: 1.加载的时候，浏览器会停止网页渲染，
              2.由于js文件之间存在依赖关系，因此必须严格保证加载顺序,
              3.当依赖关系很复杂的时候，代码的编写和维护都会变得困难。
         * */
        //require.js的诞生，就是为了解决这两个问题：
        // （1）实现js文件的异步加载，避免网页失去响应；
        // （2）管理模块之间的依赖性，便于代码的编写和维护。

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

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

        // 有人可能会想到，加载这个文件，也可能造成网页失去响应。解决办法有两个，一个是把它放在网页底部加载，另一个是写成下面这样：

        //  <script src="js/require.js" defer async="true" ><//script>
        // async属性表明这个文件需要异步加载，避免网页失去响应。IE不支持这个属性，只支持defer，所以把defer也写上。
        // 加载require.js以后，下一步就要加载我们自己的代码了。假定我们自己的代码文件是main.js，也放在js目录下面。那么，只需要写成下面这样就行了：

        //  <script src="js/require.js" data-main="js/main"><//script>
        // data-main属性的作用是，指定网页程序的主模块。在上例中，就是js目录下面的main.js，这个文件会第一个被require.js加载。由于require.js默认的文件后缀名是js，所以可以把main.js简写成main。

        // 三、主模块的写法
        // 上一节的main.js，我把它称为"主模块"，意思是整个网页的入口代码。它有点像C语言的main()函数，所有代码都从这儿开始运行。
        // 下面就来看，怎么写main.js。
        // 主模块依赖于其他模块，这时就要使用AMD规范定义的的require()函数。
        // main.js
        /**
         *  require([‘moduleA‘, ‘moduleB‘, ‘moduleC‘], function (moduleA, moduleB, moduleC){
                // some code here
            });
         * */
        //四、模块的加载
        // 上一节最后的示例中，主模块的依赖模块是[‘jquery‘, ‘underscore‘, ‘backbone‘]。默认情况下，require.js假定这三个模块与main.js在同一个目录，文件名分别为jquery.js，underscore.js和backbone.js，然后自动加载。
        //使用require.config()方法，我们可以对模块的加载行为进行自定义。require.config()就写在主模块（main.js）的头部。参数就是一个对象，这个对象的paths属性指定各个模块的加载路径。
        //另一种则是直接改变基目录（baseUrl）。
        /**
         * 　　require.config({
            　　　　baseUrl: "js/lib",
            　　　　paths: {
            　　　　　　"jquery": "jquery.min",
            　　　　　　"underscore": "underscore.min",
            　　　　　　"backbone": "backbone.min"
            　　　　}
            　　});
         * */
        // require.js要求，每个模块是一个单独的js文件。这样的话，如果加载多个模块，就会发出多次HTTP请求，会影响网页的加载速度。因此，require.js提供了一个优化工具，当模块部署完毕以后，可以用这个工具将多个模块合并在一个文件中，减少HTTP请求数。
        // 五、AMD模块的写法
        // require.js加载的模块，采用AMD规范。也就是说，模块必须按照AMD的规定来写。
        // 具体来说，就是模块必须采用特定的define()函数来定义。如果一个模块不依赖其他模块，那么可以直接定义在define()函数之中。
        // 假定现在有一个math.js文件，它定义了一个math模块。那么，math.js就要这样写：
        // math.js
        /**
         *  define(function (){
                var add = function (x,y){
                    return x+y;
                };
                return {
                    add: add
                };
            });
         */
        // 如果这个模块还依赖其他模块，那么define()函数的第一个参数，必须是一个数组，指明该模块的依赖性。
        // 当require()函数加载上面这个模块的时候，就会先加载myLib.js文件。
        /**
         *
         　　define([‘myLib‘], function(myLib){
        　　　　function foo(){
        　　　　　　myLib.doSomething();
        　　　　}
        　　　　return {
            　　　foo : foo
        　　　　};
        　　});
         */
        // 六、加载非规范的模块
        // 理论上，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文件。



      </script>

    <script src="js/require.js" defer anync="true" data-main="js/main"></script>
</body>
</html>

main.js

console.log("我加载进来了，哈哈哈哈0.0");

// require([‘module1‘,‘module2‘],function (module1,module2) {
//     module1.m2();
//     // module2.m3();
// })

// require()函数接受两个参数。第一个参数是一个数组，表示所依赖的模块，上例就是[‘moduleA‘, ‘moduleB‘, ‘moduleC‘]，
// 即主模块依赖这三个模块；第二个参数是一个回调函数，当前面指定的模块都加载成功后，它将被调用。
// 加载的模块会以参数形式传入该函数，从而在回调函数内部就可以使用这些模块。
//
// require()异步加载moduleA，moduleB和moduleC，浏览器不会失去响应；
// 它指定的回调函数，只有前面的模块都加载成功后，才会运行，解决了依赖性的问题。
// 假定主模块依赖jquery、underscore和backbone这三个模块，main.js就可以这样写：
/**
 * require([‘jquery‘, ‘underscore‘, ‘backbone‘], function ($, _, Backbone){
        // some code here
    });
 * */


require.config({
    baseUrl:‘js/lib/‘,  //根目录
    paths:{
        "jquery":"jquery"       //扩展名.js不用写，会自动加上
    }
})

require([‘jquery‘,‘../module1‘], function ($,module1){
    $("p").html("我是jQuery，我进来了，很高兴认识你！")
    module1.m2();
});

module1.js

//无依赖版
// define(function(){
//     var _count = 0;
//     var m1 = function () {}
//     var m2 = function () {
//         console.log("我是module1上的m2，很高兴认识你！")
//     }
//     return {
//         m1:m1,
//         m2:m2
//     }
// })

//有依赖
define([‘../js/module2‘], function(module2){
    var _count = 0;
    var m1 = function () {}
    var m2 = function () {
        console.log("我是module1上的m2，很高兴认识你！")
    }
    module2.m3()
    module2.m4 = function(){
        console.log("我是module1上的m4，我很特殊，是module1给module2写的扩展，很高兴认识你！")
    }
    module2.m4();
    return {
        m1:m1,
        m2:m2
    }
});

module2.js

// ;(function(mod){
//     mod.m3 = function(){
//         console.log("我是module2上的m3，很高兴认识你！")
//     }
//     return mod;
// })(module1);


define(function(){
    var m3 = function () {
        console.log("我是module2上的m3，很高兴认识你！")
    }
    return {
        m3:m3
    }
})

参考资料：

http://www.ruanyifeng.com/blog/2012/10/javascript_module.html

http://www.ruanyifeng.com/blog/2012/10/asynchronous_module_definition.html

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

以上是关于javascript模块化编程从入门到实战的主要内容，如果未能解决你的问题，请参考以下文章

社区共读《Python编程从入门到实践》第7，8，9天阅读建议

简明 JavaScript 函数式编程——入门篇

知乎力荐Spring实战笔记，从入门到实战。通俗易懂

笔记《Python编程从入门到实战》——变量与基础数据类型

python编程从入门到实战1-3章

javascript模块化编程 从入门到实战

javascript模块化编程从入门到实战