关于fastapi异步接口卡死的坑及解决

目录

• 背景
• 问题细节
• fastapi依赖注入
• 总结

背景

开发任务是使用fastapi去写一个对工业设备（PLC）的通信接口，方便其他后端服务与设备对接，将设备的功能抽象出来供MES调用。

通信协议是使用modbus TCP编程客栈，由于fastapi是异步框架，很多以前在同步函数里开发的代码移植过来发现出现了异常，这也是不断踩坑的过程，问题解决之后也能体会到异步框架的优美与高效。

问题细节

在视图函数中我们需要创建一个socket连接，使用它跟plc进行通信，完毕之后还要记得关闭该连接，否则就会造成异步框架的卡死，其他请求就进不来了。

刚开始我的代码是这样的：

@router.put("/start/{id}")
async def start(
    id:int,
    BATsize:int=Body(default=15,description='批次大小'),
    noksize:int=Body(default=3,description='最大连续失败次数')
    ):

    dip = await PLC.get(pk=id)   # 配置数据库中查询设备网络信息
    zmqconn = get_conn(dip.host,dip.port)   # 获取网络连接
    # 发送命令
    try:
        ret = zmqconn.request(action='start_batch',rqargs={'batch_size':batsize,'nok_num':noksize})
    except Exception as e:
        raise HTTPException(status_code=503,detail=str(e))
    else:
        return ret

​​​​写完之后我自己测试了一下，发现是可以正常发起命令的，而且接口也返回了期望的结果，但是我快速点了几下，发现问题就来了，第六下的时候，接口卡住无法返回，异步函数中也不执行任何动作，这在之前的同步代码中是没有出现的。

后来我经过调试发现是socket连接并没有成功创建，怀疑是之前的连接没有关闭，导致了网络阻塞，于是加入了关闭连接的代码。

@router.put("/start/{id}")
async def start(
    id:int,
    batsize:int=Body(default=15,description='批次大小'),
    noksize:int=Body(defaphpult=3,description='最大连续失败次数')
    ):

    dip = await PLC.get(pk=id)
    zmqconn = get_conn(dip.host,dip.port)
        
    try:
        ret = zmqconn.request(action='start_batch',rqargs={'batch_size':batsize,'nok_num':noksize})
    except Exception as e:
        raise HTTPExcept编程客栈ion(status_code=503,detail=str(e))
    finally:
        zmqconn.close()
    return ret

这个时候就完全没有卡住的问题了，接口可以一直点。

所以对于异步函数，我们一定要注意手动释放资源，否则可能会造成意想不到的问题。

fastapi依赖注入

但是这又出现一个问题，我们的服务是经常用到前面的sockjavascriptet框架的，其他接口也要用到，总不能每个接口都把这段代码复制粘贴一边吧。

fastapi作为最优秀的异步框架，有一个很大的特点就是非常苛刻的代码复用性，它在设计的时候考虑到了重复代码的问题。

至于苛刻到什么程度呢，举个例子，如果不同的接口用了相同的一组参数，那么你可以把这组参数进行封装，写到依赖里面，用的时候引入一下，那么你新的接口就有了一组一模一样的参数。

这里我们利用fastapi的依赖注入，把接口参数以及socket连接都封装起来，供其他接口调用。

依赖代码

async def get_conn_dep(
    id:int = Path(descriptionandroid='路径参数，设备id'),
):
    dip = await PLC.get(pk=id)
    try:
        zmqconn = get_conn(dip.host,dip.port)
        yield zmqconn                # 向接口函数注入链接
    finally:
        zmqconn.close()     # 接口函数执行完毕后会异步执行关闭

而我们的接口函数就可以非常精简

@router.put("/start/{id}")
async def start(
    zmqconn = Depends(get_conn_dep),     # 这一行直接复用了一堆代码以及相应的路径字段，简直太优雅了
    batsize:int=Body(default=15,description='批次大小'),
    noksize:int=Body(default=3,description='最大连续失败次数')
    ):

    try:
        ret = zmqconn.request(action='start_batch',rqargs={'batch_size':batsize,'nok_num':noksize})
    except Exception as e:
        raise HTTPException(status_code=503,detail=str(e))
    else:
        return ret

我们使用swagger疯狂点击该接口，并传入不同的参数进行测试，发现接口响应非常流畅，异常处理的时候也返回了我们想要的错误信息。

我们上面的代码使用了fastapi异步接口（据说性能逼近go），并使用了tortoise异步ORM，tortoise的使用与django-orm几乎一样，但它是一个纯异步orm，这两个配合起来开发简直是非常的舒服。

• fastapi.
• tortoise-orm.

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持编程客栈(www.devze.com)。