refactor: P3c 服务层迁入 src/modules/ → service.py(29 服务)
- 22 个单服务 + 3 组合并(config+config_item、dict+dict_item、login_log+operation_log) - 特殊命名:job_executor→executor、scheduler→scheduler_service、 mail_svc→mail_service、sms_svc→sms_service(含使用处标识符改写) - 重写引用:跨服务(module 别名/子模块)、models/forms→src.modules、 db/extensions→src.core、utils→src.common|core、R→src.core.response - application/services/ 全部替换为 shim 【验收】全部服务文件编译通过;应用启动;pytest 5 passed;核心服务导入正常 Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude
parent
2586c0aace
commit
87aec4e26e
@@ -1,421 +1,8 @@
|
||||
# +======================================================================
|
||||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
|
||||
# +----------------------------------------------------------------------
|
||||
# | Copyright (c) 2021-2026 一米阳光团队 版权所有
|
||||
# +----------------------------------------------------------------------
|
||||
# | 开源协议: Apache-2.0
|
||||
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
|
||||
# +----------------------------------------------------------------------
|
||||
# | 官方网站: https://www.djangoadmin.cn
|
||||
# +----------------------------------------------------------------------
|
||||
# | 研发团队: 一米阳光团队 荣誉出品
|
||||
# +======================================================================
|
||||
# | 版权和免责声明:
|
||||
# | 一、知识产权声明
|
||||
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
|
||||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
|
||||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||||
# | 二、使用限制与禁止条款
|
||||
# | 您理解并同意,禁止将本产品用于以下任何行为:
|
||||
# | 1. 任何违反中华人民共和国法律法规的用途;
|
||||
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
|
||||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||||
# | 三、责任豁免
|
||||
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||||
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||||
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
|
||||
# | 四、违约与法律责任
|
||||
# | 如发现任何违反本声明的行为,本团队有权:
|
||||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
|
||||
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
|
||||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||||
# | 五、许可范围说明
|
||||
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
|
||||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||||
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||||
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
|
||||
# | 成的一切经济损失及商誉损害。
|
||||
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
|
||||
# | 许可协议》附件为准。
|
||||
# +======================================================================
|
||||
|
||||
"""
|
||||
通知公告管理服务模块
|
||||
兼容 shim(绞杀者迁移期间保留)
|
||||
=============================================================
|
||||
|
||||
该模块实现了通知公告管理相关的所有业务逻辑。
|
||||
包括通知公告的分页查询、详情查询、添加、更新、删除等功能。
|
||||
通知公告用于发布系统通知、平台动态等信息,
|
||||
包含标题、内容、来源、状态等属性。
|
||||
|
||||
命名规范:
|
||||
- 函数参数使用驼峰命名(如 noticeId, pageNo)
|
||||
- 表单字段使用下划线命名(如 title, content)- 与数据库字段保持一致
|
||||
- 返回数据使用驼峰命名(如 createUser, updateTime)- 与前端规范保持一致
|
||||
- 私有函数以下划线开头(如 _apply_filters, _build_page_data)
|
||||
|
||||
功能模块:
|
||||
1. 分页查询:支持按标题模糊搜索、来源筛选、状态筛选,按ID倒序排列
|
||||
2. 详情查询:根据ID获取单个通知公告的详细信息(包含富文本内容处理)
|
||||
3. 数据维护:通知公告的添加、更新、删除(支持批量)
|
||||
服务已迁移至 src.modules.notice.service。
|
||||
本文件仅作兼容转发,最终在 P7(切尾)阶段删除。
|
||||
"""
|
||||
|
||||
import logging
|
||||
|
||||
from datetime import datetime, timezone
|
||||
from flask import request
|
||||
from sqlalchemy import and_
|
||||
|
||||
from application.constants.common import PAGE_SIZE
|
||||
from application.constants.dict import NOTICE_TYPE_LIST
|
||||
from application.forms.notice import NoticeForm
|
||||
from application.models.notice import Notice
|
||||
from config import FLASK_FILE_URL
|
||||
from extensions import db
|
||||
from utils import R, regular
|
||||
from utils.case_converter import convert_camel_to_snake
|
||||
from utils.model_utils import model_to_dict
|
||||
from utils.request import parse_request_body, parse_id_list, like_contains
|
||||
from utils.rich_text import save_content, save_file
|
||||
from utils.security import get_username
|
||||
|
||||
# 获取日志记录器
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
# ============================================================
|
||||
# 通知公告分页查询
|
||||
# ============================================================
|
||||
|
||||
def get_notice_page():
|
||||
"""
|
||||
查询通知公告分页数据
|
||||
|
||||
Args:
|
||||
request: Flask request对象,包含查询参数
|
||||
- pageNo: 当前页码(可选,默认为1)
|
||||
- pageSize: 每页记录数(可选,默认为PAGE_SIZE)
|
||||
- title: 通知公告标题(可选,模糊查询)
|
||||
- type: 通知类型(可选,精确匹配)
|
||||
- status: 通知状态(可选,精确匹配)
|
||||
|
||||
Returns:
|
||||
R: 包含分页数据的JSON响应,格式为:
|
||||
{
|
||||
"records": 通知公告列表,
|
||||
"total": 总记录数,
|
||||
"size": 每页大小,
|
||||
"current": 当前页码,
|
||||
"pages": 总页数
|
||||
}
|
||||
"""
|
||||
try:
|
||||
# 获取分页参数
|
||||
page_no = int(request.args.get('pageNo', 1))
|
||||
page_size = int(request.args.get('pageSize', PAGE_SIZE))
|
||||
|
||||
# 应用筛选条件
|
||||
query = _apply_filters()
|
||||
|
||||
# 记录总数
|
||||
total = query.count()
|
||||
# 计算总页数
|
||||
pages = (total + page_size - 1) // page_size if total > 0 else 0
|
||||
|
||||
# 分页查询
|
||||
notice_list = query.limit(page_size).offset((page_no - 1) * page_size).all()
|
||||
# 构建返回数据
|
||||
page_data = _build_page_data(notice_list, total, page_size, page_no, pages)
|
||||
return R.ok(data=page_data)
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"查询通知公告分页数据异常: {str(e)}")
|
||||
return R.failed(msg="查询失败,请稍后重试")
|
||||
|
||||
|
||||
def _apply_filters():
|
||||
"""
|
||||
应用查询筛选条件
|
||||
|
||||
根据请求参数动态构建查询条件:
|
||||
- 自动过滤已删除记录(is_delete == 0)
|
||||
- 支持通知公告标题模糊查询
|
||||
- 支持通知来源精确查询
|
||||
- 支持通知状态精确查询
|
||||
- 默认按ID倒序排列
|
||||
|
||||
Returns:
|
||||
Query: 应用筛选后的SQLAlchemy查询对象
|
||||
"""
|
||||
# 基础查询:过滤已删除记录
|
||||
query = Notice.query.filter(Notice.is_delete == 0)
|
||||
|
||||
# 通知公告标题模糊筛选
|
||||
title = request.args.get('title')
|
||||
if title:
|
||||
query = query.filter(Notice.title.like(like_contains(title), escape='\\'))
|
||||
|
||||
# 通知类型精确筛选
|
||||
type = request.args.get('type')
|
||||
if type:
|
||||
query = query.filter(Notice.type == type)
|
||||
|
||||
# 通知状态精确筛选
|
||||
status = request.args.get('status')
|
||||
if status:
|
||||
query = query.filter(Notice.status == status)
|
||||
|
||||
# 按ID倒序排列
|
||||
return query.order_by(Notice.id.desc())
|
||||
|
||||
|
||||
def _build_page_data(notice_list, total, page_size, page_no, pages):
|
||||
"""
|
||||
构建分页返回数据
|
||||
|
||||
Args:
|
||||
notice_list: 通知公告对象列表
|
||||
total: 总记录数
|
||||
page_size: 每页大小
|
||||
page_no: 当前页码
|
||||
pages: 总页数
|
||||
|
||||
Returns:
|
||||
dict: 分页数据,包含 records、total、size、current、pages
|
||||
"""
|
||||
# 将模型对象列表转换为字典列表,并添加额外字段
|
||||
records = []
|
||||
for notice in notice_list:
|
||||
data = model_to_dict(notice)
|
||||
# 添加通知来源描述
|
||||
data['typeText'] = NOTICE_TYPE_LIST.get(notice.type)
|
||||
records.append(data)
|
||||
|
||||
return {
|
||||
'records': records,
|
||||
'total': total,
|
||||
'size': page_size,
|
||||
'current': page_no,
|
||||
'pages': pages
|
||||
}
|
||||
|
||||
|
||||
# ============================================================
|
||||
# 通知公告详情查询
|
||||
# ============================================================
|
||||
|
||||
def get_notice_detail(notice_id):
|
||||
"""
|
||||
根据ID查询通知公告详情(返回字典格式)
|
||||
|
||||
此方法调用 get_info 获取模型对象,然后转换为字典格式返回。
|
||||
适用于前端接口调用。
|
||||
|
||||
Args:
|
||||
notice_id: 通知公告ID
|
||||
|
||||
Returns:
|
||||
dict/None: 通知公告详情字典,不存在时返回 None
|
||||
"""
|
||||
try:
|
||||
# 复用 get_info 方法查询通知公告
|
||||
notice = get_info(notice_id)
|
||||
if not notice:
|
||||
return None
|
||||
# 转换为字典格式
|
||||
data = model_to_dict(notice)
|
||||
# 富文本内容处理:替换图片URL占位符
|
||||
content = notice.content.replace("[IMG_URL]", FLASK_FILE_URL) if notice.content else ""
|
||||
data['content'] = content
|
||||
# 通知来源描述
|
||||
data['typeText'] = NOTICE_TYPE_LIST.get(notice.type)
|
||||
return data
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"查询通知公告详情异常,ID: {notice_id}, 错误: {str(e)}")
|
||||
return None
|
||||
|
||||
|
||||
# ============================================================
|
||||
# 通知公告信息查询(根据ID)- 核心查询方法
|
||||
# ============================================================
|
||||
|
||||
def get_info(notice_id: int):
|
||||
"""
|
||||
根据ID查询通知公告信息(返回模型对象)
|
||||
|
||||
这是一个通用的通知公告查询方法,返回通知公告模型对象而非字典。
|
||||
与 get_notice_detail 的区别:
|
||||
- get_notice_detail: 返回字典格式,用于前端接口
|
||||
- get_info: 返回模型对象,用于内部服务调用
|
||||
|
||||
此方法被以下方法复用:
|
||||
- get_notice_detail: 获取详情字典
|
||||
- update_notice: 验证通知公告是否存在
|
||||
|
||||
Args:
|
||||
notice_id: 通知公告ID
|
||||
|
||||
Returns:
|
||||
Notice/None: 通知公告模型对象,不存在或已删除时返回 None
|
||||
|
||||
Example:
|
||||
notice = get_info(notice_id)
|
||||
if notice:
|
||||
print(notice.title)
|
||||
"""
|
||||
# 参数有效性验证
|
||||
if not notice_id or notice_id <= 0:
|
||||
return None
|
||||
|
||||
try:
|
||||
# 查询未删除的通知公告
|
||||
notice = Notice.query.filter(
|
||||
and_(Notice.id == notice_id, Notice.is_delete == 0)
|
||||
).first()
|
||||
return notice
|
||||
except Exception as e:
|
||||
logger.error(f"查询通知公告信息异常,ID: {notice_id}, 错误: {str(e)}")
|
||||
return None
|
||||
|
||||
|
||||
# ============================================================
|
||||
# 通知公告添加
|
||||
# ============================================================
|
||||
|
||||
def add_notice():
|
||||
"""
|
||||
添加通知公告
|
||||
|
||||
流程:
|
||||
1. 解析请求体JSON数据
|
||||
2. 表单验证(字段格式等)
|
||||
3. 处理富文本内容(保存图片)
|
||||
4. 创建通知公告对象并保存到数据库
|
||||
|
||||
Returns:
|
||||
R: 操作结果
|
||||
"""
|
||||
try:
|
||||
# 获取参数
|
||||
json_data, error = parse_request_body()
|
||||
if error:
|
||||
return R.failed(msg=error)
|
||||
|
||||
# 表单验证
|
||||
form = NoticeForm(data=json_data)
|
||||
if not form.validate():
|
||||
err_msg = regular.get_err(form)
|
||||
return R.failed(msg=err_msg)
|
||||
|
||||
# 通知封面处理
|
||||
cover = form.data.get('cover')
|
||||
if cover:
|
||||
cover = save_file(cover, "notice")
|
||||
form.cover.data = cover
|
||||
# 处理富文本内容
|
||||
title = form.data.get('title', '')
|
||||
content = form.data.get('content', '')
|
||||
if content:
|
||||
form.content.data = save_content(content, title, "notice")
|
||||
|
||||
# 创建通知公告
|
||||
notice = Notice(**form.data)
|
||||
notice.create_user = get_username()
|
||||
notice.save()
|
||||
|
||||
return R.ok(msg="添加成功")
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"添加通知公告异常: {str(e)}")
|
||||
return R.failed(msg="添加失败,请稍后重试")
|
||||
|
||||
|
||||
# ============================================================
|
||||
# 通知公告更新
|
||||
# ============================================================
|
||||
|
||||
def update_notice():
|
||||
"""
|
||||
更新通知公告
|
||||
|
||||
流程:
|
||||
1. 解析请求体JSON数据
|
||||
2. 表单验证
|
||||
3. 验证通知公告是否存在(复用 get_info)
|
||||
4. 处理富文本内容(保存图片)
|
||||
5. 更新通知公告信息
|
||||
|
||||
Returns:
|
||||
R: 操作结果
|
||||
"""
|
||||
try:
|
||||
# 获取参数
|
||||
json_data, error = parse_request_body()
|
||||
if error:
|
||||
return R.failed(msg=error)
|
||||
|
||||
# 表单验证
|
||||
form = NoticeForm(data=json_data)
|
||||
if not form.validate():
|
||||
return R.failed(msg=regular.get_err(form))
|
||||
|
||||
# 获取通知公告ID
|
||||
notice_id = form.data.get('id')
|
||||
if not notice_id or int(notice_id) <= 0:
|
||||
return R.failed("通知公告ID无效")
|
||||
notice_id = int(notice_id)
|
||||
|
||||
# 复用 get_info 方法验证通知公告是否存在
|
||||
notice = get_info(notice_id)
|
||||
if not notice:
|
||||
return R.failed("通知公告不存在")
|
||||
|
||||
# 通知封面处理
|
||||
cover = form.data.get('cover')
|
||||
if cover:
|
||||
cover = save_file(cover, "notice")
|
||||
form.cover.data = cover
|
||||
# 处理富文本内容
|
||||
title = form.data.get('title', '')
|
||||
content = form.data.get('content', '')
|
||||
if content:
|
||||
form.content.data = save_content(content, title, "notice")
|
||||
|
||||
# 更新通知公告信息(移除ID,避免更新主键)
|
||||
form_data = convert_camel_to_snake(form.data.copy())
|
||||
form_data.pop('id', None)
|
||||
|
||||
form_data['update_time'] = datetime.now(tz=timezone.utc)
|
||||
form_data['update_user'] = get_username()
|
||||
|
||||
result = Notice.query.filter_by(id=notice_id).update(form_data)
|
||||
|
||||
if not result:
|
||||
return R.failed("更新失败")
|
||||
|
||||
return R.ok(msg="更新成功")
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"更新通知公告异常: {str(e)}")
|
||||
return R.failed(msg="更新通知公告失败,请稍后重试")
|
||||
|
||||
|
||||
# ============================================================
|
||||
# 通知公告删除
|
||||
# ============================================================
|
||||
|
||||
def delete_notices(notice_ids):
|
||||
"""
|
||||
删除通知公告(批量删除)
|
||||
|
||||
删除
|
||||
支持逗号分隔的多个ID批量删除。
|
||||
|
||||
Args:
|
||||
notice_ids: 通知公告ID字符串,多个ID用逗号分隔,如 "1,2,3"
|
||||
|
||||
Returns:
|
||||
R: 操作结果
|
||||
"""
|
||||
return Notice.batch_delete_r(notice_ids)
|
||||
from src.modules.notice.service import * # noqa: F401,F403
|
||||
|
||||
Reference in New Issue
Block a user