Express框架

谁借莪１个温暖的怀抱￠ 2023-10-06 17:12 26阅读 0赞

## Express框架 ##

## 1 概述 ##

Express是目前最流行的基于Node.js的Web开发框架，可以快速地搭建一个完整功能的网站。

Express上手非常简单，首先新建一个项目目录，假定叫做hello-world。

`$ mkdir hello-world`

进入该目录，新建一个package.json文件，内容如下。

{
        
      "name": "hello-world",
      "description": "hello world test app",
      "version": "0.0.1",
      "private": true,
      "dependencies": {
        
        "express": "4.x"
      }
    }

上面代码定义了项目的名称、描述、版本等，并且指定需要4.0版本以上的Express。

然后，就可以安装了。

`$ npm install`

执行上面的命令以后，在项目根目录下，新建一个启动文件，假定叫做 index.js。

var express = require('express');
    var app = express();
    
    app.use(express.static(__dirname + '/public'));
    
    app.listen(8080);

然后，运行上面的启动脚本。

`$ node index`

现在就可以访问 http://localhost:8080，它会在浏览器中打开当前目录的 public子目录（严格来说，是打开 public 目录的 index.html 文件）。如果 public 目录之中有一个图片文件 my\_image.png，那么可以用http://localhost:8080/my\_image.png 访问该文件。

你也可以在 index.js 之中，生成动态网页。

// index.js
    
    var express = require('express');
    var app = express();
    app.get('/', function (req, res) {
        
      res.send('Hello world!');
    });
    app.listen(3000);

然后，在命令行下运行启动脚本，就可以在浏览器中访问项目网站了。

`$ node index`

上面代码会在本机的3000端口启动一个网站，网页显示Hello World。

启动脚本 index.js 的 app.get 方法，用于指定不同的访问路径所对应的回调函数，这叫做“路由”（routing）。上面代码只指定了根目录的回调函数，因此只有一个路由记录。实际应用中，可能有多个路由记录。

// index.js
    
    var express = require('express');
    var app = express();
    
    app.get('/', function (req, res) {
        
      res.send('Hello world!');
    });
    app.get('/customer', function(req, res){
        
      res.send('customer page');
    });
    app.get('/admin', function(req, res){
        
      res.send('admin page');
    });
    
    app.listen(3000);

这时，最好就把路由放到一个单独的文件中，比如新建一个routes子目录。

// routes/index.js
    
    module.exports = function (app) {
        
      app.get('/', function (req, res) {
        
        res.send('Hello world');
      });
      app.get('/customer', function(req, res){
        
        res.send('customer page');
      });
      app.get('/admin', function(req, res){
        
        res.send('admin page');
      });
    };

然后，原来的index.js就变成下面这样。

// index.js
    var express = require('express');
    var app = express();
    var routes = require('./routes')(app);
    app.listen(3000);

## 2 运行原理 ##

### 2.1 底层：http模块 ###

Express 框架建立在 node.js 内置的 http 模块上。http 模块生成服务器的原始代码如下。

var http = require("http");
    
    var app = http.createServer(function(request, response) {
        
      response.writeHead(200, {
        "Content-Type": "text/plain"});
      response.end("Hello world!");
    });
    
    app.listen(3000, "localhost");

上面代码的关键是http模块的createServer方法，表示生成一个HTTP服务器实例。该方法接受一个回调函数，该回调函数的参数，分别为代表HTTP请求和HTTP回应的request对象和response对象。

Express框架的核心是对http模块的再包装。上面的代码用Express改写如下。

var express = require('express');
    var app = express();
    
    app.get('/', function (req, res) {
        
      res.send('Hello world!');
    });
    
    app.listen(3000);

比较两段代码，可以看到它们非常接近。原来是用http.createServer方法新建一个app实例，现在则是用Express的构造方法，生成一个Epress实例。两者的回调函数都是相同的。Express框架等于在http模块之上，加了一个中间层。

### 2.2 什么是中间件 ###

简单说，中间件（middleware）就是处理HTTP请求的函数。它最大的特点就是，一个中间件处理完，再传递给下一个中间件。App实例在运行过程中，会调用一系列的中间件。

