参照连接:http://nqdeng.github.io/7-days-nodejs/\#1.1



 

NodeJS基础

什么是NodeJS

JS是脚本语言,脚本语言都得一个解析器才能够运行。对于刻画在HTML页面里的JS,浏览器充当了解析器的角色。而于要独自运转的JS,NodeJS就是一个解析器。

每一样栽解析器都是一个运转环境,不但允许JS定义各种数据结构,进行各种计算,还同意JS使用运行条件提供的放开对象与章程做一些工作。例如运行在浏览器中之JS的用是操作DOM,浏览器就提供了document等等的坐对象。而运行在NodeJS中之JS的用途是操作磁盘文件要搭建HTTP服务器,NodeJS就相应提供了fshttp抵内置对象。

来吗用处

尽管在一样听说可以直接运行JS文件就觉着那个要命的同班,但多数同学在接触新物常常首先关心的是来甚用处,以及能带动啥价值。

NodeJS的作者说,他创造NodeJS的目的是为着落实强性能Web服务器,他率先注重的凡事件机制同异步IO模型的优越性,而无是JS。但是他待选择相同种植编程语言实现他的想法,这种编程语言不可知由带IO功能,并且要能尽如人意支持事件机制。JS没有于带IO功能,天生就是用来拍卖浏览器中之DOM事件,并且具有一致不胜群程序员,因此就改为了原始的精选。

如他所愿,NodeJS在劳动端活跃起来,出现了大批冲NodeJS的Web服务。而一方面,NodeJS让前面端众而得神器,终于得于自己之能力覆盖范围跳出浏览器窗口,更大批之前端工具而雨后春笋。

因而,对于前端而言,虽然不是众人都设拿NodeJS写一个服务器程序,但略但及采用命令交互模式调试JS代码片段,复杂而及编写工具提升工作效率。

NodeJS生态圈正欣欣向荣。

怎设置

安装程序

NodeJS提供了一些安装程序,都可以当nodejs.org这边下载并设置。

Windows系统下,选择与系版本匹配的.msi后缀的安装文件。Mac OS
X系统下,选择.pkg后缀的安装文件。

编译安装

Linux系统下并未现成的安装程序可用,虽然片段发行本可运用apt-get等等的艺术安装,但未自然能设置及最新版。因此Linux系统下一般采用以下办法编译方式安装NodeJS。

  1. 确保系统下g++版本在4.6以上,python版本在2.6之上。

  2. 从nodejs.org下载tar.gz后缀的NodeJS最新版源代码包并解压到某个位置。

  3. 进去解压到之目录,使用以下命令编译和安装。

     $ ./configure
     $ make
     $ sudo make install
    

争运作

打开终端,键入node进命令交互模式,可以输入一长达代码语句后顿时施行并展示结果,例如:

$ node
> console.log('Hello World!');
Hello World!

苟要运行一老大截代码的话,可以预先勾勒一个JS文件再度运行。例如有以下hello.js

function hello() {
    console.log('Hello World!');
}
hello();

形容好后在终点下键入node hello.js运转,结果如下:

$ node hello.js
Hello World!

权限问题

当Linux系统下,使用NodeJS监听80要443端口提供HTTP(S)服务时欲root权限,有些许栽办法可形成。

平等种植艺术是使sudo一声令下运行NodeJS。例如通过以下命令运行的server.js遇发出权力行使80及443端口。一般推荐这种方法,可以保证单独为发出得之JS脚本提供root权限。

$ sudo node server.js

旁一样种方法是运chmod +s指令于NodeJS总是因为root权限运行,具体做法如下。因为这种艺术叫另外JS脚本都起了root权限,不极端安全,因此在用充分考虑安全之系下未推荐以。

$ sudo chown root /usr/local/bin/node
$ sudo chmod +s /usr/local/bin/node

模块

编辑稍大一些底程序时相似还见面将代码模块化。在NodeJS中,一般将代码合理拆分到不同的JS文件被,每一个文本就是一个模块,而文件路径就是是模块名。

在编制每个模块时,都起requireexportsmodule老三单优先定义好之变量可供使用。

require

require函数用于在时模块中加载与用别的模块,传入一个模块名,返回一个模块导出对象。模块名可使用相对路径(以./千帆竞发),或者是绝对路径(以/C:等等的盘符开头)。另外,模块名被之.js扩张名好简单。以下是一个例证。

var foo1 = require('./foo');
var foo2 = require('./foo.js');
var foo3 = require('/home/user/foo');
var foo4 = require('/home/user/foo.js');

// foo1至foo4中保留之是暨一个模块的导出对象。

除此以外,可以使用以下方法加载与下一个JSON文件。

var data = require('./data.json');

exports

exports靶是眼下模块的导出对象,用于导出模块公有方法与总体性。别的模块通过require函数使用时模块时获得的即使是眼前模块的exports目标。以下例子中导出了一个国有方法。

exports.hello = function () {
    console.log('Hello World!');
};

module

通过module靶好看到当下模块的有些系消息,但最多之用处是替换当前模块的导出对象。例如模块导出对象默认是一个常备对象,如果想转成为一个函数的口舌,可以使用以下方法。

module.exports = function () {
    console.log('Hello World!');
};

如上代码中,模块默认导出对象被轮换为一个函数。

模块初始化

一个模块中之JS代码仅以模块第一次吃运时实行同样软,并以执行进程遭到初始化模块的导出对象。之后,缓存起来的导出对象吃再使用。

主模块

透过命令行参数传递给NodeJS以启动程序的模块于号称主模块。主模块当调度组成总体程序的另模块形成工作。例如通过以下命令启动程序时,main.js就是主模块。

$ node main.js

完全示例

比如有以下目录。

- /home/user/hello/
    - util/
        counter.js
    main.js

其中counter.js内容如下:

var i = 0;

function count() {
return ++i;
}

exports.count = count;

该模块内部定义了一个私家变量i,并在exports针对象导出了一个国有方法count

主模块main.js情节如下:

var counter1 = require('./util/counter');
var    counter2 = require('./util/counter');

console.log(counter1.count());
console.log(counter2.count());
console.log(counter2.count());

运作该次的结果如下:

$ node main.js
1
2
3

可以视,counter.js并无因为被require了少数不行而初始化两不善。

仲进制模块

尽管一般我们采取JS编写模块,但NodeJS也支持下C/C++编写二进制模块。编译好的二进制模块除了文件扩展名是.node外,和JS模块的行使方法同。虽然二进制模块能运用操作系统提供的持有功能,拥有无限的潜能,但对前端同学而言编写过于艰苦,并且难以超平台利用,因此无在本教程的覆盖范围内。

小结

本章介绍了关于NodeJS的基本概念和利用方式,总结起来有以下知识点:

  • NodeJS是一个JS脚本解析器,任何操作系统下安装NodeJS本质上召开的业务都是管NodeJS执行顺序复制到一个目,然后保证是目录在系统PATH环境变量下,以便终端下可下node命令。

  • 终端下直输入node一声令下可入命令交互模式,很符合用来测试一些JS代码片段,比如正则表达式。

  • NodeJS使用CMD模块系统,主模块当次入口点,所有模块于尽进程中单独初始化一次等。

  • 除非JS模块不克满足急需,否则不要擅自动二进制模块,否则你的用户会于苦连天。

代码的团体及配置

生经历的C程序员在编排一个新程序时首先由make文件写起。同样的,使用NodeJS编写程序前,为了发出只精美的初始,首先用预备好代码的目录结构及配置方式,就不啻修房子要先期增脚手架。本章将介绍和的相关的各种文化。

模块路径解析规则

咱已经了解,require函数支持斜杠(/)或盘符(C:)开头的绝对路径,也支持./发端的相对路径。但当时有限种途径在模块之间确立了强耦合关系,一旦某个模块文件之存放位置要改,使用该模块的别模块的代码也用就调整,变得牵一动员全身。因此,require函数支持第三栽样式的不二法门,写法类似于foo/bar,并逐项按以下规则解析路径,直到找到模块位置。

  1. 放置模块

    假设传递让require函数的凡NodeJS内置模块名称,不做路径解析,直接返回内部模块的导出对象,例如require('fs')

  2. node_modules目录

    NodeJS定义了一个非常之node_modules目用于存放模块。例如有模块的绝对路径是/home/user/hello.js,在该模块中行使require('foo/bar')道加载模块时,则NodeJS依次尝试以以下途径。

     /home/user/node_modules/foo/bar
     /home/node_modules/foo/bar
     /node_modules/foo/bar
    
  3. NODE_PATH环境变量

    跟PATH环境变量类似,NodeJS允许通过NODE_PATH环境变量来指定额外的模块搜索路径。NODE_PATH环境变量中寓一至多只目录路径,路径之间在Linux下用:分隔,在Windows下使用;隔。例如定义了以下NODE_PATH环境变量:

     NODE_PATH=/home/user/lib:/home/lib
    

    当使用require('foo/bar')的计加载模块时,则NodeJS依次尝试以下途径。

     /home/user/lib/foo/bar
     /home/lib/foo/bar
    

包(package)

咱俩都亮了JS模块的中心单位凡单科JS文件,但复杂些的模块往往出于多独子模块组成。为了便于管理和利用,我们可以把由多只子模块组成的百般模块称做,并把所有子模块放在和一个目里。

当做一个确保的所有子模块中,需要发一个入口模块,入口模块的导出对象为当作保之导出对象。例如有以下目录结构。

- /home/user/lib/
    - cat/
        head.js
        body.js
        main.js

其中cat目录定义了一个保证,其中含了3单子模块。main.js当入口模块,其情如下:

var head = require('./head');
var body = require('./body');

exports.create = function (name) {
return {
name: name,
head: head.create(),
body: body.create()
};
};

每当任何模块里下包的时节,需要加载包之输入模块。接着上例,使用require('/home/user/lib/cat/main')可知达到目的,但是进口模块名称出现在路里看上去不是单好主意。因此我们要开点额外的行事,让包下起来还如是单科模块。

index.js

当模块的文本称是index.js,加载模块时得以模块所在目录的路子代替模块文件路径,因此就上例,以下简单长语句等价。

var cat = require('/home/user/lib/cat');
var cat = require('/home/user/lib/cat/index');

如此处理后,就只是需要把包目录路径传递让require函数,感觉上举目录为当单个模块使用,更发出整体感。

package.json

万一想从定义入口模块的文本称以及存放位置,就用在包目录下富含一个package.json文件,并当里面指定入口模块的路线。上例被的cat模块可重构如下。

- /home/user/lib/
    - cat/
        + doc/
        - lib/
            head.js
            body.js
            main.js
        + tests/
        package.json

其中package.json内容如下。

{
    "name": "cat",
    "main": "./lib/main.js"
}

