So implementieren Sie Fehlerbehandlung und benutzerdefinierte Ausnahmen in FastAPI

So implementieren Sie Fehlerbehandlung und benutzerdefinierte Ausnahmen in FastAPI

Einführung:
FastAPI ist ein modernes Web-Framework auf Basis von Python. Aufgrund seiner hohen Leistung und schnellen Entwicklungsfunktionen wird es im Entwicklungsbereich immer beliebter. In tatsächlichen Anwendungen treten häufig Fehler und Ausnahmen auf. In diesem Artikel wird erläutert, wie Fehlerbehandlung und benutzerdefinierte Ausnahmen in FastAPI implementiert werden, um Entwicklern dabei zu helfen, Fehlersituationen in Anwendungen besser zu handhaben und zu verwalten.

FastAPI-Fehlerbehandlung:
FastAPI bietet einen integrierten Mechanismus zur Ausnahmebehandlung. Durch die Verwendung von Ausnahmehandlern oder Dekoratoren können wir Fehler in der Anwendung erfassen und behandeln. Hier ist ein einfaches Beispiel für die Fehlerbehandlung:

from fastapi import FastAPI

app = FastAPI()

@app.exception_handler(Exception)
async def validation_exception_handler(request, exc):
    return JSONResponse(status_code=400, content={"message": "Bad request"})

@app.get("/users/{user_id}")
async def read_user(user_id: int):
    if user_id <= 0:
        raise Exception("Invalid user id")
    return {"user_id": user_id}

Im obigen Beispiel verwenden wir den Dekorator @app.Exception_handler, um einen globalen Ausnahmehandler zu definieren. Es akzeptiert zwei Parameter: Der erste Parameter ist der zu behandelnde Ausnahmetyp und der zweite Parameter ist eine Rückruffunktion, die zur Behandlung der Ausnahme verwendet wird. In diesem Beispiel fangen wir alle Exception-Ausnahmen ab und geben eine JSONResponse mit einer benutzerdefinierten Fehlermeldung zurück. @app.exception_handler装饰器来定义了一个全局的异常处理器。它接受两个参数，第一个参数是要处理的异常类型，第二个参数是一个回调函数，用于处理异常。在这个例子中，我们捕获了所有的Exception异常，并返回一个带有自定义错误消息的JSONResponse。

当我们访问/users/{user_id}这个路由时，如果传入的user_id小于等于0，将会抛出一个自定义的异常。通过上面定义的全局的异常处理器，我们可以捕获并处理这个异常，并返回一个带有错误消息的JSONResponse。

自定义异常：
除了使用内置的异常类型，我们还可以自定义异常类型，以便更好地区分和处理不同类型的错误。下面是一个自定义异常的示例：

class InvalidUserIdException(Exception):
    def __init__(self, user_id: int):
        self.user_id = user_id
        super().__init__("Invalid user id")

@app.get("/users/{user_id}")
async def read_user(user_id: int):
    if user_id <= 0:
        raise InvalidUserIdException(user_id)
    return {"user_id": user_id}

在上面的示例中，我们定义了一个名为InvalidUserIdException的自定义异常类，它继承自Exception类。我们还在构造函数中接受了一个user_id参数，用于在异常消息中显示具体的用户ID。在路由处理函数中，当user_id小于等于0时，我们抛出了这个自定义异常。

再次运行应用程序时，我们会看到与之前相同的结果。这是因为我们没有定义针对该自定义异常的特定异常处理程序。为了捕获和处理自定义异常，我们可以添加一个新的异常处理器：

@app.exception_handler(InvalidUserIdException)
async def invalid_user_id_exception_handler(request, exc):
    return JSONResponse(status_code=400, content={"message": str(exc)})

在上面的示例中，我们添加了一个新的异常处理器，用于捕获InvalidUserIdException异常。它与之前的全局异常处理器有相同的结构，只是处理逻辑不同。在这个处理器中，我们将异常消息转换为字符串，并返回一个带有错误消息的JSONResponse。