每个中间件可以从App实例，接收三个参数，依次为request对象（代表HTTP请求）、response对象（代表HTTP回应），next回调函数（代表下一个中间件）。每个中间件都可以对HTTP请求（request对象）进行加工，并且决定是否调用next方法，将request对象再传给下一个中间件。

一个不进行任何操作、只传递request对象的中间件，就是下面这样。

function uselessMiddleware(req, res, next) {
        
      next();
    }

上面代码的next就是下一个中间件。如果它带有参数，则代表抛出一个错误，参数为错误文本。

function uselessMiddleware(req, res, next) {
        
      next('出错了！');
    }

抛出错误以后，后面的中间件将不再执行，直到发现一个错误处理函数为止。

### 2.3 use方法 ###

use是express注册中间件的方法，它返回一个函数。下面是一个连续调用两个中间件的例子。

上面代码使用app.use方法，注册了两个中间件。收到HTTP请求后，先调用第一个中间件，在控制台输出一行信息，然后通过next方法，将执行权传给第二个中间件，输出HTTP回应。由于第二个中间件没有调用next方法，所以request对象就不再向后传递了。

use方法内部可以对访问路径进行判断，据此就能实现简单的路由，根据不同的请求网址，返回不同的网页内容。

上面代码通过request.url属性，判断请求的网址，从而返回不同的内容。注意，app.use方法一共登记了三个中间件，只要请求路径匹配，就不会将执行权交给下一个中间件。因此，最后一个中间件会返回404错误，即前面的中间件都没匹配请求路径，找不到所要请求的资源。

除了在回调函数内部判断请求的网址，use方法也允许将请求网址写在第一个参数。这代表，只有请求路径匹配这个参数，后面的中间件才会生效。无疑，这样写更加清晰和方便。

`app.use('/path', someMiddleware);`

上面代码表示，只对根目录的请求，调用某个中间件。

因此，上面的代码可以写成下面的样子。

## 3 Express的方法 ##

### 3.1 all方法和HTTP动词方法 ###

针对不同的请求，Express提供了use方法的一些别名。比如，上面代码也可以用别名的形式来写。

上面代码的 all() 方法表示，所有请求都必须通过该中间件，参数中的“\*”表示对所有路径有效。get方法则是只有GET动词的HTTP请求通过该中间件，它的第一个参数是请求的路径。由于get方法的回调函数没有调用next方法，所以只要有一个中间件被调用了，后面的中间件就不会再被调用了。

除了get方法以外，Express还提供post、put、delete方法，即HTTP动词都是Express的方法。

这些方法的第一个参数，都是请求的路径。除了绝对匹配以外，Express允许模式匹配。

app.get("/hello/:who", function(req, res) {
        
      res.end("Hello, " + req.params.who + ".");
    });

上面代码将匹配“/hello/alice”网址，网址中的alice将被捕获，作为req.params.who属性的值。需要注意的是，捕获后需要对网址进行检查，过滤不安全字符，上面的写法只是为了演示，生产中不应这样直接使用用户提供的值。

如果在模式参数后面加上问号，表示该参数可选。

app.get('/hello/:who?',function(req,res) {
        
    	if(req.params.id) {
        
        	res.end("Hello, " + req.params.who + ".");
    	}
        else {
        
        	res.send("Hello, Guest.");
    	}
    });

下面是一些更复杂的模式匹配的例子。

app.get('/forum/:fid/thread/:tid', middleware)
    
    // 匹配/commits/71dbb9c
    // 或/commits/71dbb9c..4c084f9这样的git格式的网址
    app.get(/^\/commits\/(\w+)(?:\.\.(\w+))?$/, function(req, res){
        
      var from = req.params[0];
      var to = req.params[1] || 'HEAD';
      res.send('commit range ' + from + '..' + to);
    });

### 3.2 set方法 ###

set方法用于指定变量的值。

app.set("views", __dirname + "/views");
    app.set("view engine", "jade");

上面代码使用set方法，为系统变量“views”和“view engine”指定值。

### 3.3 response对象 ###

#### （1）response.redirect方法 ####

response.redirect方法允许网址的重定向。

response.redirect("/hello/anime");
    response.redirect("http://www.example.com");
    response.redirect(301, "http://www.example.com");

