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:
DjangoAdmin Dev
2026-08-07 14:18:40 +08:00
co-authored by Claude
parent 2586c0aace
commit 87aec4e26e
53 changed files with 10586 additions and 11055 deletions
+731
View File
@@ -0,0 +1,731 @@
# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 一米阳光团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 一米阳光团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意,禁止将本产品用于以下任何行为:
# | 1. 任何违反中华人民共和国法律法规的用途;
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为,本团队有权:
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================
"""
字典类型管理服务模块
=============================================================
该模块实现了字典类型管理相关的所有业务逻辑。
包括字典类型的分页查询、详情查询、添加、更新、删除等功能。
字典类型用于管理系统中的字典分类,如:性别、状态、类型等,
每个字典类型包含名称、编码、排序、状态等属性,通过sort字段控制显示顺序。
命名规范:
- 函数参数使用驼峰命名(如 dictId, pageNo)
- 表单字段使用下划线命名(如 name, code, sort)- 与数据库字段保持一致
- 返回数据使用驼峰命名(如 createUser, updateTime)- 与前端规范保持一致
- 私有函数以下划线开头(如 _apply_filters, _build_page_data)
功能模块:
1. 分页查询:支持按名称模糊搜索、状态筛选,按sort字段排序
2. 详情查询:根据ID获取单个字典类型的详细信息
3. 数据维护:字典类型的添加、更新、删除(支持批量)
"""
import logging
from datetime import datetime, timezone
from flask import request
from sqlalchemy import and_
from src.common.constants.common import PAGE_SIZE
from src.modules.dictionary.schema import DictForm
from src.modules.dictionary.models import Dict
from src.core.database import db
from src.core import response as R
from src.common.utils import regular
from src.common.utils.case_converter import convert_camel_to_snake
from src.common.utils.model_utils import models_to_list, model_to_dict
from src.common.utils.request import parse_request_body, parse_id_list, like_contains
from src.core.security import get_username
# 获取日志记录器
logger = logging.getLogger(__name__)
# ============================================================
# 字典类型分页查询
# ============================================================
def get_dict_page():
"""
查询字典类型分页数据
Args:
request: Flask request对象,包含查询参数
- pageNo: 当前页码(可选,默认为1)
- pageSize: 每页记录数(可选,默认为PAGE_SIZE)
- name: 字典名称(可选,模糊查询)
- 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
# 分页查询
dict_list = query.limit(page_size).offset((page_no - 1) * page_size).all()
# 构建返回数据
page_data = _build_page_data(dict_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)
- 支持字典名称模糊查询
- 支持字典状态精确查询
- 默认按排序值升序排列
Returns:
Query: 应用筛选后的SQLAlchemy查询对象
"""
# 基础查询:过滤已删除记录
query = Dict.query.filter(Dict.is_delete == 0)
# 字典名称模糊筛选
name = request.args.get('name')
if name:
query = query.filter(Dict.name.like(like_contains(name), escape='\\'))
# 字典状态精确筛选
status = request.args.get('status')
if status:
query = query.filter(Dict.status == status)
# 按排序值升序排列
return query.order_by(Dict.sort.asc())
def _build_page_data(dict_list, total, page_size, page_no, pages):
"""
构建分页返回数据
Args:
dict_list: 字典类型对象列表
total: 总记录数
page_size: 每页大小
page_no: 当前页码
pages: 总页数
Returns:
dict: 分页数据,包含 records、total、size、current、pages
"""
# 将模型对象列表转换为字典列表
records = models_to_list(dict_list)
return {
'records': records,
'total': total,
'size': page_size,
'current': page_no,
'pages': pages
}
# ============================================================
# 字典类型详情查询
# ============================================================
def get_dict_detail(dict_id):
"""
根据ID查询字典类型详情(返回字典格式)
此方法调用 get_info 获取模型对象,然后转换为字典格式返回。
适用于前端接口调用。
Args:
dict_id: 字典类型ID
Returns:
dict/None: 字典类型详情字典,不存在时返回 None
"""
try:
# 复用 get_info 方法查询字典类型
dict_obj = get_info(dict_id)
if not dict_obj:
return None
# 转换为字典格式
return model_to_dict(dict_obj)
except Exception as e:
logger.error(f"查询字典类型详情异常,ID: {dict_id}, 错误: {str(e)}")
return None
# ============================================================
# 字典类型信息查询(根据ID)- 核心查询方法
# ============================================================
def get_info(dict_id: int):
"""
根据ID查询字典类型信息(返回模型对象)
这是一个通用的字典类型查询方法,返回字典类型模型对象而非字典。
与 get_dict_detail 的区别:
- get_dict_detail: 返回字典格式,用于前端接口
- get_info: 返回模型对象,用于内部服务调用
此方法被以下方法复用:
- get_dict_detail: 获取详情字典
- update_dict: 验证字典类型是否存在
Args:
dict_id: 字典类型ID
Returns:
Dict/None: 字典类型模型对象,不存在或已删除时返回 None
Example:
dict_obj = get_info(dict_id)
if dict_obj:
print(dict_obj.name)
"""
# 参数有效性验证
if not dict_id or dict_id <= 0:
return None
try:
# 查询未删除的字典类型
dict_obj = Dict.query.filter(
and_(Dict.id == dict_id, Dict.is_delete == 0)
).first()
return dict_obj
except Exception as e:
logger.error(f"查询字典类型信息异常,ID: {dict_id}, 错误: {str(e)}")
return None
# ============================================================
# 字典类型添加
# ============================================================
def add_dict():
"""
添加字典类型
流程:
1. 解析请求体JSON数据
2. 表单验证(名称唯一性、字段格式等)
3. 创建字典类型对象并保存到数据库
Returns:
R: 操作结果
"""
try:
# 获取参数
json_data, error = parse_request_body()
if error:
return R.failed(msg=error)
# 表单验证
form = DictForm(data=json_data)
if not form.validate():
err_msg = regular.get_err(form)
return R.failed(msg=err_msg)
# 创建字典类型
dict_obj = Dict(**form.data)
dict_obj.create_user = get_username()
dict_obj.save()
return R.ok(msg="添加成功")
except Exception as e:
logger.error(f"添加字典类型异常: {str(e)}")
return R.failed(msg="添加失败,请稍后重试")
# ============================================================
# 字典类型更新
# ============================================================
def update_dict():
"""
更新字典类型
流程:
1. 解析请求体JSON数据
2. 表单验证
3. 验证字典类型是否存在(复用 get_info)
4. 更新字典类型信息
Returns:
R: 操作结果
"""
try:
# 获取参数
json_data, error = parse_request_body()
if error:
return R.failed(msg=error)
# 表单验证
form = DictForm(data=json_data)
if not form.validate():
return R.failed(msg=regular.get_err(form))
# 获取字典类型ID
dict_id = form.data.get('id')
if not dict_id or int(dict_id) <= 0:
return R.failed("字典类型ID无效")
dict_id = int(dict_id)
# 复用 get_info 方法验证字典类型是否存在
dict_obj = get_info(dict_id)
if not dict_obj:
return R.failed("字典类型不存在")
# 更新字典类型信息(移除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 = Dict.query.filter_by(id=dict_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_dicts(dict_ids):
"""
删除字典类型(批量删除)
删除
支持逗号分隔的多个ID批量删除。
Args:
dict_ids: 字典类型ID字符串,多个ID用逗号分隔,如 "1,2,3"
Returns:
R: 操作结果
"""
return Dict.batch_delete_r(dict_ids)
"""
字典项管理服务模块
=============================================================
该模块实现了字典项管理相关的所有业务逻辑。
包括字典项的分页查询、详情查询、添加、更新、删除等功能。
字典项用于管理字典类型下的具体数据项,如:性别字典下的男、女等,
每个字典项包含名称、键值、排序、状态等属性,通过sort字段控制显示顺序。
命名规范:
- 函数参数使用驼峰命名(如 dictItemId, pageNo)
- 表单字段使用下划线命名(如 name, value, sort)- 与数据库字段保持一致
- 返回数据使用驼峰命名(如 createUser, updateTime)- 与前端规范保持一致
- 私有函数以下划线开头(如 _apply_filters, _build_page_data)
功能模块:
1. 分页查询:支持按名称模糊搜索、字典ID筛选、状态筛选,按sort字段排序
2. 详情查询:根据ID获取单个字典项的详细信息
3. 数据维护:字典项的添加、更新、删除(支持批量)
"""
import logging
from datetime import datetime, timezone
from flask import request
from sqlalchemy import and_
from src.common.constants.common import PAGE_SIZE
from src.modules.dictionary.schema import DictItemForm
from src.modules.dictionary.models import Dict
from src.modules.dictionary.models import DictItem
from src.core.database import db
from src.core import response as R
from src.common.utils import regular
from src.common.utils.case_converter import convert_camel_to_snake
from src.common.utils.model_utils import models_to_list, model_to_dict
from src.common.utils.request import parse_request_body, parse_id_list, like_contains
from src.core.security import get_username
# 获取日志记录器
logger = logging.getLogger(__name__)
# ============================================================
# 字典项分页查询
# ============================================================
def get_dict_item_page():
"""
查询字典项分页数据
Args:
request: Flask request对象,包含查询参数
- pageNo: 当前页码(可选,默认为1)
- pageSize: 每页记录数(可选,默认为PAGE_SIZE)
- dictId: 字典ID(必填,用于筛选属于哪个字典类型)
- name: 字典项名称(可选,模糊查询)
- 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
# 分页查询
dict_item_list = query.limit(page_size).offset((page_no - 1) * page_size).all()
# 构建返回数据
page_data = _build_page_data(dict_item_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筛选(dict_id)
- 支持字典项名称模糊查询
- 支持字典项状态精确查询
- 默认按排序值升序排列
Returns:
Query: 应用筛选后的SQLAlchemy查询对象
"""
# 基础查询:过滤已删除记录
query = DictItem.query.filter(DictItem.is_delete == 0)
# 字典ID筛选(必填)
dict_id = request.args.get('dictId', 0)
if dict_id:
query = query.filter(DictItem.dict_id == dict_id)
# 字典项名称模糊筛选
name = request.args.get('name')
if name:
query = query.filter(DictItem.name.like(like_contains(name), escape='\\'))
# 字典项状态精确筛选
status = request.args.get('status')
if status:
query = query.filter(DictItem.status == status)
# 按排序值升序排列
return query.order_by(DictItem.sort.asc())
def _build_page_data(dict_item_list, total, page_size, page_no, pages):
"""
构建分页返回数据
Args:
dict_item_list: 字典项对象列表
total: 总记录数
page_size: 每页大小
page_no: 当前页码
pages: 总页数
Returns:
dict: 分页数据,包含 records、total、size、current、pages
"""
# 将模型对象列表转换为字典列表
records = models_to_list(dict_item_list)
return {
'records': records,
'total': total,
'size': page_size,
'current': page_no,
'pages': pages
}
# ============================================================
# 字典项详情查询
# ============================================================
def get_dict_item_detail(dict_item_id):
"""
根据ID查询字典项详情(返回字典格式)
此方法调用 get_info 获取模型对象,然后转换为字典格式返回。
适用于前端接口调用。
Args:
dict_item_id: 字典项ID
Returns:
dict/None: 字典项详情字典,不存在时返回 None
"""
try:
# 复用 get_info 方法查询字典项
dict_item = get_info(dict_item_id)
if not dict_item:
return None
# 转换为字典格式
return model_to_dict(dict_item)
except Exception as e:
logger.error(f"查询字典项详情异常,ID: {dict_item_id}, 错误: {str(e)}")
return None
# ============================================================
# 字典项信息查询(根据ID)- 核心查询方法
# ============================================================
def get_info(dict_item_id: int):
"""
根据ID查询字典项信息(返回模型对象)
这是一个通用的字典项查询方法,返回字典项模型对象而非字典。
与 get_dict_item_detail 的区别:
- get_dict_item_detail: 返回字典格式,用于前端接口
- get_info: 返回模型对象,用于内部服务调用
此方法被以下方法复用:
- get_dict_item_detail: 获取详情字典
- update_dict_item: 验证字典项是否存在
Args:
dict_item_id: 字典项ID
Returns:
DictItem/None: 字典项模型对象,不存在或已删除时返回 None
Example:
dict_item = get_info(dict_item_id)
if dict_item:
print(dict_item.name)
"""
# 参数有效性验证
if not dict_item_id or dict_item_id <= 0:
return None
try:
# 查询未删除的字典项
dict_item = DictItem.query.filter(
and_(DictItem.id == dict_item_id, DictItem.is_delete == 0)
).first()
return dict_item
except Exception as e:
logger.error(f"查询字典项信息异常,ID: {dict_item_id}, 错误: {str(e)}")
return None
# ============================================================
# 字典项添加
# ============================================================
def add_dict_item():
"""
添加字典项
流程:
1. 解析请求体JSON数据
2. 表单验证(字段格式等)
3. 创建字典项对象并保存到数据库
Returns:
R: 操作结果
"""
try:
# 获取参数
json_data, error = parse_request_body()
if error:
return R.failed(msg=error)
# 表单验证
form = DictItemForm(data=json_data)
if not form.validate():
err_msg = regular.get_err(form)
return R.failed(msg=err_msg)
# 查询配置(验证配置是否存在)
dict_id = form.dictId.data
dict = Dict.query.filter(Dict.id == dict_id).first()
if not dict:
return R.failed(msg="字典不存在")
# 创建字典项
dict_item = DictItem(**form.data)
dict_item.dict_code = dict.code
dict_item.create_user = get_username()
dict_item.save()
return R.ok(msg="添加成功")
except Exception as e:
logger.error(f"添加字典项异常: {str(e)}")
return R.failed(msg="添加失败,请稍后重试")
# ============================================================
# 字典项更新
# ============================================================
def update_dict_item():
"""
更新字典项
流程:
1. 解析请求体JSON数据
2. 表单验证
3. 验证字典项是否存在(复用 get_info)
4. 更新字典项信息
Returns:
R: 操作结果
"""
try:
# 获取参数
json_data, error = parse_request_body()
if error:
return R.failed(msg=error)
# 表单验证
form = DictItemForm(data=json_data)
if not form.validate():
return R.failed(msg=regular.get_err(form))
# 获取字典项ID
dict_item_id = form.data.get('id')
if not dict_item_id or int(dict_item_id) <= 0:
return R.failed("字典项ID无效")
dict_item_id = int(dict_item_id)
# 复用 get_info 方法验证字典项是否存在
dict_item = get_info(dict_item_id)
if not dict_item:
return R.failed("字典项不存在")
# 更新字典项信息(移除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 = DictItem.query.filter_by(id=dict_item_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_dict_items(dict_item_ids):
"""
删除字典项(批量删除)
删除
支持逗号分隔的多个ID批量删除。
Args:
dict_item_ids: 字典项ID字符串,多个ID用逗号分隔,如 "1,2,3"
Returns:
R: 操作结果
"""
return DictItem.batch_delete_r(dict_item_ids)