如此一来,就同样可以require('/home/user/lib/cat')的章程加载模块。NodeJS会根据包目录下的package.json找到入口模块所在位置。

一声令下行程序

动用NodeJS编写的事物,要么是一个保险,要么是一个指令行程序,而前者最终为会见用来开发后者。因此我们在布置代码时索要有术,让用户认为自己是以使用一个命令行程序。

譬如我们之所以NodeJS写了单次,可以把命执行参数原样打印出来。该次非常简单,在主模块内实现了富有机能。并且写好后,我们管欠次部署在/home/user/bin/node-echo.js斯职位。为了在另目录下都能够运行该次,我们得采取以下终端命令。

$ node /home/user/bin/node-echo.js Hello World
Hello World

这种用方式看起有点像是一个下令行程序,下边的才是咱们要之艺术。

$ node-echo Hello World

Linux

以Linux系统下,我们可拿JS文件作为shell脚本来运行,从而达成上述目的,具体步骤如下:

  1. 当shell脚本中,可以透过#!注解来指定当前剧本使用的解析器。所以我们第一以node-echo.js文本顶部增加以下一行注释,表明当前剧本使用NodeJS解析。

     #! /usr/bin/env node
    

    NodeJS会忽略掉放在JS模块首行的#!诠释,不必顾虑这行注释是私自语句。

  2. 下一场,我们采用以下命令赋予node-echo.js文本实施权。

     $ chmod +x /home/user/bin/node-echo.js
    
  3. 末,我们以PATH环境变量中指定的某某目录下,例如当/usr/local/bin下面创建一个软链文件,文件称以及我们希望利用的终点命令同名,命令如下:

     $ sudo ln -s /home/user/bin/node-echo.js /usr/local/bin/node-echo
    

然处理后,我们尽管好在外目录下采取node-echo命令了。

Windows

在Windows系统下的做法了两样,我们得仰仗.cmd文件来解决问题。假设node-echo.js存放在C:\Users\user\bin目,并且该目录就补充加到PATH环境变量里了。接下来要在该目录下新建一个名为也node-echo.cmd的文件,文件内容如下:

@node "C:\User\user\bin\node-echo.js" %*

诸如此类处理后,我们尽管好以外目录下使用node-echo命令了。

工目录

打探了上述文化后,现在我们得以来完全地规划一个工程目录了。以编制一个指令行程序为条例,一般我们会又提供命令行模式和API模式简单种植使方法,并且我们见面凭借三正值担保来编排代码。除了代码外,一个完好无损的顺序也相应来温馨之文档和测试用例。因此,一个业内的工程目录都看起像下这样。

- /home/user/workspace/node-echo/   # 工程目录
    - bin/                          # 存放命令行相关代码
        node-echo
    + doc/                          # 存放文档
    - lib/                          # 存放API相关代码
        echo.js
    - node_modules/                 # 存放三方包
        + argv/
    + tests/                        # 存放测试用例
    package.json                    # 元数据文件
    README.md                       # 说明文件

内有些文件内容如下:

/* bin/node-echo */
var argv = require('argv'),
    echo = require('../lib/echo');
console.log(echo(argv.join(' ')));

/ lib/echo.js /
module.exports = function (message) {
return message;
};

/ package.json /
{
“name”: “node-echo”,
“main”: “./lib/echo.js”
}

以上例子中分类存放了不同品种的公文,并经过node_moudles目录直接以三正包名加载模块。此外,定义了package.json之后,node-echo目也可吃当一个包来使用。

NPM

NPM是连同NodeJS一起安装之担保管理工具,能解决NodeJS代码部署及之洋洋题材,常见的使状况有以下几栽:

  • 许用户从NPM服务器下充斥他人修的老三方担保及地方利用。

  • 许用户从NPM服务器下载并安装别人修的通令行程序到地方使用。

  • 兴用户用团结修的保险要指令行程序上传出NPM服务器供别人利用。

足见见,NPM建立了一个NodeJS生态圈,NodeJS开发者和用户可于中互通有无。以下分别介绍这三栽情景下何以使用NPM。

下载三着担保

内需运用三正在包时,首先得清楚有什么包可用。虽然npmjs.org提供了只搜索框可以因包名来探寻,但万一连想利用的老三正担保的讳还不确定的话,就伸手百度瞬间咔嚓。知道了包名后,比如上边例子中的argv,就足以当工程目录下开辟终端,使用以下命令来下充斥三方包。

$ npm install argv
...
argv@0.0.2 node_modules\argv

下载好后,argv包就坐落了工目录下的node_modules目中,因此于代码中独需要经require('argv')的艺术就是哼,无需指定三正担保路径。

以上命令默认下充斥最新版本三正值担保,如果想使下载指定版本的话,可以以包名后止加上@<version>,例如通过以下命令可下充斥0.0.1本的argv

$ npm install argv@0.0.1
...
argv@0.0.1 node_modules\argv

如果下及之老三正担保比多,在终端下一个管教一漫长命令地安装不休太人肉了。因此NPM对package.json的字段做了扩大,允许以内部发明三着担保依赖。因此,上边例子中之package.json得改写如下:

{
    "name": "node-echo",
    "main": "./lib/echo.js",
    "dependencies": {
        "argv": "0.0.2"
    }
}

这么处理后,在工程目录下虽可采用npm install命令批量装置三正值担保了。更着重的是,当以后node-echo呢上传到了NPM服务器,别人下载者包时,NPM会根据包中申明的老三正在担保依赖自动下充斥进一步因的老三方包。例如,使用npm install node-echo指令时,NPM会自动创建以下目录结构。

- project/
    - node_modules/
        - node-echo/
            - node_modules/
                + argv/
            ...
    ...

如此一来,用户只待关注好直接采用的老三方担保,不需团结失去解决有保险之赖关系。

安装命令行程序

自打NPM服务上下载安装一个发令行程序的点子以及三着担保类似。例如上例被之node-echo提供了命令行使用办法,只要node-echo温馨安排好了有关的package.json字段,对于用户而言,只需要使用以下命令安装程序。

$ npm install node-echo -g

参数中之-g意味着全局安装,因此node-echo见面默认安装至以下职务,并且NPM会自动创建好Linux系统下得之软链文件要Windows系统下需要的.cmd文件。

- /usr/local/               # Linux系统下
    - lib/node_modules/
        + node-echo/
        ...
    - bin/
        node-echo
        ...
    ...

- %APPDATA%\npm\            # Windows系统下
    - node_modules\
        + node-echo\
        ...
    node-echo.cmd
    ...

披露代码

第一软以NPM发布代码前用报一个账号。终端下运行npm adduser,之后以提示做即可。账号搞定后,接着我们得编制package.json文件,加入NPM必需的字段。接着上边node-echo的例子,package.json里必不可少之字段如下。

{
    "name": "node-echo",           # 包名,在NPM服务器上须要保持唯一
    "version": "1.0.0",            # 当前版本号
    "dependencies": {              # 三方包依赖,需要指定包名和版本号
        "argv": "0.0.2"
      },
    "main": "./lib/echo.js",       # 入口模块位置
    "bin" : {
        "node-echo": "./bin/node-echo"      # 命令行程序名和主模块位置
    }
}

然后,我们不怕得于package.json处处目录下运行npm publish发表代码了。

版本号

运用NPM下载和公布代码时犹见面接触到版本号。NPM使用语义版本号来保管代码,这里大概介绍一下。

语义版本号分为X.Y.Z其三号,分别表示主版本号、次版本号和补丁版本号。当代码变更时,版本号以以下原则更新。

+ 如果只是修复bug,需要更新Z位。

+ 如果是新增了功能,但是向下兼容,需要更新Y位。

+ 如果有大变动,向下不兼容,需要更新X位。

本号发出了这个保险后,在说明三方担保依赖时,除了可依靠让一个一定版本号他,还可因让有范围的版本号。例如"argv": "0.0.x"表示因让0.0.x多样的新星版本argv。NPM支持之有版本号范围点名方式得以查看法定文档。

心机一点

除本章介绍的部分外,NPM还提供了众多效应,package.json里吗生成千上万任何有效之字段。除了可以在npmjs.org/doc/翻官方文档外,这里还介绍一些NPM常用命令。

  • NPM提供了过多发令,例如installpublish,使用npm help唯独查有命令。

  • 使用npm help <command>但是查阅有条命令的详细帮助,例如npm help install

  • package.json四处目录下以npm install . -g然而优先以地头安装时令行程序,可用于发布前的地面测试。

  • 使用npm update <package>可拿当前目录下node_modules子目录里边的相应模块更新至时版本。

  • 使用npm update <package> -g好拿全局安装的对应命令行程序更新至顶新版。

  • 使用npm cache clear可以清空NPM本地缓存,用于对付使用同一版本号发布新本子代码的人头。

  • 使用npm unpublish <package>@<version>足取消发布温馨公布了之某个版本代码。

小结

本章介绍了利用NodeJS编写代码前待举行的准备工作,总结起来有以下几点:

  • 编辑代码前先筹好目录结构,才能够形成有条不紊。

  • 稍加深把的先后可以将代码拆分为多单模块管理,更充分把的次第可以利用包来组织模块。

  • 理所当然施用node_modulesNODE_PATH来解耦包的动方式以及大体路径。

  • 下NPM加入NodeJS生态圈互通有管。

  • 想开了向往之包名时请提前在NPM上抢注。

文本操作

为前者觉得如得神器的非是NodeJS能召开网络编程,而是NodeJS能够操作文件。小至文件查找,大及代码编译,几乎从不一个前端工具不操作文件。换个角度讲,几乎也就需要有的数目处理逻辑,再长有文本操作,就会编写出大部分前端工具。本章将介绍与之休戚相关的NodeJS内置模块。

开门红

NodeJS提供了核心的文书操作API,但是像文件拷贝这种高级功能就不曾供,因此我们先以文件拷贝程序练手。与copy指令类似,我们的顺序要能接受源文件路径和目标文件路径两独参数。

有点文件拷贝

咱用NodeJS内置的fs模块简单实现之次如下。

var fs = require('fs');

function copy(src, dst) {
fs.writeFileSync(dst, fs.readFileSync(src));
}

function main(argv) {
copy(argv[0], argv[1]);
}

main(process.argv.slice(2));

如上程序采取fs.readFileSync从今根源路读取文件内容,并行使fs.writeFileSync拿文件内容写副目标路径。

豆知识:
process凡是一个全局变量,可经过process.argv收获命令执行参数。由于argv[0]一贯等NodeJS执行顺序的绝对路径,argv[1]固化等主模块的绝对路径,因此首先个令执行参数从argv[2]斯职位上马。

万分文件拷贝

