初识commonjs

一，为什么要用commonjs

      在大型项目中，需要根据需求和功能将程序划分为不同的模块。第一有利于多人开发，提高开发效率；第二提高了模块的复用率，清晰明确的框架也能提高程序的可维护性和健壮性。

       但是多人开发也会带来一些问题。

      依赖问题：

             不同的模块之间可能存在依赖问题，如果需要手动指定其加载次序，不仅浪费人力物力，也不利于修改。

      全局污染问题：

            加载次序不同的模块，如果重复定义了相同的变量，一定会引发无法预计的后果！

      模块化开发是一种很好的思想，但是需要有一定的规范加以约束！

      在服务器端，采用了commonjs，在浏览器端，有AMD和CMD之分。

      今天先了解一下commonjs，一步步吃成胖子！

二，准备工作

      安装nodejs和npm。

三，module对象

      commonjs认为每个文件都是一个模块，每个模块都是一个作用域，通过require其他模块来解决模块的加载次序问题，通过exports来暴露接口，解决命名冲突问题。

      每个模块内部都有一个module对象，指向当前模块，具有如下属性：

            module.id                           模块的识别符，通常是带有绝对路径的模块文件名

            module.filename              模块的文件名，带有绝对路径

            module.loaded                 boolean，标志模块是否已经加载

            module.parent                  object，表示调用该模块的模块

            module.children               array，表示该模块需要用到的模块

            module.exports                模块暴露的属性和方法

四，require

      当我们键入 > var http = require(‘http’)，commonjs就帮我们引入了http这个模块，看上去很简单，就是加载了一个模块，其实走了下面一段流程：

4.1查看缓存

      可以多次require一个模块，但是除了第一次是真正的下载、执行一个js文件，然后返回其module.exports对象，并存储起来，之后的require都是到直接获取相应的缓存。

       

                        图4-1

      

                  图4-2

       

                  图4-3

      可以发现require(‘./sub.js’)其实只执行了一次，与之后的require(‘./sub.js’)共享同一个缓存。

      commonjs将模块存储在require.cache中,修改main.js的内容，通过 > delete require.cache[ moduleName ]来清除缓存

       

                  图4-4

      

                  图4-5

      观察打印的key值，可以发现commonjs将绝对路径作为模块名，来标识模块的缓存。

4.2加载模块

      当在缓存中找不到相应的模块，就先创建相应的module实例存入缓存，然后加载相应的模块。

  4.2.1参数的解析

         /：表示加载绝对路径的模块文件

         ./：表示加载相对路径的模块文件

         默认提供的核心模块：先检索node的系统安装目录，在检索各级的node_modules

             比如/home/user/project/foo.js执行了require('bar.js')，则会顺序查找：

                 /user/local/lib/node/bar.js

                 /home/user/project/node_modules/bar.js

                 /home/user/node_modules/bar.js

                 /home/node_modules/bar.js

                 /node_mudules/bar.js

         纯路径：先搜索该路径的package.json，然后加载其中main指定的js文件，

              如果没有main或者package.json，

             加载该目录的index.js或者index.node文件

         如果找不到相应的模块，自动添加后缀名：js、json、node(以编译后的二进制文件解析)

  4.2.2同步加载

         require是同步加载的，按照在代码中出现的次序顺序加载。

         即读入、执行一个js文件，然后返回其module.exports对象再继续往下执行；

         如果require一个不存在的文件，则报错。

  4.2.3嵌套加载跟循环加载

         如果存在嵌套的require，则外部的require等待内部的require结束在继续执行。

         如果存在循环require，则会因为缓存的机制获得不完全加载的版本。

 

                  图4-6

 

                  图4-7

 

                  图4-8

 

                  图4-9

4.3加载失败

   

                图4-10

 

               图4-11

 

               图4-12

     可见即使没执行完相应的js文件，也会预先在缓存中存储module实例（存在main.js）。

     当加载失败时，从require.cache中删除预定义的module实例（删除sub.js）

4.4加载成功

     返回module.exports对象。

五，exports

 5.1 exports与module.exports

     每个模块默认定义了var exports = module.exports，通过向exports添加方法属性，等同于添加到module.exports上。

     注意，module.exports和exports指向同一块内存，

     如果对exports整体赋值，相当于改变exports的指向，则之后的任何修改都不会影响module.exports了。

     如果对module.exports整体赋值，相当于改变module.exports的指向，则module.exports和exports分道扬镳，互不干涉了。

所以如果最后只导出一个函数，只能通过赋值给module.exports来导出

 5.2 注意exports的闭包问题

    

               图5-1

     按照我的理解，这种所谓的影响不到有两个原因：

          1，counter是原始数据类型

          2，闭包。

     原因这里先不分析，之后会写写作用域链跟闭包，读者可以到时参考后自行分析。

     修改一

 

               图5-2

 

               图5-3

 

               图5-4

     思路：利用闭包保存共同的引用

    修改二

    

               图5-5

 

               图5-6

     思路：在函数运行时才确定其上下文环境

六，其他

  6.1 全局变量

     每个模块都是一个作用域，内部的变量在其他地方不可见，

     可以将变量设置为global的属性改变其可见性

  6.2 require.main === module

     返回true的话，标识着模块是直接执行

     否则为被调用执行

  6.3 IIFE(Immediately-Invoked Function Expressions)

     立即执行函数，一般减少全局作用域的污染。

     之前经常看到将jQuery等常用库作为参数传递进来，今天结合作用域链终于发现其好处了：将原本需要到全局作用域里查找的东西“放入”当前的作用域，如果在嵌套很深的情况下，能减少很多无谓的搜索！

  6.4 参考

         http://javascript.ruanyifeng.com/nodejs/module.html#toc0