#### （2）response.sendFile方法 ####

response.sendFile方法用于发送文件。

response.sendFile("/path/to/anime.mp4");

#### （3）response.render方法 ####

response.render方法用于渲染网页模板。

app.get("/", function(request, response) {
        
      response.render("index", {
         message: "Hello World" });
    });

上面代码使用render方法，将message变量传入index模板，渲染成HTML网页。

### 3.4 requst对象 ###

（1）request.ip  
request.ip属性用于获得HTTP请求的IP地址。

（2）request.files

request.files用于获取上传的文件。

### 3.5 搭建HTTPs服务器 ###

使用Express搭建HTTPs加密服务器，也很简单。

var fs = require('fs');
    var options = {
        
      key: fs.readFileSync('E:/ssl/myserver.key'),
      cert: fs.readFileSync('E:/ssl/myserver.crt'),
      passphrase: '1234'
    };
    
    var https = require('https');
    var express = require('express');
    var app = express();
    
    app.get('/', function(req, res){
        
      res.send('Hello World Expressjs');
    });
    
    var server = https.createServer(options, app);
    server.listen(8084);
    console.log('Server is running on port 8084');

## 4 项目开发实例 ##

### 4.1 编写启动脚本 ###

上一节使用express命令自动建立项目，也可以不使用这个命令，手动新建所有文件。

先建立一个项目目录（假定这个目录叫做demo）。进入该目录，新建一个package.json文件，写入项目的配置信息。

{
        
       "name": "demo",
       "description": "My First Express App",
       "version": "0.0.1",
       "dependencies": {
        
          "express": "3.x"
       }
    }

在项目目录中，新建文件app.js。项目的代码就放在这个文件里面。

var express = require('express');
    var app = express();

上面代码首先加载express模块，赋给变量express。然后，生成express实例，赋给变量app。

接着，设定express实例的参数。

# 设定port变量，意为访问端口
    app.set('port', process.env.PORT || 3000);
    
    # 设定views变量，意为视图存放的目录
    app.set('views', path.join(__dirname, 'views'));
    
    # 设定view engine变量，意为网页模板引擎
    app.set('view engine', 'jade');
    
    app.use(express.favicon());
    app.use(express.logger('dev'));
    app.use(express.bodyParser());
    app.use(express.methodOverride());
    app.use(app.router);
    
    # 设定静态文件目录，比如本地文件
    # 目录为demo/public/images，访问
    # 网址则显示为http://localhost:3000/images
    app.use(express.static(path.join(__dirname, 'public')));

上面代码中的set方法用于设定内部变量，use方法用于调用express的中间件。

最后，调用实例方法listen，让其监听事先设定的端口（3000）。

`app.listen(app.get('port'));`

这时，运行下面的命令，就可以在浏览器访问http://127.0.0.1:3000。

`node app.js`

网页提示“Cannot GET /”，表示没有为网站的根路径指定可以显示的内容。所以，下一步就是配置路由。

### 4.2 配置路由 ###

所谓“路由”，就是指为不同的访问路径，指定不同的处理方法。

#### （1）指定根路径 ####

在app.js之中，先指定根路径的处理方法。

app.get('/', function(req, res) {
        
       res.send('Hello World');
    });

上面代码的get方法，表示处理客户端发出的GET请求。相应的，还有app.post、app.put、app.del（delete是JavaScript保留字，所以改叫del）方法。

get方法的第一个参数是访问路径，正斜杠（/）就代表根路径；第二个参数是回调函数，它的req参数表示客户端发来的HTTP请求，res参数代表发向客户端的HTTP回应，这两个参数都是对象。在回调函数内部，使用HTTP回应的send方法，表示向浏览器发送一个字符串。然后，运行下面的命令。

`node app.js`

此时，在浏览器中访问http://127.0.0.1:3000，网页就会显示“Hello World”。

如果需要指定HTTP头信息，回调函数就必须换一种写法，要使用setHeader方法与end方法。

app.get('/', function(req, res){
        
      var body = 'Hello World';
      res.setHeader('Content-Type', 'text/plain');
      res.setHeader('Content-Length', body.length);
      res.end(body);
    });

#### （2）指定特定路径 ####

