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

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.8.2
     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.21.0
     hooks:
       - id: pdm-export
         args:

README.md

@@ -1,21 +1,5 @@
 # FastAPI SQLAlchemy MySQL
 
-[![Static Badge](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/downloads/)
-
-> [!TIP]
-> 此仓库是我们构建的 FastAPI 基础架构便捷版，完整版请查看：
-> [fastapi_best_architecture](https://github.com/fastapi-practices/fastapi_best_architecture)
-
-## 特征
-
-- [x] FastAPI
-- [x] Async design
-- [x] Restful API
-- [x] SQLAlchemy 2.0
-- [x] Pydantic 2.0
-- [x] Docker
-- [ ] ......
-
 ## 本地开发
 
 * Python 3.10+
@@ -35,7 +19,7 @@
    ```shell
    cd backend
    ```
-   
+
 5. 创建一个 `.env` 文件
 
    ```shell
@@ -63,40 +47,30 @@
    # 开发模式
    fastapi dev main.py
    ```
-   
+
 9. 浏览器访问: http://127.0.0.1:8000/api/v1/docs
 
 ---
 
 ### Docker
 
-> [!WARNING]
->
-> 默认端口冲突：8000，3306，6379
->
-> 建议在部署前关闭本地服务：mysql，redis...
-
 1. 进入 `docker-compose.yml` 文件所在目录，创建环境变量文件 `.env`
 
-    ```shell
-    cd deploy/docker-compose/
+   ```shell
+   cd deploy/docker-compose/
    
-    cp .env.server ../../../backend/.env
-    ```
+   cp .env.server ../../../backend/.env
+   ```
 
 2. 执行一键启动命令
 
-    ```shell
-    docker-compose up -d --build
-    ```
+   ```shell
+   docker-compose up -d --build
+   ```
 
 3. 等待命令自动完成
 4. 浏览器访问：http://127.0.0.1:8000/api/v1/docs
 
-## 互动
-
-[WeChat / QQ](https://github.com/wu-clan)
-
 ## 赞助
 
 如果此项目能够帮助到你，你可以赞助作者一些咖啡豆表示鼓励：[:coffee: Sponsor :coffee:](https://wu-clan.github.io/sponsor/)

backend/app/admin/api/router.py

@@ -4,9 +4,8 @@
 
 from backend.app.admin.api.v1.auth import router as auth_router
 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()
 
-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,27 +3,27 @@
 from fastapi import APIRouter, Depends, Request
 from fastapi.security import OAuth2PasswordRequestForm
 
-from backend.common.jwt import DependsJwtUser
+from backend.app.admin.service.auth_service import auth_service
+from backend.common.security.jwt import DependsJwtAuth
 from backend.common.response.response_schema import response_base, ResponseModel
-from backend.app.admin.schema.token import Token
+from backend.app.admin.schema.token import GetSwaggerToken, GetLoginToken
 from backend.app.admin.schema.user import Auth2
-from backend.app.admin.service.user_service import UserService
 
 router = APIRouter()
 
 
-@router.post('/login/swagger', summary='swagger 表单登录', description='form 格式登录，仅用于 swagger 文档调试接口')
-async def swagger_login(form_data: OAuth2PasswordRequestForm = Depends()) -> Token:
-    token, user = await UserService.login_swagger(form_data=form_data)
-    return Token(access_token=token, user=user)  # type: ignore
+@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='验证码登录')
-async def user_login(request: Request, obj: Auth2) -> Token:
-    token, user = await UserService.login_captcha(obj=obj, request=request)
-    return Token(access_token=token, user=user)  # type: ignore
+async def user_login(request: Request, obj: Auth2) -> ResponseModel:
+    data = await auth_service.login(request=request, obj=obj)
+    return response_base.success(data=data)
 
 
-@router.post('/logout', summary='登出', dependencies=[DependsJwtUser])
+@router.post('/logout', summary='用户登出', dependencies=[DependsJwtAuth])
 async def user_logout() -> ResponseModel:
-    return await response_base.success()
+    return response_base.success()

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

@@ -1,22 +1,35 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 from fast_captcha import img_captcha
-from fastapi import APIRouter, Request, Depends
+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.response.response_schema import ResponseModel, response_base
+from backend.core.conf import settings
 from backend.database.db_mysql import uuid4_str
 from backend.database.db_redis import redis_client
-from backend.core.conf import settings
 
 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)
+@router.get(
+    '',
+    summary='获取登录验证码',
+    dependencies=[Depends(RateLimiter(times=5, seconds=10))],
+)
+async def get_captcha(request: Request) -> ResponseModel:
+    """
+    此接口可能存在性能损耗，尽管是异步接口，但是验证码生成是IO密集型任务，使用线程池尽量减少性能损耗
+    """
+    img_type: str = 'base64'
+    img, code = await run_in_threadpool(img_captcha, img_byte=img_type)
     uuid = uuid4_str()
     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_EXPIRATION_TIME)
+    return response_base.success(
+        data={
+            'image_type': img_type,
+            'image': img,
+        }
+    )

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

@@ -4,7 +4,7 @@
 
 from fastapi import APIRouter, Query
 
-from backend.common.jwt import CurrentUser, DependsJwtUser
+from backend.common.security.jwt import CurrentUser, DependsJwtAuth
 from backend.common.pagination import paging_data, DependsPagination
 from backend.common.response.response_schema import response_base, ResponseModel
 from backend.database.db_mysql import CurrentSession
@@ -18,41 +18,41 @@
 @router.post('/register', summary='用户注册')
 async def user_register(obj: CreateUser) -> ResponseModel:
     await UserService.register(obj=obj)
-    return await response_base.success()
+    return response_base.success()
 
 
-@router.post('/password/reset', summary='密码重置', dependencies=[DependsJwtUser])
+@router.post('/password/reset', summary='密码重置', dependencies=[DependsJwtAuth])
 async def password_reset(obj: ResetPassword) -> ResponseModel:
     count = await UserService.pwd_reset(obj=obj)
     if count > 0:
-        return await response_base.success()
-    return await response_base.fail()
+        return response_base.success()
+    return response_base.fail()
 
 
-@router.get('/{username}', summary='查看用户信息', dependencies=[DependsJwtUser])
+@router.get('/{username}', summary='查看用户信息', dependencies=[DependsJwtAuth])
 async def get_user(username: str) -> ResponseModel:
     current_user = await UserService.get_userinfo(username=username)
-    data = GetUserInfo(**await select_as_dict(current_user))
-    return await response_base.success(data=data)
+    data = GetUserInfo(**select_as_dict(current_user))
+    return response_base.success(data=data)
 
 
-@router.put('/{username}', summary='更新用户信息', dependencies=[DependsJwtUser])
+@router.put('/{username}', summary='更新用户信息', dependencies=[DependsJwtAuth])
 async def update_userinfo(username: str, obj: UpdateUser) -> ResponseModel:
     count = await UserService.update(username=username, obj=obj)
     if count > 0:
-        return await response_base.success()
-    return await response_base.fail()
+        return response_base.success()
+    return response_base.fail()
 
 
-@router.put('/{username}/avatar', summary='更新头像', dependencies=[DependsJwtUser])
+@router.put('/{username}/avatar', summary='更新头像', dependencies=[DependsJwtAuth])
 async def update_avatar(username: str, avatar: Avatar) -> ResponseModel:
     count = await UserService.update_avatar(username=username, avatar=avatar)
     if count > 0:
-        return await response_base.success()
-    return await response_base.fail()
+        return response_base.success()
+    return response_base.fail()
 
 
-@router.get('', summary='（模糊条件）分页获取所有用户', dependencies=[DependsJwtUser, DependsPagination])
+@router.get('', summary='（模糊条件）分页获取所有用户', dependencies=[DependsJwtAuth, DependsPagination])
 async def get_all_users(
     db: CurrentSession,
     username: Annotated[str | None, Query()] = None,
@@ -61,33 +61,17 @@ async def get_all_users(
 ) -> ResponseModel:
     user_select = await UserService.get_select(username=username, phone=phone, status=status)
     page_data = await paging_data(db, user_select, GetUserInfo)
-    return await response_base.success(data=page_data)
-
-
-@router.put('/{pk}/super', summary='修改用户超级权限', dependencies=[DependsJwtUser])
-async def super_set(current_user: CurrentUser, pk: int) -> ResponseModel:
-    count = await UserService.update_permission(current_user=current_user, pk=pk)
-    if count > 0:
-        return await response_base.success()
-    return await response_base.fail()
-
-
-@router.put('/{pk}/status', summary='修改用户状态', dependencies=[DependsJwtUser])
-async def status_set(current_user: CurrentUser, pk: int) -> ResponseModel:
-    count = await UserService.update_status(current_user=current_user, pk=pk)
-    if count > 0:
-        return await response_base.success()
-    return await response_base.fail()
+    return response_base.success(data=page_data)
 
 
 @router.delete(
     path='/{username}',
     summary='用户注销',
     description='用户注销 != 用户登出，注销之后用户将从数据库删除',
-    dependencies=[DependsJwtUser],
+    dependencies=[DependsJwtAuth],
 )
 async def delete_user(current_user: CurrentUser, username: str) -> ResponseModel:
     count = await UserService.delete(current_user=current_user, username=username)
     if count > 0:
-        return await response_base.success()
-    return await response_base.fail()
+        return response_base.success()
+    return response_base.fail()