nodejs从基础到实战学习笔记-模块化、包

二、模块化

2.1 什么是模块化

模块化是指解决一个复杂问题时，自顶向下逐层把系统划分成若干模块的过程。对于整个系统来说，模块是可组合、分解和更换的单元。

2.1.1 把代码进行模块化拆分的好处

提高了代码的复用性
提高了代码的可维护性
可以实现按需加载

• 如果程序设计的规模达到了一定程度，则必须对其进行模块化。
• 模块化可以有多种形式，但至少应该提供能够将代码分割为多个源文件的机制。
• CommonJS 的模块功能可以帮我们解决该问题。

//导出 m.js
var val='hello commonjs'
var foo='hello foo'
exports.val=val
exports.foo=foo

//导入 n.js
var math = require('./m.js');
console.log(math)

//{ val: 'hello commonjs', foo: 'hello foo' }

2.1.2 Node.js 中的模块化规范

Node.js 遵循了 CommonJS 模块化规范，CommonJS 规定了模块的特性和各模块之间如何相互依赖。

CommonJS 规定：

每个模块内部，module 变量代表当前模块。

module 变量是一个对象，它的 exports 属性（即 module.exports）是对外的接口。
加载某个模块，其实是加载该模块的 module.exports 属性。require() 方法用于加载模块。

2.1.3 Node.js 中模块的分类

Node.js 中根据模块来源的不同，将模块分为了 3 大类，分别是：

内置模块（内置模块是由 Node.js 官方提供的，例如 fs、path、http 等）
自定义模块（用户创建的每个 .js 文件，都是自定义模块）
第三方模块（由第三方开发出来的模块，并非官方提供的内置模块，也不是用户创建的自定义模块，使用前需要先下载）

2.1.4 模块引用

在规范中，定义了require()方法，可以加载需要的内置模块、用户自定义模块、第三方模块进行使用，以此将一个模块引入到当前运行环境中。例如：

• 模块引用的示例代码：

//加载内置模块
var fs = require('fs');

//加载自定议模块
var coutus = require('./coutus.js');

//加载第三方模块。第三方模块必须npm i  来安装后，才可以使用。  require('包名')
//先找当前文件所在目录中的node_modules目录，art-template/package.json文件中的main属性,main属性中记录了art-template的入口模块
var math = require('art-template');

require()可以传递一个文件的路径作为参数，node将会自动根据该路径来引入外部模块这里路径，如果使用相对路径，必须以.或…开头

使用require()引入模块以后，该函数会返回一个对象，这个对象代表的是引入的模块

我们使用require()引入外部模块时，使用的就是模块标识，我们可以通过模块标识来找到指定的模块

两个作用：

执行被加载模块中的代码
得到被加载模块中的exports 导出接口对象

2.4 模块导出

• 在运行环境中，提供了exports对象用于导出当前模块的方法或者变量，并且它是唯一的导出的出口。
• 在模块中还存在一个module对象，它代表模块自身，而exports是module的属性。
• 在Node中一个文件就是一个模块。

2.4.1 Node.js 中的模块作用域

1.什么是模块作用域

和函数作用域类似，在自定义模块中定义的变量、方法等成员，只能在当前模块内被访问，这种模块级别的访问限制，叫做模块作用域。

2.模块作用域的好处

防止了全局变量污染的问题

在这里插入图片描述

2.4.2 向外共享模块作用域中的成员

(1)module 对象

在每个 .js 自定义模块中都有一个 module 对象，它里面存储了和当前模块有关的信息，打印如下：

(2)module.exports 对象

在自定义模块中，可以使用 module.exports 对象，将模块内的成员共享出去，供外界使用。
外界用 require() 方法导入自定义模块时，得到的就是 module.exports 所指向的对象。

注意： 使用 require() 方法导入模块时，导入的结果，永远以 module.exports 指向的对象为准。
在这里插入图片描述

(3)exports 对象

由于 module.exports 单词写起来比较复杂，为了简化向外共享成员的代码，Node 提供了 exports 对象。默认情况下，exports 和 module.exports 指向同一个对象。最终共享的结果，还是以 module.exports 指向的对象为准。

在这里插入图片描述

