DjangoAdmin_FastAPI_EleVue/apps/__init__.py

# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 一米阳光团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 一米阳光团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意，禁止将本产品用于以下任何行为：
# | 1. 任何违反中华人民共和国法律法规的用途；
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为，本团队有权：
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================

import time
import traceback

from fastapi import FastAPI
from fastapi.encoders import jsonable_encoder
from fastapi.exceptions import RequestValidationError
from fastapi.logger import logger
from starlette import status
from starlette.requests import Request
from starlette.responses import JSONResponse

from extensions.exception import AuthorizationException, BusinessException
from extensions import register_extends
from routers import register_router
from apps.middleware import register_middleware, register_cros
from apps.middleware.db_session import db_session_middleware
from apps.middleware.operation_log import operation_log_middleware
from utils.redis_ctx import redis_lifespan, redis_middleware
from config.app import FASTAPI_DEBUG


# 创建应用
def create_app() -> FastAPI:
    # # 实例化应用并鉴权
    app = FastAPI(title="FastAPI",
                  description="FastAPI",
                  version="v1",
                  lifespan=redis_lifespan,
                  )

    # 注册跨域中间件
    register_cros(app)
    # 注册Redis上下文注入中间件（先注册→内层：先注入Redis再开DB会话）
    app.middleware("http")(redis_middleware)
    # 注册数据库会话中间件（后注册→外层：DB会话包裹业务逻辑，finally保证关闭）
    app.middleware("http")(db_session_middleware)
    # 注册操作日志中间件（在DB会话内层，记录写操作日志）
    app.middleware("http")(operation_log_middleware)
    # 注册路由
    register_router(app)
    # 初始化扩展
    register_extends(app)
    # 登录检测
    register_middleware(app)
    # 注册全局异常处理
    register_exception(app)

    # 请求计时（最后注册→最外层，统计完整耗时）
    @app.middleware("http")
    async def add_process_time_header(request: Request, call_next):
        # 开始时间
        start_time = time.time()
        response = await call_next(request)
        # 过程时间
        process_time = time.time() - start_time
        # X- 作为前缀代表专有自定义请求头
        response.headers["X-Process-Time"] = str(round(process_time, 5))
        if FASTAPI_DEBUG:
            logger.info(f"访问记录:{request.method} url:{request.url}  耗时:{str(round(process_time, 5))}")
        # 放行
        return response

    # 返回应用
    return app


# 注册全局异常处理
def register_exception(app: FastAPI):
    """
    全局异常捕获
    :param app:
    :return:
    """

    # 登录认证异常处理执行句柄
    @app.exception_handler(AuthorizationException)
    async def unicorn_exception_handler(request: Request, exc: AuthorizationException):
        return JSONResponse(
            status_code=200,
            content={
                "code": exc.code,
                "data": None,
                "msg": exc.msg,
                "ok": False,
            },
        )

    # 业务异常处理执行句柄
    @app.exception_handler(BusinessException)
    async def business_exception_handler(request: Request, exc: BusinessException):
        return JSONResponse(
            status_code=200,
            content={
                "code": exc.code,
                "data": None,
                "msg": exc.msg,
                "ok": False,
            },
        )

    # Pydantic 请求参数校验异常处理
    @app.exception_handler(RequestValidationError)
    async def validation_exception_handler(request: Request, exc: RequestValidationError):
        errors = []
        for err in exc.errors():
            # 取字段路径最后一段作为字段名
            field = err.get("loc", [""])[-1]
            msg = err.get("msg", "")
            if field and field != "body":
                errors.append(f"{field}: {msg}")
            else:
                errors.append(msg)
        return JSONResponse(
            status_code=200,
            content={"code": 1, "data": None, "msg": "/".join(errors)},
        )