node.js学习笔记——模块与包

文章目录

1.模块

1.1 模块概述
1.2 Module
1.3 模块加载
1.4 作用域

2.包(package)

2.1 包概述
2.2 包结构
2.3 包描述文件
2.4 package.json自动生成

1.模块

1.1 模块概述

在node中，一个文件就是一个模块，每个模块都有自己的作用域。
Node中模块分为两类：一类是Node提供的模块，称为核心模块；另一类是用户编写的模块，称为文件模块。
核心模块在node源代码的编译过程中就编译进了二进制执行文件。在node进程启动时，部分核心模块就被直接加载进内存中，所以这部分核心模块引入时，文件定位和编译执行这两个步骤可以省略掉，并且在路径分析中优先判断，所以它的加载速度是最快的。
而文件模块则是在运行时动态加载，需要完整的路径分析、文件定位、编译执行过程，速度比核心模块慢。

1.2 Module

Module是nodejs提供的模块对象，该对象保存了当前模块相关的一些信息。
node.js学习笔记——模块与包-LMLPHP

其中module.exports最特殊，表示当前模块对外输出的接口，其他文件加载该模块，实际上就是读取module.exports变量。所以要注意，不能直接将exports变量指向一个值，因为这样等于切断了exports与module.exports的联系。

还有后面的module.paths，在下面会讲到。

1.3 模块加载

加载js文件
require函数用于在当前模块中加载和使用别的模块，传入一个模块名，返回一个模块导出对象。只要传入相对路径或者绝对路径的文件名就可以将对应的文件模块导入，如:
var foo1 = require(’./foo’);
var foo2 = require(’./foo.js’);
var foo3 = require(’/home/user/foo’);
var foo4 = require(’/home/user/foo.js’);
// foo1至foo4中保存的是同一个模块的导出对象。
如图:

一个模块中的JS代码仅在模块第一次被使用时执行一次，并在执行过程中初始化模块的导出对象。之后，缓存起来的导出对象被重复利用。
加载json文件
另外，可以使用以下方式加载和使用一个JSON文件，模块名中.json扩展名不可省略。
var data = require(’./data.json’);
如图:
require深入
require函数支持斜杠（/）或盘符（C:）开头的绝对路径，也支持./开头的相对路径。但这两种路径在模块之间建立了强耦合关系，一旦某个模块文件的存放位置需要变更，使用该模块的其它模块的代码也需要跟着调整，变得牵一发动全身。因此，require函数支持第三种形式的路径，利用上面的module.paths以及特殊的node_modules目录来查找模块。
NodeJS定义了一个特殊的node_modules目录用于存放模块。例如某个模块的绝对路径是C:\Users\Administrator\Desktop\test.js，在该模块中使用require(‘dir1/test2’)方式加载模块时，则NodeJS依次尝试使用以下路径：
C:\Users\Administrator\Desktop\node_modules\dir1\test2.js
C:\Users\Administrator\node_modules\dir1\test2.js
C:\Users\node_modules\dir1\test2.js
C:\node_modules\dir1\test2.js
另外还可以通过NODE_PATH环境变量来查找模块，NodeJS允许通过NODE_PATH环境变量来指定额外的模块搜索路径。NODE_PATH环境变量中包含一到多个目录路径，node会依次尝试每个环境变量的路径。
补充
虽然一般我们使用JS编写模块，但NodeJS也支持使用C/C++编写二进制模块。编译好的二进制模块除了文件扩展名是.node外，和JS模块的使用方式相同。

1.4 作用域

不同应用于浏览器的javascript，node的顶层模块不是window，而是global。浏览器javascript中全局条件下用var声明的变量都是window的属性，如var str=“str”，可以通过window.str访问到，而且值还是"str"。但是在node中就不一样了，因为node中每个文件都是模块，每个模块都有自己的作用域，直接在文件中var声明的属性都是独属于这个文件的，而不属于任何对象。测试如下(加上module，是因为我以为str是属于module而不是global的，然而不是)：
node.js学习笔记——模块与包-LMLPHP

2.包(package)

2.1 包概述

由多个子模块组成的大模块称做包，并把所有子模块放在同一个目录里。在组成一个包的所有子模块中，需要有一个入口模块，入口模块的导出对象被作为包的导出对象。例如在C:\test目录下有三个文件：test1.js、test2.js、main.js，而main就是入口模块，内容如下：

exports.create = function(name){
	return {
		name: name,
		test1: require("./test1"),
		test2: require("./test2")
	}
}

在其它模块里使用包的时候，需要加载包的入口模块：require(“C:\test\main”)就行了。

但是入口模块名称出现在路径里看上去不是个好主意。而当模块的文件名是index.js，加载模块时可以使用模块所在目录的路径代替模块文件路径，所以只要将main.js改为index.js就行了。这样require(“C:\test”)就可以导入test包了。

如果想自定义入口模块的文件名和存放位置，就需要在包目录下包含一个package.json文件，并在其中指定入口模块的路径。举个例子：
node.js学习笔记——模块与包-LMLPHP

2.2 包结构

包实际上是一个存档文件，即一个目录直接打包为.zip或tar.gz格式的文件，安装后解压还原为目录。完全符合CommonJS规范的包目录应该包含如下这些文件：

2.3 包描述文件

包描述文件用于表达非代码相关的信息，它是一个JSON格式的文件——package.json，位于包的根目录下，是包的重要组成部分。

package.json文件，定义了项目所需要的各种模块，以及项目的配置信息（比如名称、版本、许可证等元数据）。npm install命令根据这个配置文件，自动下载所需的模块，也就是配置项目所需的运行和开发环境。

2.4 package.json自动生成

可以通过在命令行中输入npm init，然后一路yes，输入自己想要的字段来生成最基本的package.json文件。 node.js学习笔记——模块与包-LMLPHP
然后就可以得到自己想要的package.json了：

然后在package.json中添加dependencies字段。这是使用当前包所需要依赖的包列表，这个属性十分重要，NPM会通过这个属性帮助自动加载依赖的包。
对应的版本可以加上各种限定，主要有以下几种：

要指定版本，如"1.2.3"，要形如"大版本.次要版本.小版本"。
(>=/<=/>/<)+指定版本，如">=1.2.3"，表示安装大于等于1.2.3的最新版本。
波浪号(tilde)+指定版本，比如"~1.2.3"，表示安装1.2.x的最新版本，且不低于1.2.3，但是不安装1.3.x，也就是说安装时不改变大版本号和次要版本号。
插入号(caret)+指定版本，比如"ˆ1.2.3"，表示安装1.x.x的最新版本(不低于1.2.3)，但是不安装2.x.x，也就是说安装时不改变大版本号。需要注意的是，如果大版本号为0，则插入号的行为与波浪号相同，这是因为此时处于开发阶段，即使是次要版本号变动，也可能带来程序的不兼容。
latest：安装最新版本。

比如添加了下列的字段：

{
  "name": "mytest",
  "version": "0.0.1",
  "description": "a test",
  "main": "./lib/main.js",
  "directories": {
    "lib": "lib"
  },
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "liangyy75",
  "license": "ISC",
  "devDependencies": {
    "express": "4.16.3",
    "jquery": "~1.9.0",
    "pug": ">=2.0.1",
    "bootstrap": "^3.3.3",
    "mongoose": "latest"
  }
}

然后npm install，然后用npm list查看各个包的版本，如：npm list express。

最后再说一句，其实不指定版本，直接"packageName": ""也可以下载第三方包，而且是最新的包。

小蜜蜂