2.4.3 exports 和 module.exports

时刻谨记，require() 模块时，得到的永远是 module.exports 指向的对象：

注意： 为了防止混乱，建议大家不要在同一个模块中同时使用 exports 和 module.exports

- 通过exports只能使用 . 的方式来向外暴露内部变量 exports.xxx = xxx
- 而module.exports既可以通过 . 的形式，也可以直接赋值

module.exports.xxx = xxxx
module.exports = {}

//导出单个文件(拿到的就是：函数、字符串)
exports.xxx = function() {};
exports.a=123;
exports.a={foo:'bar'}

//导出多个文件
module.exports = {};

2.4.4 模块标识

• 模块标识其实就是模块的名字，也就是传递给require()方法的参数，它必须是符合驼峰命名法的字符串，或者是以.、…开头的相对路径、或者绝对路径。

• 模块的定义十分简单，接口也十分简洁。每个模块具有独立的空间，它们互不干扰，在引用时也显得干净利落。

模块分成两大类

核心模块
- 由node引擎提供的模块
- 核心模块的标识就是，模块的名字
- 示例：var fs = require(“fs”);
文件模块
- 由用户自己创建的模块
- 文件模块的标识就是文件的路径（绝对路径，相对路径）
相对路径使用.或…开头

var md = require("./02.module");
var math = require("./math");
var fs = require("fs");
//console.log(md);
console.log(math.add(123,456));
//console.log(fs);

我们可以通过 exports 来向外部暴露变量和方法，只需要将需要暴露给外部的变量或方法设置为exports的属性即可。

//向外部暴露属性或方法
//02module.js
exports.x = "我是02.module.js中的x";
exports.y = "我是y";
exports.fn = function () {
};

在node中有一个全局对象 global，它的作用和网页中window类似
在全局中创建的变量都会作为global的属性保存
在全局中创建的函数都会作为global的方法保存
当node在执行模块中的代码时，它会首先在代码的最顶部，添加如下代码

//04module.js
function (exports, require, module, __filename, __dirname) {
//在代码的最底部，添加如下代码
}

实际上模块中的代码都是包装在一个函数中执行的，并且在函数执行时，同时传递进了5个实参

exports 该对象用来将变量或函数暴露到外部
require 函数，用来引入外部的模块
module 代表的是当前模块本身
- exports就是module的属性
- 既可以使用 exports 导出，也可以使用module.exports导出
filename 当前模块的完整路径:\Users\lilichao\WebstormProjects\class0705\01.node\04.module.js
__dirname 当前模块所在文件夹的完整路径:\Users\lilichao\WebstormProjects\class0705\01.node

三、包 package

• CommonJS的包规范允许我们将一组相关的模块组合到一起，形成一组完整的工具。
• CommonJS的包规范由包结构和包描述文件两个部分组成。
• 包结构
– 用于组织包中的各种文件
• 包描述文件
– 描述包的相关信息，以供外部读取分析

3.1 包结构

• 包实际上就是一个压缩文件，解压以后还原为目录。符合规范的目录，应该包含如下文件：
– package.json 描述文件
– bin 可执行二进制文件
– lib js 代码
– doc 文档
– test 单元测试

3.2 包描述文件

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

• package.json中的字段
name、description、version、keywords、maintainers、contributors、bugs、licenses、repositories、dependencies、homepage、os、cpu、engine、builtin、directories、implements、scripts、author、bin、main、devDependencies。

在JSON文件不能写注释

{ 
  "name": "gp19-npm", 
  "version": "1.0.1", 
  "description": "gp19 self module", 
  "main": "index.js",
  "scripts": { 
    "test": "make test" ,
    "dev": "node a.js" ,   //可以直接npm run dev   运行a.js这个文件
  }, 
  "repository": { 
    "type": "Git", 
    "url": "git+https://github.com/lurongtao/gp19-npm.git" 
  }, 
  "keywords": [ 
    "demo" 
  ], 
  "author": "Felixlu", 
  "license": "ISC", 
  "bugs": { 
    "url": "https://github.com/lurongtao/gp19-npm/issues" 
  }, 
  "homepage": "https://github.com/lurongtao/gp19-npm#readme", 
}