Custom Middleware In Django

Custom Middleware In Django


2 min read

In Django, middleware is a framework of hooks into Django's request/response processing. It's a way to modify the input or output of Django views and allows you to perform operations on requests and responses globally for your project. Middleware sits between the request and the view, and between the view and the response, allowing you to modify incoming requests and outgoing responses.

Here's a brief overview of middleware in Django:

  1. How Middleware Works: Middleware consists of a series of classes defined in Python that define methods for processing requests and responses. Each middleware component can perform operations before and after the view is called.

  2. Order of Middleware Execution: Middleware classes are executed in the order they are defined in the MIDDLEWARE setting in your Django project's settings file ( Middleware defined earlier in the list are executed first, and middleware defined later are executed later.

  3. Common Use Cases for Middleware:

    • Authentication: Checking if a user is logged in and redirecting if not.

    • Session Management: Handling session-related tasks.

    • Security: Adding security headers, XSS protection, etc.

    • Content-Length Header: Setting the Content-Length header for responses.

    • CORS (Cross-Origin Resource Sharing) Handling: Adding CORS headers to responses.

    • Request/Response Logging: Logging incoming requests and outgoing responses for debugging or analytics purposes.

    • Compression: Compressing responses for improved performance.

  4. Creating Custom Middleware: You can create custom middleware by defining a class with methods such as __init__, __call__, process_request, process_response, etc. These methods are called at different stages of request/response processing.

    Here's a simple example of custom middleware that logs each request and its corresponding response:


class RequestResponseLoggerMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):
        # Logic to execute before the view is called
        response = self.get_response(request)
        # Logic to execute after the view is called
        return response

    def process_request(self, request):
        # Logic to execute before the view is called
        print(f"Request Path: {request.path}")

    def process_response(self, request, response):
        # Logic to execute after the view is called
        print(f"Response Status Code: {response.status_code}")
        return response

To use this middleware, add its path to the MIDDLEWARE setting in your Django project's settings file:


    # Other middleware classes...

This will log the path of each incoming request and the corresponding response status code.

Overall, middleware in Django provides a powerful way to globally customize the behavior of request/response processing in your Django project. It's a fundamental aspect of Django's architecture and is widely used for various purposes such as authentication, security, logging, and more.

Did you find this article valuable?

Support Deven by becoming a sponsor. Any amount is appreciated!