Exemples de code détaillés de développement Node.js de routage express et de middleware

Cet article présente principalement le développement de nodejs - le routage express et le middleware. L'éditeur pense qu'il est plutôt bon. Maintenant, je vais le partager avec vous et le donner comme référence. Suivons l'éditeur pour y jeter un œil.

Routage

Habituellement, le format de l'URL HTTP est comme ceci :

host[:port][path]

http représente le protocole.

hôte signifie hôte.

port est le port, un champ facultatif S'il n'est pas fourni, la valeur par défaut est 80.

chemin spécifie l'URI (Uniform Resource Identifier, Uniform Resource Locator) de la ressource demandée. Si le chemin n'est pas indiqué dans l'URL, il sera généralement par défaut "/" (généralement complété par un navigateur ou autre). client HTTP) supérieur).

Le soi-disant routage consiste à gérer la partie chemin dans la requête HTTP. Par exemple, pour l'URL « xxx.com/users/profile », le routage déterminera comment gérer le chemin /users/profile.

Passons en revue la version express du code HelloWorld que nous avons fournie dans Premiers pas avec le développement Node.js - Installation et utilisation express :

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');
});

L'appel app.get() dans le code ci-dessus , En fait, une route est ajoutée à notre site Web, et le chemin "/" est spécifié pour être traité par la fonction représentée par le deuxième paramètre de get. L'objet

express peut spécifier des itinéraires pour les méthodes HTTP courantes, en utilisant les méthodes suivantes :

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

Chemin d'itinéraire

Exemple de chemin de routage utilisant une chaîne :

// 匹配根路径的请求

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');

});

caractères ?, +, * et () sont des expressions régulières sous-ensembles, - et . sont interprétés littéralement dans des chemins basés sur des chaînes.

Exemple de chemin de routage utilisant des expressions régulières :

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

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

 res.send('/a/');

});

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

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

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

});

Possibilité d'itinéraire

Plusieurs peuvent être fournis pour le traitement des requêtes >Fonction de rappel, qui se comporte comme un middleware. La seule différence est que ces fonctions de rappel peuvent appeler la méthode next('route') et ignorer d'autres fonctions de rappel d'itinéraire. Ce mécanisme peut être utilisé pour définir les conditions préalables au routage, et si cela n'a aucun sens de poursuivre l'exécution sur le chemin existant, le contrôle peut être donné au chemin restant.

Les descripteurs d'itinéraire se présentent sous de nombreuses formes et peuvent être une fonction, un tableau de fonctions ou un mélange des deux, comme indiqué ci-dessous

Utilisez une fonction de rappel pour gérer le routage :

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

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

});

Utilisez plusieurs fonctions de rappel pour traiter les itinéraires (n'oubliez pas de spécifier l'objet suivant) :

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!');

});

Utilisez des tableaux de fonctions de rappel pour traiter les itinéraires :

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]);

MixteUtilisation de fonctions et routage de traitement de tableaux de fonctions :

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 peut être la casse inférieure des méthodes HTTP telles que GET et POST, telles que app.get, app.post. La partie chemin peut être soit une chaîne littérale, soit une expression régulière. L'exemple le plus simple consiste à modifier un paramètre '/' dans l'appel app.get() dans le code précédent en '*', et la signification sera différente. Avant le changement, seuls les accès sous la forme "localhost:8000" ou "localhost:8000/" renvoyaient "Hello World!", mais après le changement, "localhost:8000/xxx/yyyy.zz" renvoyait Access will renvoie également "Hello World!".

Lorsque vous utilisez express pour créer un serveur Web, une partie très importante du travail consiste à décider comment répondre aux demandes pour un certain chemin, c'est-à-dire le traitement du routage.

La méthode de configuration de route la plus directe consiste à appeler app.get() et app.post() pour les configurer un par un. Cependant, pour les sites Web qui doivent gérer un grand nombre de routes, cela entraînera des pertes de vie. . Par conséquent, dans le développement réel, nous devons combiner des paramètres de routage (chaîne de requête, expression régulière, paramètres personnalisés, paramètres de publication) pour réduire la charge de travail et améliorer la maintenabilité.

Middleware

Il existe un concept de middleware dans Express. Le soi-disant middleware fait référence à certaines fonctions qui sont exécutées à ce stade après la réception de la demande et avant l'envoi de la réponse.

Pour insérer un middleware dans la chaîne de traitement d'une route, vous pouvez utiliser la méthode use de l'objet express. Le prototype de cette méthode est le suivant :

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

Lorsque app.use ne fournit pas de paramètre de chemin, le chemin par défaut est "/". Lorsque vous installez un middleware pour un chemin, le middleware sera appliqué à chaque accès à un chemin basé sur ce chemin. Par exemple, si vous définissez un middleware pour "/abcd", le middleware sera également appliqué lors de l'accès à "/abcd/xxx".

Le prototype de la fonction middleware est le suivant :

function (req, res, next)

Le premier paramètre est l'objet Request req. Le deuxième paramètre est la réponse de l'objet Response. La troisième est la fonction suivante utilisée pour piloter la chaîne d'appels du middleware. Si vous souhaitez que le middleware suivant continue de traiter les requêtes, vous devez appeler la méthode suivante.

Un appel typique pour appliquer une fonction middleware à un certain chemin est le suivant :

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

middleware app.static

Express fournit A middleware statique qui peut être utilisé pour gérer les requêtes GET pour les fichiers statiques sur le site Web et est accessible via express.static.

L'utilisation de express.static est la suivante :

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.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!