Deploy FastAPI application with SQLite on Flyio

本篇文章给大家分享《Deploy FastAPI application with SQLite on Flyio》，覆盖了文章的常见基础知识，其实一个语言的全部知识点一篇文章是不可能说完的，但希望通过这些问题，让读者对自己的掌握程度有一定的认识(B 数)，从而弥补自己的不足，更好的掌握它。

云解决方案适用于中型和大型项目，但对于小型个人项目来说太重了。如果你想启动一些小东西（一些 api 端点和一个小存储库），有三个选项：

• 使用与“大型”项目（aws ecs/eks、rds）相同的方法，但它们是多余的，并且基础设施代码可能比实际项目的代码更大。而且价格也很贵（~$100）。
• 使用无服务器解决方案（lambda、vercel）。大多数云提供商都有这样的解决方案，但这些服务在简单数据库方面存在困难 - 他们提供廉价的供应商解决方案（aws）或需要托管数据库，这又很昂贵（对于无服务器来说几乎没有什么，数据库大约 20 美元）
• 将 vps 与 docker 结合使用。它很便宜（小型机器约 5 美元），几乎不需要管理基础设施，但部署很糟糕（需要私有或自托管注册表、来自 ci 的 ssh 访问）。

我通常使用 sqlite 编写小型应用程序，它是一个方便的小型单文件数据库，可以使用任何编程语言运行，并且可以复制到本地计算机以分析数据等。因此，我一直在寻找一些结合了无服务方法、易于部署和使用 sqlite 的能力的中间件解决方案，并找到了 fly.io。

设置

如果您在 fly.io 中没有帐户 – 您需要创建一个帐户。管理项目还需要名为 flyctl 的 cli 工具。 fly.io 既可以在本地部署，也可以从 ci 部署。

flyctl 通过 dockerfile 从项目的根文件夹进行部署，这很酷，因为相同的 dockerfile 可以在其他系统中使用。为了玩 fly.io，我准备了一个简单的 fastapi 项目，将状态存储在数据库中 - 具有点击计数功能的通用 url 缩短器。

dockerfile：

from python:3.13-alpine
workdir /app

copy ./requirements.txt .
run pip install --no-cache-dir --upgrade -r requirements.txt

copy . /app

env host=0.0.0.0 port=8080
expose ${port}
cmd uvicorn main:app --host ${host} --port ${port}

main.py:

import asyncio
import random
import string
from urllib.parse import urlparse

import aiosqlite
from fastapi import fastapi, httpexception, request
from fastapi.responses import redirectresponse

db_path = "/data/app.db"

app = fastapi()

async def get_db() -> aiosqlite.connection:
    if db := getattr(get_db, "_db", none):
        if db.is_alive:
            return db

    db = await aiosqlite.connect(db_path, loop=asyncio.get_event_loop())
    db.row_factory = aiosqlite.row

    qs = """
    create table if not exists links (
        created_at integer default (strftime('%s', 'now')),
        short_code text primary key,
        full_url text not null,
        clicks integer default 0
    )
    """

    await db.execute(qs)
    await db.commit()

    setattr(get_db, "_db", db)
    return db

def random_code(length=8) -> str:
    alphabet = string.ascii_letters + string.digits
    return "".join(random.choice(alphabet) for x in range(length))

def is_valid_url(url: str) -> bool:
    try:
        parts = urlparse(url)
        return all([parts.scheme, parts.netloc])
    except valueerror:
        return false

@app.post("/")
async def shorten(url: str, req: request):
    if not is_valid_url(url):
        raise httpexception(status_code=400, detail="invalid url")

    host = req.headers.get("host")
    if host is none:
        raise httpexception(status_code=500, detail="missing host header")

    short_code = random_code()
    db = await get_db()
    qs = "insert into links (short_code, full_url) values (?, ?)"
    await db.execute(qs, (short_code, url))
    await db.commit()

    return f"https://{host}/{short_code}"