上面是处理根目录的情况，下面再举一个例子。假定用户访问/api路径，希望返回一个JSON字符串。这时，get可以这样写。

app.get('/api', function(request, response) {
        
       response.send({
        name:"张三",age:40});
    });

上面代码表示，除了发送字符串，send方法还可以直接发送对象。重新启动node以后，再访问路径/api，浏览器就会显示一个JSON对象。

{
        
      "name": "张三",
      "age": 40
    }

我们也可以把app.get的回调函数，封装成模块。先在routes目录下面建立一个api.js文件。

// routes/api.js
    
    exports.index = function (req, res){
        
      res.json(200, {
        name:"张三",age:40});
    }

然后，在app.js中加载这个模块。

// app.js
    
    var api = require('./routes/api');
    app.get('/api', api.index);

现在访问时，就会显示与上一次同样的结果。

如果只向浏览器发送简单的文本信息，上面的方法已经够用；但是如果要向浏览器发送复杂的内容，还是应该使用网页模板。

#### （3）静态网页模板 ####

在项目目录之中，建立一个子目录views，用于存放网页模板。

假定这个项目有三个路径：根路径（/）、自我介绍（/about）和文章（/article）。那么，app.js可以这样写：

上面代码表示，三个路径分别对应views目录中的三个模板：index.html、about.html和article.html。另外，向服务器发送信息的方法，从send变成了sendfile，后者专门用于发送文件。

假定index.html的内容如下：

<html>
    <head>
       <title>首页</title>
    </head>
    
    <body>
    <h1>Express Demo</h1>
    
    <footer>
    <p>
       <a href="/">首页</a> - <a href="/about">自我介绍</a> - <a href="/article">文章</a>
    </p>
    </footer>
    
    </body>
    </html>

上面代码是一个静态网页。如果想要展示动态内容，就必须使用动态网页模板。

#### （4）动态网页模板 ####

网站真正的魅力在于动态网页，下面我们来看看，如何制作一个动态网页的网站。

##### （1） 安装模板引擎 #####

Express支持多种模板引擎，这里采用Handlebars模板引擎的服务器端版本hbs模板引擎。

先安装hbs。

`npm install hbs --save-dev`

上面代码将hbs模块，安装在项目目录的子目录node\_modules之中。save-dev参数表示，将依赖关系写入package.json文件。安装以后的package.json文件变成下面这样：

// package.json文件
    
    {
        
      "name": "demo",
      "description": "My First Express App",
      "version": "0.0.1",
      "dependencies": {
        
        "express": "3.x"
      },
      "devDependencies": {
        
        "hbs": "~2.3.1"
      }
    }

安装模板引擎之后，就要改写app.js。

// app.js文件
    
    var express = require('express');
    var app = express();
    
    // 加载hbs模块
    var hbs = require('hbs');
    
    // 指定模板文件的后缀名为html
    app.set('view engine', 'html');
    
    // 运行hbs模块
    app.engine('html', hbs.__express);
    
    app.get('/', function (req, res){
        
    	res.render('index');
    });
    
    app.get('/about', function(req, res) {
        
    	res.render('about');
    });
    
    app.get('/article', function(req, res) {
        
    	res.render('article');
    });

上面代码改用render方法，对网页模板进行渲染。

render方法的参数就是模板的文件名，默认放在子目录views之中，后缀名已经在前面指定为html，这里可以省略。

所以，res.render(‘index’) 就是指，把子目录views下面的index.html文件，交给模板引擎hbs渲染。

##### （2） 新建数据脚本 #####

渲染是指将数据代入模板的过程。实际运用中，数据都是保存在数据库之中的，这里为了简化问题，假定数据保存在一个脚本文件中。

在项目目录中，新建一个文件blog.js，用于存放数据。blog.js的写法符合CommonJS规范，使得它可以被require语句加载。

