Flask-RQ

Flask-RQ库教程

Flask-RQ 是一个用于在 Flask 应用中集成 RQ(Redis Queue)的扩展。RQ 是一个简单的 Python 库,用于将任务排入 Redis 队列并异步执行这些任务。这对于处理长时间运行的任务(如发送电子邮件、生成报告等)非常有用。

官方文档链接

Flask-RQ2官方文档

安装和配置

  1. 安装 Flask-RQ2

首先,你需要安装 Flask、Redis 和 Flask-RQ2。可以使用 pip 来安装:

bash 复制代码
pip install Flask Redis Flask-RQ2
  1. 基本配置

以下是一个基本的配置示例,展示了如何在 Flask 应用中集成 RQ:

python 复制代码
from flask import Flask
from flask_rq2 import RQ

app = Flask(__name__)
app.config['RQ_REDIS_URL'] = 'redis://localhost:6379/0'
rq = RQ(app)

@app.route('/')
def index():
    return 'Hello, Flask-RQ!'

if __name__ == '__main__':
    app.run(debug=True)

定义和调用任务

  1. 定义任务

任务是在单独的函数中定义的,这些函数可以通过 RQ 异步执行。例如,定义一个简单的任务来添加两个数字:

python 复制代码
def add(a, b):
    return a + b
  1. 调用任务

你可以通过 RQ 的 enqueue 方法将任务添加到队列中:

python 复制代码
from flask import Flask, request, jsonify
from flask_rq2 import RQ

app = Flask(__name__)
app.config['RQ_REDIS_URL'] = 'redis://localhost:6379/0'
rq = RQ(app)

def add(a, b):
    return a + b

@app.route('/add', methods=['POST'])
def add_task():
    a = request.json.get('a')
    b = request.json.get('b')
    job = rq.get_queue().enqueue(add, a, b)
    return jsonify({'job_id': job.id}), 202

if __name__ == '__main__':
    app.run(debug=True)
  1. 运行 RQ Worker

在另一个终端窗口中运行 RQ worker 来处理队列中的任务:

bash 复制代码
rq worker

检查任务状态

你可以通过任务 ID 检查任务的状态和结果:

python 复制代码
from flask import Flask, request, jsonify
from flask_rq2 import RQ
from rq.job import Job

app = Flask(__name__)
app.config['RQ_REDIS_URL'] = 'redis://localhost:6379/0'
rq = RQ(app)

def add(a, b):
    return a + b

@app.route('/add', methods=['POST'])
def add_task():
    a = request.json.get('a')
    b = request.json.get('b')
    job = rq.get_queue().enqueue(add, a, b)
    return jsonify({'job_id': job.id}), 202

@app.route('/status/<job_id>', methods=['GET'])
def task_status(job_id):
    job = Job.fetch(job_id, connection=rq.connection)
    return jsonify({'status': job.get_status(), 'result': job.result})

if __name__ == '__main__':
    app.run(debug=True)

进阶功能

  1. 定时任务

你可以使用 rq-scheduler 来调度定时任务:

bash 复制代码
pip install rq-scheduler

然后在代码中调度任务:

python 复制代码
from datetime import datetime, timedelta
from flask import Flask, request, jsonify
from flask_rq2 import RQ
from rq_scheduler import Scheduler

app = Flask(__name__)
app.config['RQ_REDIS_URL'] = 'redis://localhost:6379/0'
rq = RQ(app)

scheduler = Scheduler(connection=rq.connection)

def add(a, b):
    return a + b

@app.route('/schedule', methods=['POST'])
def schedule_task():
    a = request.json.get('a')
    b = request.json.get('b')
    job = scheduler.enqueue_in(timedelta(minutes=1), add, a, b)
    return jsonify({'job_id': job.id}), 202

if __name__ == '__main__':
    app.run(debug=True)
  1. 任务失败处理

你可以定义一个失败处理函数来处理任务失败:

python 复制代码
from flask import Flask
from flask_rq2 import RQ

app = Flask(__name__)
app.config['RQ_REDIS_URL'] = 'redis://localhost:6379/0'
rq = RQ(app)

def add(a, b):
    if b == 0:
        raise ValueError('Cannot add zero')
    return a + b

def handle_failure(job, exc_type, exc_value, traceback):
    print(f'Task {job.id} failed: {exc_value}')

rq.get_queue().enqueue(add, 1, 0, failure_ttl=10, on_failure=handle_failure)

if __name__ == '__main__':
    app.run(debug=True)

总结

Flask-RQ2 是一个功能强大且易于使用的库,可以帮助开发者在 Flask 应用中集成 RQ 任务队列。通过本文介绍的基本配置、任务定义和调用、任务状态检查和进阶功能,开发者可以轻松上手并熟练运用 Flask-RQ2 进行各种异步任务的处理。更多详细信息和示例请参考官方文档

相关推荐
纨妙2 分钟前
python打卡day59
开发语言·python
waynaqua2 分钟前
FastAPI开发AI应用二:多厂商模型使用指南
python·openai
neoooo5 分钟前
别慌,Java只有值传递——一次搞懂“为啥我改了它还不变”!
java·后端·spring
秋难降6 分钟前
Python 知识 “八股”:给有 C 和 Java 基础的你😁😁😁
java·python·c
用户7785371836969 分钟前
一力破万法:从0实现一个http代理池
后端·爬虫
FF-Studio19 分钟前
大语言模型(LLM)课程学习(Curriculum Learning)、数据课程(data curriculum)指南:从原理到实践
人工智能·python·深度学习·神经网络·机器学习·语言模型·自然语言处理
拖孩36 分钟前
微信群太多,管理麻烦?那试试接入AI助手吧~
前端·后端·微信
像风一样的男人@38 分钟前
python --货车装厢问题
开发语言·python
Humbunklung1 小时前
Rust枚举:让数据类型告别单调乏味
开发语言·后端·rust
Y1nhl1 小时前
力扣_链表_python版本
开发语言·python·算法·leetcode·链表·职场和发展