Uvicorn安装与FastAPI项目部署搭建

admin

Uvicorn 安装与 FastAPI 项目部署指南

1. 安装 Uvicorn

Uvicorn 是一个轻量级的 ASGI 服务器，用于运行 FastAPI 应用。安装步骤如下：

使用 pip 安装

1. pip install uvicorn

复制代码

可选：安装带有标准库异步支持的版本

1. pip install uvicorn[standard]  # 或者 uvloop 和 httptools
2. # 或者更具体的安装
3. pip install uvicorn uvloop httptools

复制代码

2. 创建 FastAPI 项目

初始化项目

1. mkdir myfastapi_project
2. cd myfastapi_project
3. python -m venv venv  # 创建虚拟环境
4. source venv/bin/activate  # Linux/Mac
5. # venv\Scripts\activate  # Windows

复制代码

安装 FastAPI

1. pip install fastapi

复制代码

创建主应用文件
创建

1. main.py

复制代码

文件，内容如下：

1. from fastapi import FastAPI
3. app = FastAPI()
5. @app.get("/")
6. async def read_root():
7.     return {"message": "Hello World"}
9. @app.get("/items/{item_id}")
10. async def read_item(item_id: int, q: str = None):
11.     return {"item_id": item_id, "q": q}

复制代码

3. 使用 Uvicorn 运行应用

开发模式运行

1. uvicorn main:app --reload

复制代码

• 1. main

  复制代码
  : main.py 文件 (不需要 .py 后缀)
  
• 1. app

  复制代码
  : 在 main.py 文件中创建的 FastAPI 实例
  
• 1. --reload

  复制代码
  : 启用代码更改自动重载 (仅开发使用)
  

生产环境运行

1. uvicorn main:app --host 0.0.0.0 --port 8000

复制代码

• 1. --host 0.0.0.0

  复制代码
  : 允许外部访问
  
• 1. --port 8000

  复制代码
  : 指定端口
  

4. 生产环境部署选项

选项1: 使用 Gunicorn 作为进程管理器

1. pip install gunicorn
2. gunicorn -k uvicorn.workers.UvicornWorker main:app --bind 0.0.0.0:8000

复制代码

选项2: 使用 Systemd 管理服务
创建 systemd 服务文件

1. /etc/systemd/system/fastapi_app.service

复制代码

:

1. [Unit]
2. Description=FastAPI Application
3. After=network.target
5. [Service]
6. User=your_username
7. WorkingDirectory=/path/to/your/project
8. Environment="PATH=/path/to/your/project/venv/bin"
9. ExecStart=/path/to/your/project/venv/bin/gunicorn -k uvicorn.workers.UvicornWorker -w 4 -t 300 main:app
11. [Install]
12. WantedBy=multi-user.target

复制代码

然后启用服务:

1. sudo systemctl daemon-reload
2. sudo systemctl start fastapi_app
3. sudo systemctl enable fastapi_app

复制代码

选项3: 使用 Docker 部署
创建

1. Dockerfile

复制代码

:

1. FROM python:3.9-slim
3. WORKDIR /app
5. COPY requirements.txt .
6. RUN pip install --no-cache-dir -r requirements.txt
8. COPY . .
10. CMD ["gunicorn", "-k", "uvicorn.workers.UvicornWorker", "-w", "4", "-t", "300", "main:app"]
11. # 或者直接使用 uvicorn (不推荐生产环境直接使用)
12. # CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000"]

复制代码

构建并运行:

1. docker build -t fastapi-app .
2. docker run -d -p 8000:8000 fastapi-app

复制代码

5. 配置选项

Uvicorn 有许多有用的配置选项:

[]
1. --workers
复制代码
: 指定工作进程数 (通常为 CPU 核心数 2 + 1)

• 1. --timeout

  复制代码
  : 设置超时时间 (秒)
  
• 1. --limit-concurrency

  复制代码
  : 限制并发连接数
  
• 1. --backlog

  复制代码
  : 设置连接队列大小
  
• 1. --log-level

  复制代码
  : 设置日志级别 (info, debug, warning, error)
  

6. 验证部署

访问以下端点验证应用是否正常运行:

• 1. http://localhost:8000/

  复制代码
  - 返回 "Hello World"
  
• 1. http://localhost:8000/docs

  复制代码
  - 自动生成的交互式 API 文档
  
• 1. http://localhost:8000/redoc

  复制代码
  - 另一种风格的 API 文档
  

通过以上步骤，您已经成功安装了 Uvicorn 并部署了一个基本的 FastAPI 应用。根据您的需求，可以选择适合的生产环境部署方式。