上的次第拷贝一些有点文件没有啥问题,但这种一次性将具有文件内容还读取到外存中后还一次性写副磁盘的方式不相符拷贝大文件,内存会爆仓。对于那个文件,我们不得不读一些写一些,直到好拷贝。因此上边的先后要改造如下。

var fs = require('fs');

function copy(src, dst) {
fs.createReadStream(src).pipe(fs.createWriteStream(dst));
}

function main(argv) {
copy(argv[0], argv[1]);
}

main(process.argv.slice(2));

上述程序下fs.createReadStream始建了一个来源于文件的单纯读数据流,并运用fs.createWriteStream创建了一个靶文件之单写数据流,并且因此pipe艺术把有限个数据流连接了起。连接起来后出的事情,说得抽象点的话,水顺着水管从一个桶流到了任何一个桶。

API走马观花

咱们事先盖看看NodeJS提供了如何与文件操作有关的API。这里连无逐一介绍每个API的运方法,官方文档已经举行得不得了好了。

Buffer(数据块)

法定文档: http://nodejs.org/api/buffer.html

JS语言自身就生字符串数据类型,没有二进制数据类型,因此NodeJS提供了一个以及String对顶的大局构造函数Buffer来提供对二进制数据的操作。除了可以读取文件得到Buffer的实例外,还能直接组织,例如:

var bin = new Buffer([ 0x68, 0x65, 0x6c, 0x6c, 0x6f ]);

Buffer和字符串类似,除了可以就此.length性得到字节长度外,还可据此[index]计读取指定位置的字节,例如:

bin[0]; // => 0x68;

Buffer和字符串能够互相转化,例如可以应用指定编码将二进制数据转发为字符串:

var str = bin.toString('utf-8'); // => "hello"

要么转,将字符串转换为指定编码下的二进制数据:

var bin = new Buffer('hello', 'utf-8'); // => <Buffer 68 65 6c 6c 6f>

Buffer同字符串有一个主要分。字符串是一味读之,并且对字符串的其他修改得的都是一个新字符串,原字符串保持不转换。至于Buffer,更如是可做指针操作的C语言数组。例如,可以为此[index]计一直改动某位置的字节。

bin[0] = 0x48;

.slice艺术也无是回来一个新的Buffer,而重如是返了依赖于本Buffer中级的某某位置的指针,如下所示。

[ 0x68, 0x65, 0x6c, 0x6c, 0x6f ]
    ^           ^
    |           |
   bin     bin.slice(2)

因此对.slice术返回的Buffer的修改会作用被原来Buffer,例如:

var bin = new Buffer([ 0x68, 0x65, 0x6c, 0x6c, 0x6f ]);
var sub = bin.slice(2);

sub[0] = 0x65;
console.log(bin); // =>

也就此,如果想如果拷贝一卖Buffer,得首先创建一个新的Buffer,并通过.copy办法将本Buffer惨遭之多少复制过去。这个类似于申请一块新的内存,并将已经产生外存中的数复制过去。以下是一个例证。

var bin = new Buffer([ 0x68, 0x65, 0x6c, 0x6c, 0x6f ]);
var dup = new Buffer(bin.length);

bin.copy(dup);
dup[0] = 0x48;
console.log(bin); // =>
console.log(dup); // =>

总之,Buffer以JS的数额处理能力由字符串扩展至了随便二进制数据。

Stream(数据流)

官方文档: http://nodejs.org/api/stream.html

当内存中无法同不善装下得处理的数额常常,或者一边读取一边处理越迅速时,我们便用用到数据流。NodeJS中经各种Stream来供针对性数据流的操作。

上述边的不得了文件拷贝程序吗例,我们可为多少来源创建一个就念数据流,示例如下:

var rs = fs.createReadStream(pathname);

rs.on(‘data’, function (chunk) {
doSomething(chunk);
});

rs.on(‘end’, function () {
cleanUp();
});

豆知识:
Stream冲事件机制工作,所有Stream的实例都连续给NodeJS提供的EventEmitter。

上的代码中data事件会源源不断地给硌,不管doSomething函数是否处理得回复。代码可以连续召开如下改造,以缓解此题材。

var rs = fs.createReadStream(src);

rs.on(‘data’, function (chunk) {
rs.pause();
doSomething(chunk, function () {
rs.resume();
});
});

rs.on(‘end’, function () {
cleanUp();
});

以上代码给doSomething函数加上了回调,因此我们得以以处理多少前暂停数据读取,并于处理数量后连续读取数据。

除此以外,我们啊可以吧数量目标创造一个特写数据流,示例如下:

var rs = fs.createReadStream(src);
var ws = fs.createWriteStream(dst);

rs.on(‘data’, function (chunk) {
ws.write(chunk);
});

rs.on(‘end’, function () {
ws.end();
});

我们把doSomething变成了向就写多少流里写副数据后,以上代码看起便比如是一个文件拷贝程序了。但是上述代码是上提到的题材,如果写副速度跟不上读取速度之言辞,只写多少流内部的休养存会爆仓。我们好依据.write办法的归来值来判定传入的数据是描摹副目标了,还是临时在了缓存了,并冲drain事件来判定什么时就写数据流已经拿缓存中之数据勾勒副目标,可以流传下一个需要写多少了。因此代码可以改造如下:

var rs = fs.createReadStream(src);
var ws = fs.createWriteStream(dst);

rs.on(‘data’, function (chunk) {
if (ws.write(chunk) === false) {
rs.pause();
}
});

rs.on(‘end’, function () {
ws.end();
});

ws.on(‘drain’, function () {
rs.resume();
});

以上代码实现了多少从单纯念数据流到只写数据流的搬运,并包了防范爆仓控制。因为这种使用状况很多,例如头的好文件拷贝程序,NodeJS直接提供了.pipe法来开这件业务,其内部贯彻方式跟上方的代码类似。

File System(文件系统)

官方文档: http://nodejs.org/api/fs.html

NodeJS通过fs嵌入模块提供对文本之操作。fs模块提供的API基本上可以分为以下三近似:

  • 文件属性读写。

    内部常用之发出fs.statfs.chmodfs.chown等等。

  • 文件内容念写。

    内常用的有fs.readFilefs.readdirfs.writeFilefs.mkdir等等。

  • 根文件操作。

    个中常用的出fs.openfs.readfs.writefs.close等等。

NodeJS最精华的异步IO模型在fs模块里所有充分的体现,例如头提到的这些API都通过回调函数传递结果。以fs.readFile为例:

fs.readFile(pathname, function (err, data) {
    if (err) {
        // Deal with error.
    } else {
        // Deal with data.
    }
});

若果上边代码所示,基本上所有fs模块API的回调参数都产生点儿独。第一个参数在生荒唐产生时相当异常对象,第二只参数始终用来返回API方法执行结果。

此外,fs模块的具备异步API都发生相应的齐版本,用于无法运用异步操作时,或者同步操作更便利时之情形。同步API除了艺术名之末段多矣一个Sync外,异常对象与实施结果的传递方式啊闹相应变更。同样因为fs.readFileSync为例:

try {
    var data = fs.readFileSync(pathname);
    // Deal with data.
} catch (err) {
    // Deal with error.
}

fs模块提供的API很多,这里不一一介绍,需要时要自行查阅官方文档。

Path(路径)

法定文档: http://nodejs.org/api/path.html

操作文件时难免不跟公事路径打交道。NodeJS提供了path放置模块来简化路径相关操作,并升级代码可读性。以下分别介绍几只常因此的API。

  • path.normalize

    将盛传的不二法门转换为规范路径,具体讲的语句,除了解析路径中之...外,还会去丢多余的斜杠。如果起次序要动用路径作为少数数据的目,但又允许用户擅自输入路径时,就得使用该方式保证路径的唯一性。以下是一个例证:

      var cache = {};
    

      function store(key, value) {
          cache[path.normalize(key)] = value;
      }
    

      store('foo/bar', 1);
      store('foo//baz//../bar', 2);
      console.log(cache);  // => { "foo/bar": 2 }
    

    坑有无注意:
    标准化后的不二法门里的斜杠在Windows系统下是\,而在Linux系统下是/。如果想保其他系统下还以/用作路径分隔符的讲话,需要因此.replace(/\\/g, '/')重复交替一下标准路径。

  • path.join

    以盛传的大多只路子拼接为规范路径。该方法可避免手工拼接路径字符串的麻烦,并且能在不同体系下是采取相应的路线分隔符。以下是一个例证:

      path.join('foo/', 'baz/', '../bar'); // => "foo/bar"
    
  • path.extname

    当我们要依据不同文件扩展名做不同操作时,该办法就是显得很好用。以下是一个例子:

      path.extname('foo/bar.js'); // => ".js"
    

path模块提供的其他方法吗非多,稍微看一下官文档就会全左右。

遍历目录

遍历目录是操作文件时的一个常见需求。比如写一个程序,需要找到并处理指定目录下的具有JS文件时,就需遍历整个目录。

递归算法

遍历目录时一般采用递归算法,否则就是不便编写出简洁之代码。递归算法和数学归纳法类似,通过持续压缩问题的局面来化解问题。以下示例说明了这种措施。

function factorial(n) {
    if (n === 1) {
        return 1;
    } else {
        return n * factorial(n - 1);
    }
}

头的函数用于计算N的阶乘(N!)。可以看来,当N大于1时,问题简化为计算N乘以N-1的阶乘。当N等于1时,问题上最小圈圈,不待再次简化,因此一直返回1。

陷阱:
使用递归算法编写的代码虽然简单,但鉴于每递归一软就是闹相同浅函数调用,在急需事先考虑性能时,需要拿递归算法转换为循环算法,以减小函数调用次数。

遍历算法

目录是一个树状结构,在总体历时一般下深度优先+先先后遍历算法。深度优先,意味着到一个节点后,首先随着举历子节点而无是邻居节点。先序遍历,意味着首差至了有节点就算遍历完成,而非是最后一浅回到某节点才算数。因此下这种遍历方式时,下边这棵树的遍历顺序是A > B > D > E > C > F

          A
         / \
        B   C
       / \   \
      D   E   F

联手遍历

了解了不可或缺之算法后,我们可概括地贯彻以下目录遍历函数。

function travel(dir, callback) {
    fs.readdirSync(dir).forEach(function (file) {
        var pathname = path.join(dir, file);

if (fs.statSync(pathname).isDirectory()) {
travel(pathname, callback);
} else {
callback(pathname);
}
});
}

可见见,该函数以某个目录作为遍历的起点。遇到一个子目录时,就先跟着整个历子目录。遇到一个文本时,就管文件的绝对路径传给回调函数。回调函数拿到文件路径后,就得举行各种判断与拍卖。因此只要来以下目录:

- /home/user/
    - foo/
        x.js
    - bar/
        y.js
    z.css

运用以下代码遍历该目录时,得到的输入如下。

