Fastapi教程：使用aioredis异步访问redis

本文将介绍如何使用 FastAPI 异步访问 Redis，包括环境配置、连接创建、数据库初始化、增删查改操作、键过期、管道（pipeline）操作以及事务管理等内容。

环境准备

首先，我们需要安装必要的依赖包。Redis 是一个键值存储系统，而 aioredis 是一个支持异步访问 Redis 的 Python 客户端库。你可以使用以下命令安装 FastAPI、Uvicorn 和 aioredis：

pip install fastapi
pip install uvicorn
pip install aioredis

在安装完成后，我们就可以开始编写代码了。

1. 配置 Redis 连接

首先，确保你已经安装并启动了 Redis 服务。可以通过以下命令启动 Redis：

redis-server

然后，我们创建一个 Redis 连接。为了支持异步操作，我们使用 aioredis 包。

import aioredis# 配置 Redis 连接
REDIS_URL = "redis://localhost:6379"# 创建 Redis 连接
async def get_redis_connection():redis = await aioredis.from_url(REDIS_URL, encoding="utf-8", decode_responses=True)return redis

我们通过 aioredis.from_url 方法创建了一个 Redis 连接，它允许我们直接从指定的 Redis 服务 URL 中连接 Redis 服务器，并且设置编码和解码格式为 UTF-8，以便处理字符串数据。

2. FastAPI 实例化和数据库初始化

在 FastAPI 中，我们使用 Depends 依赖注入机制来获取 Redis 连接。通过 on_startup 事件，我们可以在 FastAPI 启动时进行一些初始化操作，如测试 Redis 连接。

from fastapi import FastAPI, Dependsapp = FastAPI()# 获取 Redis 连接
async def get_db():redis = await get_redis_connection()try:yield redisfinally:await redis.close()# 在应用启动时初始化 Redis 连接
@app.on_event("startup")
async def on_startup():redis = await get_redis_connection()print("Redis connection initialized")await redis.close()

3. 数据库的增删查改操作（CRUD）

我们现在将实现一些常见的 Redis 操作，如增、删、查、改。

创建/设置数据

我们使用 Redis 的 set 命令来设置键值对。为了简化操作，我们将设置数据的函数定义为一个 POST 请求：

from fastapi import HTTPException@app.post("/set/{key}/{value}")
async def set_key(key: str, value: str, redis: aioredis.Redis = Depends(get_db)):try:await redis.set(key, value)  # 设置键值对return {"message": "Key set successfully"}except Exception as e:raise HTTPException(status_code=500, detail=str(e))
  • await redis.set(key, value)：在 Redis 中设置键值对。

获取数据

我们使用 Redis 的 get 命令来获取数据。通过 GET 请求来查询某个键的值：

@app.get("/get/{key}")
async def get_key(key: str, redis: aioredis.Redis = Depends(get_db)):value = await redis.get(key)  # 获取键对应的值if value is None:raise HTTPException(status_code=404, detail="Key not found")return {"key": key, "value": value}
  • await redis.get(key)：获取指定键的值，如果键不存在，则返回 None。

更新数据

Redis 是一个键值存储系统，我们可以通过 set 命令更新已经存在的键值对。如果键存在，值将被更新；如果不存在，则会创建新的键值对。

@app.put("/update/{key}/{value}")
async def update_key(key: str, value: str, redis: aioredis.Redis = Depends(get_db)):exists = await redis.exists(key)if not exists:raise HTTPException(status_code=404, detail="Key not found")await redis.set(key, value)  # 更新键值对return {"message": "Key updated successfully"}
  • await redis.exists(key)：检查键是否存在。

删除数据

我们使用 Redis 的 delete 命令删除指定的键：

@app.delete("/delete/{key}")
async def delete_key(key: str, redis: aioredis.Redis = Depends(get_db)):result = await redis.delete(key)  # 删除指定键if result == 0:raise HTTPException(status_code=404, detail="Key not found")return {"message": "Key deleted successfully"}
  • await redis.delete(key)：删除指定的键，返回删除的键数量。

4. 设置键的过期时间

Redis 提供了 expire 命令来设置键的过期时间。通过 EX 参数，我们可以设置键的过期时间为秒数，或者通过 PX 设置毫秒。

@app.post("/set_with_expiration/{key}/{value}/{expiration}")
async def set_key_with_expiration(key: str, value: str, expiration: int, redis: aioredis.Redis = Depends(get_db)):await redis.set(key, value, ex=expiration)  # 设置过期时间return {"message": f"Key will expire in {expiration} seconds"}
  • ex=expiration：设置键的过期时间为 expiration 秒。

5. 使用管道（Pipeline）

