node-header

Node.js/express: Gestionar las URL de tu proyecto mas eficientemente.

Normalmente cuando haces una aplicación usando express, por comodidad tiendes a poner todas las definiciones de las url’s en la raíz del proyecto:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
var express = require('express');
var app = express();
 
//...
//Configuraciones varias
//...
 
app.get("/users", function (req, res) {
    return res.render("list users");
});
 
app.get("/user/:uid", function (req, res) {
    return res.render("show an user");
});
 
app.get("/articles", function (req, res) {
    return res.render("list articles");
});
 
app.get("/article/:id", function (req, res) {
    return res.render("show an article");
});
 
app.get("/article/new", function (req, res) {
    return res.render("new article");
});
 
http.createServer(app).listen(app.get('port'), function () {
    console.log("http://localhost:" + app.get('port'));
});

Pero esto a la corta se vuelve algo inmanejable. La solución es adoptar un patrón que nos permita extraer las URL a archivos en los que poder juntar las url que se refieran a algo en común (en este ejemplo usuarios por un lado y articles por otro.).

Manos a la obra

crea un directorio llamado routes, crea los archivos “users.js” y “articles.js” y llévate allí las urls.
En el lugar que estaban las URL (dentro de app.js o server.js, como sea que lo hayas llamado.) pon:

1
2
3
4
var routePath = __dirname + '/routes/';
fs.readdirSync(routePath).forEach(function (file) {
    require(routePath + file)(app);
});

Este snippet se va a encargar de cargar todos los archivos que haya en la carpeta routes. Si te fijas bien vas a ver que está haciendo un require pero le pasa “(app)” al final de este. Eso es porque dentro de nuestros archivos de rutas vamos a devolver funciones que van a ejecutarse ni bien sean cargadas.

Lo ultimo que nos queda es definir la estructura que debe tener cada archivo que esté alojado en routes. Como ya no están en la raíz, vamos a encapsular estas definiciones de rutas dentro de una función, que es la que se va a encargar de hacernos llegar a app (que es la instancia de express que va a recibir nuestras rutas):

users.js:

1
2
3
4
5
6
7
8
9
10
11
module.exports = function (app) {
 
    app.get("/users", function (req, res) {
        return res.render("list users");
    });
 
    app.get("/user/:uid", function (req, res) {
        return res.render("show an user");
    });
 
};

articles.js:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
module.exports = function (app) {
 
    app.get("/articles", function (req, res) {
        return res.render("list articles");
    });
 
    app.get("/article/:id", function (req, res) {
        return res.render("show an article");
    });
 
    app.get("/article/new", function (req, res) {
        return res.render("new article");
    });
 
};

Como podemos ver, en cada uno de los archivos que contienen las rutas, hemos metido las rutas dentro de module.exports = function (app){}. Esto sumado a que a cada archivo cargado se le estaba pasando la app por medio del require (require(routePath + file)(app);) todo cobra sentido.

Ya hemos acabado, ya puedes crear tantos archivos .js como tu corazón y lógica dicten, que se van a cargar sin problemas.

Chau!