add more code

Author: wu-clan

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

@@ -4,38 +4,45 @@
 
 from fastapi import APIRouter, Depends, Path, Query
 
-from backend.app.admin.schema.config import CreateConfigParam, UpdateConfigParam
+from backend.app.admin.schema.config import (
+    CreateAnyConfigParam,
+    GetAnyConfigListDetails,
+    SaveConfigParam,
+    UpdateAnyConfigParam,
+)
 from backend.app.admin.service.config_service import config_service
+from backend.common.pagination import DependsPagination, paging_data
 from backend.common.response.response_schema import ResponseModel, response_base
 from backend.common.security.jwt import DependsJwtAuth
 from backend.common.security.permission import RequestPermission
 from backend.common.security.rbac import DependsRBAC
+from backend.database.db_mysql import CurrentSession
 
 router = APIRouter()
 
 
 @router.get('/website', summary='获取网站配置信息', dependencies=[DependsJwtAuth])
 async def get_website_config() -> ResponseModel:
-    config = config_service.get_website()
+    config = await config_service.get_website()
     return response_base.success(data=config)
 
 
 @router.post(
     '/website',
     summary='保存网站配置信息',
     dependencies=[
-        Depends(RequestPermission('sys:config:add')),
+        Depends(RequestPermission('sys:config:website:add')),
         DependsRBAC,
     ],
 )
-async def save_website_config() -> ResponseModel:
-    await config_service.save_website()
+async def save_website_config(obj: SaveConfigParam) -> ResponseModel:
+    await config_service.save_website(obj)
     return response_base.success()
 
 
 @router.get('/protocol', summary='获取用户协议', dependencies=[DependsJwtAuth])
 async def get_protocol_config() -> ResponseModel:
-    config = config_service.get_protocol()
+    config = await config_service.get_protocol()
     return response_base.success(data=config)
 
 
@@ -47,14 +54,14 @@ async def get_protocol_config() -> ResponseModel:
         DependsRBAC,
     ],
 )
-async def save_protocol_config() -> ResponseModel:
-    await config_service.save_protocol()
+async def save_protocol_config(obj: SaveConfigParam) -> ResponseModel:
+    await config_service.save_protocol(obj)
     return response_base.success()
 
 
 @router.get('/policy', summary='获取用户政策', dependencies=[DependsJwtAuth])
 async def get_policy_config() -> ResponseModel:
-    config = config_service.get_policy()
+    config = await config_service.get_policy()
     return response_base.success(data=config)
 
 
@@ -66,39 +73,57 @@ async def get_policy_config() -> ResponseModel:
         DependsRBAC,
     ],
 )
-async def save_policy_config() -> ResponseModel:
-    await config_service.save_policy()
+async def save_policy_config(obj: SaveConfigParam) -> ResponseModel:
+    await config_service.save_policy(obj)
     return response_base.success()
 
 
-@router.get('/{pk}', summary='获取系统配置详情', dependencies=[DependsJwtAuth])
+@router.get('/{pk}', summary='获取系统参数配置详情', dependencies=[DependsJwtAuth])
 async def get_config(pk: Annotated[int, Path(...)]) -> ResponseModel:
     config = await config_service.get(pk)
     return response_base.success(data=config)
 
 
+@router.get(
+    '',
+    summary='（模糊条件）分页获取所有系统参数配置',
+    dependencies=[
+        DependsJwtAuth,
+        DependsPagination,
+    ],
+)
+async def get_pagination_config(
+    db: CurrentSession,
+    name: Annotated[str | None, Query()] = None,
+    type: Annotated[str | None, Query()] = None,
+) -> ResponseModel:
+    config_select = await config_service.get_select(name=name, type=type)
+    page_data = await paging_data(db, config_select, GetAnyConfigListDetails)
+    return response_base.success(data=page_data)
+
+
 @router.post(
     '',
-    summary='创建系统配置',
+    summary='创建系统参数配置',
     dependencies=[
         Depends(RequestPermission('sys:config:add')),
         DependsRBAC,
     ],
 )
-async def create_config(obj: CreateConfigParam) -> ResponseModel:
+async def create_config(obj: CreateAnyConfigParam) -> ResponseModel:
     await config_service.create(obj=obj)
     return response_base.success()
 
 
 @router.put(
     '/{pk}',
-    summary='更新系统配置',
+    summary='更新系统参数配置',
     dependencies=[
         Depends(RequestPermission('sys:config:edit')),
         DependsRBAC,
     ],
 )
-async def update_config(pk: Annotated[int, Path(...)], obj: UpdateConfigParam) -> ResponseModel:
+async def update_config(pk: Annotated[int, Path(...)], obj: UpdateAnyConfigParam) -> ResponseModel:
     count = await config_service.update(pk=pk, obj=obj)
     if count > 0:
         return response_base.success()