// blog.js文件
    
    var entries = [
    	{
        "id":1, "title":"第一篇", "body":"正文", "published":"6/2/2013"},
    	{
        "id":2, "title":"第二篇", "body":"正文", "published":"6/3/2013"},
    	{
        "id":3, "title":"第三篇", "body":"正文", "published":"6/4/2013"},
    	{
        "id":4, "title":"第四篇", "body":"正文", "published":"6/5/2013"},
    	{
        "id":5, "title":"第五篇", "body":"正文", "published":"6/10/2013"},
    	{
        "id":6, "title":"第六篇", "body":"正文", "published":"6/12/2013"}
    ];
    
    exports.getBlogEntries = function (){
        
       return entries;
    }
    
    exports.getBlogEntry = function (id){
        
       for(var i=0; i < entries.length; i++){
        
          if(entries[i].id == id) return entries[i];
       }
    }

##### （3） 新建网页模板 #####

接着，新建模板文件index.html。

<h1>文章列表</h1>
    
    {
       {#each entries}}
       <p>
          <a href="/article/{
         {id}}">{
       {title}}</a><br/>
          Published: {
       {published}}
       </p>
    {
       {/each}}

模板文件about.html。

<h1>自我介绍</h1>
    
    <p>正文</p>

模板文件article.html。

<h1>{
       {blog.title}}</h1>
    Published: {
       {blog.published}}
    
    <p/>
    
    {
       {blog.body}}

可以看到，上面三个模板文件都只有网页主体。因为网页布局是共享的，所以布局的部分可以单独新建一个文件 layout.html。

<html>
    
    <head>
       <title>{
       {title}}</title>
    </head>
    
    <body>
    
    	{
       {
       {body}}}
    
       <footer>
          <p>
             <a href="/">首页</a> - <a href="/about">自我介绍</a>
          </p>
       </footer>
    
    </body>
    </html>

##### （4） 渲染模板 #####

最后，改写app.js文件。

// app.js文件
    
    var express = require('express');
    var app = express();
    
    var hbs = require('hbs');
    
    // 加载数据模块
    var blogEngine = require('./blog');
    
    app.set('view engine', 'html');
    app.engine('html', hbs.__express);
    app.use(express.bodyParser());
    
    app.get('/', function(req, res) {
        
       res.render('index',{
        title:"最近文章", entries:blogEngine.getBlogEntries()});
    });
    
    app.get('/about', function(req, res) {
        
       res.render('about', {
        title:"自我介绍"});
    });
    
    app.get('/article/:id', function(req, res) {
        
       var entry = blogEngine.getBlogEntry(req.params.id);
       res.render('article',{
        title:entry.title, blog:entry});
    });
    
    app.listen(3000);

上面代码中的render方法，现在加入了第二个参数，表示模板变量绑定的数据。

现在重启node服务器，然后访问http://127.0.0.1:3000。

`node app.js`

可以看得，模板已经使用加载的数据渲染成功了。

##### （5） 指定静态文件目录 #####

模板文件默认存放在views子目录。这时，如果要在网页中加载静态文件（比如样式表、图片等），就需要另外指定一个存放静态文件的目录。

`app.use(express.static('public'));`

上面代码在文件app.js之中，指定静态文件存放的目录是public。于是，当浏览器发出非HTML文件请求时，服务器端就到public目录寻找这个文件。比如，浏览器发出如下的样式表请求：

`<link href="/bootstrap/css/bootstrap.css" rel="stylesheet">`

服务器端就到public/bootstrap/css/目录中寻找bootstrap.css文件。

## 5 Express.Router用法 ##

从Express 4.0开始，路由器功能成了一个单独的组件Express.Router。它好像小型的express应用程序一样，有自己的use、get、param和route方法。

### 1 基本用法 ###

首先，Express.Router是一个构造函数，调用后返回一个路由器实例。然后，使用该实例的HTTP动词方法，为不同的访问路径，指定回调函数；最后，挂载到某个路径。

var router = express.Router();
    
    router.get('/', function(req, res) {
        
      res.send('首页');
    });
    
    router.get('/about', function(req, res) {
        
      res.send('关于');
    });
    
    app.use('/', router);

上面代码先定义了两个访问路径，然后将它们挂载到根目录。如果最后一行改为app.use(‘/app’, router)，则相当于为/app和/app/about这两个路径，指定了回调函数。

这种路由器可以自由挂载的做法，为程序带来了更大的灵活性，既可以定义多个路由器实例，也可以为将同一个路由器实例挂载到多个路径。

### 2 router.route方法 ###

