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