掘金翻译计划 关注
手机版

Node & Express 入门指南

  1. 云栖社区>
  2. 掘金翻译计划>
  3. 博客>
  4. 正文

Node & Express 入门指南

玄学酱 2017-10-18 14:44:00 浏览664 评论0

摘要: 本文讲的是Node & Express 入门指南,Node 是一个 JavaScript 环境,使用了与谷歌 Chrome 浏览器相同的 JavaScript 引擎。Node 具有非常强大的功能,无论对 web 服务器还是 web 服务器的平台 API 来说,它都是搭建服务端应用中间层的诱人之选。

本文讲的是Node & Express 入门指南,

Node 是一个 JavaScript 环境,使用了与谷歌 Chrome 浏览器相同的 JavaScript 引擎。Node 具有非常强大的功能,无论对 web 服务器还是 web 服务器的平台 API 来说,它都是搭建服务端应用中间层的诱人之选。

非阻塞事件驱动的 I/O 模型给予 Node 非常强大的性能,轻而易举地就能打败阻塞 I/O 和分线程处理多用户并发的线程服务器环境,比如 PHP 和 Ruby on Rails。

我曾经将千万级用户的 app 产品从 PHP 和 Ruby on Rails 环境迁移至 Node 环境,并实现了响应处理时间和单服务器多用户并发状况处理 2-10 倍的性能提升。

Node 的特征:

  • 快!(默认为非阻塞 I/O)
  • 事件驱动
  • 一流的网络性能
  • 一流的流媒体接口
  • 用于接入操作系统和文件系统等的强大的标准库
  • 支持编译的二进制模块,以便用户可以用其他更为基础的语言(如 C++)实现 Node 的强大性能
  • 深受许多大企业的信赖和支持,并用于运行关键任务应用(如:Adobe, Google, Microsoft, Netflix, PayPal, Uber, Walmart 等)
  • 易于上手

安装 Node

入圈之前,要确保已经安装了 Node。Node 一般提供两个版本,长期支持版本(即 LTS 版本,稳定)和最新版本。如果用于生产项目,你应该使用长期支持版本,如果想使用最前沿的功能则应选择最新版本。

Windows

访问Node 官网并且点击绿色的安装按钮。

Mac 或者 Linux

在 Mac 或者 Linux 系统上,我最喜欢的方式是用 nvm 安装 Node。

你可以使用 install script 来安装或者升级 nvm,使用 curl:

`curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.32.1/install.sh | bash`

或者 Wget:

`wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.32.1/install.sh | bash`

安装好 nvm 后,你可以用它来安装各种版本的 Node。

Hello, World! 实例

Node & Express 非常简单,你可以仅用 12 行代码就能够实现一个基本的 web 服务器来实现 “Hello,world!” :

    const express = require('express');

    const app = express();
    const port = process.env.PORT || 3000;

    app.get('/', (req, res) => {
      res.send('\n\nHello, world!\n\n');
    });

    app.listen(port, () => {
      console.log(`listening on port ${ port }`);
    });

在代码运行之前,你需要创建你的应用。从创建一个新的 git 仓库开始:

    mkdir my-node-app && cd my-node-app
    git init

你需要一个 package.json 文件来存储应用的配置信息,你可以用 Node 中自带的 npm 来创建:

`npm init`

填写一些问题(应用名称、git 仓库等)之后你就可以准备部署应用了。接下来你需要安装 Express:

`npm install --save express`

依赖安装完之后,你可以输入以下命令来运行你的应用:

`node index.js`

用 curl 来测试:

`curl localhost:3000`

或者在浏览器中访问 localhost:3000

搞定了!你已经搭建了你的首个 Node 应用。

环境变量

你可以使用环境变量来配置你的 Node 应用,这样就能很容易地因地制宜切换不同的配置,比如在开发者本地环境,测试环境以及生产环境下使用对应的配置。

你应该使用环境变量给应用注入应用密文,如 API 的 key,而不是在源代码控制中对其进行校验。一些开发环境使用 .env 文件来保存应用的配置信息,但是你可能对此充满了疑问,“我如何才能将 .env 文件中的设置加载到应用的环境变量中去呢?”

