Express.js Middleware with Practical Examples

When you're working with Express.js, one of the most powerful features you'll encounter is middleware. But what exactly is middleware, and why should you care about it? Think of middleware like the layers of an onion. Each layer represents a different function or operation in your server’s request-handling path.

What is Middleware?

In simple terms, middleware functions have access to the request and response objects. They can execute any code, make changes to the request-response objects, end the request-response cycle, or call the next middleware in the stack. This makes them vital in building a flexible and efficient server.

Types of Middleware

Before diving into examples, let's break down the types of middleware:

• Application-level Middleware: Bound to an instance of Express, this middleware can be applied to specific routes or universally.
• Router-level Middleware: These are specific to an instance of express.Router().
• Error-handling Middleware: Defined similarly to other types of middleware, but with four arguments.
• Built-in Middleware: Such as express.static, serving static files.
• Third-party Middleware: Integrations like body-parser.

Setting Up Express.js

First, you’ll need Node.js and Express installed. If you haven't already, run:

npm install express

Now, you can start creating your server and experimenting with middleware.

Basic Application Level Middleware Example

Let's start with a simple middleware function that logs details about each request.

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

// Middleware function
app.use((req, res, next) => {
  console.log(`${req.method} request for '${req.url}'`);
  next(); // Pass control to the next middleware function
});

app.get('/', (req, res) => {
  res.send('Hello, world!');
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Line-by-Line Explanation

Line 1-2: Import Express and create an app instance.

Line 5: Create a middleware function using app.use(). It logs the HTTP method and request URL for each incoming request.

Line 10: The next() function passes control to the next matching route or middleware. Without it, the request would be left hanging.

Line 12-15: Define a simple GET route for the root URL.

Line 17-19: Start the server on port 3000 and log a message once it's running.

Router Level Middleware Example

Once you understand basic middleware, router-level middleware is a logical next step. Here's how to set it up:

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

// Router-level middleware
router.use((req, res, next) => {
  console.log(`Time: ${Date.now()} - ${req.method} request on router`);
  next();
});

router.get('/about', (req, res) => {
  res.send('About Page');
});

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

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Line-by-Line Explanation

Line 3-4: Define a new router instance.

Line 7: Use router.use() to create middleware specific to this router.

Line 13: Add a route to the router. This route responds with "About Page" when accessed.

Line 16: Apply the router to /router base path in the application.

Error-Handling Middleware Example

Every app needs to handle errors gracefully. Here's how to create an error-handling middleware:

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

// Application-level middleware causing error
app.get('/error', (req, res, next) => {
  const err = new Error('Something went wrong!');
  err.status = 500;
  next(err); // Pass the error to the error-handling middleware
});

// Error-handling middleware
app.use((err, req, res, next) => {
  console.error(err.stack);
  res.status(err.status || 500).send(err.message || 'Internal Server Error');
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Line-by-Line Explanation

Line 5: Define a GET route that simulates an error.

Line 7-9: Creates an Error object and sets its status. Passes it to the next function to trigger the error handler.

Line 12-15: Logs the error and sends a response. It uses the error status and message or defaults to a 500 Internal Server Error.

Conclusion

Express.js middleware is more than just a helpful feature—it's the backbone of effective request handling. By learning to write custom middleware functions, you're better equipped to manage your app’s logic, enhance security, and streamline processes. Experiment with the examples above and adapt them to your needs, crafting a robust server architecture. Now that you know the basics, what's your next project going to look like? Consider integrating your newfound knowledge into your applications for smoother and more efficient operation.