Why middleware matters in Django - See It in Action

Why middleware matters in Django

📖 Scenario: You are building a simple Django web application that needs to log every request's path and method for monitoring purposes. Middleware is a perfect place to add this logging because it can process requests before they reach your views and responses before they go back to the user.

🎯 Goal: Create a custom Django middleware that logs the HTTP method and path of each incoming request.

📋 What You'll Learn

Create a middleware class named SimpleLoggingMiddleware.

Add a method to process the request and log the HTTP method and path.

Configure the middleware in Django settings.

Ensure the middleware runs on every request.

💡 Why This Matters

🌍 Real World

Middleware is used in real Django projects to handle tasks like logging, authentication, and modifying requests or responses globally.

💼 Career

Understanding middleware is important for backend developers working with Django, as it helps manage cross-cutting concerns efficiently.

1

Create the middleware class

Create a Python class called SimpleLoggingMiddleware inside a file named middleware.py. The class should have an __init__ method that accepts get_response and stores it as an instance variable.

Django

# Your code here

Hint

Middleware classes in Django need an __init__ method that takes get_response and saves it.

2

Add request processing method

Inside the SimpleLoggingMiddleware class, add a __call__ method that takes request as a parameter. Inside this method, log the HTTP method and path using print(f"Method: {request.method}, Path: {request.path}"). Then call and return self.get_response(request).

Django

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

    # Your code here

Hint

The __call__ method lets the middleware process each request. Use print to log the method and path.

3

Configure middleware in settings

Open your Django project's settings.py file. Add the string 'yourapp.middleware.SimpleLoggingMiddleware' to the MIDDLEWARE list. Place it near the top so it runs early.

Django

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

    def __call__(self, request):
        print(f"Method: {request.method}, Path: {request.path}")
        response = self.get_response(request)
        return response

# Add 'yourapp.middleware.SimpleLoggingMiddleware' to MIDDLEWARE in settings.py

Hint

Middleware must be listed in the MIDDLEWARE setting to be active.

4

Test middleware by running server

Run the Django development server with python manage.py runserver. Visit any page in your browser. Confirm that the console shows logs like Method: GET, Path: / for each request.

Django

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

    def __call__(self, request):
        print(f"Method: {request.method}, Path: {request.path}")
        response = self.get_response(request)
        return response

# Run the server and check console logs
# Your code here

Hint

Use the Django runserver command and watch the terminal for your log messages.

Practice

1. What is the main purpose of middleware in a Django application?

easy

A. To process requests and responses globally before reaching views

B. To define database models and relationships

C. To create HTML templates for rendering pages

D. To handle user authentication only

Solution

1. Step 1: Understand middleware role

   Middleware acts on requests and responses before and after views run.

2. Step 2: Compare options to middleware function

   Only To process requests and responses globally before reaching views describes processing requests and responses globally, which matches middleware's purpose.

3. Final Answer:

   To process requests and responses globally before reaching views -> Option A

4. Quick Check:

   Middleware = global request/response processing [OK]

Hint: Middleware acts on requests/responses before views [OK]

Common Mistakes:

• Confusing middleware with models or templates
• Thinking middleware only handles authentication
• Assuming middleware runs after views only

2. Which of the following is the correct way to add a custom middleware class in Django's settings?

easy

A. Add 'myapp.middleware.MyMiddleware' to TEMPLATES list

B. Add 'myapp.middleware.MyMiddleware' to MIDDLEWARE list in settings.py

C. Add 'myapp.middleware.MyMiddleware' to INSTALLED_APPS list

D. Add 'myapp.middleware.MyMiddleware' to DATABASES dictionary

Solution

1. Step 1: Identify where middleware is configured

   Django uses the MIDDLEWARE list in settings.py to register middleware classes.

2. Step 2: Match the correct setting for middleware

   Only Add 'myapp.middleware.MyMiddleware' to MIDDLEWARE list in settings.py correctly adds the middleware class path to the MIDDLEWARE list.