Redis 提供了管道（Pipeline）功能，可以将多个命令打包成一个批量请求发送，提高性能。以下是一个使用管道操作多个键值的示例：

@app.post("/set_multiple/{key}/{value}")
async def set_multiple_keys(key: str, value: str, redis: aioredis.Redis = Depends(get_db)):async with redis.pipeline() as pipe:for i in range(1, 6):await pipe.set(f"{key}_{i}", f"{value}_{i}")await pipe.execute()  # 执行管道中的所有命令return {"message": "Multiple keys set successfully"}
  • async with redis.pipeline()：创建一个 Redis 管道。
  • await pipe.set(f"{key}_{i}", f"{value}_{i}")：向管道中添加多个设置命令。
  • await pipe.execute()：执行管道中的所有命令。

6. Redis 事务管理

Redis 本身支持事务机制。通过管道，我们可以执行事务。管道可以保证所有命令一起执行，要么全部成功，要么全部失败。

@app.post("/transaction/{key}/{value}")
async def redis_transaction(key: str, value: str, redis: aioredis.Redis = Depends(get_db)):async with redis.pipeline() as pipe:await pipe.set(key, value)await pipe.expire(key, 60)  # 设置过期时间为60秒await pipe.execute()  # 执行所有命令return {"message": "Transaction executed successfully"}
  • async with redis.pipeline()：开始一个事务。
  • await pipe.set(key, value)：设置键值对。
  • await pipe.expire(key, 60)：设置键的过期时间。
  • await pipe.execute()：执行事务。

完整代码示例

from fastapi import FastAPI, HTTPException, Depends
import aioredisapp = FastAPI()REDIS_URL = "redis://localhost:6379"# 获取 Redis 连接
async def get_db():redis = await aioredis.from_url(REDIS_URL, encoding="utf-8", decode_responses=True)try:yield redisfinally:await redis.close()# 初始化 Redis 连接
@app.on_event("startup")
async def on_startup():redis = await get_db()print("Redis connection initialized")await redis.close()# 设置数据
@app.post("/set/{key}/{value}")
async def set_key(key: str, value: str, redis: aioredis.Redis = Depends(get_db)):await redis.set(key, value)return {"message": "Key set successfully"}# 获取数据
@app.get("/get/{key}")
async def get_key(key: str, redis: aioredis.Redis = Depends(get_db)):value = await redis.get(key)if value is None:raise HTTPException(status_code=404, detail="Key not found")return {"key": key, "value": value}# 更新数据
@app.put("/update/{key}/{value}")
async def update_key(key: str, value: str, redis: aioredis.Redis = Depends(get_db)):exists = await redis.exists(key)if not exists:raise HTTPException(status_code=404, detail="Key not found")await redis.set(key, value)return {"message": "Key updated successfully"}# 删除数据
@app.delete("/delete/{key}")
async def delete_key(key: str, redis: aioredis.Redis = Depends(get_db)):result = await redis.delete(key)if result == 0:raise HTTPException(status_code=404, detail="Key not found")return {"message": "Key deleted successfully"}# 设置过期时间
@app.post("/set_with_expiration/{key}/{value}/{expiration}")
async def set_key_with_expiration(key: str, value: str, expiration: int, redis: aioredis.Redis = Depends(get_db)):await redis.set(key, value, ex=expiration)return {"message": f"Key will expire in {expiration} seconds"}# 使用管道操作
@app.post("/set_multiple/{key}/{value}")
async def set_multiple_keys(key: str, value: str, redis: aioredis.Redis = Depends(get_db)):async with redis.pipeline() as pipe:for i in range(1, 6):await pipe.set(f"{key}_{i}", f"{value}_{i}")await pipe.execute()return {"message": "Multiple keys set successfully"}# Redis 事务
@app.post("/transaction/{key}/{value}")
async def redis_transaction(key: str, value: str, redis: aioredis.Redis = Depends(get_db)):async with redis.pipeline() as pipe:await pipe.set(key, value)await pipe.expire(key, 60)await pipe.execute()return {"message": "Transaction executed successfully"}

总结

本文详细介绍了如何在 FastAPI 中使用异步方式访问 Redis，包括 Redis 连接的创建、数据的增删查改、键过期、使用管道操作和事务管理等内容。通过使用 aioredis 库，结合 FastAPI 提供的异步支持，可以高效地处理缓存数据，提升系统性能。希望本文对你在项目中使用 Redis 提供了帮助。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/bicheng/63712.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

duxapp 2024-12-09 更新 PullView可以弹出到中间，优化CLI使用体验

duxapp 2024-12-09 更新 PullView可以弹出到中间，优化CLI使用体验