router实例对象的route方法，可以接受访问路径作为参数。

### 3 router中间件 ###

use方法为router对象指定中间件，即在数据正式发给用户之前，对数据进行处理。下面就是一个中间件的例子。

router.use(function(req, res, next) {
        
    	console.log(req.method, req.url);
    	next();
    });

上面代码中，回调函数的next参数，表示接受其他中间件的调用。函数体中的next()，表示将数据传递给下一个中间件。

注意，中间件的放置顺序很重要，等同于执行顺序。而且，中间件必须放在HTTP动词方法之前，否则不会执行。

### 4 对路径参数的处理 ###

router对象的param方法用于路径参数的处理。

router.param('name', function(req, res, next, name) {
        
    	// 对name进行验证或其他处理……
    	console.log(name);
    	req.name = name;
    	next();
    });
    
    router.get('/hello/:name', function(req, res) {
        
    	res.send('hello ' + req.name + '!');
    });

上面代码中，get方法为访问路径指定了name参数，param方法则是对name参数进行处理。注意，param方法必须放在HTTP动词方法之前。

### 5 app.route ###

假定app是Express的实例对象，Express 4.0为该对象提供了一个route属性。app.route实际上是express.Router()的缩写形式，除了直接挂载到根路径。因此，对同一个路径指定get和post方法的回调函数，可以写成链式形式。

app.route('/login')
    	.get(function(req, res) {
        
    		res.send('this is the login form');
    	})
    	.post(function(req, res) {
        
    		console.log('processing');
    		res.send('processing the login form!');
    	});

上面代码的这种写法，显然非常简洁清晰。

### 6 上传文件 ###

首先，在网页插入上传文件的表单。

<form action="/pictures/upload" method="POST" enctype="multipart/form-data">
      Select an image to upload:
      <input type="file" name="image">
      <input type="submit" value="Upload Image">
    </form>

然后，服务器脚本建立指向/upload目录的路由。这时可以安装multer模块，它提供了上传文件的许多功能。

上面代码是上传文件到本地目录。下面是上传到Amazon S3的例子。

首先，在S3上面新增CORS配置文件。

<?xml version="1.0" encoding="UTF-8"?>
    <CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
      <CORSRule>
        <AllowedOrigin>*</AllowedOrigin>
        <AllowedMethod>GET</AllowedMethod>
        <AllowedMethod>POST</AllowedMethod>
        <AllowedMethod>PUT</AllowedMethod>
        <AllowedHeader>*</AllowedHeader>
      </CORSRule>
    </CORSConfiguration>

上面的配置允许任意电脑向你的bucket发送HTTP请求。

然后，安装aws-sdk。

`$ npm install aws-sdk --save`

下面是服务器脚本。

上面代码中，用户访问/sign路径，正确登录后，会收到一个JSON对象，里面是S3返回的数据和一个暂时用来接收上传文件的URL，有效期只有60秒。

浏览器代码如下。

// HTML代码为
    // <br>Please select an image
    // <input type="file" id="image">
    // <br>
    // <img id="preview">
    
    document.getElementById("image").onchange = function() {
        
      var file = document.getElementById("image").files[0]
      if (!file) return
    
      sign_request(file, function(response) {
        
        upload(file, response.signed_request, response.url, function() {
        
          document.getElementById("preview").src = response.url
        })
      })
    }
    
    function sign_request(file, done) {
        
      var xhr = new XMLHttpRequest()
      xhr.open("GET", "/sign?file_name=" + file.name + "&file_type=" + file.type)
    
      xhr.onreadystatechange = function() {
        
        if(xhr.readyState === 4 && xhr.status === 200) {
        
          var response = JSON.parse(xhr.responseText)
          done(response)
        }
      }
      xhr.send()
    }
    
    function upload(file, signed_request, url, done) {
        
      var xhr = new XMLHttpRequest()
      xhr.open("PUT", signed_request)
      xhr.setRequestHeader('x-amz-acl', 'public-read')
      xhr.onload = function() {
        
        if (xhr.status === 200) {
        
          done()
        }
      }
    
      xhr.send(file)
    }

上面代码首先监听file控件的change事件，一旦有变化，就先向服务器要求一个临时的上传URL，然后向该URL上传文件。