模块代码Node.js[4] 第一个模块 -java教程

最新推荐文章于 2022-11-07 22:49:05 发布

dyl_love98

最新推荐文章于 2022-11-07 22:49:05 发布

阅读量283

点赞数

文章标签：模块代码

本文链接：https://blog.csdn.net/javablogs/article/details/8843537

版权

查了好多资料，发现还是不全，干脆自己理整吧，至少保证在我的做法正确的，以免误导读者，也是给自己做个记录吧！

面前几篇算是node各种基本，这篇向着创立第一个node模块的标目迈进。之前的文章复反说起模块在node中的主要性。正因为有了模块，node才有了扩展性，才会有如此多的node社区员成介入进来，node才能如此迅速地开展。

NPM（Node Packaged Module，以后简称module或模块）是node的内置功能，通过module的式形为node带来更多的API。其实node原生API也是通过模块的式形供给给发开者应用的。

模块?

node实现了commonjs module范规。下面的例子来自Module范规，修改了require输入参数以便能在node中运行，请参照注释别分存保至3个件文中，或者载下整完示例代码：

// 这段代码存保为件文math.js

exports.add =

function

() {

var

sum = 0, i = 0, args =

arguments

, l = args.

length

;

while

(i < l) {

sum += args[i++];

}

return

sum;

};

// 这段代码存保为件文increment.js

var

add = require('./math').add;

exports.increment =

function

(val) {

return

add(val, 1);

};

// 这段代码存保为件文program.js

var

inc = require('./increment').increment;

var

a = 1;

inc(a);

// 2

console.log('a=', inc(a));

模块分类

node中模块可分为核心模块(Core Module)和第三方模块，核心模块是node内置模块，平日存在于node安装路径lib目录下；第三方模块也就是本文论讨并望期创立的模块。

Require & Module path

下面的代码中现出的require是node中载加模块的全局数函，node是如何寻找到对应模块的呢？明简规矩如下：

路径为Y的module中应用 require(X)
如果是X为核心模块，中命则束结
如果X以‘./’、‘/’、‘../’扫尾时，载加第三方模块，中命则束结
查找失败抛出异常

这里能看到整完描述：

require(X) from module at path Y

1. If X is a core module,

return

the core module

b. STOP

2. If X begins

with

'./' or '/' or '../'

a. LOAD_AS_FILE(Y + X)

b. LOAD_AS_DIRECTORY(Y + X)

3. LOAD_NODE_MODULES(X, dirname(Y))

4. THROW "

not found

LOAD_AS_FILE(X)

1. If X is a file, load X as JavaScript text. STOP

2. If X.js is a file, load X.js as JavaScript text. STOP

3. If X.node is a file, load X.node as binary addon. STOP

LOAD_AS_DIRECTORY(X)

1. If X/

package

.json is a file,

a. Parse X/

package

.json, and look

for

main

" field.

b. let M = X + (json main field)

c. LOAD_AS_FILE(M)

2. If X/index.js is a file, load X/index.js as JavaScript text. STOP

3. If X/index.node is a file, load X/index.node as binary addon. STOP

LOAD_NODE_MODULES(X, START)

1. let DIRS=NODE_MODULES_PATHS(START)

for

each DIR

DIRS:

a. LOAD_AS_FILE(DIR/X)

b. LOAD_AS_DIRECTORY(DIR/X)

NODE_MODULES_PATHS(START)

1. let PARTS = path split(START)

2. let ROOT = index of first instance of "

node_modules

PARTS, or 0

3. let I = count of PARTS - 1

4. let DIRS = []

while

I > ROOT,

PARTS[I] = "

node_modules

" CONTINUE

c. DIR = path join(PARTS[0 .. I] + "

node_modules

b. DIRS = DIRS + DIR

c. let I = I - 1

return

DIRS

模块结构

connect-header是笔者应用express期间写的一个小模块，充足简略且包含了第三方模块的诸多素元，比拟合适作为入门示例。

这里用connect-header作为示例，欢送fork，样同可用下面令命安装：

每日一道理
人的生命似洪水奔流，不遇着岛屿和暗礁，难以激起美丽的浪花。

$ npm install connect-header

件文结构

以下假设之前行执npm install的路径为X，我们看到connect-header被安装在X/node_modules/connect-header；X/node_modules是node安装第三方模块的认默置位;node已不推荐将模块安装至全局路径下，更推荐当地安装，是能可出于移植的虑考。

lib 模块代码
- header.js 代码写在这里！
- index.js node认默载加模块
test Unit Test
- header.js
.npmignore 模块宣布时当地件文忽略列表
LICENSE 权版声明
package.json 模块属性声明
README.md 模块绍介
test.js UT启动脚本

package.json

模块中最为主要的件文，申了明各种模块别级的属性，或称为元数据。这些元数据部份由npm程序读取，部份是npmjs.org上模块页面的数据源。整完文档请考参npm json，网上找到的一个交互文档也可考参。初次接触package.json可以应用”npm init”，这是个交互式package.json成生工具。

$ npm init

针对connect-header的package.json，我们分析个每字段的义意（见注释）：

{

name

":"

connect-header

//模块称名

version

":"

0.0.5

//模块本版号

description