mirror of
https://github.com/zebrajr/express.git
synced 2025-12-06 12:19:51 +01:00
f41d09a3cf
This is an overhaul of middleware processing, Router and Route. Connect is no
longer used to process the middleware stack. This functionality has been
split into two parts: middleware stack and default error response.
The entry point for request processing is the `app.handle` method. It
sets up the default error response handle (to run in the event of no
other error handler) and then triggers the app router (instance of
Router) to handle the request.
The app router `handle` function contains the middleware dispatch layer
previously in the connect codebase. This layer handle the logic for
dispatching `.use` calls (stripping paths if needed). The app contains a
base router `app._router`. New routes can be created and `.use`d on this
router to organize routes into files.
Routers now have the following methods `.use`, `.all`, `.param` which
are all public.
Additionally, Routers have a `.route(path)` method which returns a new
instance of Route for the requested path. Route(s) are isolated
middleware stacks and contain methods for the HTTP verbs as well as an
`.all` method to act similar to middleware. These methods are chainable
to easily describe requirements for a route.
var route = Router.route('/foo'); // or 'app.route('/foo')'
route
.all(auth)
.get(function(...) {})
.all(more_checks)
.post(function(...) {})
Any Route and Router methods which accept handlers also accept error
(arity 4) handlers which will also behave as expected.
Finally, the `app.router` getter has been removed. Middleware and
handlers are run IN THE ORDER they are seen in the file. This means that
code which injected the `app.router` and then added error handlers (or
other middleware) will need to be updated to move those handlers after
any requests added on the app object. The examples have been updated
accordingly. This is the largest breaking change to codebases in this
commit.
111 lines
2.7 KiB
JavaScript
111 lines
2.7 KiB
JavaScript
|
|
/**
|
|
* Module dependencies.
|
|
*/
|
|
|
|
var express = require('../../');
|
|
|
|
var app = module.exports = express();
|
|
|
|
// create an error with .status. we
|
|
// can then use the property in our
|
|
// custom error handler (Connect repects this prop as well)
|
|
|
|
function error(status, msg) {
|
|
var err = new Error(msg);
|
|
err.status = status;
|
|
return err;
|
|
}
|
|
|
|
// if we wanted to supply more than JSON, we could
|
|
// use something similar to the content-negotiation
|
|
// example.
|
|
|
|
// here we validate the API key,
|
|
// by mounting this middleware to /api
|
|
// meaning only paths prefixed with "/api"
|
|
// will cause this middleware to be invoked
|
|
|
|
app.use('/api', function(req, res, next){
|
|
var key = req.query['api-key'];
|
|
|
|
// key isnt present
|
|
if (!key) return next(error(400, 'api key required'));
|
|
|
|
// key is invalid
|
|
if (!~apiKeys.indexOf(key)) return next(error(401, 'invalid api key'));
|
|
|
|
// all good, store req.key for route access
|
|
req.key = key;
|
|
next();
|
|
});
|
|
|
|
// map of valid api keys, typically mapped to
|
|
// account info with some sort of database like redis.
|
|
// api keys do _not_ serve as authentication, merely to
|
|
// track API usage or help prevent malicious behavior etc.
|
|
|
|
var apiKeys = ['foo', 'bar', 'baz'];
|
|
|
|
// these two objects will serve as our faux database
|
|
|
|
var repos = [
|
|
{ name: 'express', url: 'http://github.com/visionmedia/express' }
|
|
, { name: 'stylus', url: 'http://github.com/learnboost/stylus' }
|
|
, { name: 'cluster', url: 'http://github.com/learnboost/cluster' }
|
|
];
|
|
|
|
var users = [
|
|
{ name: 'tobi' }
|
|
, { name: 'loki' }
|
|
, { name: 'jane' }
|
|
];
|
|
|
|
var userRepos = {
|
|
tobi: [repos[0], repos[1]]
|
|
, loki: [repos[1]]
|
|
, jane: [repos[2]]
|
|
};
|
|
|
|
// we now can assume the api key is valid,
|
|
// and simply expose the data
|
|
|
|
app.get('/api/users', function(req, res, next){
|
|
res.send(users);
|
|
});
|
|
|
|
app.get('/api/repos', function(req, res, next){
|
|
res.send(repos);
|
|
});
|
|
|
|
app.get('/api/user/:name/repos', function(req, res, next){
|
|
var name = req.params.name
|
|
, user = userRepos[name];
|
|
|
|
if (user) res.send(user);
|
|
else next();
|
|
});
|
|
|
|
// middleware with an arity of 4 are considered
|
|
// error handling middleware. When you next(err)
|
|
// it will be passed through the defined middleware
|
|
// in order, but ONLY those with an arity of 4, ignoring
|
|
// regular middleware.
|
|
app.use(function(err, req, res, next){
|
|
// whatever you want here, feel free to populate
|
|
// properties on `err` to treat it differently in here.
|
|
res.send(err.status || 500, { error: err.message });
|
|
});
|
|
|
|
// our custom JSON 404 middleware. Since it's placed last
|
|
// it will be the last middleware called, if all others
|
|
// invoke next() and do not respond.
|
|
app.use(function(req, res){
|
|
res.send(404, { error: "Lame, can't find that" });
|
|
});
|
|
|
|
if (!module.parent) {
|
|
app.listen(3000);
|
|
console.log('Express server listening on port 3000');
|
|
}
|