添加系统消息有关实体类服务类控制类等

This commit is contained in:
haotian 2025-07-30 10:22:32 +08:00
parent a42403c49a
commit b9ea308be1
5 changed files with 470 additions and 0 deletions

View File

@ -0,0 +1,113 @@
from datetime import datetime
from fastapi import APIRouter, Depends, Form, Request
from pydantic_validation_decorator import ValidateFields
from sqlalchemy.ext.asyncio import AsyncSession
from config.enums import BusinessType
from config.get_db import get_db
from module_admin.annotation.log_annotation import Log
from module_admin.aspect.interface_auth import CheckUserInterfaceAuth
from module_admin.entity.vo.user_vo import CurrentUserModel
from module_admin.service.login_service import LoginService
from module_admin.service.message_service import MessageService
from module_admin.entity.vo.message_vo import DeleteMessageModel, MessageModel, MessagePageQueryModel
from utils.common_util import bytes2file_response
from utils.log_util import logger
from utils.page_util import PageResponseModel
from utils.response_util import ResponseUtil
messageController = APIRouter(prefix='/system/message', dependencies=[Depends(LoginService.get_current_user)])
@messageController.get(
'/list', response_model=PageResponseModel
# , dependencies=[Depends(CheckUserInterfaceAuth('system:message:list'))]
)
async def get_system_message_list(
request: Request,
message_page_query: MessagePageQueryModel = Depends(MessagePageQueryModel.as_query),
query_db: AsyncSession = Depends(get_db),
):
# 获取分页数据
message_page_query_result = await MessageService.get_message_list_services(query_db, message_page_query, is_page=True)
logger.info('获取成功')
return ResponseUtil.success(model_content=message_page_query_result)
@messageController.post(''
# , dependencies=[Depends(CheckUserInterfaceAuth('system:message:add'))]
)
@ValidateFields(validate_model='add_message')
@Log(title='系统消息', business_type=BusinessType.INSERT)
async def add_system_message(
request: Request,
add_message: MessageModel,
query_db: AsyncSession = Depends(get_db),
current_user: CurrentUserModel = Depends(LoginService.get_current_user),
):
add_message.create_time = datetime.now()
add_message.create_by = current_user.user.user_name
add_message.update_time = datetime.now()
add_message.update_by = current_user.user.user_name
add_message_result = await MessageService.add_message_services(query_db, add_message)
logger.info(add_message_result.message)
return ResponseUtil.success(msg=add_message_result.message)
@messageController.put(''
# , dependencies=[Depends(CheckUserInterfaceAuth('system:message:edit'))]
)
@ValidateFields(validate_model='edit_message')
@Log(title='系统消息', business_type=BusinessType.UPDATE)
async def edit_system_message(
request: Request,
edit_message: MessageModel,
query_db: AsyncSession = Depends(get_db),
current_user: CurrentUserModel = Depends(LoginService.get_current_user),
):
edit_message.update_by = current_user.user.user_name
edit_message.update_time = datetime.now()
edit_message_result = await MessageService.edit_message_services(query_db, edit_message)
logger.info(edit_message_result.message)
return ResponseUtil.success(msg=edit_message_result.message)
@messageController.delete('/{message_ids}'
, dependencies=[Depends(CheckUserInterfaceAuth('system:message:remove'))]
)
@Log(title='系统消息', business_type=BusinessType.DELETE)
async def delete_system_message(request: Request, message_ids: str, query_db: AsyncSession = Depends(get_db)):
delete_message = DeleteMessageModel(messageIds=message_ids)
delete_message_result = await MessageService.delete_message_services(query_db, delete_message)
logger.info(delete_message_result.message)
return ResponseUtil.success(msg=delete_message_result.message)
@messageController.get(
'/{message_id}', response_model=MessageModel
# , dependencies=[Depends(CheckUserInterfaceAuth('system:message:query'))]
)
async def query_detail_system_message(request: Request, message_id: int, query_db: AsyncSession = Depends(get_db)):
message_detail_result = await MessageService.message_detail_services(query_db, message_id)
logger.info(f'获取message_id为{message_id}的信息成功')
return ResponseUtil.success(data=message_detail_result)
# @messageController.post('/export', dependencies=[Depends(CheckUserInterfaceAuth('system:message:export'))])
# @Log(title='系统消息', business_type=BusinessType.EXPORT)
# async def export_system_message_list(
# request: Request,
# message_page_query: MessagePageQueryModel = Form(),
# query_db: AsyncSession = Depends(get_db),
# ):
# # 获取全量数据
# message_query_result = await MessageService.get_message_list_services(query_db, message_page_query, is_page=False)
# message_export_result = await MessageService.export_message_list_services(message_query_result)
# logger.info('导出成功')
#
# return ResponseUtil.streaming(data=bytes2file_response(message_export_result))

View File