travel('/home/user', function (pathname) {
    console.log(pathname);
});

/home/user/foo/x.js
/home/user/bar/y.js
/home/user/z.css

异步遍历

假使读取目录或读取文件状态时行使的是异步API,目录遍历函数实现起来会略复杂,但原理完全一致。travel函数的异步版本如下。

function travel(dir, callback, finish) {
    fs.readdir(dir, function (err, files) {
        (function next(i) {
            if (i < files.length) {
                var pathname = path.join(dir, files[i]);

fs.stat(pathname, function (err, stats) {
if (stats.isDirectory()) {
travel(pathname, callback, function () {
next(i + 1);
});
} else {
callback(pathname, function () {
next(i + 1);
});
}
});
} else {
finish && finish();
}
}(0));
});
}

这边不详细介绍异步遍历函数的编技巧,在持续章节中见面详细介绍这。总之我们得看看异步编程还是那个复杂的。

文本编码

动NodeJS编写前端工具时,操作得最为多之凡文件文件,因此为就是关系到了文件编码的拍卖问题。我们经常因此之文件编码有UTF8GBK两种,并且UTF8文件还可能含有BOM。在读取不同编码的文件文件时,需要用文件内容转换为JS使用的UTF8编码字符串后才能够正常处理。

BOM的移除

BOM用于标记一个文件文件使用Unicode编码,其本人是一个Unicode字符(”\uFEFF”),位于文本文件头部。在不同之Unicode编码下,BOM字符对应的次前进制字节如下:

    Bytes      Encoding
----------------------------
    FE FF       UTF16BE
    FF FE       UTF16LE
    EF BB BF    UTF8

故此,我们得以依据文件文件头几乎只字节等于啥来判断文件是否包含BOM,以及用啊种Unicode编码。但是,BOM字符虽然从及了标记文件编码的图,其自也休属文件内容的同等局部,如果读取文本文件时未去掉BOM,在某些使用状况下虽会见产生题目。例如我们将几独JS文件合并成为一个文书后,如果文件中含有BOM字符,就见面造成浏览器JS语法错误。因此,使用NodeJS读取文本文件时,一般用去掉BOM。例如,以下代码实现了甄别与去UTF8
BOM的功用。

function readText(pathname) {
    var bin = fs.readFileSync(pathname);

if (bin[0] === 0xEF && bin[1] === 0xBB && bin[2] === 0xBF) {
bin = bin.slice(3);
}

return bin.toString(‘utf-8’);
}

GBK转UTF8

NodeJS支持在读取文本文件时,或者以Buffer变为字符串时指定文本编码,但遗憾的凡,GBK编码不以NodeJS自身支持范围外。因此,一般我们借助iconv-lite这三正担保来换编码。使用NPM下充斥该包后,我们得按下方式编写一个读取GBK文本文件之函数。

var iconv = require('iconv-lite');

function readGBKText(pathname) {
var bin = fs.readFileSync(pathname);

return iconv.decode(bin, ‘gbk’);
}

单字节编码

偶然,我们无能为力预知需要读取的公文采用哪种编码,因此为不怕无法指定正确的编码。比如我们设处理的少数CSS文件被,有的据此GBK编码,有的据此UTF8编码。虽然可得水平足以依据文件之字节内容猜测出文本编码,但此而介绍的是起若干局限,但是只要简明得几近之相同种植技术。

率先我们了解,如果一个文本文件只包含英文字符,比如Hello World,那无论是用GBK编码或是UTF8编码读取这个文件都是从未问题的。这是以于这些编码下,ASCII0~128克外字符都采取相同的单字节编码。

反过来讲,即使一个文本文件中生出中文等字符,如果我们要处理的字符仅在ASCII0~128限外,比如除了注释和字符串以外的JS代码,我们尽管足以合以单字节编码来读取文件,不用关心文件之实在编码是GBK还是UTF8。以下示例说明了这种方法。

1. GBK编码源文件内容:
    var foo = '中文';
2. 对应字节:
    76 61 72 20 66 6F 6F 20 3D 20 27 D6 D0 CE C4 27 3B
3. 使用单字节编码读取后得到的内容:
    var foo = '{乱码}{乱码}{乱码}{乱码}';
4. 替换内容:
    var bar = '{乱码}{乱码}{乱码}{乱码}';
5. 使用单字节编码保存后对应字节:
    76 61 72 20 62 61 72 20 3D 20 27 D6 D0 CE C4 27 3B
6. 使用GBK编码读取后得到内容:
    var bar = '中文';

此的门槛在于,不管大于0xEF的单个字节在单字节编码下于分析成什么乱码字符,使用同样的单字节编码保留这些乱码字符时,背后对应的字节保持不变换。

NodeJS中由带了同样种植binary编码可以据此来促成者办法,因此在下例中,我们运用这种编码来演示上例对应的代码该怎么形容。

function replace(pathname) {
    var str = fs.readFileSync(pathname, 'binary');
    str = str.replace('foo', 'bar');
    fs.writeFileSync(pathname, str, 'binary');
}

小结

本章介绍了采取NodeJS操作文件时索要的API以及有技术,总结起来有以下几点:

  • 学好文件操作,编写各种程序还尽管。

  • 要是非是可怜在全性能,fs模块的同步API能被在更加光明。

  • 急需针对文件读写得字节级别之精工细作控制时,请用fs模块的文书底层操作API。

  • 甭使用拼接字符串的方来拍卖途径,使用path模块。

  • 控好目录遍历和文件编码处理技术,很实用。

纱操作

莫打听网络编程的程序员不是好前端,而NodeJS恰好提供了同一鼓了解网络编程的窗口。通过NodeJS,除了可编制一些服务端程序来帮忙前端开发和测试外,还会学习一些HTTP协议和Socket协议的连锁知识,这些知识以优化前端性能及排查前端故障时或许会派上用场。本章将介绍及的休戚相关的NodeJS内置模块。

开门红

NodeJS本来之用是编写高性能Web服务器。我们先是以这边再次一下合法文档里的事例,使用NodeJS内置的http模块简单实现一个HTTP服务器。

var http = require('http');

http.createServer(function (request, response) {
response.writeHead(200, { ‘Content-Type’: ‘text-plain’ });
response.end(‘Hello World\n’);
}).listen(8124);

以上程序创建了一个HTTP服务器并监听8124端口,打开浏览器访问该端口http://127.0.0.1:8124/就算能够看出效果。

豆知识:
在Linux系统下,监听1024之下端口需要root权限。因此,如果想监听80要么443端口之语句,需要以sudo命令启动程序。

API走马观花

俺们事先盖看看NodeJS提供了什么样以及网操作有关的API。这里并无逐一介绍每个API的利用办法,官方文档已经做得稀好了。

HTTP

法定文档: http://nodejs.org/api/http.html

‘http’模块提供零星栽采取方式:

  • 作为服务端使用时,创建一个HTTP服务器,监听HTTP客户端请求并返响应。

  • 作为客户端采用时,发起一个HTTP客户端请求,获取服务端响应。

首先我们来瞧服务端模式下何以做事。如开门红中之例证所示,首先需要使用.createServer办法创建一个服务器,然后调用.listen法监听端口。之后,每当来了一个客户端请求,创建服务器时传入的回调函数就叫调用一潮。可以看看,这是同种植事件机制。

HTTP请求精神上是一个数据流,由要求头(headers)和呼吁求体(body)组成。例如以下是一个一体化的HTTP请求数据内容。

POST / HTTP/1.1
User-Agent: curl/7.26.0
Host: localhost
Accept: */*
Content-Length: 11
Content-Type: application/x-www-form-urlencoded

Hello World

足见见,空行之上是央求头,之下是央求体。HTTP请求于发送给服务器时,可以看是按照从头到尾的依次一个字节一个字节地盖数流方式发送的。而http模块创建的HTTP服务器在收到及一体化的求头晚,就见面调用回调函数。在回调函数中,除了可以以request对象看请求求头数据外,还会拿request对象当作一个一味念数据流来访问请求求体数据。以下是一个例证。

http.createServer(function (request, response) {
    var body = [];

console.log(request.method);
console.log(request.headers);

request.on(‘data’, function (chunk) {
body.push(chunk);
});

request.on(‘end’, function () {
body = Buffer.concat(body);
console.log(body.toString());
});
}).listen(80);

POST
{ 'user-agent': 'curl/7.26.0',
  host: 'localhost',
  accept: '*/*',
  'content-length': '11',
  'content-type': 'application/x-www-form-urlencoded' }
Hello World

HTTP响应本质上也是一个数据流,同样出于响应头(headers)和响应体(body)组成。例如以下是一个整体的HTTP请求数据内容。

HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 11
Date: Tue, 05 Nov 2013 05:31:38 GMT
Connection: keep-alive

Hello World

当回调函数中,除了可以使用response目标来写入响应头数据外,还会拿response目标当作一个只是写多少流来写副响应体数据。例如当偏下例子中,服务端原样将客户端请求的请求体数据返回给客户端。

http.createServer(function (request, response) {
    response.writeHead(200, { 'Content-Type': 'text/plain' });

request.on(‘data’, function (chunk) {
response.write(chunk);
});

request.on(‘end’, function () {
response.end();
});
}).listen(80);

搭下去我们看客户端模式下何以做事。为了提倡一个客户端HTTP请求,我们得指定目标服务器的职务并发送请求头和请求求体,以下示例演示了具体做法。

var options = {
        hostname: 'www.example.com',
        port: 80,
        path: '/upload',
        method: 'POST',
        headers: {
            'Content-Type': 'application/x-www-form-urlencoded'
        }
    };

var request = http.request(options, function (response) {});

request.write(‘Hello World’);
request.end();

好看来,.request法创建了一个客户端,并点名要目标及请求头数据。之后,就得把request靶当作一个一味写多少流来写副请求体数据和终结请求。另外,由于HTTP请求被GET吁是极其常见的同样栽,并且不需请求体,因此http模块也供了以下就捷API。

http.get('http://www.example.com/', function (response) {});

当客户端发送请求并吸收到整的服务端响应头时,就会见调用回调函数。在回调函数中,除了可以动用response目标看响应头数据外,还会将response目标当作一个只念数据流来访问响应体数据。以下是一个事例。

http.get('http://www.example.com/', function (response) {
    var body = [];

console.log(response.statusCode);
console.log(response.headers);

response.on(‘data’, function (chunk) {
body.push(chunk);
});

response.on(‘end’, function () {
body = Buffer.concat(body);
console.log(body.toString());
});
});

200
{ 'content-type': 'text/html',
  server: 'Apache',
  'content-length': '801',
  date: 'Tue, 05 Nov 2013 06:08:41 GMT',
  connection: 'keep-alive' }
<!DOCTYPE html>
...

HTTPS

