node.js開發-express路由與中介軟體的程式碼範例詳解

這篇文章主要介紹了nodejs開發－express路由與中間件 ，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟著小編過來看看吧

路由

通常HTTP URL的格式是這樣的：

host[:port][path]

http表示協定。

host表示主機。

port為端口，可選字段，不提供時預設為80。

path指定請求資源的URI(Uniform Resource Identifier，統一資源定位符)，如果URL中沒有給予path，一般會預設成「/」（通常由瀏覽器或其它HTTP客戶端完成補充上）。

所謂路由，就是如何處理HTTP請求中的路徑部分。例如「xxx.com/users/profile」這個URL，路由將決定怎麼處理/users/profile這個路徑。

來回顧我們在Node.js開發入門——Express安裝與使用中提供的express版本的HelloWorld程式碼：

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

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

app.listen(8000, function () {
 console.log('Hello World is listening at port 8000');
});

上面程式碼裡的app.get()調用，實際上就為我們的網站增加了一條路由，指定「/」這個路徑由get的第二個參數所代表的函數來處理。

express物件可以針對常見的HTTP方法指定路由，使用下面的方法：

app.METHOD(path, callback [, callback ...])

路由路徑

使用字串的路由路徑範例：

// 匹配根路径的请求

app.get('/', function (req, res) {

 res.send('root');

});

// 匹配 /about 路径的请求

app.get('/about', function (req, res) {

 res.send('about');

});

// 匹配 /random.text 路径的请求

app.get('/random.text', function (req, res) {

 res.send('random.text');

});

使用字符串模式的路由路径示例：

// 匹配 acd 和 abcd

app.get('/ab?cd', function(req, res) {

 res.send('ab?cd');

});

// 匹配 abcd、abbcd、abbbcd等

app.get('/ab+cd', function(req, res) {

 res.send('ab+cd');

});

// 匹配 abcd、abxcd、abRABDOMcd、ab123cd等

app.get('/ab*cd', function(req, res) {

 res.send('ab*cd');

});

// 匹配 /abe 和 /abcde

app.get('/ab(cd)?e', function(req, res) {

 res.send('ab(cd)?e');

});

字元?、+、* 和() 是正規表示式的子集，-和. 在基於字串的路徑中按照字面值解釋。

使用正規表示式的路由路徑範例：

// 匹配任何路径中含有 a 的路径：

app.get(/a/, function(req, res) {

 res.send('/a/');

});

// 匹配 butterfly、dragonfly，不匹配 butterflyman、dragonfly man等

app.get(/.*fly$/, function(req, res) {

 res.send('/.*fly$/');

});

#路由句柄

可以為請求處理提供多個回呼函數，其行為類似中間件。唯一的差異是這些回呼函數有可能呼叫 next('route') 方法而略過其他路由回呼函數。可以利用此機制為路由定義前提條件，如果在現有路徑上繼續執行沒有意義，則可將控制權交給剩餘的路徑。

路由句柄有多種形式，可以是一個函數、一個函數數組，或是兩者混合，如下所示.

使用一個回呼函數處理路由：

app.get('/example/a', function (req, res) {

 res.send('Hello from A!');

});

使用多個回呼函數處理路由（記得指定next 物件）：

app.get('/example/b', function (req, res, next) {

 console.log('response will be sent by the next function ...');

 next();

}, function (req, res) {

 res.send('Hello from B!');

});

使用回呼函數數組處理路由：

var cb0 = function (req, res, next) {

 console.log('CB0');

 next();

}

var cb1 = function (req, res, next) {

 console.log('CB1');

 next();

}

var cb2 = function (req, res) {

 res.send('Hello from C!');

}

app.get('/example/c', [cb0, cb1, cb2]);

混合使用函數和函數數組處理路由：

var cb0 = function (req, res, next) {

 console.log('CB0');

 next();

}

var cb1 = function (req, res, next) {

 console.log('CB1');

 next();

}

