Django SessionMiddleware

最新推荐文章于 2025-07-05 05:31:31 发布

原创最新推荐文章于 2025-07-05 05:31:31 发布 · 1.0k 阅读

1 ·

CC 4.0 BY-SA版权

python 专栏收录该内容

22 篇文章

订阅专栏

本文介绍了Django的Session功能，包括Session的存储引擎，默认的db存储、缓存存储和文件系统存储的配置。重点讲解了SessionMiddleware的工作原理，如何在请求和响应阶段处理Session，以及SessionBase类的角色。内容涵盖了SessionCookieName、SessionBase的load方法以及SessionMiddleware在处理请求和响应时的操作。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Django 对Session完全支持。Django 可以将session 数据存储在服务端，并对cookie 的存取过程完成抽象。注意：cookie中只包含session ID，而不是session数据本身（除非你使用cookie 作为session的后端）。

如果你要使用session功能，则你需要在setting.py文件中配置 中间件。

1. 关于Session存储引擎

默认情况下，session 数据存储在db 中，对应的model 为：django.contrib.sessions.models.Session。

1.1 配置Session 存储到其他位置

（1）将Session存储在缓存中：

如果想获得更好的性能，我们可以将Session保存在缓存中。这里有两种配置方式：一种是设置SESSION_ENGINE 为”django.contrib.sessions.backends.cache” 。 这是一种简单配置，Session将之被保存在缓存中，但是不保证Session总是能取到（比如缓存溢出时Session会丢失）；另一种方式是设置SESSION_ENGINE 为 “django.contrib.sessions.backends.cached_db”。这种方式下，Session在保存到缓存的同时还会被保存到数据库中，当Django在缓存中找不到Session时，会从数据库中找到。第二种方式会有一点点性能开销，但是安全性和冗余性更好。

(2) 将Session存储在文件系统中：

最后一种方式是将Session存储在文件系统中。需要设置SESSION_ENGINE 为”django.contrib.sessions.backends.file”，这时你还需要同时设置SESSION_FILE_PATH 变量，它代表Session文件保存的位置，缺省的设置一般是tempfile.gettempdir()，表示系统的临时目录。这里要确保应用程序对那个目录有读写的权限。

2. SessionMiddleware

SessionMiddleware是Django 默认处理Session 存储的中间件。

通过配置SESSION_COOKIE_NAME 这是cookie端存储的默认名字，如：

SESSION_COOKIE_NAME=MySessionID
curl   -H  "Cookie:MySessionID=XXXXXX"   url

在服务端收到请求后，会从Header 中Cookie中获取key=SESSION_COOKIE_NAME的键，获取其值，然后将这个值作为session ID。

在SessionMiddleware的初始化时，会获取当前配置session引擎，使用存储引擎来加载存储数据。

class SessionMiddleware(MiddlewareMixin):
    def __init__(self, get_response=None):
        self.get_response = get_response
        engine = import_module(settings.SESSION_ENGINE)
        self.SessionStore = engine.SessionStore

上述SessionStore是SessionBase 的子类。

2.1 关于SessionBase

SessionBase是所有Session类的基类。

在SesionBase 执行初始化时，会保存session_key，该key即为浏览器发送过来的session ID

   def __init__(self, session_key=None):
        self._session_key = session_key
        self.accessed = False
        self.modified = False
        self.serializer = import_string(settings.SESSION_SERIALIZER)

SessionBase的子类需要实现父类的方法load 方法，从底层存储引擎中根据session_key获取session的值。

    def load(self):
        """
        Load the session data and return a dictionary.
        """
        raise NotImplementedError('subclasses of SessionBase must provide a load() method')

一般load 的函数的实现原则是：使用SesionBase的_get_or_create_session_key方法判定请求是否携带了session ID，如果没有携带，则生成一个随机的字符串作为session ID。然后，根据该ID，去存储介质中查询，如查询PK=该ID的数据记录，或是去memcache中根据key 查询。

    def _get_or_create_session_key(self):
        if self._session_key is None:
            self._session_key = self._get_new_session_key()
        return self._session_key
   
    def _get_new_session_key(self):
        "Return session key that isn't being used."
        while True:
            session_key = get_random_string(32, VALID_KEY_CHARS)
            if not self.exists(session_key):
                return session_key

2.2 SessionMiddleware处理请求

SessionMiddleware处理请求的过程就是使用配置的存储引擎（SessionStore)来创建session，并将session绑定到此request对象中。

    def process_request(self, request):
        session_key = request.COOKIES.get(settings.SESSION_COOKIE_NAME)
        request.session = self.SessionStore(session_key)

2.3 SessionMiddleware处理响应

在SessionMiddleware处理响应时，如果session是空的，则清除session。否则，在response中设置Cookie，并设置Cookie值属性，如失效时间等。

    def process_response(self, request, response):
        """
        If request.session was modified, or if the configuration is to save the
        session every time, save the changes and set a session cookie or delete
        the session cookie if the session has been emptied.
        """
        try:
            accessed = request.session.accessed
            modified = request.session.modified
            empty = request.session.is_empty()
        except AttributeError:
            pass
        else:
            # First check if we need to delete this cookie.
            # The session should be deleted only if the session is entirely empty
            if settings.SESSION_COOKIE_NAME in request.COOKIES and empty:
                response.delete_cookie(
                    settings.SESSION_COOKIE_NAME,
                    path=settings.SESSION_COOKIE_PATH,
                    domain=settings.SESSION_COOKIE_DOMAIN,
                )
            else:
                if accessed:
                    patch_vary_headers(response, ('Cookie',))
                if (modified or settings.SESSION_SAVE_EVERY_REQUEST) and not empty:
                    if request.session.get_expire_at_browser_close():
                        max_age = None
                        expires = None
                    else:
                        max_age = request.session.get_expiry_age()
                        expires_time = time.time() + max_age
                        expires = http_date(expires_time)
                    # Save the session data and refresh the client cookie.
                    # Skip session save for 500 responses, refs #3881.
                    if response.status_code != 500:
                        try:
                            request.session.save()
                        except UpdateError:
                            raise SuspiciousOperation(
                                "The request's session was deleted before the "
                                "request completed. The user may have logged "
                                "out in a concurrent request, for example."
                            )
                        response.set_cookie(
                            settings.SESSION_COOKIE_NAME,
                            request.session.session_key, max_age=max_age,
                            expires=expires, domain=settings.SESSION_COOKIE_DOMAIN,
                            path=settings.SESSION_COOKIE_PATH,
                            secure=settings.SESSION_COOKIE_SECURE or None,
                            httponly=settings.SESSION_COOKIE_HTTPONLY or None,
                            samesite=settings.SESSION_COOKIE_SAMESITE,
                        )
        return response