FastAPI：获取客户端真实IP

在本文中，我们将介绍如何使用FastAPI（基于Starlette框架）获取客户端的真实IP地址。获取客户端的真实IP地址对于应用程序的安全性和追踪访问者非常重要。虽然FastAPI默认情况下提供了处理HTTP请求的功能，但在有些情况下，FastAPI无法准确地获取客户端的IP地址。因此，我们将学习如何使用FastAPI的功能来获取客户端发送请求的真实IP地址。

阅读更多：FastAPI 教程

什么是客户端真实IP地址？

客户端真实IP地址是指向服务器发送请求的客户端设备的IP地址。在一些情况下，客户端的请求经过代理服务器或者负载均衡服务器后，会丢失原始的客户端IP地址。在这种情况下，我们需要从HTTP头中获取客户端真实的IP地址。

如何获取客户端真实IP地址？

FastAPI使用了Starlette框架来处理HTTP请求。我们可以利用Starlette的功能在FastAPI应用程序中来获取客户端的真实IP地址。下面我们演示如何使用FastAPI来实现这一功能。

首先，我们需要导入Request和Depends类以及HTTPConnection模块：

from fastapi import FastAPI, Request, Depends
from starlette.middleware import Middleware
from starlette.middleware.base import BaseHTTPMiddleware
from starlette.middleware.trustedhost import TrustedHostMiddleware
from http.client import HTTPConnection

然后，我们创建一个自定义的RealIPMiddleware中间件类，继承自BaseHTTPMiddleware：

class RealIPMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        client_host = request.client.host
        forwarded_host = request.headers.get('X-Forwarded-Host')
        forwarded_for = request.headers.get('X-Forwarded-For')

        real_ip = forwarded_for.split(',')[0] if forwarded_for else client_host
        setattr(request, 'client', HTTPConnection(real_ip))

        response = await call_next(request)

        return response

在上述代码中，我们获取了请求的client属性和X-Forwarded-Host、X-Forwarded-For等HTTP头信息。然后，我们提取出真实IP地址并设置到client属性中。设置完毕后，我们使用await call_next(request)执行其余的中间件和请求处理器。

接下来，我们创建一个FastAPI应用程序，并将我们自定义的RealIPMiddleware中间件添加到应用程序的中间件列表中：

app = FastAPI()

middlewares = [
    Middleware(TrustedHostMiddleware, allowed_hosts=['*']),
    Middleware(RealIPMiddleware)
]

app.middleware_stack = middlewares

在上述代码中，我们使用了TrustedHostMiddleware来允许所有的请求主机。然后，我们添加了我们自定义的RealIPMiddleware中间件到应用程序的中间件列表中。

最后，我们定义一个路由处理函数来获取客户端真实IP地址：

@app.get("/client_ip")
async def get_client_ip(request: Request):
    return {"client_ip": request.client.host}

当我们访问/client_ip路由时，该处理函数将返回客户端的真实IP地址。

示例

让我们来测试一下我们的FastAPI应用程序，并获取客户端的真实IP地址。

假设我们的FastAPI应用程序运行在http://localhost:8000上。我们可以使用curl或者浏览器来发送HTTP请求。在终端中执行以下命令：

curl http://localhost:8000/client_ip

或者在浏览器中打开http://localhost:8000/client_ip地址。

FastAPI应用程序将返回一个JSON格式的响应，其中包含客户端的真实IP地址。

总结

在本文中，我们学习了如何使用FastAPI（基于Starlette框架）获取客户端的真实IP地址。我们创建了一个自定义的中间件来解析HTTP头中的IP地址，并将其设置到request对象的client属性中。通过使用这个中间件，我们能够准确地获取客户端的真实IP地址，从而提高了应用程序的安全性和可追踪性。

快速API提供了一个强大且易于使用的框架，通过使用负载均衡服务器，我们也可以确保我们能够准确获取到客户端的真实IP地址。始终确保你的应用程序能够获取到正确的IP地址对于应用程序的正常运行和重要数据的安全性至关重要。