Django（39）使用redis配置快取

Silent丿丶黑羽發表於2021-06-01
DjangoRedis快取

前言

  動態網站的基本權衡是，它們是動態的。每次使用者請求頁面時，Web伺服器都會進行各種計算 - 從資料庫查詢到模板呈現再到業務邏輯 - 以建立站點訪問者看到的頁面。從處理開銷的角度來看，這比標準的檔案讀取檔案系統伺服器要耗時多了。對於大多數Web應用程式來說，這種開銷並不是什麼大問題。因為大多數Web應用程式只是中小型網站，沒有擁有一流的流量。但對於中到高流量的站點，儘可能減少開銷是至關重要的，這就是快取的用武之地。快取某些內容是為了儲存昂貴計算的結果，這樣就不必在下次執行計算。
  Django框架帶有一個強大的快取系統，可以儲存動態頁面，因此不必為每個請求計算它們。Django提供不同級別的快取粒度：可以快取特定檢視的輸出，也可以只快取頁面中難以生成的部分或者可以快取整個站點。
  Redis是一個記憶體資料庫（現在已經支援記憶體資料持久化到硬碟當中，重新啟動時，會自動從硬碟進行載入），由於其效能極高，因此經常作為中介軟體、快取使用。
 

django應用redis快取

django中安裝第三方庫，使用如下命令

pip3 install django-redis

1.settings配置

首先，我們在settings.py中配置如下程式碼

CACHES = {
    # default 是快取名，可以配置多個快取
    "default": {
        # 應用 django-redis 庫的 RedisCache 快取類
        "BACKEND": "django_redis.cache.RedisCache",
        # 配置正確的 ip和port
        "LOCATION": "redis://127.0.0.1:6379",
        "OPTIONS": {
            # redis客戶端類
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
            # redis連線池的關鍵字引數
            "CONNECTION_POOL_KWARGS": {
                "max_connections": 100
            }
            # 如果 redis 設定了密碼，那麼這裡需要設定對應的密碼，如果redis沒有設定密碼，那麼這裡也不設定
            # "PASSWORD": "123456",
        }
    }
}

 

2.全站快取

2.1 全站快取的2箇中介軟體

  • FetchFromCacheMiddleware ：從快取中讀取資料
    • 快取狀態為200的GET和HEAD請求的響應（除非響應頭中設定不進行快取）
    • 對具有不同查詢引數的相同URL的請求的響應被認為是各自不同的頁面，並且被分別單獨快取。
    • 該中介軟體會使用與對應的GET請求相同的響應頭來回答HEAD請求，即可以為HEAD請求返回快取的GET響應。
  • UpdateCacheMiddleware ：將資料更新到快取中
    • 該中介軟體會自動在每個響應中設定幾個headers：
      • 設定Expires為當前日期/時間 加上 定義的CACHE_MIDDLEWARE_SECONDS值，GMT時間
      • 設定響應的Cache-Control的max-age，值是定義的CACHE_MIDDLEWARE_SECONDS值。
    • 如果檢視設定了自己的快取時間（即設定了Cache-Control 的max age），那麼頁面將被快取直到到期時間，而不是CACHE_MIDDLEWARE_SECONDS。
    • 如果USE_I18N設定為True，則生成的快取key將包含當前語言的名稱，這樣可以輕鬆快取多語言網站，而無需自己建立快取金鑰。
    • 如果 USE_L10N設定為True 並且 USE_TZ被設定為True，快取key也會包括當前語言

在settings的中介軟體中設定：

MIDDLEWARE = [
    'django.middleware.cache.UpdateCacheMiddleware',
    # 其他中介軟體...
    'django.middleware.cache.FetchFromCacheMiddleware',
]

注意：UpdateCacheMiddleware必須是第一個中介軟體，FetchFromCacheMiddleware必須是最後一箇中介軟體
 

2.2 全站快取的必填設定

將以下必須設定新增到Django的settings檔案中

CACHE_MIDDLEWARE_ALIAS = 'default'
CACHE_MIDDLEWARE_SECONDS = 60*60
CACHE_MIDDLEWARE_KEY_PREFIX = "cache_redis_demo_first"

配置解釋如下：

  • CACHE_MIDDLEWARE_ALIAS：用於儲存的快取別名
  • CACHE_MIDDLEWARE_SECONDS：每個頁面應快取的秒數
  • CACHE_MIDDLEWARE_KEY_PREFIX：用於生成快取key的字首，如果使用相同的Django安裝在多個站點之間共享快取，請將其設定為站點名稱或此Django例項特有的其他字串，以防止發生金鑰衝突。如果你不在乎，請使用空字串。
     

2.3 全站快取示例

接著我們在檢視中寫入如下函式：

def index(request):
    # 通過設定時間戳，進行多次訪問，可以看到時間戳的變化，就可以得知是否是快取頁面了
    return HttpResponse('當前時間戳：' + str(time.time()))

我們開啟瀏覽器訪問127.0.0.1/redis/，多次訪問該url，發現時間戳不會改變，這是因為我們在配置中設定了快取時間為1個小時。
我們可以開啟瀏覽器的網路請求中檢視response header，檢視max_age和Expires，如下圖

我們會發現響應頭中已經有了快取的時間，說明我們快取配置成功了
 

3.檢視函式快取

  一般情況下，我們不會使用全域性快取，因為全域性快取，只要伺服器返回狀態碼是200，他都會將其快取下來，這樣會影響效能，所以我們一般都會使用檢視快取，針對某個檢視，需要進行快取，則使用快取。
 

3.1通過裝飾器cache_page