这样，当我们访问/users/{user_id}这个路由时，如果传入的user_id小于等于0，将会抛出InvalidUserIdException异常。通过特定的异常处理器，我们可以捕获并处理这个异常，并返回一个带有自定义错误消息的JSONResponse

Wenn wir auf die Route /users/{user_id zugreifen und die eingehende user_id kleiner oder gleich 0 ist, wird eine benutzerdefinierte Ausnahme ausgelöst. Durch den oben definierten globalen Ausnahmehandler können wir diese Ausnahme abfangen und behandeln und eine JSONResponse mit einer Fehlermeldung zurückgeben.

Benutzerdefinierte Ausnahmen:

Zusätzlich zur Verwendung der integrierten Ausnahmetypen können wir auch Ausnahmetypen anpassen, um verschiedene Fehlertypen besser zu unterscheiden und zu behandeln. Hier ist ein Beispiel für eine benutzerdefinierte Ausnahme:

rrreee

Im obigen Beispiel haben wir eine benutzerdefinierte Ausnahmeklasse mit dem Namen InvalidUserIdException definiert, die von der Klasse Exception erbt. Wir akzeptieren auch einen user_id-Parameter im Konstruktor, um die spezifische Benutzer-ID in der Ausnahmemeldung anzuzeigen. Wenn in der Routing-Verarbeitungsfunktion user_id kleiner oder gleich 0 ist, lösen wir diese benutzerdefinierte Ausnahme aus.

• Wenn wir die Anwendung erneut ausführen, werden wir die gleichen Ergebnisse wie zuvor sehen. Dies liegt daran, dass wir für diese benutzerdefinierte Ausnahme keinen spezifischen Ausnahmehandler definiert haben. Um benutzerdefinierte Ausnahmen abzufangen und zu behandeln, können wir einen neuen Ausnahmehandler hinzufügen:
rrreee
• Im obigen Beispiel haben wir einen neuen Ausnahmehandler zum Abfangen von InvalidUserIdException-Ausnahmen hinzugefügt. Es hat die gleiche Struktur wie der vorherige globale Ausnahmebehandler, die Verarbeitungslogik ist jedoch unterschiedlich. In diesem Handler konvertieren wir die Ausnahmemeldung in einen String und geben eine JSONResponse mit der Fehlermeldung zurück.

Wenn wir auf die Route /users/{user_id zugreifen und die eingehende user_id kleiner oder gleich 0 ist, kommt es zu einer InvalidUserIdException Code> wird ausgelöst, Code>Ausnahme. Mit einem bestimmten Ausnahmehandler können wir diese Ausnahme abfangen und behandeln und eine <code>JSONResponse mit einer benutzerdefinierten Fehlermeldung zurückgeben. 🎜🎜Zusammenfassung: 🎜Durch die Verwendung des Fehlerbehandlungsmechanismus von FastAPI können wir Fehlersituationen in unseren Anwendungen besser behandeln und verwalten. Wir können einen globalen Ausnahmehandler verwenden, um alle Ausnahmen abzufangen und zu behandeln, oder wir können spezifische Ausnahmehandler definieren, um bestimmte Ausnahmetypen zu behandeln. Gleichzeitig können wir auch Ausnahmeklassen anpassen, um verschiedene Fehlertypen besser zu unterscheiden und zu behandeln und so die Lesbarkeit und Wartbarkeit des Codes zu verbessern. 🎜🎜Referenzlink: 🎜🎜🎜Offizielle FastAPI-Dokumentation: https://fastapi.tiangolo.com/tutorial/handling-errors/🎜🎜Offizielle Python-Dokumentation: https://docs.python.org/3/tutorial/errors. html🎜🎜

Das obige ist der detaillierte Inhalt vonSo implementieren Sie Fehlerbehandlung und benutzerdefinierte Ausnahmen in FastAPI. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!