要想解决这个问题,不妨来试试 dotenv 的 Node 版本:

`npm install --save dotenv`

然后在入口文件顶部添加:

`require('dotenv').config();`

现在你能从 .env 文件中加载 port 的设置了,接下来在项目的根目录下新建一个名为 .env 的文件:

`PORT=5150`

保存,重启应用,之后你会看到:

`listening on port 5150`

如果你不想将 .env 文件提交到 Git,你需要将它添加到 .gitignore 文件中。事实上,我们还需要将一些其他的内容添加进去:

    node_modules
    build
    npm-debug.log
    .env
    .DS_Store

如果你还是想记录应用所需的配置信息,我通常喜欢添加一份 .env 文件的副本,并将应用密文写进去。新用户可以复制该文件,将其命名为 .env 并自定义设置选项、关闭文件然后运行。我会将提交的副本文件命名为 .env.example 并在项目的README.md 文件中写一份开发指南。

[可将应用的配置项写入 .env.example 文件,并将敏感配置信息以加密形式处理,仅作为配置内容示例,译者注。]

    PORT=5150
    AWS_KEY=

你应该注意,如我所言,所有的应用密文全都要写在 .env.example 文件中。

不要将你的应用密文提交到 Git 仓库。

测试 Node 应用

我喜欢用 Supertest 来测试 Node 应用,它会抽象出 http 连接问题,并且提供一个简单、流畅的 API。我用 functional tests 进行 http 端点测试,它让我不必担心模拟数据库等问题。我只需要点击 API 并传入一些值,然后静候一个具体的响应。

以下是一个使用 Supertest 和 Tape 测试的一个简单的实例:

    const test = require('tape');
    const request = require('supertest');

    const app = require('app');

    test('get /', assert => {
      request(app)
        .get('/')
        .expect(200)
        .end((err, res) => {
          const msg = 'should return 200 OK';
          if (err) return assert.fail(msg);
          assert.pass(msg);
          assert.end();
        });
    });

我也会给任何我用于构建 API 的稍小的、可重用的模块写单元测试

需要注意的是,我们直接导入了快速应用,而没有使用网络。Supertest 并不需要读取应用配置来确定连接端口,它将所有的细节都封装起来,为了能够正常工作,你需要在应用文件中导出你的应用。

`module.exports = app;`

基于这样和那样的原因,我将应用分割成许多不同的切片,在 app.js 中搭建并配置应用,在 server.js 中导入应用,在app.listen() 中处理网络细节。

设置 Node 路径

当你将应用划分为多个模块时,你将会对相对路径的引入关系感到不胜其烦:

`const app = require('../../app');`

幸运的是,你不需要这样做。把你的应用文件放在名为 source 或者 src 的目录中,然后设置 NODE_PATH 环境变量。你可以使用 cross-env 设置环境变量,使他们可以跨平台使用(可以在 Windows 下读取并运行应用)。

`npm install --save cross-env`

之后,你可以很安全地在 package.json 脚本中设置环境变量:

     "scripts": {
        "start": "cross-env NODE_PATH=source node source/server.js",
        "debug": "cross-env NODE_PATH=source node --debug-brk --inspect source/server.js",
        "test": "cross-env NODE_PATH=source node source/test/index.js"
      }

设置 NODE_PATH 之后,你可以这样引入模块:

`const app = require('app');`

超赞!

中间件

Express 是 Node 应用中最流行的框架,它使用延续传递的方式实现中间件。如果你有可能在许多路由中都会运行相同的代码,也许最好的方式是将它们写入中间件。

中间件其实是一个函数,他能够调用一个名为 next() 的函数,来传递请求和响应对象。假如你想在每个请求和响应中都添加一个 requestId ,从而能够很方便地在调试中追踪单个请求或者在日志中搜索内容,你可以写一个像这样的中间件:

    require('dotenv').config();
    const express = require('express');
    const cuid = require('cuid');

    const app = express();

    // 请求 id 的中间件
    const requestId = (req, res, next) => {
      const requestId = cuid();
      req.id = requestId;

      // 延续传递至下一个中间件
      next();
    };

    app.use(requestId);

    app.get('/', (req, res) => {
      res.send('\n\nHello, world!\n\n');
    });

    module.exports = app;

