# +====================================================================== # | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ] # +---------------------------------------------------------------------- # | Copyright (c) 2021-2026 一米阳光团队 版权所有 # +---------------------------------------------------------------------- # | 开源协议: Apache-2.0 # | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。 # +---------------------------------------------------------------------- # | 官方网站: https://www.djangoadmin.cn # +---------------------------------------------------------------------- # | 研发团队: 一米阳光团队 荣誉出品 # +====================================================================== # | 版权和免责声明: # | 一、知识产权声明 # | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、 # | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权, # | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。 # | 二、使用限制与禁止条款 # | 您理解并同意,禁止将本产品用于以下任何行为: # | 1. 任何违反中华人民共和国法律法规的用途; # | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为; # | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。 # | 三、责任豁免 # | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失 # | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三 # | 方提起索赔或行政机关进行调查,您应独立承担全部责任。 # | 四、违约与法律责任 # | 如发现任何违反本声明的行为,本团队有权: # | 1. 无条件配合公安机关及其他有权机关的调查取证工作; # | 2. 依法追究相关方的民事责任,并要求赔偿全部损失; # | 3. 保留进一步采取刑事控告等法律措施的权利。 # | 五、许可范围说明 # | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包 # | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通 # | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、 # | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造 # | 成的一切经济损失及商誉损害。 # | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件 # | 许可协议》附件为准。 # +====================================================================== """ 城市管理服务模块 ============================================================= 该模块实现了城市/行政区划管理相关的所有业务逻辑。 包括城市的分页查询、详情查询、添加、更新、删除、子级城市查询等功能。 城市数据采用树形结构,通过 pid/parent_code 字段建立层级关系, 支持省、市、区三级行政区划管理。 命名规范: - 函数参数使用驼峰命名(如 cityId, cityCode) - 表单字段使用下划线命名(如 name, code, level)- 与数据库字段保持一致 - 返回数据使用驼峰命名(如 createUser, updateTime)- 与前端规范保持一致 - 私有函数以下划线开头(如 _apply_filters, _build_tree) 功能模块: 1. 列表查询:支持按父级ID、名称模糊搜索 2. 详情查询:根据ID获取单个城市的详细信息 3. 数据维护:城市的添加、更新、删除(支持批量) 4. 子级查询:根据城市编码获取子级城市列表 5. 城市树形数据:获取完整的城市树形结构 """ import logging from datetime import datetime, timezone from flask import request from sqlalchemy import and_ from application.constants.dict import CITY_LEVEL_LIST from application.forms.city import CityForm from application.models.city import City from extensions import db from utils import R, regular from utils.case_converter import convert_camel_to_snake from utils.request import parse_request_body, parse_id_list, like_contains from utils.model_utils import models_to_list, model_to_dict from utils.security import get_username # 获取日志记录器 logger = logging.getLogger(__name__) # ============================================================ # 城市列表查询 # ============================================================ def get_city_list(): """ 查询城市列表 用于城市管理页面的列表展示,支持按父级ID和名称筛选。 Args: request: Flask request对象,包含查询参数 - pid: 父级ID(可选,默认为0,查询顶级城市) - name: 城市名称(可选,模糊查询) Returns: R: 包含城市列表的JSON响应 """ try: # 应用筛选条件 query = _apply_filters() # 查询数据 city_list = query.all() # 转换为字典列表并补充关联数据 records = _enrich_city_records(city_list) return R.ok(data=records) except Exception as e: logger.error(f"查询城市列表异常: {str(e)}") return R.failed(msg="查询失败,请稍后重试") def _apply_filters(): """ 应用查询筛选条件 根据请求参数动态构建查询条件: - 自动过滤已删除记录(is_delete == 0) - 支持父级ID精确查询 - 支持城市名称模糊查询 Returns: Query: 应用筛选后的SQLAlchemy查询对象 """ # 基础查询:过滤已删除记录 query = City.query.filter(City.is_delete == 0) # 父级ID精确筛选(默认为0,查询顶级城市) pid = request.args.get('pid', 0) if pid is not None: try: query = query.filter(City.pid == int(pid)) except ValueError: pass # 城市名称模糊筛选 name = request.args.get('name') if name: query = query.filter(City.name.like(like_contains(name), escape='\\')) # 按ID升序排列 return query.order_by(City.id.asc()) def _enrich_city_records(city_list): """ 为城市记录补充关联数据 Args: city_list: 城市模型对象列表 Returns: list: 补充关联数据后的城市字典列表 """ if not city_list: return [] records = models_to_list(city_list) for data in records: # 城市级别名称 level = data.get('level') data['level_name'] = CITY_LEVEL_LIST.get(level) if level else None # 是否有子级(level < 3 表示还有下级) data['have_child'] = data.get('level', 4) < 3 if data.get('level') else False return records # ============================================================ # 城市详情查询 # ============================================================ def get_city_detail(city_id): """ 根据ID查询城市详情(返回字典格式) 此方法调用 get_info 获取模型对象,然后转换为字典格式返回。 适用于前端接口调用。 Args: city_id: 城市ID Returns: dict/None: 城市详情字典,不存在时返回 None """ try: # 复用 get_info 方法查询城市 city = get_info(city_id) if not city: return None # 转换为字典格式 return model_to_dict(city) except Exception as e: logger.error(f"查询城市详情异常,ID: {city_id}, 错误: {str(e)}") return None # ============================================================ # 城市信息查询(根据ID)- 核心查询方法 # ============================================================ def get_info(city_id: int): """ 根据ID查询城市信息(返回模型对象) 这是一个通用的城市查询方法,返回城市模型对象而非字典。 与 get_city_detail 的区别: - get_city_detail: 返回字典格式,用于前端接口 - get_info: 返回模型对象,用于内部服务调用 此方法被以下方法复用: - get_city_detail: 获取详情字典 - update_city: 验证城市是否存在 - delete_cities: 验证城市是否存在 Args: city_id: 城市ID Returns: City/None: 城市模型对象,不存在或已删除时返回 None Example: city = get_info(city_id) if city: print(city.name) """ # 参数有效性验证 if not city_id or city_id <= 0: return None try: # 查询未删除的城市 city = City.query.filter( and_(City.id == city_id, City.is_delete == 0) ).first() return city except Exception as e: logger.error(f"查询城市信息异常,ID: {city_id}, 错误: {str(e)}") return None # ============================================================ # 城市添加 # ============================================================ def add_city(): """ 添加城市 流程: 1. 解析请求体JSON数据 2. 表单验证(编码唯一性、字段格式等) 3. 创建城市对象并保存到数据库 Returns: R: 操作结果 """ try: # 获取参数 json_data, error = parse_request_body() if error: return R.failed(msg=error) # 表单验证 form = CityForm(data=json_data) if not form.validate(): err_msg = regular.get_err(form) return R.failed(msg=err_msg) # 创建城市 city = City(**form.data) city.create_user = get_username() city.save() return R.ok(msg="添加成功") except Exception as e: logger.error(f"添加城市异常: {str(e)}") return R.failed(msg="添加城市失败,请稍后重试") # ============================================================ # 城市更新 # ============================================================ def update_city(): """ 更新城市 流程: 1. 解析请求体JSON数据 2. 表单验证 3. 验证城市是否存在(复用 get_info) 4. 更新城市信息 Returns: R: 操作结果 """ try: # 获取参数 json_data, error = parse_request_body() if error: return R.failed(msg=error) # 表单验证 form = CityForm(data=json_data) if not form.validate(): return R.failed(msg=regular.get_err(form)) # 获取城市ID city_id = form.data.get('id') if not city_id or int(city_id) <= 0: return R.failed("城市ID无效") city_id = int(city_id) # 复用 get_info 方法验证城市是否存在 city = get_info(city_id) if not city: 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 = City.query.filter_by(id=city_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_cities(city_ids): """ 删除城市(批量删除) 删除 支持逗号分隔的多个ID批量删除。 Args: city_ids: 城市ID字符串,多个ID用逗号分隔,如 "1,2,3" Returns: R: 操作结果 """ if not city_ids: return R.failed("记录ID不存在") # 解析ID列表 id_list = parse_id_list(city_ids) if not id_list: return R.failed("无效的记录ID") # 检查是否有子级城市 for city_id in id_list: child_count = City.query.filter( and_(City.pid == city_id, City.is_delete == 0) ).count() if child_count > 0: return R.failed(f"城市ID {city_id} 存在子级城市,请先删除子级城市") return City.batch_delete_r(city_ids) # ============================================================ # 子级城市查询 # ============================================================ def get_child_cities(city_code): """ 根据城市编码获取子级城市列表 用于级联选择器,根据父级编码查询下级城市。 Args: city_code: 父级城市编码 Returns: list: 子级城市列表,每个元素包含 area_code 和 name Example: child_list = get_child_cities("440000") # 返回:[{"area_code": "440100", "name": "广州市"}, ...] """ if not city_code: return [] try: # 查询子级城市 child_list = City.query.filter( and_(City.parent_code == city_code, City.is_delete == 0) ).order_by(City.id.asc()).all() # 构建返回数据 result = models_to_list(child_list) return result except Exception as e: logger.error(f"查询子级城市异常,城市编码: {city_code}, 错误: {str(e)}") return [] # ============================================================ # 城市树形数据获取 # ============================================================ def get_city_tree(): """ 获取城市树形数据 用于级联选择器、行政区划选择等场景。 返回完整的省-市-区三级树形结构。 Returns: list: 城市树形数据列表 """ try: # 查询所有未删除的城市 all_cities = City.query.filter(City.is_delete == 0).order_by(City.id.asc()).all() if not all_cities: return [] # 转换为字典列表 city_dicts = models_to_list(all_cities) # 构建树形结构 tree = _build_city_tree(city_dicts) return tree except Exception as e: logger.error(f"获取城市树形数据异常: {str(e)}") return [] def _build_city_tree(city_list, parent_id=0): """ 构建城市树形结构 Args: city_list: 城市字典列表 parent_id: 父级ID Returns: list: 树形结构数据 """ tree = [] for city in city_list: if city.get('pid') == parent_id: node = { 'id': city.get('id'), 'name': city.get('name'), 'code': city.get('area_code'), 'level': city.get('level'), 'children': _build_city_tree(city_list, city.get('id')) } # 如果没有子节点,移除children字段 if not node['children']: del node['children'] tree.append(node) return tree