简要掌握CommonJS的规范和使用方法

小鱼儿 2022-05-25 00:37 168阅读 0赞

前言：CommonJs规范的出发点：后台JS没有模块系统、标准库较少、缺乏包管理工具；为了让JS可以在任何地方运行，以达到Java、C\#、PHP这些后台语言具备开发大型应用的能力；事实上ES6已经出现了模块规范，如果使用ES6的模块规范是无需node.js环境的。因此，需要将commonJS规范和ES6的模块规范区分开来。  
1.CommonJS模块规范主要分为三部分：模块定义、模块标识、模块引用。  
a. 一个文件就是一个模块，拥有单独的作用域；  
b.普通方式定义的变量、函数、对象都属于该模块内；  
c.通过require来加载模块；  
d.通过exports和modul.exports来暴露模块中的内容；

模块定义、模块标识：

//在数据库模块database.js文件中,把各个函数写好，然后暴露出来
     module.exports={
        'saveDatabase':saveDatabase,//保存数据函数
        'saveLastSpider':saveLastSpider,//保存最后一条数据函数
        'getInfoByType':getInfoByType,//通过类型查找函数
        'getInfoByOrder':getInfoByOrder,//通过排序查找函数
     }
    //函数具体的实现没有贴出来，上面名称的是函数名。

模块引用：

//在控制模块controller.js中引用上面定义好的模块
    var database = require('./database');//引用模块，将生成的对象指向database对象（命名可以是任意定的）
    database.saveDatabase([1,2,3,4,5]);//通过database对象调用相应的函数

3、所有代码都运行在模块作用域，不会污染全局作用域；模块可以多次加载，但只会在第一次加载的时候运行一次，然后运行结果就被缓存了，以后再加载，就直接读取缓存结果；模块的加载顺序，按照代码的出现顺序是同步加载的;

4、\_\_dirname代表当前模块文件所在的文件夹路径，\_\_filename代表当前模块文件所在的文件夹路径+文件名;

5、require（同步加载）基本功能：读取并执行一个JS文件，然后返回该模块的exports对象，如果没有发现指定模块会报错;

6、模块内的exports：为了方便，node为每个模块提供一个exports变量，其指向module.exports，相当于在模块头部加了这句话：var exports = module.exports，在对外输出时，可以给exports对象添加方法，PS：不能直接赋值（因为这样就切断了exports和module.exports的联系）;

7、npm root -g：查看npm全局包安装位置，建议在nvm目录下新建npm\\node\_modules目录，然后设置npm的全局包安装位置：npm config set prefix “”，然后将该路径添加到环境变量中;

8、npm init -y：初始化一个package.json文件，加上-y就会默认生成该文件，无需一步一步填写；npm docs 包名：查看包的文档；npm install：安装package.json中dependencies属性中所有依赖的包

9、由于npm的服务器是国外的，所以如果你没有和谐工具是下载不了的，这里推荐使用淘宝NPM镜像：[http://npm.taobao.org/][http_npm.taobao.org]，与官方NPM的同步频率目前为10分钟一次；安装命令：npm install -g cnpm –registry=[https://registry.npm.taobao.org][https_registry.npm.taobao.org]，安装包：cnpm install 包名（其它命令基本一致）;

10、如果你不想下载cnpm，npm还提供了一个镜像源管理工具：npm install -g nrm，通过：nrm ls，查看镜像源列表 ，通过：npm use 镜像源，来切换;

11、NPM的模块加载机制：

如果require的是绝对路径文件，查找不会去遍历每个node_modules目录，其速度最快

1）.从module.paths数组中（由当前执行文件目录到磁盘根目录）取出第一个目录作为查找基准

2）.直接从目录中查找该文件，如果存在则结束查找，如果不存在则进行下一条查找

3）.尝试添加.js、.node、.json后缀之后查找，如果存在文件则结束查找，如果不存在则进行下一条查找

4）.尝试将require的参数作为一个包来进行查找，读取目录下的package.json文件，取得Main参数指定的文件

5）.尝试查找该文件，如果存在则结束查找，如果不存在则进行第3条查找

6）.如果继续失败，则取出module.paths数组中的下一目录作为基准查找，循环第1-5个步骤

7）.如果继续失败，循环第1-6个步骤，直到module.paths中的最后一个值

8）.如果继续失败，则抛出异常

[http_npm.taobao.org]: http://npm.taobao.org/
[https_registry.npm.taobao.org]: https://registry.npm.taobao.org