Flask-RQ

Flask-RQ库教程

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

官方文档链接

Flask-RQ2官方文档

安装和配置

1. 安装 Flask-RQ2

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

pip install Flask Redis Flask-RQ2

2. 基本配置

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

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 异步执行。例如，定义一个简单的任务来添加两个数字：

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

2. 调用任务

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

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)

3. 运行 RQ Worker

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

rq worker

检查任务状态

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

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/', 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 来调度定时任务：

pip install rq-scheduler

然后在代码中调度任务：

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)

2. 任务失败处理

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

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 进行各种异步任务的处理。更多详细信息和示例请参考官方文档。