python自帶快取lru_cache用法及擴充套件(詳細)
阿新 • • 發佈：2020-12-08
本篇部落格將結合[python官方文件](https://docs.python.org/zh-cn/3/library/functools.html#functools.update_wrapper)和原始碼詳細講述lru_cache快取方法是怎麼實現， 它與redis快取的區別是什麼， 在使用時碰上functiontools.wrap裝飾器時會發生怎樣的變化，以及瞭解它給我們提供了哪些功能然後在其基礎上實現我們自制的快取方法my_cache。
********************************
[toc]
### 1. lru_cache的使用
#### 1.1 引數詳解
以下是lru_cache方法的實現，我們看出可供我們傳入的引數有2個maxsize和typed，如果不傳則maxsize的預設值為128，typed的預設值為False。其中maxsize引數表示是的被裝飾的方法最大可快取結果數量， 如果是預設值128則表示被裝飾方法最多可快取128個返回結果，如果maxsize傳入為None則表示可以快取無限個結果，你可能會疑惑被裝飾方法的n個結果是怎麼來的，打個比方被裝飾的方法為```def add(a, b):```當函式被lru_cache裝飾時，我們呼叫add(1, 2)和add(3, 4)將會快取不同的結果。如果 *typed* 設定為true，不同型別的函式引數將被分別快取。例如， `f(3)` 和 `f(3.0)` 將被視為不同而分別快取。
```python
def lru_cache(maxsize=128, typed=False):
if isinstance(maxsize, int):
if maxsize < 0:
maxsize = 0
elif maxsize is not None:
raise TypeError('Expected maxsize to be an integer or None')
def decorating_function(user_function):
wrapper = _lru_cache_wrapper(user_function, maxsize, typed, _CacheInfo)
return update_wrapper(wrapper, user_function)
return decorating_function
```
#### 1.2 基本用法
在我們編寫介面時可能需要快取一些變動不大的資料如配置資訊，我們可能編寫如下介面：
```python
@api.route("/user/info", methods=["GET"])
@functools.lru_cache()
@login_require
def get_userinfo_list():
userinfos = UserInfo.query.all()
userinfo_list = [user.to_dict() for user in userinfos]
return jsonify(userinfo_list)
```
我們快取了從資料庫查詢的使用者資訊，下次再呼叫這個介面時將直接返回使用者資訊列表而不需要重新執行一遍資料庫查詢邏輯，可以有效較少IO次數，加快介面反應速度。
#### 1.3 進階用法
還是以上面的例子，如果發生使用者的刪除或者新增時，我們再請求使用者介面時仍然返回的是快取中的資料，這樣返回的資訊就和我們資料庫中的資料就會存在差異，所以當發生使用者新增或者刪除時，我們需要清除原先的快取，然後再請求使用者介面時可以重新載入快取。
```python
@api.route("/user/info", methods=["POST"])
@functools.lru_cache()
@login_require
def add_user():
user = UserInfo(name="李四")
db.session.add(user)
db.session.commit()
# 清除get_userinfo_list中的快取
get_userinfo_list = current_app.view_functions["api.get_machine_list"]
cache_info = get_userinfo_list.cache_info()
# cache_info 具名元組，包含命中次數 hits，未命中次數 misses ，最大快取數量 maxsize 和 當前快取大小 currsize
# 如果快取數量大於0則清除快取
if cache_info[3] > 0:
get_userinfo_list.cache_clear()
return jsonify("新增使用者成功")
```
在上面這個用法中我們，如果我們把lru_cache裝飾器和login_require裝飾器調換位置時，上述的寫法將會報錯，這是因為login_require裝飾器中用了functiontools.wrap模組進行裝飾導致的，具原因我們在下節解釋， 如果想不報錯得修改成如下寫法。
```python
@api.route("/user/info", methods=["POST"])
@login_require
@functools.lru_cache()
def add_user():
user = UserInfo(name="李四")
db.session.add(user)
db.session.commit()
# 清除get_userinfo_list中的快取
get_userinfo_list = current_app.view_functions["api.get_machine_list"]
cache_info = get_userinfo_list.__wrapped__.cache_info()
# cache_info 具名元組，包含命中次數 hits，未命中次數 misses ，最大快取數量 maxsize 和 當前快取大小 currsize
# 如果快取數量大於0則清除快取
if cache_info[3] >