@app.get("/")
async def list_links():
    db = await get_db()
    qs = "select short_code, full_url, clicks from links order by created_at desc"
    async with db.execute(qs) as cursor:
        return await cursor.fetchall()

@app.get("/{short_code}")
async def redirect(short_code: str):
    db = await get_db()
    qs = """
    update links set clicks = clicks + 1 where short_code = ?
    returning full_url
    """

    async with db.execute(qs, (short_code,)) as cursor:
        if row := await cursor.fetchone():
            return redirectresponse(row["full_url"])

    raise httpexception(status_code=404)

需求.txt：

aiosqlite
fastapi
uvicorn

部署

要部署我们的代码，首先我们需要创建一个 fly.io 项目。这可以在 web 界面或使用 flyctl 中完成。要使用 clu 工具在根文件夹（代码所在的位置）中创建项目，应运行 flyctl launch。此命令将提供选择所需的硬件并创建 fly.toml 文件：

fly launch --build-only

您将来可以通过更改此文件中的参数或通过 web ui 来修改项目。基本的fly.toml看起来不错，但sqlite需要存储，可以使用以下命令创建：

fly volumes create sqlite_data -s 1 -r ams

其中 -s 1 将卷大小设置为 1 gb（默认为 3 gb），-r 是将创建卷的区域（使用与创建 fly.io 项目相同的区域）。您稍后可以随时更改存储大小。

最后要做的事情是向 fly.toml 添加一个 mounts 部分，它将卷附加到应用程序：

[mounts]
source = "sqlite_data"
destination = "/data"

sqlite_data 是存储的名称，/data 是卷将连接的路径。这本质上与 docker run --mount source=sqlite_data,target=/data 或相应的 docker compose 部分相同。

sqlite 无法从多个应用程序写入，并且 fly.io 默认情况下会为一个应用程序创建 2 个实例，因此我们可以将副本数量指定为 1，以防万一：

fly scale count 1

所有配置现已完成，我们可以使用命令部署我们的应用程序：

fly deploy

应用程序应成功启动，公共 dns 名称将打印到控制台。现在我们可以通过发布一些缩短器的网址来检查它：

❯ curl -x post 'https://fly-fastapi-sqlite.fly.dev/?url=https://example.com'
https://fly-fastapi-sqlite.fly.dev/8ydmfack

然后我们可以访问这个链接，它应该重定向到 https://example.com。最后，我们可以检查点击次数是否已更新：

❯ curl -s 'https://fly-fastapi-sqlite.fly.dev/' | jq
[
  {
    "short_code": "8ydmfack",
    "full_url": "https://example.com",
    "clicks": 1
  }
]

要检查部署之间保存的数据库状态，我们可以使用 fly 部署执行新部署，并检查链接列表是否与上面相同（1 个链接，1 个点击）。

迁移

如果您使用外部解决方案进行迁移，而不是在应用程序启动时从代码运行它们，那么运行迁移的唯一方法是将其作为 run 命令的一部分放入 dockerfile 中。

备份

我们可以使用 fly ssh 控制台连接到机器，然后在 /data 文件夹中与数据库文件交互。我们还可以使用以下命令将数据库文件复制到本地计算机：

fly ssh sftp get /data/app.db ./app-backup.db

结论

fly.io 是一项简单便捷的应用程序部署服务。从 docker 容器进行部署，附加服务包括 psql、redis、s3 等存储（与 vercel 不同）。它很便宜，最便宜的服务费用为 3 美元（1 个共享 cpu / 256 mb） - 如果流量很少，容器可能会更少 - 容器在没有活动的几分钟后关闭，并在流量出现时自动打开。

缺点是，没有针对计划任务的内置解决方案 - 相反，官方解决方案是使用 crontab 设置单独的服务器并从中运行任务 - 这有点令人毛骨悚然。

今天关于《Deploy FastAPI application with SQLite on Flyio》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！