3. Final Answer:

   Add 'myapp.middleware.MyMiddleware' to MIDDLEWARE list in settings.py -> Option B

4. Quick Check:

   Middleware goes in MIDDLEWARE list [OK]

Hint: Middleware classes go in MIDDLEWARE list, not INSTALLED_APPS [OK]

Common Mistakes:

• Adding middleware to INSTALLED_APPS instead of MIDDLEWARE
• Placing middleware in TEMPLATES or DATABASES settings
• Using incorrect string format for middleware path

3. Given this middleware code snippet, what will be printed when a request is processed?

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

    def __call__(self, request):
        print('Before view')
        response = self.get_response(request)
        print('After view')
        return response

medium

A. Before view printed before the view runs, After view printed after

B. Only Before view is printed

C. Only After view is printed

D. No output is printed

Solution

1. Step 1: Analyze __call__ method flow

   The middleware prints 'Before view', calls the view via get_response, then prints 'After view'.

2. Step 2: Understand order of prints

   'Before view' prints before the view runs, 'After view' prints after the view returns.

3. Final Answer:

   Before view printed before the view runs, After view printed after -> Option A

4. Quick Check:

   Middleware prints before and after view [OK]

Hint: Middleware __call__ runs code before and after get_response [OK]

Common Mistakes:

• Thinking only one print runs
• Confusing order of prints
• Assuming middleware skips printing

4. You wrote this middleware but it causes an error:

class ErrorMiddleware:
    def __init__(self, get_response):
        pass

    def __call__(self, request):
        return self.get_response(request)

What is the problem?

medium

A. Middleware classes must inherit from a base class

B. The __call__ method should not return anything

C. The __init__ method does not save get_response, causing AttributeError

D. The __init__ method should not have parameters

Solution

1. Step 1: Check __init__ method implementation

   The __init__ method ignores get_response and does not save it as self.get_response.

2. Step 2: Understand __call__ method usage

   __call__ tries to call self.get_response, but it does not exist, causing an AttributeError.

3. Final Answer:

   The __init__ method does not save get_response, causing AttributeError -> Option C

4. Quick Check:

   Save get_response in __init__ to avoid errors [OK]

Hint: Always save get_response in __init__ as self.get_response [OK]

Common Mistakes:

• Not storing get_response in __init__
• Assuming __call__ doesn't need to return response
• Thinking middleware must inherit from a base class

5. You want to create middleware that adds a custom header X-App-Version with value 1.0 to every response. Which code snippet correctly implements this?

hard

A. class VersionMiddleware:
def __init__(self, get_response):
self.get_response = get_response
def process_response(self, request, response):
response['X-App-Version'] = '1.0'
return response

B. class VersionMiddleware:
def __init__(self, get_response):
self.get_response = get_response
def process_request(self, request):
request['X-App-Version'] = '1.0'

C. class VersionMiddleware:
def __init__(self, get_response):
self.get_response = get_response
def __call__(self, request):
request['X-App-Version'] = '1.0'
return self.get_response(request)

D. class VersionMiddleware:
def __init__(self, get_response):
self.get_response = get_response
def __call__(self, request):
response = self.get_response(request)
response['X-App-Version'] = '1.0'
return response

Solution

1. Step 1: Identify where to add headers in middleware

   Headers must be added to the response object after the view runs, inside __call__.

2. Step 2: Check each option's method

   class VersionMiddleware:
       def __init__(self, get_response):
           self.get_response = get_response
       def __call__(self, request):
           response = self.get_response(request)
           response['X-App-Version'] = '1.0'
           return response

   correctly adds the header after calling get_response and returns the modified response.

3. Final Answer:

   correctly adds the header in __call__ after response creation -> Option D

4. Quick Check:

   Add headers after get_response in __call__ [OK]

Hint: Modify response headers after get_response call in __call__ [OK]

Common Mistakes:

• Trying to add headers to request instead of response
• Using process_request which can't modify response
• Not returning the response object