Django 頁面快取的cache_key是如何生成的

luozx207發表於2021-03-10
原文網址 : https://www.cnblogs.com/luozx207/p/14512144.html
Django快取

頁面快取

e.g.

@cache_page(time_out, key_prefix=key_prefix)
def my_view():
    ...

預設情況下，將使用配置中的default cache

cache_page裝飾器是由快取中介軟體CacheMiddleware轉換而來的

CacheMiddleware繼承了UpdateCacheMiddleware和 FetchFromCacheMiddleware

UpdateCacheMiddleware繼承自MiddlewareMixin，只重寫了process_response方法，用於在處理完檢視之後將檢視快取起來

class UpdateCacheMiddleware(MiddlewareMixin):
    def process_response(self, request, response):
        """Sets the cache, if needed."""
        ...
        if timeout and response.status_code == 200:
            # 根據請求和響應引數、設定的key_prefix生成頁面快取的key
            cache_key = learn_cache_key(request, response, timeout, self.key_prefix, cache=self.cache)
            self.cache.set(cache_key, response, timeout)
        return response

FetchFromCacheMiddleware繼承自MiddlewareMixin，只重寫了process_request方法，用於獲取當前檢視的快取

# django/middleware/cache.py
class FetchFromCacheMiddleware(MiddlewareMixin):
    def process_request(self, request):
        """
        Checks whether the page is already cached and returns the cached
        version if available.
        """
        # 只對方法為 GET 或 HEAD 的請求獲取快取
        if request.method not in ('GET', 'HEAD'):
            request._cache_update_cache = False
            return None  # Don't bother checking the cache.

        # try and get the cached GET response
        # 這裡會根據請求的資訊、快取鍵字首生成一個cache_key。預設情況下，訪問同一個介面其cache_key應該相同
        cache_key = get_cache_key(request, self.key_prefix, 'GET', cache=self.cache)
        if cache_key is None:
            request._cache_update_cache = True
            return None  # No cache information available, need to rebuild.
        # 如果獲取到response，則直接返回快取的response，那麼實際的檢視就不會被執行
        response = self.cache.get(cache_key)
        # if it wasn't found and we are looking for a HEAD, try looking just for that
        if response is None and request.method == 'HEAD':
            cache_key = get_cache_key(request, self.key_prefix, 'HEAD', cache=self.cache)
            response = self.cache.get(cache_key)

        if response is None:
            # 如果沒有獲取到快取，將返回None，則會執行到實際的檢視，並且重建快取
            request._cache_update_cache = True
            return None  # No cache information available, need to rebuild.

        # hit, return cached response
        request._cache_update_cache = False
        return response

頁面快取的cache_key

​ 這一節將回答兩個問題：

  1. 為什麼在redis中，一個頁面會儲存兩個key：cache_key以及cache_header？

  2. 頁面快取是如何被唯一標識的？當請求頭不同的時候（比如換了一個使用者請求相同的頁面）會使用同一個快取嗎？

​ 我們先從儲存快取檢視過程中的learn_cache_key開始

# django/utils/cache.py
def learn_cache_key(request, response, cache_timeout=None, key_prefix=None, cache=None):
    # 見下文，這個cache_key由 request的完整url 以及 key_prefix 唯一確定
    cache_key = _generate_cache_header_key(key_prefix, request)
    if cache is None:
        # cache 是一個快取例項
        cache = caches[settings.CACHE_MIDDLEWARE_ALIAS]
    # Vary 是一個HTTP響應頭欄位。其內容是一個或多個http頭部名稱
    # 比如 `Vary: User-Agent` 表示此響應根據請求頭 `User-Agent` 的值有所不同
    # 只有當下一個請求的 `User-Agent` 值與當前請求相同時，才會使用當前響應的快取
    if response.has_header('Vary'):
        headerlist = []
        for header in cc_delim_re.split(response['Vary']):
            # 將 Vary 中出現的 http頭部名稱 加到 headerlist 中去
            header = header.upper().replace('-', '_')
            headerlist.append('HTTP_' + header)
        headerlist.sort()
        # 當前 cache_key 實際上是 cache_header_key，它存的是響應頭中Vary欄位的值
        cache.set(cache_key, headerlist, cache_timeout)
        # 這裡返回的才是頁面內容對應的 cache_key，它由 
        # 出現在Vary欄位中的request請求頭欄位的值(有序拼在一起)、request的完整url、request的method、key_prefix 唯一確定
        return _generate_cache_key(request, request.method, headerlist, key_prefix)
    else:
        # if there is no Vary header, we still need a cache key
        # for the request.build_absolute_uri()
        cache.set(cache_key, [], cache_timeout)
        return _generate_cache_key(request, request.method, [], key_prefix)

def _generate_cache_header_key(key_prefix, request):
    """Returns a cache key for the header cache."""
    # request.build_absolute_uri()返回的是完整的請求URL。如 http://127.0.0.1:8000/api/leaflet/filterList?a=1
    # 因此，請求同一個介面，但是介面引數不同，會生成兩個cache_key
    url = hashlib.md5(force_bytes(iri_to_uri(request.build_absolute_uri())))
    cache_key = 'views.decorators.cache.cache_header.%s.%s' % (
        key_prefix, url.hexdigest())
    return _i18n_cache_key_suffix(request, cache_key)

def _generate_cache_key(request, method, headerlist, key_prefix):
    """Returns a cache key from the headers given in the header list."""
    ctx = hashlib.md5()
    # headerlist是響應頭中Vary欄位的值
    for header in headerlist:
        # 出現在Vary欄位中的request請求頭欄位的值
        value = request.META.get(header)
        if value is not None:
            ctx.update(force_bytes(value))
    url = hashlib.md5(force_bytes(iri_to_uri(request.build_absolute_uri())))
    cache_key = 'views.decorators.cache.cache_page.%s.%s.%s.%s' % (
        key_prefix, method, url.hexdigest(), ctx.hexdigest())
    return _i18n_cache_key_suffix(request, cache_key)

​ 再看獲取快取的get_cache_key方法

def get_cache_key(request, key_prefix=None, method='GET', cache=None):
    # 由 request的完整url 以及 key_prefix 生成 cache_header_key
    cache_key = _generate_cache_header_key(key_prefix, request)
    # headerlist是之前快取的 與當前請求具有相同cache_header_key 的請求的響應的響應頭中Vary欄位的值
    headerlist = cache.get(cache_key)
    # 即使響應頭沒有Vary欄位，還是會針對當前 cache_header_key 存一個空陣列
    # 因此如果headerlist為None，表示當前請求沒有快取
    if headerlist is not None:
        # 根據 出現在Vary欄位中的request請求頭欄位的值(有序拼在一起)、request的完整url、request的method、key_prefix 生成 cache_key
        return _generate_cache_key(request, method, headerlist, key_prefix)
    else:
        return None

​ 綜上所述：

  • cache_header中存的是響應頭Vary欄位的值，cache_key存的是快取檢視

  • cache_key由 出現在Vary欄位中的request請求頭欄位的值(有序拼在一起)、request的完整url、request的method、key_prefix 唯一確定

  • 當請求頭不同的時候，有可能會使用同一個快取，這取決於不同的請求頭欄位名是否出現在響應頭Vary欄位中。比如，如果響應頭中有Vary: User-Agent，那麼 User-Agent 不同的兩個請求必然生成不同的 cache_key，因此就不會使用同一個快取。但如果只是在請求頭加一個 cache-control: no-cache （瀏覽器提供的Disable cache功能），訪問同樣的url，那還是會命中之前的快取的

相關文章