from django.views.decorators.cache import never_cache, cache_page
@cache_page(20)
def view_cache(request, num):
    return HttpResponse(f"num：{num},時間戳：{time.time()}")
  • cache_page除了預設的timeout引數外，還有兩個可選的關鍵字引數
    • cache，示例程式碼：@cache_page(60 * 15, cache="special_cache")， 該cache指向settings中配置的快取的名稱，預設是"default"
    • key_prefix：快取key的字首，與CACHE_MIDDLEWARE_KEY_PREFIX功能相同
  • 如果多個url指向同一個檢視函式，會為每個url建立一個單獨的快取，例如：
urlpatterns = [
    path('view_cache/<int:num>/', views.view_cache, name="view_cache")
]

/view_cache/1/和/view_cache/2/請求會分別進行快取
 

3.2通過urls中配置cache_page

在URLconf中指定檢視快取，而不是在檢視函式上硬編碼裝飾器，可以進一步解耦快取和檢視函式之間的關係，使用起來更靈活

from django.views.decorators.cache import cache_page
 
urlpatterns = [
    path('view_cache/<int:num>/', cache_page(20)(views.view_cache), name="view_cache")
]

以上2種方式作用是一樣的，這裡我們更加推薦3.2這種寫法
 

4.低階快取

  有時我們不想快取整個頁面資料，而只是想快取某些費時查詢並且基本不會改變的資料，可以通過一個簡單的低階快取API實現，該API可以快取任何可以安全pickle的Python物件：字串，字典，模型物件列表等
 

django.core.cache.caches

from django.core.cache import caches
cache1 = caches['myalias']
cache2 = caches['myalias']
# 判斷為True
if cache1 is cache2: 
    ...

說明：

  • 可以通過CACHES類似字典一樣的方式訪問settings中配置的快取，在同一個執行緒中重複請求相同的別名將返回相同的物件
  • 如果指定的myalias不存在，將引發 InvalidCacheBackendError
  • 為了執行緒安全性，為會每個執行緒返回快取的不同例項
  • 作為快捷方式， 預設快取(default)可以使用 django.core.cache.cache ：
# 使用 default 快取
from django.core.cache import cache

# 上面的cache等同於下面的寫法
from django.core.cache import caches
cache = caches['default']

 

django.core.cache.cache

from django.core.cache import cache

# 使用 redis 的一般用法
cache.set('manul_set', 'ok')
manul_set = cache.get('manul_set')

# 可以手動設定 timeout，如果不指定timeout，預設是 300秒，如果指定為None，則代表沒有過期時間
cache.set("key", "value", timeout=None)

# 可以獲取key的超時設定（ttl：time to live）
# 返回值的3種情況：
# 0： key 不存在 (或已過期)
# None： key 存在但沒有設定過期
# ttl： 任何有超時設定的 key 的超時值
cache.set("foo", "value", timeout=25)
cache.ttl("foo") # 得到 25 
cache.ttl("not-existent") # 得到 0

# 讓一個值永久存在
cache.persist("foo")
cache.ttl("foo") # 得到 None

# 指定一個新的過期時間
cache.set("foo", "bar", timeout=22)
cache.ttl("foo") # 得到 22
cache.expire("foo", timeout=5)
cache.ttl("foo") # 得到 5

# 支援 redis 分散式鎖， 使用 上下文管理器 分配鎖
with cache.lock("somekey"):
    do_some_thing()
    
# 使用全域性萬用字元的方式來檢索或者刪除鍵
cache.keys("foo_*")  # 返回所有匹配的值, 如 ["foo_1", "foo_2"]


# 刪除 鍵
cache.delete_pattern("foo_*")  # 支援萬用字元

 

實戰案例

首先建立個common資料夾，然後在資料夾下面建立cache_helper.py檔案，寫入如下程式碼

from django.core.cache import cache


def get_cache_or_exc_func(key, func, *args, **kwargs):
    """
    根據傳入的key和func，先獲取快取內容，沒有則使用func計算並儲存結果
    :param key: 快取的key
    :param func: 計算函式
    :param args: 可變引數
    :param kwargs: 可變字典
    :return: 快取的n內容或func計算的結果
    """
    # 加上cache鎖
    with cache.lock(key+'lock'):
        # 獲取快取中的變數
        result = cache.get(key)
        if result:
            # 存在，則直接返回快取結果
            return result
        else:
            # 不存在，則計算資料，得到結果
            result = func(*args, **kwargs)
            # 將結果儲存到快取中
            cache.set(key, result)
            # 返回結果
            return result

然後配置url路徑，如下

urlpatterns = [
    path('lower_level_cache/', views.lower_level_cache, name="lower_level_cache"),
]

最後在檢視中，寫入2個函式

def get_result():
    """做一些費時但不經常變更的操作，這裡模擬等待3秒"""
    time.sleep(3)
    return 'ok'


def lower_level_cache(request):
    result = get_cache_or_exc_func('test_key', get_result)
    return JsonResponse({"result": result})

現在我們開啟瀏覽器，訪問127.0.0.1/redis/low_level_cache/，我們會發現，瀏覽器不會馬上響應，而是等待了3秒，因為我們程式碼中模擬等待了3秒，而且我們是第一次訪問，沒有快取，當第二次訪問時，就立馬響應了，原因是此時已經有了快取
 

5.session快取

在settings.py檔案中，配置如下程式碼即可

# 配置session的引擎為cache
SESSION_ENGINE = 'django.contrib.sessions.backends.cache'
# 此處別名依賴快取的設定
SESSION_CACHE_ALIAS = 'default'

相關文章