法定文档: http://nodejs.org/api/https.html

https模块与http模块极为类似,区别在https模块需要格外处理SSL证书。

于服务端模式下,创建一个HTTPS服务器的演示如下。

var options = {
        key: fs.readFileSync('./ssl/default.key'),
        cert: fs.readFileSync('./ssl/default.cer')
    };

var server = https.createServer(options, function (request, response) {
// …
});

足见到,与创造HTTP服务器相比,多了一个options对象,通过keycert字段指定了HTTPS服务器使用的私钥和公钥。

此外,NodeJS支持SNI技术,可以依据HTTPS客户端请求使用的域名动态下不同的证件,因此与一个HTTPS服务器可以用多单域名提供劳动。接着上例,可以使以下措施为HTTPS服务器添加多组关系。

server.addContext('foo.com', {
    key: fs.readFileSync('./ssl/foo.com.key'),
    cert: fs.readFileSync('./ssl/foo.com.cer')
});

server.addContext(‘bar.com’, {
key: fs.readFileSync(‘./ssl/bar.com.key’),
cert: fs.readFileSync(‘./ssl/bar.com.cer’)
});

在客户端模式下,发起一个HTTPS客户端请求和http模块几乎相同,示例如下。

var options = {
        hostname: 'www.example.com',
        port: 443,
        path: '/',
        method: 'GET'
    };

var request = https.request(options, function (response) {});

request.end();

可若是目标服务器使用的SSL证书是自制的,不是自发布机构市之,默认情况下https模块会拒绝连接,提示说生证书安全题材。在options里加入rejectUnauthorized: false字段可以禁用对关系中的自我批评,从而允许https模块请求支付条件下用自制证书的HTTPS服务器。

URL

官方文档: http://nodejs.org/api/url.html

处理HTTP请求时url模块使用率超高,因为拖欠模块允许解析URL、生成URL,以及拼接URL。首先我们来看看一个完完全全的URL的各有。

                           href
 -----------------------------------------------------------------
                            host              path
                      --------------- ----------------------------
 http: // user:pass @ host.com : 8080 /p/a/t/h ?query=string #hash
 -----    ---------   --------   ---- -------- ------------- -----
protocol     auth     hostname   port pathname     search     hash
                                                ------------
                                                   query

我们得以利用.parse术来将一个URL字符串转换为URL对象,示例如下。

url.parse('http://user:pass@host.com:8080/p/a/t/h?query=string#hash');
/* =>
{ protocol: 'http:',
  auth: 'user:pass',
  host: 'host.com:8080',
  port: '8080',
  hostname: 'host.com',
  hash: '#hash',
  search: '?query=string',
  query: 'query=string',
  pathname: '/p/a/t/h',
  path: '/p/a/t/h?query=string',
  href: 'http://user:pass@host.com:8080/p/a/t/h?query=string#hash' }
*/

传给.parse措施的无自然要是一个圆的URL,例如当HTTP服务器回调函数中,request.url未分包协议头与域名,但同可以用.parse法分析。

http.createServer(function (request, response) {
    var tmp = request.url; // => "/foo/bar?a=b"
    url.parse(tmp);
    /* =>
    { protocol: null,
      slashes: null,
      auth: null,
      host: null,
      port: null,
      hostname: null,
      hash: null,
      search: '?a=b',
      query: 'a=b',
      pathname: '/foo/bar',
      path: '/foo/bar?a=b',
      href: '/foo/bar?a=b' }
    */
}).listen(80);

.parse术还支持第二个及老三单布尔项目可选参数。第二只参数等于true常常,该措施返回的URL对象中,query字段不再是一个字符串,而是一个经过querystring模块转换后底参数对象。第三单参数等于true常常,该方法可正确解析不牵动协议头的URL,例如//www.example.com/foo/bar

反过来,format艺术允许以一个URL对象转换为URL字符串,示例如下。

url.format({
    protocol: 'http:',
    host: 'www.example.com',
    pathname: '/p/a/t/h',
    search: 'query=string'
});
/* =>
'http://www.example.com/p/a/t/h?query=string'
*/

另外,.resolve办法可用于拼接URL,示例如下。

url.resolve('http://www.example.com/foo/bar', '../baz');
/* =>
http://www.example.com/baz
*/

Query String

法定文档: http://nodejs.org/api/querystring.html

querystring模块用于落实URL参数字符串与参数对象的相转换,示例如下。

querystring.parse('foo=bar&baz=qux&baz=quux&corge');
/* =>
{ foo: 'bar', baz: ['qux', 'quux'], corge: '' }
*/

querystring.stringify({ foo: ‘bar’, baz: [‘qux’, ‘quux’], corge: ” });
/ =>
‘foo=bar&baz=qux&baz=quux&corge=’
/

Zlib

官文档: http://nodejs.org/api/zlib.html

zlib模块提供了数据压缩和解压的成效。当我们处理HTTP请求和响应时,可能得用到此模块。

首先我们看一个以zlib模块压缩HTTP响应体数据的事例。这个事例中,判断了客户端是不是支持gzip,并当支撑之情下下zlib模块返回gzip之后的响应体数据。

http.createServer(function (request, response) {
    var i = 1024,
        data = '';

while (i–) {
data += ‘.’;
}

if ((request.headers[‘accept-encoding’] || ”).indexOf(‘gzip’) !== -1) {
zlib.gzip(data, function (err, data) {
response.writeHead(200, {
‘Content-Type’: ‘text/plain’,
‘Content-Encoding’: ‘gzip’
});
response.end(data);
});
} else {
response.writeHead(200, {
‘Content-Type’: ‘text/plain’
});
response.end(data);
}
}).listen(80);

就我们看一个施用zlib模块解压HTTP响应体数据的事例。这个事例中,判断了服务端响应是否采取gzip压缩,并在减少的景象下利用zlib模块解压响应体数据。

var options = {
        hostname: 'www.example.com',
        port: 80,
        path: '/',
        method: 'GET',
        headers: {
            'Accept-Encoding': 'gzip, deflate'
        }
    };

http.request(options, function (response) {
var body = [];

response.on(‘data’, function (chunk) {
body.push(chunk);
});

response.on(‘end’, function () {
body = Buffer.concat(body);

if (response.headers[‘content-encoding’] === ‘gzip’) {
zlib.gunzip(body, function (err, data) {
console.log(data.toString());
});
} else {
console.log(data.toString());
}
});
}).end();

Net

官方文档: http://nodejs.org/api/net.html

net模块可用于创造Socket服务器或Socket客户端。由于Socket在前者领域的用限制还未是老普遍,这里先不涉到WebSocket的牵线,仅仅略演示一下争自Socket层面来贯彻HTTP请求和响应。

首先我们来拘禁一个动Socket搭建筑一个那个不严谨的HTTP服务器的例证。这个HTTP服务器无收到什么要,都稳定返回相同的应。

net.createServer(function (conn) {
    conn.on('data', function (data) {
        conn.write([
            'HTTP/1.1 200 OK',
            'Content-Type: text/plain',
            'Content-Length: 11',
            '',
            'Hello World'
        ].join('\n'));
    });
}).listen(80);

随后我们来拘禁一个运用Socket发起HTTP客户端请求的事例。这个事例中,Socket客户端在起连接后发送了一个HTTP
GET请求,并通过data事件监听函数来取服务器响应。

var options = {
        port: 80,
        host: 'www.example.com'
    };

var client = net.connect(options, function () {
client.write([
‘GET / HTTP/1.1’,
‘User-Agent: curl/7.26.0’,
‘Host: www.baidu.com’,
‘Accept: /‘,
”,

].join(‘\n’));
});

client.on(‘data’, function (data) {
console.log(data.toString());
client.end();
});

头脑一点

运NodeJS操作网络,特别是操作HTTP请求与应时会碰到有惊喜,这里对片广问题举行解答。

  • 问:
    为什么通过headers对象看到之HTTP请求头或响应头字段未是驼峰的?

    答:
    从正式及言语,HTTP请求头和应头字段都应是驼峰的。但现实是残忍之,不是每个HTTP服务端或客户端程序都严格按照规范,所以NodeJS在拍卖从别的客户端或服务端收到的峰字段经常,都统一地转移为小写字母格式,以便开发者能够应用统一之计来访问头字段,例如headers['content-length']

  • 问:
    为什么http模块创建的HTTP服务器返回的响应是chunked传输方式的?

    报经:
    因为默认情况下,使用.writeHead措施勾勒入响应头后,允许下.write方式勾勒副随便长度的响应体数据,并应用.end主意了一个应。由于响应体数据长度不确定,因此NodeJS自动在响应头里补充加了Transfer-Encoding: chunked字段,并采用chunked传输方式。但是当响应体数据长度确定时,可利用.writeHead艺术以应头里加上Content-Length字段,这样做下NodeJS就非会见活动抬高Transfer-Encoding字段和下chunked传输方式。

  • 叩问:
    为什么使用http模块发起HTTP客户端请求时,有时候会起socket hang up错误?

    报:
    发起客户端HTTP请求前用事先创造一个客户端。http模块提供了一个大局客户端http.globalAgent,可以叫咱们利用.request.get主意时不要手动创建客户端。但是全局客户端默认只同意5只连发Socket连接,当某一个随时HTTP客户端请求创建了多,超过这数字时,就会发socket hang up左。解决办法吧颇简短,通过http.globalAgent.maxSockets特性将此数字改不行些即可。另外,https模块遇到是问题经常为同通过https.globalAgent.maxSockets属性来处理。

小结

本章介绍了采用NodeJS操作网络时需要的API以及一些坑回避技巧,总结起来有以下几点:

  • httphttps模块支持服务端模式和客户端模式简单种植下办法。

  • requestresponse靶除了用于读写头数据外,都得以看作数据流来操作。

  • url.parse措施加上request.url性是处理HTTP请求时的稳搭配。

  • 使用zlib模块可减少使用HTTP协议时之数码传输量。

  • 通过net模块的Socket服务器和客户端可针对HTTP协议举行底层操作。

  • 小心踩坑。

过程管理

NodeJS可以感知和操纵我进程的运作环境暨状态,也得以创建子进程并和该协同工作,这叫NodeJS可以将多只程序组合在一起共同完成某项工作,并当中当胶水和调度器的意图。本章除了介绍与之有关的NodeJS内置模块外,还见面要介绍典型的用状况。

开门红