@ -0,0 +1,119 @@
from sqlalchemy import delete, select, update
from sqlalchemy.ext.asyncio import AsyncSession
from module_admin.entity.do.message_do import Message
from module_admin.entity.vo.message_vo import MessageModel, MessagePageQueryModel
from utils.page_util import PageUtil
class MessageDao:
"""
系统消息模块数据库操作层
"""
@classmethod
async def get_message_detail_by_id(cls, db: AsyncSession, message_id: int):
"""
根据消息主键获取系统消息详细信息
:param db: orm对象
:param message_id: 消息主键
:return: 系统消息信息对象
"""
message_info = (
(
await db.execute(
select(Message)
.where(
Message.message_id == message_id
)
)
)
.scalars()
.first()
)
return message_info
@classmethod
async def get_message_detail_by_info(cls, db: AsyncSession, message: MessageModel):
"""
根据系统消息参数获取系统消息信息
:param db: orm对象
:param message: 系统消息参数对象
:return: 系统消息信息对象
"""
message_info = (
(
await db.execute(
select(Message).where(
)
)
)
.scalars()
.first()
)
return message_info
@classmethod
async def get_message_list(cls, db: AsyncSession, query_object: MessagePageQueryModel, is_page: bool = False):
"""
根据查询参数获取系统消息列表信息
:param db: orm对象
:param query_object: 查询参数对象
:param is_page: 是否开启分页
:return: 系统消息列表信息对象
"""
query = (
select(Message)
.where(
Message.type == query_object.type if query_object.type else True,
Message.status == query_object.status if query_object.status else True,
Message.detail == query_object.detail if query_object.detail else True,
)
.order_by(Message.message_id)
.distinct()
)
message_list = await PageUtil.paginate(db, query, query_object.page_num, query_object.page_size, is_page)
return message_list
@classmethod
async def add_message_dao(cls, db: AsyncSession, message: MessageModel):
"""
新增系统消息数据库操作
:param db: orm对象
:param message: 系统消息对象
:return:
"""
db_message = Message(**message.model_dump(exclude={}))
db.add(db_message)
await db.flush()
return db_message
@classmethod
async def edit_message_dao(cls, db: AsyncSession, message: dict):
"""
编辑系统消息数据库操作
:param db: orm对象
:param message: 需要更新的系统消息字典
:return:
"""
await db.execute(update(Message), [message])
@classmethod
async def delete_message_dao(cls, db: AsyncSession, message: MessageModel):
"""
删除系统消息数据库操作
:param db: orm对象
:param message: 系统消息对象
:return:
"""
await db.execute(delete(Message).where(Message.message_id.in_([message.message_id])))

View File

@ -0,0 +1,22 @@
from sqlalchemy import DateTime, String, BigInteger, Column
from config.database import Base
class Message(Base):
"""
系统消息表
"""
__tablename__ = 'message'
message_id = Column(BigInteger, primary_key=True, autoincrement=True, nullable=False, comment='消息主键')
type = Column(String(2), nullable=False, comment='类型0告警消息')
status = Column(String(2), nullable=False, comment='状态0未处理1已处理')
detail = Column(String(512), nullable=True, comment='消息描述')
create_time = Column(DateTime, nullable=False, comment='创建时间')
create_by = Column(String(64), nullable=True, comment='创建者')
update_time = Column(DateTime, nullable=False, comment='更新时间')
update_by = Column(String(64), nullable=False, comment='更新者')

View File

@ -0,0 +1,83 @@
from datetime import datetime
from pydantic import BaseModel, ConfigDict, Field
from pydantic.alias_generators import to_camel
from pydantic_validation_decorator import NotBlank
from typing import Optional
from module_admin.annotation.pydantic_annotation import as_query
class MessageModel(BaseModel):
"""
系统消息表对应pydantic模型
"""
model_config = ConfigDict(alias_generator=to_camel, from_attributes=True)
message_id: Optional[int] = Field(default=None, description='消息主键')
type: Optional[str] = Field(default=None, description='类型0告警消息')
status: Optional[str] = Field(default=None, description='状态0未处理1已处理')
detail: Optional[str] = Field(default=None, description='消息描述')
create_time: Optional[datetime] = Field(default=None, description='创建时间')
create_by: Optional[str] = Field(default=None, description='创建者')
update_time: Optional[datetime] = Field(default=None, description='更新时间')
update_by: Optional[str] = Field(default=None, description='更新者')
@NotBlank(field_name='type', message='类型不能为空')
def get_type(self):
return self.type
@NotBlank(field_name='status', message='状态不能为空')
def get_status(self):
return self.status
@NotBlank(field_name='create_time', message='创建时间不能为空')
def get_create_time(self):
return self.create_time
@NotBlank(field_name='update_time', message='更新时间不能为空')
def get_update_time(self):
return self.update_time
@NotBlank(field_name='update_by', message='更新者不能为空')
def get_update_by(self):
return self.update_by
def validate_fields(self):
self.get_type()
self.get_status()
self.get_create_time()
self.get_update_time()
self.get_update_by()
class MessageQueryModel(MessageModel):
"""
系统消息不分页查询模型
"""
begin_create_time: Optional[str] = Field(default=None, description='开始创建时间')
end_create_time: Optional[str] = Field(default=None, description='结束创建时间')
begin_update_time: Optional[str] = Field(default=None, description='开始更新时间')
end_update_time: Optional[str] = Field(default=None, description='结束更新时间')
@as_query
class MessagePageQueryModel(MessageQueryModel):
"""
系统消息分页查询模型
"""
page_num: int = Field(default=1, description='当前页码')
page_size: int = Field(default=10, description='每页记录数')
class DeleteMessageModel(BaseModel):
"""
删除系统消息模型
"""
model_config = ConfigDict(alias_generator=to_camel)
message_ids: str = Field(description='需要删除的消息主键')

