fastapi教程-进阶八（Handling Errors）_fastapi websocket 发送消息阻塞

参考内容：

• https://fastapi.tiangolo.com/

在很多情况下，在服务端出现错误时，我们需要告诉客户端出现了什么错误，例如：

• 客户端没有足够的权限进行该操作。
• 客户端无权访问该资源。
• 客户端尝试访问的项目不存在。

这时，我们需要返回给客户端400-499范围内的HTTP状态码。接下来介绍如何通过fastapi对服务端错误进行处理并返回给客户端HTTP状态码

HTTPException

如果希望将错误返回给客户端，可以使用HTTPException:

from fastapi import FastAPI, HTTPException

app = FastAPI()

items = {
   "foo": "The Foo Wrestlers"}


@app.get("/items/{item_id}")
async def read_item(item_id: str):
    if item_id not in items:
        raise HTTPException(status_code=404, detail="Item not found")
    return {
   "item": items[item_id]}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

上面这个代码的含义是希望当查询的item_id不存在时，返回404状态码，并告诉客户端查询的id不存在。

我们先尝试请求http://127.0.0.1:8000/items/a，看看服务端会响应什么:

回到代码中，我们注意到这里的HTTPException使用了raise，而不是return，这是为什么呢？

因为HTTPException本身是python的异常类，异常我们通常都是需要将它抛出，所以用了raise。这也就意味着，当我们触发了HTTPException这个异常，余下的代码将不会再执行，并且服务端会直接将错误通过HTTPException响应给客户端。

另外，当我们抛出HTTPException时，服务端会返回给我们:

{
   
  "detail": "Item not found"
}
1
2
3
4

如果我们想返回更具体的错误信息，可以对detail进行修改，它不仅可以接收字符串，也可以是json、dict、list等结构，例如我们修改代码:

from fastapi import FastAPI, HTTPException

app = FastAPI()

items = {
   "foo": "The Foo Wrestlers"}


@app.get("/items/{item_id}")
async def read_item(item_id: str):
    if item_id not in items:
        raise HTTPException(status_code=404, detail={
   'msg': "Item not found"})
    return {
   "item": items[item_id]}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

再次请求http://127.0.0.1:8000/items/a，此时的响应就发生了变化：

{
   
  "detail&
1
2