NodeJs基础

 



参照连接: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有一个庞然大物的生态圈,在写代码从前先看看有没有现成的三方包能节省不可胜举岁月。

  • 毫无迷信三方包。任何业务做过度了就不佳了,三方包也是均等。三方包是一个黑盒,每多应用一个三方包,就为顺序增加了一份机密风险。并且三方包很难恰好只提供程序必要的功力,每多采纳一个三方包,就让程序越发臃肿一些。因而在控制选择某个三方包此前,最好深思熟虑。