NodeJS框架express的路径映射（路由）功能及控制

 

我们知道Express是一个基于NodeJS的非常优秀的服务端开发框架，本篇CSSer将提供express框架的route和route control章节，route实现了客户端请求的URL的路径映射功能，暂且译为路由或URL映射吧。如果你还是不太理解，相信看完本篇文章将会有些收获的。

路由（URL映射）

Express利用HTTP动作提供了有意义并富有表现力的URL映射API，例如我们可能想让用户帐号的URL看起来像“/user/12”的样子，下面的例子就能实现这样的路由，其中与占位标识符（本例为:id）相关的值可以被req.params获取到。

app.get('/user/:id', function(req, res){
    res.send('user ' + req.params.id);
});

上例中当我们访问/user/12时返回“user 12”,CSSer注：app.get相当于在服务器注册了一个监听get请求事件的侦听器，当请求的URL满足第一个参数时，执行后面的回调函数，该过程是异步的。

路由是一个可以被内部编译成正则表达式的简单字符串，比如当/user/:id被编译后，被内部编译后的正则表达式字符串看起来会是下面的样子（简化后）：

\/user\/([^\/]+)\/?

要实现复杂点的，我们可以传入正则表达式直接量，因为正则捕获组是匿名的因此我们可以通过req.params进行访问，第一个捕获组应该是req.params[0]，第二个应该是req.params[1]，以此类推。

app.get(/^\/users?(?:\/(\d+)(?:\.\.(\d+))?)?/, function(req, res){
    res.send(req.params);
});

通过Linux的curl命令来测试我们定义的路由：

$ curl http://cssercom:3000/user
[null,null]
$ curl http://cssercom:3000/users
[null,null]
$ curl http://cssercom:3000/users/1
["1",null]
$ curl http://cssercom:3000/users/1..15
["1","15"]

下面是一些路由例子，以及与之相匹配的关联路径：

"/user/:id"
/user/12

"/users/:id?"
/users/5
/users

"/files/*"
/files/jquery.js
/files/javascripts/jquery.js

"/file/*.*"
/files/jquery.js
/files/javascripts/jquery.js

"/user/:id/:operation?"
/user/1
/user/1/edit

"/products.:format"
/products.json
/products.xml

"/products.:format?"
/products.json
/products.xml
/products

"/user/:id.:format?"
/user/12
/user/12.json

另外，我们可以通过POST方式提交json数据，然后利用bodyParser中间件解析json请求体并把json数据返回给客户端：

var express = require('express')
  , app = express.createServer();

app.use(express.bodyParser());

app.post('/', function(req, res){
  res.send(req.body);
});

app.listen(3000);

通常我们所使用的占位符（比如/user/:id）都没有任何限制，即用户可以传入各种各样数据类型的id值，如果我们希望限制用户id为数字，可以这样写“/user/:id(\d+)”，这样就能保证只有该占位符数据类型为数值类型才会进行路由的相关处理。

路由控制

一个应用中可以定义多个路由，我们可以控制以令其转向下一个路由，Express提供了第三个参数即next()函数。当一个模式不被匹配时，控制将被转回Connect（Express基于Connect模块），同时中间件会继续按照它们在use()中增加的顺序来执行。当多个定义的路由都可能匹配同一个URL时也是如此，除非某个路由并不调用next()且已将响应输出到客户端，否则它们也将按顺序执行。

app.get('/users/:id?', function(req, res, next){
    var id = req.params.id;
    if (id) {
        // 一回注：如果在这里就将响应内容输出给客户端，那么后续的URL映射将不会被调用
    } else {
        next(); // 将控制转向下一个符合URL的路由
    }
});

app.get('/users', function(req, res){
    // do something else
});

app.all()方法可以对所有HTTP动作应用单一调用入口，这在有些情况下很有用。下面我们使用该功能来从我们的模拟数据库中加载一个用户，并把它分配给req.user。

var express = require('express')
  , app = express.createServer();

var users = [{ name: 'www.csser.com' }];

app.all('/user/:id/:op?', function(req, res, next){
  req.user = users[req.params.id];
  if (req.user) {
    next();
  } else {
    next(new Error('cannot find user ' + req.params.id));
  }
});

app.get('/user/:id', function(req, res){
  res.send('viewing ' + req.user.name);
});

app.get('/user/:id/edit', function(req, res){
  res.send('editing ' + req.user.name);
});

app.put('/user/:id', function(req, res){
  res.send('updating ' + req.user.name);
});

app.get('*', function(req, res){
  res.send('what???', 404);
});

app.listen(3000);

路由参数预处理

本节为后补（2011-4-16）。

路由参数预处理通过隐式的数据处理，可以大幅提高应用代码的可读性和请求URL的验证。假如你经常性的从几个路由获取通用数据，如通过/user/:id加载用户信息，通常我们可能会这样做：

app.get('/user/:userId', function(req, res, next){
  User.get(req.params.userId, function(err, user){
    if (err) return next(err);
    res.send('user ' + user.name);
  });
});

利用预处理后参数可以被映射到回调函数，从而可以提供诸如验证、强制性改变值，甚至从数据库中加载数据等功能。下面我们将调用app.param()并传入我们希望映射到某个中间件的参数，可以看到我们接收了包含占位符（:userId）值的id参数。在这里可以与平常一样进行用户数据加载以及错误处理，并能简单的通过调用next()将控制权转向下一个预处理或路由（路径控制）。

app.param('userId', function(req, res, next, id){
  User.get(id, function(err, user){
    if (err) return next(err);
    if (!user) return next(new Error('failed to find user'));
    req.user = user;
    next();
  });
});

这样做，不仅向上面提到的可以大幅提高路由的可读性，还能在整个应用中共享该部分的逻辑实现，达到复用目的。

app.get('/user/:userId', function(req, res){
  res.send('CSSer用户为 ' + req.user.name);
});

对于简单的情况如路由占位符验证和强迫改变值，只需要传入1个参数（支持1个参数），期间抛出的异常将自动传入next(err)。

app.param('number', function(n){ return parseInt(n, 10); });

也可以同时将回调函数应用到多个占位符，比如路由/commits/:from-:to来说，:from和:to都是数值类型，我们可以将它们定义为数组：

app.param(['from', 'to'], function(n){ return parseInt(n, 10); });

结语

通过本文的学习，我们应该有些感觉了，NodeJS不仅仅可以实现我们产品的服务端逻辑，同时我们还可以利用Javascript做服务器编程，注意是服务器，也就是说，我们可以利用Javascript来定制以往只能在apache中才可以做到的功能。NodeJS还需要rewrite吗？路径映射更简单更强大，还要rewrite干嘛用？