FastAPI 学习 - Redis使用

  • 在配置redis的时候遇到了一个神奇的问题
    在同一个请求中 使用redis可以set和get内容
    另一个请求中却不能get到之前set的内容

1. 注册redis到app

参考了别人的项目和redis的官方文档, 在app启动的时候增加了redis的注册

from redis import asyncio

@app.on_event("startup")
async def startup_event():
    app.redis = await asyncio.from_url(REDIS_URL, decode_responses=True, encoding="utf8", )

然后在后续的项目中通过request.app.redis.get/set 来插入和获得内容

2. 增加通用工具方法

在工具类中增加了set_cache 和 get_cache del_cache

import json

from datetime import timedelta

from fastapi import Request


async def set_cache(key: str, value, request: Request, ex: timedelta = None) -> bool:
   if not all((key, value)):
       return False

   params = {'name': 'blog.cache.' + key, 'value': value}
   if ex:
       params['ex'] = ex

   if isinstance(value, int | float | str):
       return await request.app.redis.set(**params)
   else:
       try:
           params['value'] = json.dumps(value)
           return await request.app.redis.set(**params)
       except json.JSONDecodeError:
           return False


async def get_cache(key: str, request: Request) -> str:
   return await request.app.redis.get('blog.cache.' + key)


async def del_cache(key: str, request: Request) -> str:
   return await request.app.redis.delete('blog.cache.' + key)

可是在后续的使用过程中发现每次需要调用缓存的时候必须要传入request, 也就是必须从接口进入, 非常的不优雅

于是发现redis是注册在request.app中, 于是直接引用app, 尝试使用app.redis.get/set/delete, 发现是有效的, 只是我目前的项目代码结构会导致循环引用的问题, 于是优化了项目的代码结构

3. 改为直接使用app.redis.get/set

现在就方便很多了, 在其他地方使用的时候也不需要注意传递request

import json

from datetime import timedelta

from config.init_blog import app


async def set_cache(key: str, value, ex: timedelta = None) -> bool:
    if not all((key, value)):
        return False

    params = {'name': 'blog.cache.' + key, 'value': value}
    if ex:
        params['ex'] = ex

    if isinstance(value, int | float | str):
        return await app.redis.set(**params)
    else:
        try:
            params['value'] = json.dumps(value)
            return await app.redis.set(**params)
        except json.JSONDecodeError:
            return False


async def get_cache(key: str) -> str:
    return await app.redis.get('blog.cache.' + key)


async def del_cache(key: str) -> str:
    return await app.redis.delete('blog.cache.' + key)

4. 优化项目文件结构

之前我的init_blog 文件中的 create_app方法不仅创建了FastAPI的app, 还做了静态文件目录挂载, 允许访问的源配置, CORS中间件的配置, pg数据库注册, redis数据库注册, 模块路由的注册

在这里面做了很多创建app以外的事情, 这样非常的不优雅, 而且路由注册会引入其他模块的文件, 导致通用工具包在引入全局app的时候出现循环引用

于是把这个方法进行了拆分, create_app的时候只做app相关的配置(静态文件目录挂载, 允许访问的源配置, CORS中间件的配置), 其他的注册放到其他文件中, 这里建议把路由注册的方法放在一个独立的文件里, 因为这个方法需要导入所有的模块的router, 跟其他方法放在一起很容易出现循环引用

5. 添加几个测试api

我在common模块下的api文件里面都是用来测试的, 所以我就直接加到里面

@router.get('/redis/get/{key}')
async def test_redis_get(key: str):
    return await get_cache(key)


@router.get('/redis/set/{key}')
async def test_redis_set(key: str, value: str):
    await set_cache(key, value)
    return await get_cache(key)

然后进入到swagger里面进行测试
这里简书一直上传图片失败, 所以就不放图片了, 大家可以自己测试


后续如果有遇到其他问题 我会继续更新
欢迎关注此代码仓库, 如果觉得有用请给我一个🌟

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,188评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,464评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,562评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,893评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,917评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,708评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,430评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,342评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,801评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,976评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,115评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,804评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,458评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,008评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,135评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,365评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,055评论 2 355

推荐阅读更多精彩内容