内存管理

因为 Node 是单线程的,这也意味着所有的用户都会共享同一块内存空间。换句话说,不像是在浏览器中,你不得不当心不要在闭包函数中保存某个特定用户的数据,因为其他的连接可能会拿到那些数据。正因如此,我喜欢用 res.locals 来存储当前用户的信息,这只在该用户的请求和响应循环中可用。

    app.use((req, res, next) => {
        res.locals.user = req.user;
        res.locals.authenticated = !req.user.anonymous;
        next();
    });

这也是一个用来存储上文提到的 requestId 的更好的办法。

调试 Node 应用

Node v6.4.x+ 版本中集成了完整的 Chrome 调试工具,因此你可以像在浏览器中调试 JS 应用一样调试 Node。

要使用调试功能,你只需简单的在断点处添加一个调试声明,然后运行:

`node --debug-brk --inspect source/app.js`

在浏览器中打开所提供的 URL,之后你就能得到一个交互式的调试环境。

我会使用 --debug-brk 默认地在起点设置一个断点,但是你也可以取消。要记住,你可能需要在浏览器中点击路由或者从 curl 中触发路由处理机制并且点击你的断点位置。

你可能知道的,Chrome 的开发工具集成了非常有价值的调试信息。你能够浏览、检查内存管理并监控内存泄漏、一次只执行一行代码、鼠标悬停在变量上来查看变量的值等等。

应用崩溃

进程崩溃。众生皆如此,你的服务器在运行中可能会遭遇一个它无法处理的错误。不要苦恼,记录下错误信息,关闭服务器然后重新运行一个新的实例。

你绝对不能像这样做:

    process.on('uncaughtException', (err) => {
      console.log('Oops!');
    });

当出现未捕获的异常时,你必须关闭进程,因为从定义上来讲,如果你不知道应用哪里出了问题,你的应用就处在一种不可知不明确的状态,并且随处都有可能产生错误。

你可能会造成资源泄漏,用户可能看到错误的数据,你可能会得到各种疯狂的不明确的应用操作。当产生一个你意料之外的异常时,记录下错误信息,清理所有你能清理的资源,并且关闭进程。

我用 Node 写了一个优雅的错误处理模块,在此检出 express-error-handler

崩溃修复

有各种各种的服务器监控工具可以检测崩溃并且修复服务来保持应用运行流畅,即使是遇到了未知异常,它们同样有效。

我极力推荐 PM2 ,因为不光我在使用它而且它也深受许多公司的信赖,比如 Microsoft,IBM 和 PayPal。

安装的时候,运行 npm install -g pm2,在本地安装就使用 npm install --save-dev pm2 命令。之后你就可以使用 pm2 start source/app.js 来运行应用了。

你可以用 pm2 list 管理运行的应用实例,也可以使用 pm2 stop 来终止实例。查看更多细节请点击 quick start

福利:PM2 能配置集成 Keymetrics,它能以非常友好的 web 界面为你的生产应用实例提供很棒的调试意见。

小结

我们仅仅是蜻蜓点水一般地了解了 Node,还有很多的东西需要我们去学习,包括会话管理、token 验证、API 设计等等。我对其中一些内容做了更深刻地阐释,详见 “Programming JavaScript Applications”(免费)。


想学习更多 Node 的知识?我们为 EricElliottJS.com 的会员发行了新的 Node 视频系列,如果你不是会员,那么好机会就与你擦肩而过啦!


Eric Elliott是 “Programming JavaScript Applications”(O’Reilly) 和 “Learn JavaScript with Eric Elliott” 的作者。他曾在 Adobe Systems, Zumba Fitness, The Wall Street Journal,ESPN, BBC 的软件开发领域立下汗马功劳,也曾为顶级唱片大师 Usher, Frank Ocean,Metallica 等人量身定制。

他的大部分时光都是和世界上最美丽的女人在旧金山海湾地区度过的。






原文发布时间为:2016年12月07日

本文来自云栖社区合作伙伴掘金,了解相关信息可以关注掘金网站。
【云栖快讯】阿里云栖开发者沙龙(Java技术专场)火热来袭!快来报名参与吧!  详情请点击

网友评论