app.get('/example/d', [cb0, cb1], function (req, res, next) {

 console.log('response will be sent by the next function ...');

 next();

}, function (req, res) {

 res.send('Hello from D!');

METHOD可以是GET、POST等HTTP方法的小寫，例如app.get，app.post。 path部分呢，既可以是字串字面量，也可以是正規表示式。最簡單的例子，把前面程式碼裡的app.get()呼叫的一個參數'/'修改為'*'，意義就不一樣。在改變之前，只有訪問“localhost:8000”或“localhost:8000/”這種形式的訪問才會返回“Hello World!”，而改之後呢，像“localhost:8000/xxx/yyyy.zz”這種訪問也會返回“Hello World!”。

使用express建置Web伺服器時，很重要的部分工作就是決定怎麼回應針對某個路徑的請求，也即路由處理。

最直接的路由配置方法，就是呼叫app.get()、app.post()一條一條的配置，不過對於需要處理大量路由的網站來講，這會搞出人命來的。所以呢，我們實際開發中需要結合路由參數（query string、正規表示式、自訂的參數、post參數）來減少工作量提高可維護性。

中間件

Express裡有個中介軟體（middleware）的概念。所謂中間件，就是在收到請求後和發送回應之前這個階段執行的一些函數。

要在一條路由的處理鏈上插入中間件，可以使用express物件的use方法。此方法原型如下：

app.use([path,] function [, function...])

當app.use沒有提供path參數時，路徑預設為「/」。當你為某個路徑安裝了中間件，則當以該路徑為基礎的路徑被存取時，都會套用該中間件。例如你為「/abcd」設定了中間件，那麼「/abcd/xxx」被存取時也會套用該中間件。

中間件函數的原型如下：

function (req, res, next)

第一個參數是Request物件req。第二個參數是Response物件res。第三個則是用來驅動中間件呼叫鏈的函數next，如果你想讓後面的中間件繼續處理請求，就需要呼叫next方法。

給某個路徑應用中間件函數的典型呼叫是這樣的：

app.use('/abcd', function (req, res, next) {
 console.log(req.baseUrl);
 next();
})

#app.static中間件

Express提供了一個static中間件，可以用來處理網站裡的靜態檔案的GET請求，可以透過express.static存取。

express.static的用法如下：

express.static(root, [options])

第一个参数root，是要处理的静态资源的根目录，可以是绝对路径，也可以是相对路径。第二个可选参数用来指定一些选项，比如maxAge、lastModified等，

一个典型的express.static应用如下：

var options = {
 dotfiles: 'ignore',
 etag: false,
 extensions: ['htm', 'html'],
 index: false,
 maxAge: '1d',
 redirect: false,
 setHeaders: function (res, path, stat) {
  res.set('x-timestamp', Date.now());
 }
}

app.use(express.static('public', options));

上面这段代码将当前路径下的public目录作为静态文件，并且为Cache-Control头部的max-age选项为1天。还有其它一些属性，请对照express.static的文档来理解。

使用express创建的HelloExpress项目的app.js文件里有这样一行代码：

app.use(express.static(path.join(dirname, 'public')));

这行代码将HelloExpress目录下的public目录作为静态文件交给static中间件来处理，对应的HTTP URI为“/”。path是一个Node.js模块，dirname是Node.js的全局变量，指向当前运行的js脚本所在的目录。path.join()则用来拼接目录。

有了上面的代码，你就可以在浏览器里访问“localhost:3000/stylesheets/style.css”。我们做一点改动，把上面的代码修改成下面这样：

app.use('/static', express.static(path.join(dirname, 'public')));

上面的代码呢，针对/static路径使用static中间件处理public目录。这时你再用浏览器访问“localhost:3000/stylesheets/”就会看到一个404页面，将地址换成“localhost:3000/static/stylesheets/style.css”就可以了。

Router

Express还提供了一个叫做Router的对象，行为很像中间件，你可以把Router直接传递给app.use，像使用中间件那样使用Router。另外你还可以使用router来处理针对GET、POST等的路由，也可以用它来添加中间件，总之你可以将Router看作一个微缩版的app。

下面的代码创建一个Router实例：

var router = express.Router([options]);

然后你就可以像使用app一样使用router：

// invoked for any requests passed to this router
router.use(function(req, res, next) {
 // .. some logic here .. like any other middleware
 next();
});

// will handle any request that ends in /events
// depends on where the router is "use()'d"
router.get('/events', function(req, res, next) {
 // ..
});

定义了router后，也可以将其作为中间件传递给app.use：

app.use('/events', router);

上面这种用法，会针对URL中的“/events”路径应用router，你在router对象上配置的各种路由策略和中间件，都会被在合适的时候应用。

路由模块

express工具创建的应用，有一个routes目录，下面保存了应用到网站的Router模块，index.js和user.js。这两个模块基本一样，我们研究一下index.js。

下面是index.js的内容：

var express = require('express');
var router = express.Router();

/* GET home page. */
router.get('/', function(req, res, next) {
 res.render('index', { title: 'Express' });
});

module.exports = router;

index.js创建了一个Router实例，然后调用router.get为“/”路径应用了路由函数。最后呢使用module.exports将Router对象导出。

下面是app.js里引用到index.js的代码：

var routes = require('./routes/index');
...
app.use('/', routes);

第一处，require(‘./routes/index')将其作为模块使用，这行代码导入了index.js，并且将index.js导出的router对象保存在变量routes里以供后续使用。注意，上面代码里的routes就是index.js里的router。

第二处代码，把routes作为一个中间件，挂载到了“/”路径上。

模块

前面分析index.js时看到了module.exports的用法。module.exports用来导出一个Node.js模块内的对象，调用者使用require加载模块时，就会获得导出的对象的实例。

我们的index.js导出了Router对象。app.js使用require(‘./routes/index')获取了一个Router实例。

module.exports还有一个辅助用法，即直接使用exports来导出。

exports.signup = function(req, res){
 //some code
}

exports.login = function(req, res){
 //some code
}

上面的代码（假定在users.js文件里）直接使用exports来导出。当使用exports来导出时，你设置给exports的属性和方法，实际上都是module.exports的。这个模块最终导出的是module.exports对象，你使用类似“exports.signup”这种形式设置的方法或属性，调用方在require后都可以直接使用。

使用users模块的代码可能是这样的：

var express = require('express');
var app = express();
...
var users = require('./routes/users');
app.post('/signup', users.signup);
app.post('/login', users.login);
...

1.  什么是router路径，什么是middleware？

我们输入www.baidu.com 来访问百度的主页，浏览器会自动转换为 www.baidu.com:80/(省略一些参数)。 http://代表我们同服务器连接使用的是http协议，www.baidu.com 代表的是服务器的主机地址，会被我们的pc通过DNS解析为IP地址。80是默认的应用层端口。/ 即为我们访问的服务器(www.baidu.com)的路径，服务器要对我们访问的这个路径做出响应，采取一定的动作。我们可以把这一过程看做一个路由。

 访问的路径‘/'即为router的路径，服务器采取的动作即为middleware，即为一个个特殊的函数。

2. router路径

www.baidu.com/test: 路径为 /test

www.baidu.com/test?name=1&number=2: 路径同样为/test, ?后面会被服务器理解传给路径的参数。

3. Middleware

An Express application is essentially a stack of middleware which are executed serially.(express应用其实就是由一系列顺序执行的Middleware组成。)

A middleware is a function with access to the request object (req), the response object (res), and the next middleware in line in the request-response cycle of an Express application. It is commonly denoted by a variable named next. Each middleware has the capacity to execute any code, make changes to the request and the reponse object, end the request-response cycle, and call the next middleware in the stack. Since middleware are execute serially, their order of inclusion is important.(中间件其实就是一个访问express应用串入的req，res，nex参数的函数，这个函数可以访问任何通过req，res传入的资源。)

If the current middleware is not ending the request-response cycle, it is important to call next() to pass on the control to the next middleware, else the request will be left hanging.(如果当前中间件没有完成对网页的res响应 ，还可以通过next把router 留给下一个middleware继续执行)

With an optional mount path, middleware can be loaded at the application level or at the router level. Also, a series of middleware functions can be loaded together, creating a sub-stack of middleware system at a mount point.

路由的产生是通过HTTP的各种方法(GET, POST)产生的，Middleware可以跟router路径跟特定的HTTP方法绑定，也可以跟所有的方法绑定。

3.1 通过express应用的use（all），把Middleware同router路径上的所有HTTP方法绑定：

 app.use(function (req, res, next) {
  console.log('Time: %d', Date.now());
  next();
 })

3.2 通过express应用的http.verb，把Middleware同router路径上的特定的HTTP方法绑定：

app.get('/', function(req, res){
 res.send('hello world');
});


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

4.  Express的Router对象

当express实例的路由越来越多的时候，最好把路由分类独立出去，express的实例(app) 能更好的处理其他逻辑流程。Express的Router对象是一个简化的 app实例，只具有路由相关的功能，包括use, http verbs等等。最后这个Router再通过app的use挂载到app的相关路径下。

 var express = require('express');
var app = express();
var router = express.Router();

// simple logger for this router's requests
// all requests to this router will first hit this middleware
router.use(function(req, res, next) {
 console.log('%s %s %s', req.method, req.url, req.path);
 next();
});

// this will only be invoked if the path ends in /bar
router.use('/bar', function(req, res, next) {
 // ... maybe some additional /bar logging ...
 next();
});

// always invoked
router.use(function(req, res, next) {
 res.send('Hello World');
});

app.use('/foo', router);

app.listen(3000);

router的路由必须通过app.use和app.verbs 挂载到app上才能被响应。所以上述代码，只有在app捕捉到 /foo路径上的路由时，才能router中定义的路由，虽然router中有针对 '/' 的路由，但是被app中的路由给覆盖了。

附：app.verbs和app.use的路由路径区别：

先看一段测试代码：

var express = require('express');

var app = express();
var router = express.Router();

app.get('/', function(req, res){
   console.log('test1');
});

app.use('/', function(req, res){
   console.log('test2');
});

router.get('/', function(req, res){
   console.log('test3');
});

app.listen(4000);

输入url： localhost:4000

输出结果：test1 

输入url： localhost:4000/hello

输出结果：test2

结论：app.get挂载‘/'的路由只响应跟'/'精确匹配的GET请求。 而app.use挂载的'/'的路由响应所有以'/' 为起始路由的路由，且不限制HTTP访问的方法。以下说明：Mounting a middleware at a path will cause the middleware function to be executed whenever the base of the requested path matches the path.

以上是node.js開發-express路由與中介軟體的程式碼範例詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章！