Django用apscheduler定时调用api_view接口报request缺失错误如何解决

错误根因 #

1. 你使用@api_view装饰的函数是DRF提供的HTTP接口视图，默认必须接收request作为第一个入参，定时任务直接调用时没有传入合法的请求对象，因此抛出参数缺失错误。
2. 你的函数视图参数写法错误：函数视图的第一个参数应为request而非self，self是类视图方法的专属第一个参数，即使正常发送HTTP请求调用这个接口也会报错。
3. apps.py中的导入名称错误：你的定时任务文件名为alerts_scheduler.py，你导入时写的alerts_schedule名称不匹配，会触发导入错误。

最优解决方案（推荐） #

将公共业务逻辑从视图中抽离，视图仅负责处理HTTP请求相关逻辑，定时任务直接调用抽离的业务函数，无需走接口请求流程。

1. 修改views.py #

# 抽离公共的查询用户数据逻辑，供视图和定时任务共同调用
def get_sorted_user_data():
    return UserSerializer(UserDetail.objects.all().order_by('name'), many=True).data

@api_view(['GET'])
def UserViewSet(request):
    return Response(get_sorted_user_data())

2. 修改alerts_scheduler.py #

直接调用抽离的业务函数，不调用接口视图：

from apscheduler.schedulers.background import BackgroundScheduler
from ..views import get_sorted_user_data

def start():
    scheduler = BackgroundScheduler()
    scheduler.add_job(get_sorted_user_data, 'interval', seconds=5)
    scheduler.start()

3. 修正apps.py的导入和重复启动问题 #

Django开发环境默认会启动重载进程，会导致定时任务被执行两次，添加判断仅在主进程启动定时任务，同时修正导入错误：

from django.apps import AppConfig
import os

class AppbackendConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'AppBackend'

    def ready(self):
        # 仅主进程启动定时任务，避免开发环境重复执行
        if os.environ.get('RUN_MAIN') == 'true':
            from .app_scheduler.alerts_scheduler import start
            start()

特殊场景解决方案（不推荐） #

如果你确实需要直接调用接口视图，可以手动构造虚拟Request对象传入，但这种方式没有实际业务价值，完全没必要走接口的请求校验流程：

# alerts_scheduler.py 示例
from apscheduler.schedulers.background import BackgroundScheduler
from .. import views
from rest_framework.test import APIRequestFactory

def start():
    scheduler = BackgroundScheduler()
    # 构造虚拟GET请求
    factory = APIRequestFactory()
    request = factory.get('/fake-path')
    scheduler.add_job(views.UserViewSet, 'interval', seconds=5, args=[request])
    scheduler.start()

内容的提问来源于stack exchange，提问作者Charitha Reddy