更新架构并修复问题 (#25)

* 更新架构并修复问题

* 修复问题

Author: wu-clan

.pre-commit-config.yaml

@@ -1,14 +1,14 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
       - id: end-of-file-fixer
       - id: check-yaml
       - id: check-toml
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.4.5
+    rev: v0.9.5
     hooks:
       - id: ruff
         args:
@@ -19,7 +19,7 @@ repos:
       - id: ruff-format
 
   - repo: https://github.com/pdm-project/pdm
-    rev: 2.12.4
+    rev: 2.22.3
     hooks:
       - id: pdm-export
         args:

.ruff.toml

@@ -1,31 +1,35 @@
 line-length = 120
+unsafe-fixes = true
+cache-dir = ".ruff_cache"
 target-version = "py310"
-cache-dir = "./.ruff_cache"
 
 [lint]
 select = [
     "E",
     "F",
-    "I",
     "W505",
-    "PT018",
     "SIM101",
     "SIM114",
     "PGH004",
     "PLE1142",
     "RUF100",
+    "I002",
     "F404",
-    "TCH",
+    "TC",
     "UP007"
 ]
+preview = true
 
 [lint.isort]
 lines-between-types = 1
+order-by-type = true
 
 [lint.per-file-ignores]
-"backend/app/api/v1/*.py" = ["TCH"]
-"backend/app/models/*.py" = ["TCH003"]
-"backend/app/**/__init__.py" = ["F401"]
+"**/api/v1/*.py" = ["TC"]
+"**/model/*.py" = ["TC003"]
+"**/model/__init__.py" = ["F401"]
 
 [format]
+preview = true
 quote-style = "single"
+docstring-code-format = true

Dockerfile

@@ -4,20 +4,27 @@ WORKDIR /ftm
 
 COPY . .
 
-RUN sed -i s@/deb.debian.org/@/mirrors.aliyun.com/@g /etc/apt/sources.list \
-    && sed -i s@/security.debian.org/@/mirrors.aliyun.com/@g /etc/apt/sources.list
+RUN sed -i 's/deb.debian.org/mirrors.ustc.edu.cn/g' /etc/apt/sources.list.d/debian.sources \
+    && sed -i 's|security.debian.org/debian-security|mirrors.ustc.edu.cn/debian-security|g' /etc/apt/sources.list.d/debian.sources
 
 RUN apt-get update \
-    && apt-get install -y --no-install-recommends gcc python3-dev \
-    && rm -rf /var/lib/apt/lists/*
+    && apt-get install -y --no-install-recommends gcc python3-dev supervisor \
+    && rm -rf /var/lib/apt/lists/* \
+    # 某些包可能存在同步不及时导致安装失败的情况，可更改为官方源：https://pypi.org/simple
+    && pip install --upgrade pip -i https://mirrors.aliyun.com/pypi/simple \
+    && pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple \
+    && pip install gunicorn wait-for-it -i https://mirrors.aliyun.com/pypi/simple
 
-RUN pip install --upgrade pip -i https://mirrors.aliyun.com/pypi/simple \
-    && pip install --no-cache-dir -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple
+ENV TZ="Asia/Shanghai"
 
-ENV TZ = Asia/Shanghai
+RUN mkdir -p /var/log/fastapi_server \
+    && mkdir -p /var/log/supervisor \
+    && mkdir -p /etc/supervisor/conf.d
 
-RUN mkdir -p /var/log/fastapi_server
+COPY deploy/supervisor.conf /etc/supervisor/supervisord.conf
+
+COPY deploy/fastapi_server.conf /etc/supervisor/conf.d/
 
 EXPOSE 8001
 
-CMD ["uvicorn", "backend.main:app", "--host", "127.0.0.1", "--port", "8000"]
+CMD ["uvicorn", "backend.main:app", "--host", "0.0.0.0", "--port", "8001"]

README.md

@@ -1,23 +1,10 @@
 # FastAPI Tortoise Architecture
 
-作为 FastAPI 框架的一个基础项目，基于 python3.10 开发
+## 本地开发
 
-## 特征
-
-- [x] FastAPI > 0.100.0
-- [x] Async design
-- [x] Restful API
-- [x] Tortoise-orm > 0.20.0
-- [x] Pydantic 2.0
-- [x] Docker
-- [ ] ......
-
-## 使用
-
-> [!WARNING]
-> 此过程请格外注意端口占用情况, 特别是 8000, 3306, 6379...
-
-### 1: 传统
+* Python 3.10+
+* Mysql 8.0+
+* Redis 推荐最新稳定版
 
 1. 安装依赖项
 
@@ -64,7 +51,7 @@
    # 开发模式
    fastapi dev main.py
    ```
-   
+
 9. 浏览器访问: http://127.0.0.1:8000/api/v1/docs
 
 ---
@@ -86,11 +73,7 @@
     ```
 
 3. 等待命令自动完成
-4. 浏览器访问：http://127.0.0.1:8000/api/v1/docs
-
-## 互动
-
-[WeChat / QQ](https://github.com/wu-clan)
+4. 浏览器访问：http://127.0.0.1:8000/docs
 
 ## 赞助
 

backend/.env.example

@@ -1,10 +1,10 @@
 # Env: dev、pro
 ENVIRONMENT='dev'
-# MySQL
-DB_HOST='127.0.0.1'
-DB_PORT=3306
-DB_USER='root'
-DB_PASSWORD='123456'
+# Database
+DATABASE_HOST='127.0.0.1'
+DATABASE_PORT=3306
+DATABASE_USER='root'
+DATABASE_PASSWORD='123456'
 # Redis
 REDIS_HOST='127.0.0.1'
 REDIS_PORT=6379

backend/app/admin/api/router.py

@@ -6,7 +6,7 @@
 from backend.app.admin.api.v1.user import router as user_router
 from backend.core.conf import settings
 
-v1 = APIRouter(prefix=settings.API_V1_STR)
+v1 = APIRouter(prefix=settings.FASTAPI_API_V1_PATH)
 
-v1.include_router(auth_router, prefix='/auth', tags=['认证'])
+v1.include_router(auth_router)
 v1.include_router(user_router, prefix='/users', tags=['用户'])

backend/app/admin/api/v1/auth/__init__.py

@@ -5,7 +5,7 @@
 from backend.app.admin.api.v1.auth.auth import router as auth_router
 from backend.app.admin.api.v1.auth.captcha import router as captcha_router
 
-router = APIRouter()
+router = APIRouter(prefix='/auth')
 
-router.include_router(auth_router)
-router.include_router(captcha_router)
+router.include_router(auth_router, tags=['授权'])
+router.include_router(captcha_router, prefix='/captcha', tags=['验证码'])

backend/app/admin/api/v1/auth/auth.py

@@ -3,33 +3,27 @@
 from fastapi import APIRouter, Depends, Request
 from fastapi.security import OAuth2PasswordRequestForm
 
-from backend.app.admin.schemas.token import Token
-from backend.app.admin.schemas.user import Auth, Auth2
-from backend.app.admin.services.user_service import UserService
-from backend.common.jwt import DependsJwtUser
-from backend.common.response.response_schema import response_base
+from backend.app.admin.schema.token import GetLoginToken, GetSwaggerToken
+from backend.app.admin.schema.user import Auth2
+from backend.app.admin.service.auth_service import auth_service
+from backend.common.response.response_schema import ResponseModel, ResponseSchemaModel, response_base
+from backend.common.security.jwt import DependsJwtAuth
 
 router = APIRouter()
 
 
-@router.post('/swagger_login', summary='swagger 表单登录', description='form 格式登录，仅用于 swagger 文档调试接口')
-async def login1(form_data: OAuth2PasswordRequestForm = Depends()) -> Token:
-    token, user = await UserService.login_swagger(form_data)
-    return Token(access_token=token, user=user)
+@router.post('/login/swagger', summary='swagger 调试专用', description='用于快捷进行 swagger 认证')
+async def swagger_login(form_data: OAuth2PasswordRequestForm = Depends()) -> GetSwaggerToken:
+    token, user = await auth_service.swagger_login(form_data=form_data)
+    return GetSwaggerToken(access_token=token, user=user)  # type: ignore
 
 
-@router.post('/login', summary='json登录')
-async def login2(obj: Auth) -> Token:
-    token, user = await UserService.login_json(obj)
-    return Token(access_token=token, user=user)
+@router.post('/login', summary='验证码登录')
+async def user_login(request: Request, obj: Auth2) -> ResponseSchemaModel[GetLoginToken]:
+    data = await auth_service.login(request=request, obj=obj)
+    return response_base.success(data=data)
 
 
-@router.post('/captcha_login', summary='验证码登录')
-async def login3(request: Request, obj: Auth2) -> Token:
-    token, user = await UserService.login_captcha(obj=obj, request=request)
-    return Token(access_token=token, user=user)
-
-
-@router.post('/logout', summary='登出', dependencies=[DependsJwtUser])
-async def user_logout():
-    return await response_base.response_200()
+@router.post('/logout', summary='用户登出', dependencies=[DependsJwtAuth])
+async def user_logout() -> ResponseModel:
+    return response_base.success()

backend/app/admin/api/v1/auth/captcha.py

@@ -1,22 +1,37 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+from uuid import uuid4
+
 from fast_captcha import img_captcha
 from fastapi import APIRouter, Depends, Request
 from fastapi_limiter.depends import RateLimiter
 from starlette.concurrency import run_in_threadpool
-from starlette.responses import StreamingResponse
 
-from backend.common.redis import redis_client
+from backend.app.admin.schema.captcha import GetCaptchaDetail
+from backend.common.response.response_schema import ResponseSchemaModel, response_base
 from backend.core.conf import settings
-from backend.utils.generate_string import get_uuid4_str
+from backend.database.redis import redis_client
 
 router = APIRouter()
 
 
-@router.get('/captcha', summary='获取验证码', dependencies=[Depends(RateLimiter(times=5, seconds=10))])
-async def get_captcha(request: Request):
-    img, code = await run_in_threadpool(img_captcha)
-    uuid = get_uuid4_str()
+@router.get(
+    '',
+    summary='获取登录验证码',
+    dependencies=[Depends(RateLimiter(times=5, seconds=10))],
+)
+async def get_captcha(request: Request) -> ResponseSchemaModel[GetCaptchaDetail]:
+    """
+    此接口可能存在性能损耗，尽管是异步接口，但是验证码生成是IO密集型任务，使用线程池尽量减少性能损耗
+    """
+    img_type: str = 'base64'
+    img, code = await run_in_threadpool(img_captcha, img_byte=img_type)
+    uuid = str(uuid4())
     request.app.state.captcha_uuid = uuid
-    await redis_client.set(uuid, code, settings.CAPTCHA_EXPIRATION_TIME)
-    return StreamingResponse(content=img, media_type='image/jpeg')
+    await redis_client.set(
+        f'{settings.CAPTCHA_LOGIN_REDIS_PREFIX}:{uuid}',
+        code,
+        ex=settings.CAPTCHA_LOGIN_EXPIRE_SECONDS,
+    )
+    data = GetCaptchaDetail(image_type=img_type, image=img)
+    return response_base.success(data=data)