俺们曾明白了NodeJS自带的fs模块于基础,把一个目录里之兼具文件及子目录都拷贝到任何一个索引里待写过多代码。另外我们吧懂得,终端下之cp令于好用,一长长的cp -r source/* target指令就会搞定目录拷贝。那咱们首先看望哪些运用NodeJS调用极命令来简化目录拷贝,示例代码如下:

var child_process = require('child_process');
var util = require('util');

function copy(source, target, callback) {
child_process.exec(
util.format(‘cp -r %s/* %s’, source, target), callback);
}

copy(‘a’, ‘b’, function (err) {
// …
});

自从以上代码中好观看,子进程是异步运行的,通过回调函数返回执行结果。

API走马观花

俺们先盖看看NodeJS提供了怎样与经过管理有关的API。这里并无逐一介绍每个API的动方式,官方文档已经举行得十分好了。

Process

法定文档: http://nodejs.org/api/process.html

另外一个过程都起启动进程时行使的吩咐执行参数,有专业输入标准输出,有运行权限,有运行条件及运行状态。在NodeJS中,可以通过process对象感知和控制NodeJS自身进程的整套。另外待小心的是,process免是放模块,而是一个大局对象,因此在其余地方都得以一直利用。

Child Process

合法文档: http://nodejs.org/api/child_process.html

使用child_process模块可创造与控制子进程。该模块提供的API中最为中心的凡.spawn,其余API都是对特定使用状况对它们的更封装,算是一栽语法糖。

Cluster

法定文档: http://nodejs.org/api/cluster.html

cluster模块是针对child_process模块的尤为封装,专用于解决但进程NodeJS
Web服务器无法充分利用多核CPU的题材。使用该模块可简化多进程服务器程序的出,让每个核上运行一个办事历程,并联合通过主进程监听端口和分发请求。

动场景

以及经过管理相关的API单独介绍起比干燥,因此这里从一些突出的采用场景出发,分别介绍一些主要API的运用方式。

怎么样获得命令执行参数

于NodeJS中得以经过process.argv收获命令执行参数。但是于奇怪之是,node实行顺序路径和主模块文件路径固定占据了argv[0]argv[1]些微个职务,而首先单指令执行参数从argv[2]开始。为了让argv运用起来越自然,可以以以下方式处理。

function main(argv) {
    // ...
}

main(process.argv.slice(2));

什么退出程序

平常一个程序召开得了所有事情后即见怪不怪退出了,这时程序的退出状态码为0。或者一个程序运行时发生了异常后即便挂了,这时程序的退出状态码不齐0。如果我们于代码中捕获了某个大,但是看程序不应有继续运行下去,需要马上退出,并且要将退出状态码设置也指定数字,比如1,就好依照以下办法:

try {
    // ...
} catch (err) {
    // ...
    process.exit(1);
}

怎么样控制输入输出

NodeJS程序的正规输入流(stdin)、一个规范输出流(stdout)、一个标准错误流(stderr)分别对应process.stdinprocess.stdoutprocess.stderr,第一只是单纯念数据流,后止两独是只写数据流,对它的操作以对数据流的操作方式即可。例如,console.log可以以下方式实现。

function log() {
    process.stdout.write(
        util.format.apply(util, arguments) + '\n');
}

什么降权

当Linux系统下,我们解需要使用root权限才会监听1024之下端口。但是只要完成端口监听后,继续给程序运行在root权限下存在安全隐患,因此最好好会将权降下。以下是如此一个例证。

http.createServer(callback).listen(80, function () {
    var env = process.env,
        uid = parseInt(env['SUDO_UID'] || process.getuid(), 10),
        gid = parseInt(env['SUDO_GID'] || process.getgid(), 10);

process.setgid(gid);
process.setuid(uid);
});

齐例被生几乎点要留意:

  1. 若是透过sudo取root权限的,运行程序的用户之UID和GID保存在环境变量SUDO_UIDSUDO_GID其间。如果是透过chmod +s方式取得root权限的,运行程序的用户的UID和GID可直接通过process.getuidprocess.getgid方取得。

  2. process.setuidprocess.setgid方只有领number花色的参数。

  3. 降权时务必先退GID再退UID,否则顺序反过来的言辞就无权力更改程序的GID了。

怎样创建子进程

以下是一个创办NodeJS子进程的例证。

var child = child_process.spawn('node', [ 'xxx.js' ]);

child.stdout.on(‘data’, function (data) {
console.log(‘stdout: ‘ + data);
});

child.stderr.on(‘data’, function (data) {
console.log(‘stderr: ‘ + data);
});

child.on(‘close’, function (code) {
console.log(‘child process exited with code ‘ + code);
});

达到例被使用了.spawn(exec, args, options)计,该方式支持三单参数。第一只参数是实行文书路径,可以是推行文书之相对还是绝对路径,也得以是冲PATH环境变量能找到的实行文书称。第二个参数中,数组中的每个成员都按梯次对应一个命令执行参数。第三个参数可选取,用于配置子进程的履环境暨作为。

另外,上例被尽管通过子进程对象的.stdout.stderr访问子进程的出口,但经options.stdio字段的异配置,可以将子进程的输入输出重定向到其它数据流上,或者让子进程同享父进程的业内输入输出流,或者直接忽略子进程的输入输出。

经过之中如何报道

当Linux系统下,进程中可由此信号互相通信。以下是一个例证。

/* parent.js */
var child = child_process.spawn('node', [ 'child.js' ]);

child.kill(‘SIGTERM’);

/ child.js /
process.on(‘SIGTERM’, function () {
cleanUp();
process.exit(0);
});

于上例中,父进程经过.kill措施向子进程发送SIGTERM信号,子进程监听process对象的SIGTERM事件响应信号。不要为.kill主意的号迷惑了,该方式本质上是故来给进程发送信号的,进程收到信号后实际而举行什么,完全在信号的类别及经过本身的代码。

除此以外,如果父子进程都是NodeJS进程,就可由此IPC(进程中通讯)双向传递数据。以下是一个事例。

/* parent.js */
var child = child_process.spawn('node', [ 'child.js' ], {
        stdio: [ 0, 1, 2, 'ipc' ]
    });

child.on(‘message’, function (msg) {
console.log(msg);
});

child.send({ hello: ‘hello’ });

/ child.js /
process.on(‘message’, function (msg) {
msg.hello = msg.hello.toUpperCase();
process.send(msg);
});

好看来,父进程在创建子进程时,在options.stdio字段中通过ipc翻开了一致长条IPC通道,之后便得监听子进程对象的message事件接受来自子进程的信息,并通过.send法给子进程发送信息。在分层进程就边,可以于process目标及监听message事件接受来自父亲进程的信,并经.send方法为父亲进程发送信息。数据以传递过程遭到,会先在发送端采用JSON.stringify术序列化,再当接收端使用JSON.parse道反序列化。

怎样近乎护子进程

守护进程一般用来监控工作过程的运转状态,在工作进程不正常退出时再次开工作历程,保障工作过程不间断运行。以下是均等种实现方式。

/* daemon.js */
function spawn(mainModule) {
    var worker = child_process.spawn('node', [ mainModule ]);

worker.on(‘exit’, function (code) {
if (code !== 0) {
spawn(mainModule);
}
});
}

spawn(‘worker.js’);

得视,工作过程非正常退出时,守护进程就又开工作经过。

小结

本章介绍了运用NodeJS管理过程时需要之API以及主要的以场景,总结起来有以下几点:

  • 使用process靶管理我。

  • 使用child_process模块创建与管理子进程。

异步编程

NodeJS最可怜之卖点——事件机制及异步IO,对开发者并无是晶莹剔透底。开发者需要依照异步方式编写代码才用得及是卖点,而立或多或少吧饱受了有NodeJS反对者的口诛笔伐。但不管怎样,异步编程确实是NodeJS最酷之性状,没有控制异步编程就无能够算得真正学会了NodeJS。本章将介绍及异步编程相关的各种知识。

回调

每当代码中,异步编程的直接体现就是是回调。异步编程依托于回调来落实,但未能够说运了回调后先后即使异步化了。我们先是得看看以下代码。

function heavyCompute(n, callback) {
    var count = 0,
        i, j;

for (i = n; i > 0; –i) {
for (j = n; j > 0; –j) {
count += 1;
}
}

callback(count);
}

heavyCompute(10000, function (count) {
console.log(count);
});

console.log(‘hello’);

— Console ——————————
100000000
hello

足见到,以上代码中之回调函数仍然先于后续代码执行。JS本身是单线程运行的,不容许当同样段子代码还免结运行时失去运转别的代码,因此为尽管无有异步执行之概念。

然,如果某个函数做的作业是创建一个别的线程或进程,并同JS主线程并行地召开片事情,并当事情做得了晚通知JS主线程,那情况而未雷同了。我们就看看以下代码。

setTimeout(function () {
    console.log('world');
}, 1000);

console.log(‘hello’);

— Console ——————————
hello
world

这次可以看来,回调函数后吃继续代码执行了。如同上边所说,JS本身是单线程的,无法异步执行,因此我们得以看setTimeout即时看似JS规范以外的由运行环境提供的特种函数做的工作是创办一个平线程后即刻回到,让JS主进程可以就执行后续代码,并在收取平行进程的通后还履行回调函数。除了setTimeoutsetInterval这些大规模的,这类似函数还包NodeJS提供的比如fs.readFile等等的异步API。

除此以外,我们照例回到JS是单线程运行的这其实,这决定了JS在推行了一段落代码之前无法履行包括回调函数在内的别的代码。也就是说,即使平行线程完成工作了,通知JS主线程执行回调函数了,回调函数也要当及JS主线程空闲时才会开实施。以下就是是如此一个例证。

function heavyCompute(n) {
    var count = 0,
        i, j;

for (i = n; i > 0; –i) {
for (j = n; j > 0; –j) {
count += 1;
}
}
}

var t = new Date();

setTimeout(function () {
console.log(new Date() – t);
}, 1000);

heavyCompute(50000);

— Console ——————————
8520

得看来,本来当于1秒后为调用的回调函数因为JS主线程忙于运行其它代码,实际履行时让大幅推。

代码设计模式

异步编程有好多特有的代码设计模式,为了兑现同的力量,使用并方式同异步方式编写的代码会生格外要命距离。以下分别介绍部分广泛的模式。

函数返回值

动一个函数的输出作为任何一个函数的输入是殊广阔的急需,在一道方式下一般以以下方式编写代码:

var output = fn1(fn2('input'));
// Do something.

一经于异步方式下,由于函数执行结果莫是透过返回值,而是通过回调函数传递,因此一般按照以下措施编写代码:

fn2('input', function (output2) {
    fn1(output2, function (output1) {
        // Do something.
    });
});

可看看,这种艺术就是一个回调函数模仿一个回调函多,套得太多了老容易写起>造型的代码。

遍历数组

于遍历数组时,使用某函数依次对数码成员召开一些拍卖也是大面积的需。如果函数是共实施之,一般就是见面写起以下代码:

var len = arr.length,
    i = 0;

for (; i < len; ++i) { arr[i] = sync(arr[i]); }
// All array items have processed.