UI库 修复 Button 禁用状态失效的问题Modal 组件即将停用，请使用 PullView 基础库 PullView side 新增 center 指定弹出到屏幕中间PullView 新增 duration 属性，指定动画时长新增 useBackHandler hook 用来阻止安卓端点击返回键 RN端 修复 windows …
阅读更多...
多线程与线程互斥

多线程与线程互斥

目录 引言 一、多线程设计 多线程模拟抢票 二、互斥锁 互斥量的接口 修改抢票代码 锁的原理 锁的封装：RAII 引言 随着信息技术的飞速发展，计算机软件正变得越来越复杂，对性能和响应速度的要求也日益提高。在这样的背景下，…
阅读更多...
Vue导出报表功能【动态表头+动态列】

Vue导出报表功能【动态表头+动态列】

安装依赖包 npm install -S file-saver npm install -S xlsx npm install -D script-loader创建export-excel.vue组件 代码内容如下&#xff08;以element-ui样式代码示例&#xff09;&#xff1a; <template><el-button type"primary" click"Expor…
阅读更多...
ZUC256 Go Go Go！！！

ZUC256 Go Go Go！！！

文章目录 背景运行效果代码 背景 因业务需要使用ZUC算法&#xff0c;GitHub上又没有对ZUC256相对应的Go语言的实现。 吃水不忘挖井人&#xff0c;在这里感谢GmSSL及BouncyCastle两个强大的密码学库&#xff01; 本ZUC256的编写&#xff0c;参考了这两个库及中科院软件院发布的…
阅读更多...
力扣打卡12：复原IP地址

力扣打卡12：复原IP地址

链接&#xff1a;93. 复原 IP 地址 - 力扣&#xff08;LeetCode&#xff09; 这道题需要对字符串进行操作&#xff0c;我选择了三层循环&#xff0c;其实还可以递归。 我在循环时进行了剪枝&#xff0c;比如一些情况直接跳出循环。 我的代码&#xff1a; class Solution { p…
阅读更多...
The ‘.git/hooks/pre-push‘ hook was ignored because it‘s not set as executable.

The ‘.git/hooks/pre-push‘ hook was ignored because it‘s not set as executable.

Mac上使用Git提交代码提示&#xff1a; hint: The .git/hooks/prepare-commit-msg hook was ignored because its not set as executable. hint: You can disable this warning with git config advice.ignoredHook false. hint: The .git/hooks/commit-msg hook was ignored b…
阅读更多...
【实践·专业课】内存管理-存储管理-文件系统

【实践·专业课】内存管理-存储管理-文件系统

1. 基于Linux的简单区块链实现 1.1. 环境准备 确保使用的 Linux 系统&#xff08;如 Ubuntu、CentOS 等&#xff09;已安装 Python 3。 在终端输入python3命令&#xff0c;若出现 Python 解释器的版本信息等提示&#xff0c;则表示已安装&#xff1b; 若提示未找到命令&…
阅读更多...
MySQL 学习 之 批量插入数据性能问题

MySQL 学习 之 批量插入数据性能问题

文章目录 现象优化 现象 在使用 kettle 同步大数据的数据到我们的 MySQL 数据库中时发现&#xff0c;数据量大时插入效率很慢&#xff0c;大约在 2000/s 优化 在 MySQL 驱动连接中添加 rewriteBatchedStatementstrue 参数&#xff0c;减少 网络 IO DB IO 耗时 默认关闭指定…
阅读更多...
2个GitHub上最近比较火的Java开源项目

2个GitHub上最近比较火的Java开源项目

1. SpringBlade 微服务架构 标题 SpringBlade 微服务架构 摘要 SpringBlade 是一个由商业级项目升级优化而来的微服务架构&#xff0c;采用Spring Boot 3.2、Spring Cloud 2023等核心技术构建&#xff0c;遵循阿里巴巴编码规范&#xff0c;提供基于React和Vue的两个前端框架&am…
阅读更多...
MongoDB 建模调优change stream实战

MongoDB 建模调优change stream实战

MongoDB开发规范 &#xff08;1&#xff09;命名原则。数据库、集合命名需要简单易懂&#xff0c;数据库名使用小写字符&#xff0c;集合名称使用统一命名风格&#xff0c;可以统一大小写或使用驼峰式命名。数据库名和集合名称均不能超过64个字符。 &#xff08;2&#xff09…
阅读更多...
Ubuntu 环境美化

Ubuntu 环境美化