@@ -107,7 +132,7 @@ async def update_config(pk: Annotated[int, Path(...)], obj: UpdateConfigParam) -
 
 @router.delete(
     '',
-    summary='（批量）删除系统配置',
+    summary='（批量）删除系统参数配置',
     dependencies=[
         Depends(RequestPermission('sys:config:del')),
         DependsRBAC,

backend/app/admin/conf.py

@@ -31,7 +31,7 @@ class AdminSettings(BaseSettings):
     CAPTCHA_LOGIN_EXPIRE_SECONDS: int = 60 * 5  # 过期时间，单位：秒
 
     # Config
-    CONFIG_REDIS_KEY: str = 'fba:config'
+    CONFIG_BUILT_IN_TYPES: list = ['website', 'protocol', 'policy']
 
 
 @lru_cache

backend/app/admin/crud/crud_config.py

@@ -2,35 +2,62 @@
 # -*- coding: utf-8 -*-
 from typing import Sequence
 
-from sqlalchemy import select
+from sqlalchemy import Select
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy_crud_plus import CRUDPlus
 
+from backend.app.admin.conf import admin_settings
 from backend.app.admin.model import Config
-from backend.app.admin.schema.config import CreateConfigParam, UpdateConfigParam
+from backend.app.admin.schema.config import CreateAnyConfigParam, UpdateAnyConfigParam
 
 
 class CRUDConfig(CRUDPlus[Config]):
-    async def get_one(self, db: AsyncSession) -> Config | None:
+    async def get(self, db: AsyncSession, pk: int) -> Config | None:
         """
-        获取 Config
+        获取系统参数配置
 
         :param db:
+        :param pk:
+        :return:
+        """
+        return await self.select_model_by_column(db, id=pk, type__not_in=admin_settings.CONFIG_BUILT_IN_TYPES)
+
+    async def get_by_type(self, db: AsyncSession, type: str) -> Sequence[Config]:
+        """
+        通过 type 获取系统配置参数
+
+        :param db:
+        :param type:
         :return:
         """
-        query = await db.execute(select(self.model).limit(1))
-        return query.scalars().first()
+        return await self.select_models(db, type=type)
 
-    async def get_all(self, db: AsyncSession) -> Sequence[Config]:
+    async def get_by_name(self, db: AsyncSession, name: str) -> Config | None:
         """
-        获取所有 Config
+        通过 name 获取系统配置参数
 
         :param db:
+        :param name:
+        :return:
+        """
+        return await self.select_model_by_column(db, name=name, type__not_in=admin_settings.CONFIG_BUILT_IN_TYPES)
+
+    async def get_list(self, name: str = None, type: str = None) -> Select:
+        """
+        获取系统参数配置列表
+
+        :param name:
+        :param type:
         :return:
         """
-        return await self.select_models(db)
+        filters = {'name__not_in': admin_settings.CONFIG_BUILT_IN_TYPES}
+        if name is not None:
+            filters.update(name__like=f'%{name}%')
+        if type is not None:
+            filters.update(type__like=f'%{type}%')
+        return await self.select_order('created_time', 'desc', **filters)
 
-    async def create(self, db: AsyncSession, obj_in: CreateConfigParam) -> None:
+    async def create(self, db: AsyncSession, obj_in: CreateAnyConfigParam) -> None:
         """
         创建 Config
 
@@ -40,7 +67,7 @@ async def create(self, db: AsyncSession, obj_in: CreateConfigParam) -> None:
         """
         await self.create_model(db, obj_in)
 
-    async def update(self, db: AsyncSession, pk: int, obj_in: UpdateConfigParam) -> int:
+    async def update(self, db: AsyncSession, pk: int, obj_in: UpdateAnyConfigParam) -> int:
         """
         更新 Config
 

backend/app/admin/model/sys_config.py

@@ -15,7 +15,7 @@ class Config(Base):
     id: Mapped[id_key] = mapped_column(init=False)
     name: Mapped[str] = mapped_column(String(20), comment='名称')
     type: Mapped[str | None] = mapped_column(String(20), server_default=None, comment='类型')
-    key: Mapped[str] = mapped_column(String(50), comment='键名')
+    key: Mapped[str] = mapped_column(String(50), unique=True, comment='键名')
     value: Mapped[str] = mapped_column(LONGTEXT, comment='键值')
     is_frontend: Mapped[str] = mapped_column(Boolean, default=False, comment='是否前端')
     remark: Mapped[str | None] = mapped_column(LONGTEXT, default=None, comment='备注')

backend/app/admin/schema/config.py

@@ -7,30 +7,17 @@
 from backend.common.schema import SchemaBase
 
 
-class ConfigSchemaBase(SchemaBase):
+class SaveConfigParam(SchemaBase):
     name: str
     key: str
     value: str
 
 
-class CreateConfigParam(ConfigSchemaBase):
-    pass
-
-
-class UpdateConfigParam(ConfigSchemaBase):
-    pass
-
-
-class GetConfigListDetails(ConfigSchemaBase):
-    model_config = ConfigDict(from_attributes=True)
-
-    id: int
-    created_time: datetime
-    updated_time: datetime | None = None
-
-
-class AnyConfigSchemaBase(ConfigSchemaBase):
+class AnyConfigSchemaBase(SchemaBase):
+    name: str
     type: str | None
+    key: str
+    value: str
     is_frontend: bool
     remark: str
 

backend/app/admin/service/api_service.py

@@ -41,6 +41,9 @@ async def create(*, obj: CreateApiParam) -> None:
     @staticmethod
     async def update(*, pk: int, obj: UpdateApiParam) -> int:
         async with async_db_session.begin() as db:
+            api = await api_dao.get(db, pk)
+            if not api:
+                raise errors.NotFoundError(msg='接口不存在')
             count = await api_dao.update(db, pk, obj)
             return count
 

backend/app/admin/service/config_service.py

@@ -1,38 +1,88 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+from typing import Sequence
+
+from sqlalchemy import Select
+
+from backend.app.admin.conf import admin_settings
 from backend.app.admin.crud.crud_config import config_dao
 from backend.app.admin.model import Config
-from backend.app.admin.schema.config import CreateConfigParam, UpdateConfigParam
+from backend.app.admin.schema.config import (
+    CreateAnyConfigParam,
+    SaveConfigParam,
+    UpdateAnyConfigParam,
+)
 from backend.common.exception import errors
 from backend.database.db_mysql import async_db_session
 
 
 class ConfigService:
     @staticmethod
-    async def get() -> Config | dict:
+    async def get_website() -> Sequence[Config]:
+        async with async_db_session() as db:
+            return await config_dao.get_by_type(db, 'website')
+
+    @staticmethod
+    async def save_website(obj: SaveConfigParam):
+        async with async_db_session.begin() as db:
+            config = await config_dao.get_by_name(db, obj.name)
+            if config is None:
+                await config_dao.create_models()
+
+    @staticmethod
+    async def get_protocol() -> Sequence[Config]:
+        async with async_db_session() as db:
+            return await config_dao.get_by_type(db, 'protocol')
+
+    @staticmethod
+    async def save_protocol(obj: SaveConfigParam):
+        pass
+
+    @staticmethod
+    async def get_policy() -> Sequence[Config]:
         async with async_db_session() as db:
-            config = await config_dao.get(db)
+            return await config_dao.get_by_type(db, 'policy')
+
+    @staticmethod
+    async def save_policy(obj: SaveConfigParam):
+        pass
+
+    @staticmethod
+    async def get(pk) -> Config | dict:
+        async with async_db_session() as db:
+            config = await config_dao.get(db, pk)
             if not config:
-                raise errors.NotFoundError(msg='配置不存在')
+                raise errors.NotFoundError(msg='参数配置不存在')
             return config
 
     @staticmethod
-    async def get_select(): ...
+    async def get_select(*, name: str = None, type: str = None) -> Select:
+        return await config_dao.get_list(name=name, type=type)
 
     @staticmethod
-    async def create(*, obj: CreateConfigParam) -> None:
-        async with async_db_session.begin():
-            ...
+    async def create(*, obj: CreateAnyConfigParam) -> None:
+        async with async_db_session.begin() as db:
+            config = await config_dao.get_by_name(db, obj.name)
+            if config:
+                raise errors.ForbiddenError(msg='参数配置已存在')
+            if obj.type in admin_settings.CONFIG_BUILT_IN_TYPES:
+                raise errors.ForbiddenError(msg='非法类型参数')
+            await config_dao.create(db, obj)
 
     @staticmethod
-    async def update(*, pk: int, obj: UpdateConfigParam) -> int:
-        async with async_db_session.begin():
-            ...
+    async def update(*, pk: int, obj: UpdateAnyConfigParam) -> int:
+        async with async_db_session.begin() as db:
+            config = await config_dao.get(db, pk)
+            if not config:
+                raise errors.NotFoundError(msg='参数配置不存在')
+            count = await config_dao.update(db, pk, obj)
+            return count
 
     @staticmethod
     async def delete(*, pk: list[int]) -> int:
-        async with async_db_session.begin():
-            ...
+        async with async_db_session.begin() as db:
+            count = await config_dao.delete(db, pk)
+            return count
 
 
 config_service: ConfigService = ConfigService()