使函数是异步执行的,以上代码就无法担保循环结束后具备数组成员都处理完毕了。如果数组成员必须一个连通一个串行处理,则一般照以下方法编写异步代码:

(function next(i, len, callback) {
    if (i < len) {
        async(arr[i], function (value) {
            arr[i] = value;
            next(i + 1, len, callback);
        });
    } else {
        callback();
    }
}(0, arr.length, function () {
    // All array items have processed.
}));

可以看出,以上代码在异步函数执行同一次于并赶回执行结果后才传入下一个数组成员并开始下一样轮子执行,直到有数组成员处理完毕后,通过回调的点子触发后续代码的施行。

要数组成员可以并行处理,但连续代码仍然需要具有数组成员处理完毕后才会实施的话,则异步代码会调整成为以下形式:

(function (i, len, count, callback) {
    for (; i < len; ++i) {
        (function (i) {
            async(arr[i], function (value) {
                arr[i] = value;
                if (++count === len) {
                    callback();
                }
            });
        }(i));
    }
}(0, arr.length, 0, function () {
    // All array items have processed.
}));

可观看,与异步串行遍历的本对照,以上代码并行处理所有数组成员,并经过计数器变量来判定什么时所有数组成员还处理完毕了。

老处理

JS自身提供的万分捕获和处理机制——try..catch..,只能用来共同实施之代码。以下是一个例。

function sync(fn) {
    return fn();
}

try {
sync(null);
// Do something.
} catch (err) {
console.log(‘Error: %s’, err.message);
}

— Console ——————————
Error: object is not a function

得看到,异常会顺代码执行路径一直冒泡,直到撞第一单try谈时为破获住。但由于异步函数会打断代码执行路径,异步函数执行进程被及实施后发的深冒泡到执行路径为由断的职时,如果直白未曾碰到try谈,就当一个大局十分抛出。以下是一个例。

function async(fn, callback) {
    // Code execution path breaks here.
    setTimeout(function () {
        callback(fn());
    }, 0);
}

try {
async(null, function (data) {
// Do something.
});
} catch (err) {
console.log(‘Error: %s’, err.message);
}

— Console ——————————
/home/user/test.js:4
callback(fn());
^
TypeError: object is not a function
at null._onTimeout (/home/user/test.js:4:13)
at Timer.listOnTimeout [as ontimeout] (timers.js:110:15)

因为代码执行路径为起断了,我们即便待以那个冒泡到断点之前用try语把死捕获住,并由此回调函数传递给捕获的十分。于是我们得以像下这样改造上的例证。

function async(fn, callback) {
    // Code execution path breaks here.
    setTimeout(function () {
        try {
            callback(null, fn());
        } catch (err) {
            callback(err);
        }
    }, 0);
}

async(null, function (err, data) {
if (err) {
console.log(‘Error: %s’, err.message);
} else {
// Do something.
}
});

— Console ——————————
Error: object is not a function

足见到,异常再次落网获住了。在NodeJS中,几乎有异步API都循以上办法设计,回调函数中第一个参数还是err。因此我们当编制好之异步函数时,也堪按这种方式来处理好,与NodeJS的宏图风格保持一致。

出了大处理方式后,我们就可以想同一怀念一般我们是怎么形容代码的。基本上,我们的代码都是做片事情,然后调用一个函数,然后重新做有工作,然后再调用一个函数,如此循环。如果我们描绘的是合代码,只需要在代码入口点写一个try谈就能够捕获所有冒泡上来的老大,示例如下。

function main() {
    // Do something.
    syncA();
    // Do something.
    syncB();
    // Do something.
    syncC();
}

try {
main();
} catch (err) {
// Deal with exception.
}

只是,如果我们刻画的凡异步代码,就惟有呵呵了。由于每次异步函数调用都见面堵塞代码执行路径,只能通过回调函数来传递异常,于是我们不怕需在每个回调函数里判断是否生很来,于是就所以三糟异步函数调用,就会见产生下这种代码。

function main(callback) {
    // Do something.
    asyncA(function (err, data) {
        if (err) {
            callback(err);
        } else {
            // Do something
            asyncB(function (err, data) {
                if (err) {
                    callback(err);
                } else {
                    // Do something
                    asyncC(function (err, data) {
                        if (err) {
                            callback(err);
                        } else {
                            // Do something
                            callback(null);
                        }
                    });
                }
            });
        }
    });
}

main(function (err) {
if (err) {
// Deal with exception.
}
});

足见到,回调函数已经于代码变得复杂了,而异步方式下本着怪的拍卖又加剧了代码的复杂度。如果NodeJS的不过特别卖点最后变成这个法,那就是从不人乐于就此NodeJS了,因此接下去会介绍NodeJS提供的片化解方案。

域(Domain)

合法文档: http://nodejs.org/api/domain.html

NodeJS提供了domain模块,可以简化异步代码的可怜处理。在介绍该模块之前,我们得首先知道“域”的定义。简单的语,一个域哪怕是一个JS运行环境,在一个周转条件受到,如果一个异常没有吃擒获,将当一个大局十分被抛弃来。NodeJS通过process对象提供了捕获全局十分的不二法门,示例代码如下

process.on('uncaughtException', function (err) {
    console.log('Error: %s', err.message);
});

setTimeout(function (fn) {
fn();
});

— Console ——————————
Error: undefined is not a function

尽管全局十分出个地方得捕获了,但是对于绝大多数要命,我们意在赶紧捕获,并根据结果决定代码的推行路径。我们用来下HTTP服务器代码作为例子:

function async(request, callback) {
    // Do something.
    asyncA(request, function (err, data) {
        if (err) {
            callback(err);
        } else {
            // Do something
            asyncB(request, function (err, data) {
                if (err) {
                    callback(err);
                } else {
                    // Do something
                    asyncC(request, function (err, data) {
                        if (err) {
                            callback(err);
                        } else {
                            // Do something
                            callback(null, data);
                        }
                    });
                }
            });
        }
    });
}

http.createServer(function (request, response) {
async(request, function (err, data) {
if (err) {
response.writeHead(500);
response.end();
} else {
response.writeHead(200);
response.end(data);
}
});
});

如上代码用呼吁对象交给异步函数处理后,再冲处理结果返回响应。这里用了动用回调函数传递异常的方案,因此async函数内部如果再次多几只异步函数调用的语句,代码就成为上这可鬼样子了。为了让代码好看点,我们得于列处理一个伸手时,使用domain模块创建一个子域(JS子运行条件)。在子域内运行的代码可以肆意丢来很,而这些很可以通过子域对象的error事件联合捕获。于是以上代码可以举行如下改造:

function async(request, callback) {
    // Do something.
    asyncA(request, function (data) {
        // Do something
        asyncB(request, function (data) {
            // Do something
            asyncC(request, function (data) {
                // Do something
                callback(data);
            });
        });
    });
}

http.createServer(function (request, response) {
var d = domain.create();

d.on(‘error’, function () {
response.writeHead(500);
response.end();
});

d.run(function () {
async(request, function (data) {
response.writeHead(200);
response.end(data);
});
});
});

足看,我们采取.create道创建了一个子域对象,并经.run艺术上待以子域中运作的代码的入口点。而坐落子域中之异步函数回调函数由于不再要捕获异常,代码一下子瘦身很多。

陷阱

管通过process对象的uncaughtException事件捕获到全局十分,还是经过子域对象的error事件捕获到了子域异常,在NodeJS官方文档里还强烈建议处理终结异常后旋即又开程序,而非是让程序继续运行。按照法定文档的说教,发生大后的次序处于一个请勿确定的运转状态,如果非及时退出的话,程序可能会见发生严重内存泄漏,也说不定呈现得特别想得到。

不过这边要澄清一些事实。JS本身的throw..try..catch特别处理机制并无见面促成内存泄漏,也非会见于程序的实行结果出乎意料,但NodeJS并无是存粹的JS。NodeJS里大量的API内部是用C/C++实现的,因此NodeJS程序的周转过程被,代码执行路径穿梭给JS引擎内部与外部,而JS的好抛出机制可能会见卡住正常的代码执行流程,导致C/C++部分的代码表现很,进而导致内存泄漏等问题。

因此,使用uncaughtExceptiondomain抓获异常,代码执行路径里干到了C/C++部分的代码时,如果不克确定是否会见导致内存泄漏等题材,最好于处理完毕异常后再行开程序于妥善。而使用try报句捕获异常时相似捕获到之还是JS本身的不胜,不用顾虑上诉问题。

小结

本章介绍了JS异步编程相关的知,总结起来有以下几点:

  • 不掌握异步编程就不算是学会NodeJS。

  • 异步编程依托于回调来贯彻,而使回调不肯定就是是异步编程。

  • 异步编程下之函数间数传递、数组遍历和怪处理及协同编程有特别特别距离。

  • 使用domain模块简化异步代码的酷处理,并小心骗局。

大示例

习讲究的凡学以致用和贯通。至此我们已经分头介绍了NodeJS的群知识点,本章作为最终一章节,将完整地介绍一个使NodeJS开发Web服务器的言传身教。

需求

俺们而开销的是一个粗略的静态文件合并服务器,该服务器需要支持类似以下格式的JS或CSS文件合并请求。

http://assets.example.com/foo/??bar.js,baz.js

在以上URL中,??凡是一个分隔符,之前是亟需统一的差不多只文本之URL的官部分,之后是采用,相隔的别部分。因此服务器处理此URL时,返回的是以下简单单公文按顺序合并后底情节。

/foo/bar.js
/foo/baz.js

除此以外,服务器也急需能够支持类似以下格式的普通的JS或CSS文件要。

http://assets.example.com/foo/bar.js

以上就是满需求。

首先不好迭代

疾迭代是同样种是的开发方式,因此我们在第一糟糕迭代时先实现服务器的基本功能。

设计

简易解析了需要后,我们大概会得到以下的设计方案。

           +---------+   +-----------+   +----------+
request -->|  parse  |-->|  combine  |-->|  output  |--> response
           +---------+   +-----------+   +----------+

也就是说,服务器会率先分析URL,得到请求的文本的路径和类(MIME)。然后,服务器会读取请求的文书,并循顺序合并文件内容。最后,服务器返回响应,完成对同样不良呼吁的处理。

此外,服务器在读取文件时用来个根本目录,并且服务器监听的HTTP端口最好与否决不写很在代码里,因此服务器需要是不过配备的。

实现

依据上述设计,我们刻画来了第一版代码如下。

var fs = require('fs'),
    path = require('path'),
    http = require('http');

var MIME = {
‘.css’: ‘text/css’,
‘.js’: ‘application/javascript’
};