View File

@ -0,0 +1,133 @@
from sqlalchemy.ext.asyncio import AsyncSession
from typing import List
from config.constant import CommonConstant
from exceptions.exception import ServiceException
from module_admin.entity.vo.common_vo import CrudResponseModel
from module_admin.dao.message_dao import MessageDao
from module_admin.entity.vo.message_vo import DeleteMessageModel, MessageModel, MessagePageQueryModel
from utils.common_util import CamelCaseUtil
from utils.excel_util import ExcelUtil
class MessageService:
"""
系统消息模块服务层
"""
@classmethod
async def get_message_list_services(
cls, query_db: AsyncSession, query_object: MessagePageQueryModel, is_page: bool = False
):
"""
获取系统消息列表信息service
:param query_db: orm对象
:param query_object: 查询参数对象
:param is_page: 是否开启分页
:return: 系统消息列表信息对象
"""
message_list_result = await MessageDao.get_message_list(query_db, query_object, is_page)
return message_list_result
@classmethod
async def add_message_services(cls, query_db: AsyncSession, page_object: MessageModel):
"""
新增系统消息信息service
:param query_db: orm对象
:param page_object: 新增系统消息对象
:return: 新增系统消息校验结果
"""
try:
await MessageDao.add_message_dao(query_db, page_object)
await query_db.commit()
return CrudResponseModel(is_success=True, message='新增成功')
except Exception as e:
await query_db.rollback()
raise e
@classmethod
async def edit_message_services(cls, query_db: AsyncSession, page_object: MessageModel):
"""
编辑系统消息信息service
:param query_db: orm对象
:param page_object: 编辑系统消息对象
:return: 编辑系统消息校验结果
"""
edit_message = page_object.model_dump(exclude_unset=True, exclude={'create_time', 'create_by', })
message_info = await cls.message_detail_services(query_db, page_object.message_id)
if message_info.message_id:
try:
await MessageDao.edit_message_dao(query_db, edit_message)
await query_db.commit()
return CrudResponseModel(is_success=True, message='更新成功')
except Exception as e:
await query_db.rollback()
raise e
else:
raise ServiceException(message='系统消息不存在')
@classmethod
async def delete_message_services(cls, query_db: AsyncSession, page_object: DeleteMessageModel):
"""
删除系统消息信息service
:param query_db: orm对象
:param page_object: 删除系统消息对象
:return: 删除系统消息校验结果
"""
if page_object.message_ids:
message_id_list = page_object.message_ids.split(',')
try:
for message_id in message_id_list:
await MessageDao.delete_message_dao(query_db, MessageModel(messageId=message_id))
await query_db.commit()
return CrudResponseModel(is_success=True, message='删除成功')
except Exception as e:
await query_db.rollback()
raise e
else:
raise ServiceException(message='传入消息主键为空')
@classmethod
async def message_detail_services(cls, query_db: AsyncSession, message_id: int):
"""
获取系统消息详细信息service
:param query_db: orm对象
:param message_id: 消息主键
:return: 消息主键对应的信息
"""
message = await MessageDao.get_message_detail_by_id(query_db, message_id=message_id)
if message:
result = MessageModel(**CamelCaseUtil.transform_result(message))
else:
result = MessageModel(**dict())
return result
@staticmethod
async def export_message_list_services(message_list: List):
"""
导出系统消息信息service
:param message_list: 系统消息信息列表
:return: 系统消息信息对应excel的二进制数据
"""
# 创建一个映射字典,将英文键映射到中文键
mapping_dict = {
'messageId': '消息主键',
'type': '类型',
'status': '状态',
'detail': '消息描述',
'createTime': '创建时间',
'createBy': '创建者',
'updateTime': '更新时间',
'updateBy': '更新者',
}
binary_data = ExcelUtil.export_list2excel(message_list, mapping_dict)
return binary_data