一、终端选择 zsh 参考文章使用 oh-my-zsh 美化终端 Oh My Zsh 是基于 zsh 命令行的一个扩展工具集&#xff0c;提供了丰富的扩展功能。 先安装zsh再安装Oh My Zsh 1.zsh安装 sudo apt-get install zsh 2.设置默认终端为 zsh chsh -s /bin/zsh 3.安装 oh-my-zsh 官网&…
阅读更多...
MySQL 在线 DDL 变更的一个异常问题

MySQL 在线 DDL 变更的一个异常问题

文章目录 前言1. 模拟现场2. 原因推测3. 如何解决4. 误导报错后记 前言 业务执行一条 DDL engineinnodb 失败了很多次&#xff0c;报错 ERROR 1062 (23000): Duplicate entry xxx for key ‘xxx’&#xff0c;在官方文档中也提到过&#xff0c;Online DDL 期间可能会出现 ERRO…
阅读更多...
分布式事务的前世今生-纯理论

分布式事务的前世今生-纯理论

一个可用的复杂的系统总是从可用的简单系统进化而来。反过来这句话也正确: 从零开始设计的复杂的系统从来都用不了&#xff0c;也没办法让它变的可用。 --John Gal 《系统学》 1975 1. 事务的概念 百科&#xff1a; 事务&#xff08;Transaction&#xff09;&#xff0c;一般是…
阅读更多...
微前端框架micro-app中的数据通信机制

微前端框架micro-app中的数据通信机制

在微前端框架micro-app中&#xff0c;getData方法和addDataListener方法都是用于数据通信的重要工具&#xff0c;但它们在使用方式和功能上存在一些显著的差别。 getData方法 功能&#xff1a;getData方法用于直接获取micro-app框架注入的全局对象window.microApp中存储的数据…
阅读更多...
操作系统的文件系统

操作系统的文件系统

文件系统的基本组成 ⽂件系统是操作系统中负责管理持久数据的⼦系统&#xff0c;说简单点&#xff0c;就是负责把⽤户的⽂件存到磁盘硬件中&#xff0c; 因为即使计算机断电了&#xff0c;磁盘⾥的数据并不会丢失&#xff0c;所以可以持久化的保存⽂件。 ⽂件系统的基本数据单位…
阅读更多...
vue使用百度富文本编辑器

vue使用百度富文本编辑器

1、安装 npm add vue-ueditor-wrap 或者 pnpm add vue-ueditor-wrap 进行安装 2、下载UEditor 官网&#xff1a;ueditor:rich text 富文本编辑器 - GitCode 整理好的&#xff1a;vue-ueditor: 百度编辑器JSP版 因为官方的我没用来&#xff0c;所以我自己找的另外的包…
阅读更多...
浅谈自然语言处理技术（NLP）在银行领域的应用

浅谈自然语言处理技术（NLP）在银行领域的应用

自然语言处理技术（NLP）通过解析和理解海量非结构化数据，为银行领域提供了前所未有的洞察力和决策支持。这项技术的应用不仅优化了风险管理，还革新了客户服务和市场分析等多个方面。 银行系统中存在大量的非结构化信息，这些信息不仅数据量庞大，而且种类繁多，处理起来相对…
阅读更多...
nvm安装指定版本显示不存在及nvm ls-remote 列表只出现 iojs 而没有 node.js 解决办法

nvm安装指定版本显示不存在及nvm ls-remote 列表只出现 iojs 而没有 node.js 解决办法

在使用 nvm install 18.20.3 安装 node 时会发现一直显示不存在此版本 Version 18.20.3 not found - try nvm ls-remote to browse available versions.使用 nvm ls-remote 查看可安装列表时发现&#xff0c;列表中只有 iojs 解决方法&#xff1a; 可以使用以下命令查看可安装…
阅读更多...
算法基础 -- 背包问题类型与算法整理

算法基础 -- 背包问题类型与算法整理

背包问题类型与算法整理 1. 背包问题类型与描述 背包问题类型问题描述0-1 背包问题每种物品只能选择一次&#xff0c;求如何选择物品使得总价值最大。完全背包问题每种物品可以选择多次&#xff0c;求如何选择物品使得总价值最大。多重背包问题每种物品选择次数有限&#xff…
阅读更多...
Linux磁盘存储概念(六)

Linux磁盘存储概念(六)

本文为Ubuntu Linux操作系统- 第六弹 今天开始新的知识点&#xff0c;讲磁盘存储问题 上期回顾&#xff1a;Linux文件、目录权限问题 今天由帝皇侠陪伴大家学习&#xff01;&#xff01;&#xff01; 文章目录 磁盘数据组织低级格式化磁盘分区高级格式化 磁盘设备命名磁盘分区分…
阅读更多...
最新文章

Copyright @ 2022~2023