function combineFiles(pathnames, callback) {
var output = [];

(function next(i, len) {
if (i < len) { fs.readFile(pathnames[i], function (err, data) { if (err) { callback(err); } else { output.push(data); next(i + 1, len); } }); } else { callback(null, Buffer.concat(output)); } }(0, pathnames.length)); }
function main(argv) {
var config = JSON.parse(fs.readFileSync(argv[0], ‘utf-8’)),
root = config.root || ‘.’,
port = config.port || 80;

http.createServer(function (request, response) {
var urlInfo = parseURL(root, request.url);

combineFiles(urlInfo.pathnames, function (err, data) {
if (err) {
response.writeHead(404);
response.end(err.message);
} else {
response.writeHead(200, {
‘Content-Type’: urlInfo.mime
});
response.end(data);
}
});
}).listen(port);
}

function parseURL(root, url) {
var base, pathnames, parts;

if (url.indexOf(‘??’) === -1) {
url = url.replace(‘/’, ‘/??’);
}

parts = url.split(‘??’);
base = parts[0];
pathnames = parts[1].split(‘,’).map(function (value) {
return path.join(root, base, value);
});

return {
mime: MIME[path.extname(pathnames[0])] || ‘text/plain’,
pathnames: pathnames
};
}

main(process.argv.slice(2));

上述代码完整兑现了服务器所需要的功能,并且产生以下几点值得注意:

  1. 下命令行参数传递JSON配置文件路径,入口函数负责读取配置并创立服务器。

  2. 入口函数完整描述了次的运作逻辑,其中解析URL和联文件之现实性贯彻封装在其他少只函数里。

  3. 解析URL时事先将惯常URL转换为文件合并URL,使得个别种植URL的处理方式可以同样。

  4. 合文件时使用异步API读取文件,避免服务器因为等磁盘IO而发短路。

咱得以拿上述代码保存也server.js,之后就好透过node server.js config.json一声令下启动程序,于是我们的第一版本静态文件合并服务器就顺完工了。

除此以外,以上代码有一个勿那么肯定的逻辑缺陷。例如,使用以下URL请求服务器时会发生悲喜。

    http://assets.example.com/foo/bar.js,foo/baz.js

由此分析之后咱们会发觉题目发出在/受活动替换/??本条作为达到,而之题材我们可以到第二不善迭代时再也解决。

第二糟糕迭代

每当首先次等迭代过后,我们既有了一个但工作之本子,满足了作用需求。接下来我们得由性质的角度出发,看看代码还有如何改善余地。

设计

map措施变成for循环或许会再快有,但首先本代码最老之属性问题存在吃从读取文件及输出响应的过程中。我们为处理/??a.js,b.js,c.js夫要为条例,看看整个处理过程中耗时在哪儿。

 发送请求       等待服务端响应         接收响应
---------+----------------------+------------->
         --                                        解析请求
           ------                                  读取a.js
                 ------                            读取b.js
                       ------                      读取c.js
                             --                    合并数据
                               --                  输出响应

得看到,第一本子代码依次将要的文本读取到外存中之后,再统一数据和输出响应。这会招致以下简单独问题:

  1. 当呼吁的文件较多比特别时,串行读取文件会较耗时,从而拉开了服务端响应等时。

  2. 由于每次响应输出的数据还急需先整体地休息存在内存里,当服务器请求并发数较生时,会出比充分的内存开销。

对此第一个问题,很容易想到将读取文件之法门由串行改吧彼此。但是别这么做,因为对于机械磁盘而言,因为光发一个磁头,尝试并行读取文件才会招致磁头频繁抖动,反而下降IO效率。而对固态硬盘,虽然真正有多个彼此IO通道,但是对服务器并行处理的基本上只请求而言,硬盘已经当开并行IO了,对单个请求采用互动IO无异于拆东墙补西墙。因此,正确的做法未是改用并行IO,而是一头读取文件一边输出响应,把响应输出时机提前至读取第一只公文的天天。这样调整后,整个请求处理过程变成下边这样。

发送请求 等待服务端响应 接收响应
---------+----+------------------------------->
         --                                        解析请求
           --                                      检查文件是否存在
             --                                    输出响应头
               ------                              读取和输出a.js
                     ------                        读取和输出b.js
                           ------                  读取和输出c.js

遵循上述方式化解第一单问题后,因为服务器无需总体地缓存每个请求的出口数据了,第二单问题吗解决。

实现

依据以上设计,第二本代码按以下方式调动了部分函数。

function main(argv) {
    var config = JSON.parse(fs.readFileSync(argv[0], 'utf-8')),
        root = config.root || '.',
        port = config.port || 80;

http.createServer(function (request, response) {
var urlInfo = parseURL(root, request.url);

validateFiles(urlInfo.pathnames, function (err, pathnames) {
if (err) {
response.writeHead(404);
response.end(err.message);
} else {
response.writeHead(200, {
‘Content-Type’: urlInfo.mime
});
outputFiles(pathnames, response);
}
});
}).listen(port);
}

function outputFiles(pathnames, writer) {
(function next(i, len) {
if (i < len) { var reader = fs.createReadStream(pathnames[i]);
reader.pipe(writer, { end: false });
reader.on(‘end’, function() {
next(i + 1, len);
});
} else {
writer.end();
}
}(0, pathnames.length));
}

function validateFiles(pathnames, callback) {
(function next(i, len) {
if (i < len) { fs.stat(pathnames[i], function (err, stats) { if (err) { callback(err); } else if (!stats.isFile()) { callback(new Error()); } else { next(i + 1, len); } }); } else { callback(null, pathnames); } }(0, pathnames.length)); }

可观看,第二版本代码在检讨了央的富有文件是否有效之后,立即就输出了响应头,并随即一边以梯次读取文件一边输出响应内容。并且,在读取文件时,第二版本代码直接动用了仅念数据流来简化代码。

老三次迭代

亚浅迭代过后,服务器本身的意义以及总体性都获得了起满足。接下来我们要由平静的角度再次审视一下代码,看看还亟需开些什么。

设计

起工程角度上称,没有断然可靠的系统。即使第二差迭代的代码通过反复检查后能保证没有bug,也很难说是否会盖NodeJS本身,或者是操作系统本身,甚至是硬件本身造成我们的服务器程序在某一样上挂掉。因此一般生环境下之服务器程序都配起一个护理进程,在服务挂掉的时光这又开服务。一般守护进程的代码会远较服务过程的代码简单,从概率上可以确保医护进程又难以挂掉。如果还做得小心一些,甚至守护进程本身可以当大团结挂掉时再也开自己,从而实现对确保。

于是在此次迭代时,我们先行下NodeJS的进程管理机制,将守护进程作为父亲进程,将服务器程序作为子进程,并被爸爸进程监控子进程的运行状态,在其绷退出时更启子进程。

实现

根据上述设计,我们编辑了护理进程需要之代码。

var cp = require('child_process');

var worker;

function spawn(server, config) {
worker = cp.spawn(‘node’, [ server, config ]);
worker.on(‘exit’, function (code) {
if (code !== 0) {
spawn(server, config);
}
});
}

function main(argv) {
spawn(‘server.js’, argv[0]);
process.on(‘SIGTERM’, function () {
worker.kill();
process.exit(0);
});
}

main(process.argv.slice(2));

另外,服务器代码本身的入口函数也使召开以下调。

function main(argv) {
    var config = JSON.parse(fs.readFileSync(argv[0], 'utf-8')),
        root = config.root || '.',
        port = config.port || 80,
        server;

server = http.createServer(function (request, response) {

}).listen(port);

process.on(‘SIGTERM’, function () {
server.close(function () {
process.exit(0);
});
});
}

我们可以拿守护进程的代码保存也daemon.js,之后咱们好透过node daemon.js config.json启航服务,而护理进程会越加启动同监察服务器进程。此外,为了能健康终止服务,我们吃医护进程在接及SIGTERM信号时已服务器进程。而以服务器进程就同一端,同样于接到SIGTERM信号时优先停少HTTP服务再正常退出。至此,我们的服务器程序就指谱很多矣。

季糟迭代

当咱们缓解了服务器本身的效果、性能与可靠性的问题后,接着我们要考虑一下代码部署的题目,以及服务器控制的问题。

设计

一般而言,程序于服务器上产生一个定位的配备目录,每次程序来更新后,都还颁发暨布置目录里。而而好布局后,一般也堪由此定位的劳务控制脚本启动暨停止服务。因此我们的服务器程序部署目录可以做如下设计。

- deploy/
    - bin/
        startws.sh
        killws.sh
    + conf/
        config.json
    + lib/
        daemon.js
        server.js

每当以上目录结构面临,我们分类存放了劳动控制脚本、配置文件以及服务器代码。

实现

遵照上述目录结构分别存放对应之公文从此,接下去我们看控制脚本怎么形容。首先是start.sh

#!/bin/sh
if [ ! -f "pid" ]
then
    node ../lib/daemon.js ../conf/config.json &
    echo $! > pid
fi

然后是killws.sh

#!/bin/sh
if [ -f "pid" ]
then
    kill $(tr -d '\r\n' < pid)
    rm pid
fi

乃这样咱们不怕生了一个简便的代码部署目录和劳动控制脚本,我们的服务器程序就可以上线工作了。

延续迭代

俺们的服务器程序正式上丝工作后,我们接下可能会意识还发出好多足改善之触发。比如服务器程序在合JS文件时方可自行在JS文件中插入一个;来避免有语法问题,比如服务器程序需要提供日志来统计访问量,比如服务器程序需要能够充分利用多核CPU,等等。而此时底而,在读书了这般久NodeJS之后,应该早就明白该怎么开了。

小结

本章将事先零散介绍的知识点串了起来,完整地示范了一个运NodeJS开发顺序的例证,至此我们的教程就所有竣工了。以下是对新出生之NodeJSer的部分建议。

  • 要熟悉官方API文档。并无是说要熟悉到能够记住每个API的称号及用法,而是只要熟悉NodeJS提供了哪职能,一旦需要经常知道查询API文档的哪块地方。

  • 只要先规划更落实。在付出一个主次前第一要生一个大局的筹划,不肯定要是死周全,但要够能写有一部分代码。

  • 假使促成后又规划。在写了有些代码,有矣有的有血有肉的物后,一定会意识有前忽视掉的底细。这时又扭改进前的计划,为次轮子迭代做准备。

  • 苟充分利用三方包。NodeJS有一个大之生态圈,在写代码之前先看有没发生成的老三着担保会节省成千上万光阴。

  • 不用信三方包。任何事情做过头了就算坏了,三正担保也是一样。三在担保是一个黑盒,每多使用一个叔正值担保,就也序增加了同等客机密风险。并且三在担保死为难恰好就供次需要的意义,每多采取一个老三正值担保,就被程序更加臃肿一些。因此于控制以有三在担保之前,最好三思而后行。

相关文章

网站地图xml地图