Add local file upload interfaces (#489)

* Add the alibaba cloud oss plugin

* Update oss plugin struct

* Add local upload

Author: wu-clan

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

@@ -10,6 +10,7 @@
 from backend.app.admin.api.v1.sys.menu import router as menu_router
 from backend.app.admin.api.v1.sys.role import router as role_router
 from backend.app.admin.api.v1.sys.token import router as token_router
+from backend.app.admin.api.v1.sys.upload import router as upload_router
 from backend.app.admin.api.v1.sys.user import router as user_router
 
 router = APIRouter(prefix='/sys')
@@ -23,3 +24,4 @@
 router.include_router(user_router, prefix='/users', tags=['系统用户'])
 router.include_router(data_rule_router, prefix='/data-rules', tags=['系统数据权限规则'])
 router.include_router(token_router, prefix='/tokens', tags=['系统令牌'])
+router.include_router(upload_router, prefix='/upload', tags=['系统上传'])

backend/app/admin/api/v1/sys/upload.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+from typing import Annotated
+
+from fastapi import APIRouter, File, UploadFile
+
+from backend.common.dataclasses import UploadUrl
+from backend.common.enums import FileType
+from backend.common.response.response_schema import ResponseSchemaModel, response_base
+from backend.common.security.jwt import DependsJwtAuth
+from backend.utils.file_ops import file_verify, upload_file
+
+router = APIRouter()
+
+
+@router.post('/image', summary='上传图片', dependencies=[DependsJwtAuth])
+async def upload_image(file: Annotated[UploadFile, File()]) -> ResponseSchemaModel[UploadUrl]:
+    file_verify(file, FileType.image)
+    filename = await upload_file(file)
+    return response_base.success(data={'url': f'/static/upload/{filename}'})
+
+
+@router.post('/video', summary='上传视频', dependencies=[DependsJwtAuth])
+async def upload_video(file: Annotated[UploadFile, File()]) -> ResponseSchemaModel[UploadUrl]:
+    file_verify(file, FileType.video)
+    filename = await upload_file(file)
+    return response_base.success(data={'url': f'/static/upload/{filename}'})

backend/app/generator/conf.py

@@ -2,16 +2,12 @@
 # -*- coding: utf-8 -*-
 from functools import lru_cache
 
-from pydantic_settings import BaseSettings, SettingsConfigDict
-
-from backend.core.path_conf import BasePath
+from pydantic_settings import BaseSettings
 
 
 class GeneratorSettings(BaseSettings):
     """Admin Settings"""
 
-    model_config = SettingsConfigDict(env_file=f'{BasePath}/.env', env_file_encoding='utf-8', extra='ignore')
-
     # 模版目录
     TEMPLATE_BACKEND_DIR_NAME: str = 'py'
 

backend/common/dataclasses.py

@@ -59,3 +59,8 @@ class TokenPayload:
     id: int
     session_uuid: str
     expire_time: datetime
+
+
+@dataclasses.dataclass
+class UploadUrl:
+    url: str

backend/common/enums.py

@@ -103,6 +103,13 @@ class UserSocialType(StrEnum):
     linuxdo = 'LinuxDo'
 
 
+class FileType(StrEnum):
+    """文件类型"""
+
+    image = 'image'
+    video = 'video'
+
+
 class GenModelMySQLColumnType(StrEnum):
     """代码生成模型列类型（MySQL）"""
 

backend/core/conf.py

@@ -48,6 +48,13 @@ class Settings(BaseSettings):
     FASTAPI_OPENAPI_URL: str | None = '/openapi'
     FASTAPI_STATIC_FILES: bool = True
 
+    # Upload
+    UPLOAD_READ_SIZE: int = 1024  # 上传文件时分片读取大小
+    UPLOAD_IMAGE_EXT_INCLUDE: list[str] = ['jpg', 'jpeg', 'png', 'gif', 'webp']
+    UPLOAD_IMAGE_SIZE_MAX: int = 1024 * 1024 * 5
+    UPLOAD_VIDEO_EXT_INCLUDE: list[str] = ['mp4', 'mov', 'avi', 'flv']
+    UPLOAD_VIDEO_SIZE_MAX: int = 1024 * 1024 * 20
+
     # Database
     DATABASE_ECHO: bool = False
     DATABASE_SCHEMA: str = 'fba'
@@ -114,7 +121,6 @@ class Settings(BaseSettings):
     CORS_ALLOWED_ORIGINS: list[str] = [
         'http://127.0.0.1:8000',
         'http://localhost:5173',  # 前端地址，末尾不要带 '/'
-        'http://localhost:63342',
     ]
     CORS_EXPOSE_HEADERS: list[str] = [
         TRACE_ID_REQUEST_HEADER_KEY,

backend/core/path_conf.py

@@ -17,9 +17,12 @@
 # 离线 IP 数据库路径
 IP2REGION_XDB = os.path.join(BasePath, 'static', 'ip2region.xdb')
 
-# 挂载静态目录
+# 静态资源目录
 STATIC_DIR = os.path.join(BasePath, 'static')
 
+# 上传文件目录
+UPLOAD_DIR = os.path.join(BasePath, 'static', 'upload')
+
 # jinja2 模版文件路径
 JINJA2_TEMPLATE_DIR = os.path.join(BasePath, 'templates')
 

backend/core/registrar.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+import os
+
 from contextlib import asynccontextmanager
 
 import socketio
@@ -9,11 +11,12 @@
 from fastapi_limiter import FastAPILimiter
 from fastapi_pagination import add_pagination
 from starlette.middleware.authentication import AuthenticationMiddleware
+from starlette.staticfiles import StaticFiles
 
 from backend.common.exception.exception_handler import register_exception
 from backend.common.log import set_customize_logfile, setup_logging
 from backend.core.conf import settings
-from backend.core.path_conf import STATIC_DIR
+from backend.core.path_conf import STATIC_DIR, UPLOAD_DIR
 from backend.database.db import create_table
 from backend.database.redis import redis_client
 from backend.middleware.jwt_auth_middleware import JwtAuthMiddleware
@@ -101,14 +104,17 @@ def register_logger() -> None:
 
 def register_static_file(app: FastAPI):
     """
-    静态文件交互开发模式, 生产将自动关闭，生产必须使用 nginx 静态资源服务
+    静态资源服务，生产应使用 nginx 代理静态资源服务
 
     :param app:
     :return:
     """
+    # 上传静态资源
+    if not os.path.exists(UPLOAD_DIR):
+        os.makedirs(UPLOAD_DIR)
+    app.mount('/static/upload', StaticFiles(directory=UPLOAD_DIR), name='upload')
+    # 固有静态资源
     if settings.FASTAPI_STATIC_FILES:
-        from fastapi.staticfiles import StaticFiles
-
         app.mount('/static', StaticFiles(directory=STATIC_DIR), name='static')
 
 

backend/plugin/tools.py

@@ -169,8 +169,18 @@ async def install_requirements_async() -> None:
         if not os.path.exists(requirements_file):
             continue
         else:
-            await async_subprocess.create_subprocess_exec(sys.executable, '-m', 'ensurepip', '--upgrade')
-            res = await async_subprocess.create_subprocess_exec(
+            ensurepip_process = await async_subprocess.create_subprocess_exec(
+                sys.executable,
+                '-m',
+                'ensurepip',
+                '--upgrade',
+                stdout=asyncio.subprocess.PIPE,
+                stderr=asyncio.subprocess.PIPE,
+            )
+            _, ensurepip_stderr = await ensurepip_process.communicate()
+            if ensurepip_process.returncode != 0:
+                raise PluginInjectError(f'ensurepip 安装失败：{ensurepip_stderr}')
+            pip_process = await async_subprocess.create_subprocess_exec(
                 sys.executable,
                 '-m',
                 'pip',
@@ -180,6 +190,6 @@ async def install_requirements_async() -> None:
                 stdout=asyncio.subprocess.PIPE,
                 stderr=asyncio.subprocess.PIPE,
             )
-            _, stderr = await res.communicate()
-            if res.returncode != 0:
-                raise PluginInjectError(f'插件 {plugin} 依赖包安装失败：{stderr}')
+            _, pip_stderr = await pip_process.communicate()
+            if pip_process.returncode != 0:
+                raise PluginInjectError(f'插件 {plugin} 依赖包安装失败：{pip_stderr}')

backend/utils/file_ops.py

@@ -0,0 +1,75 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+import os
+
+import aiofiles
+
+from fastapi import UploadFile
+
+from backend.common.enums import FileType
+from backend.common.exception import errors
+from backend.common.log import log
+from backend.core.conf import settings
+from backend.core.path_conf import UPLOAD_DIR
+from backend.utils.timezone import timezone
+
+
+def build_filename(file: UploadFile):
+    """
+    构建文件名
+
+    :param file:
+    :return:
+    """
+    timestamp = int(timezone.now().timestamp())
+    filename = file.filename
+    file_ext = filename.split('.')[-1].lower()
+    new_filename = f'{filename.replace(f".{file_ext}", f"_{timestamp}")}.{file_ext}'
+    return new_filename
+
+
+def file_verify(file: UploadFile, file_type: FileType) -> None:
+    """
+    文件验证
+
+    :param file:
+    :param file_type:
+    :return:
+    """
+    filename = file.filename
+    file_ext = filename.split('.')[-1].lower()
+    if not file_ext:
+        raise errors.ForbiddenError(msg='未知的文件类型')
+    if file_type == FileType.image:
+        if file_ext not in settings.UPLOAD_IMAGE_EXT_INCLUDE:
+            raise errors.ForbiddenError(msg='此图片格式暂不支持')
+        if file.size > settings.UPLOAD_IMAGE_SIZE_MAX:
+            raise errors.ForbiddenError(msg='图片超出最大限制，请重新选择')
+    elif file_type == FileType.video:
+        if file_ext not in settings.UPLOAD_VIDEO_EXT_INCLUDE:
+            raise errors.ForbiddenError(msg='此视频格式暂不支持')
+        if file.size > settings.UPLOAD_VIDEO_SIZE_MAX:
+            raise errors.ForbiddenError(msg='视频超出最大限制，请重新选择')
+
+
+async def upload_file(file: UploadFile):
+    """
+    上传文件
+
+    :param file:
+    :return:
+    """
+    filename = build_filename(file)
+    try:
+        async with aiofiles.open(os.path.join(UPLOAD_DIR, filename), mode='wb') as fb:
+            while True:
+                content = await file.read(settings.UPLOAD_READ_SIZE)
+                if not content:
+                    break
+                await fb.write(content)
+    except Exception as e:
+        log.error(f'上传文件 {filename} 失败：{str(e)}')
+        raise errors.RequestError(msg='上传文件失败')
+    finally:
+        await file.close()
+    return filename

deploy/backend/docker-compose/docker-compose.yml

@@ -81,6 +81,7 @@ services:
     volumes:
       - ../nginx.conf:/etc/nginx/conf.d/default.conf:ro
       - fba_static:/www/fba_server/backend/static
+      - fba_static_upload:/www/fba_server/backend/static/upload
     networks:
       - fba_network
 

deploy/backend/nginx.conf

@@ -48,4 +48,8 @@ server {
     location /static {
         alias /www/fba_server/backend/static;
     }
+
+    location /static/upload {
+        alias /www/fba_server/backend/static/upload;
+    }
 }