Files
DjangoAdmin_Flask_EleVue/application/services/user.py
T
DjangoAdmin DevandClaude 15f2a5e097 chore: 基线提交(重构前代码快照)
- git 初始化 + .gitignore 补全(根 .env / logs / instance / __pycache__ 等)
- 修复 utils/.gitignore 误将整个 utils/ 源码层忽略的问题,补入全部工具源码(含 ip2region.xdb)
- 含后端全部代码:application / extensions / utils / config / migrations
- 含前端 ui/(后续整体迁走)
- 不含根 .env(含密钥,本地保留)

Co-Authored-By: Claude <noreply@anthropic.com>
2026-08-07 12:12:06 +08:00

795 lines
26 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 一米阳光团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 一米阳光团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意,禁止将本产品用于以下任何行为:
# | 1. 任何违反中华人民共和国法律法规的用途;
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为,本团队有权:
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================
"""
用户管理服务模块
=============================================================
该模块实现了用户管理相关的所有业务逻辑。
包括用户的分页查询、详情查询、添加、更新、删除、状态设置、密码管理等功能。
用户用于标识系统账户,包含用户名、真实姓名、性别、手机号、邮箱、部门、职级、岗位等信息。
命名规范:
- 函数参数使用驼峰命名(如 userId, pageNo)
- 表单字段使用下划线命名(如 realname, gender, status)- 与数据库字段保持一致
- 返回数据使用驼峰命名(如 createUser, updateTime)- 与前端规范保持一致
- 私有函数以下划线开头(如 _apply_filters, _build_page_data)
功能模块:
1. 分页查询:支持按真实姓名模糊搜索、性别筛选、状态筛选
2. 详情查询:根据ID获取单个用户的详细信息(含角色、行政区划等关联数据)
3. 数据维护:用户的添加、更新、删除(支持批量)
4. 状态管理:单独更新用户的启用/禁用状态
5. 个人信息:更新当前用户的基本信息
6. 密码管理:修改密码、重置密码
"""
import logging
from datetime import datetime, timezone
from flask import request
from sqlalchemy import and_
from application.constants.dict import GENDER_LIST
from application.forms.user import UserForm, UserStatusForm, UpdatePwdForm, UserInfoForm, ResetPwdForm
from application.models.dept import Dept
from application.models.level import Level
from application.models.position import Position
from application.models.user import User
from application.models.user_role import UserRole
from application.services import user_role
from application.services.menu import invalidate_user_cache
from application.constants.common import DEFAULT_PASSWORD, PAGE_SIZE
from extensions import db
from utils import R, regular, password
from utils.case_converter import convert_camel_to_snake
from utils.rich_text import get_file_url, save_file
from utils.model_utils import models_to_list, model_to_dict
from utils.password import verify_password, encrypt_password, generate_salt
from utils.request import parse_request_body, parse_id_list, like_contains
from utils.security import get_username, get_user_id
# 获取日志记录器
logger = logging.getLogger(__name__)
# ============================================================
# 用户分页查询
# ============================================================
def get_user_page():
"""
查询用户分页数据
Args:
request: Flask request对象,包含查询参数
- page: 当前页码(可选,默认为1)
- limit: 每页记录数(可选,默认为PAGE_SIZE)
- realname: 用户真实姓名(可选,模糊查询)
- gender: 用户性别(可选,精确匹配)
- status: 用户状态(可选,精确匹配)
Returns:
R: 包含分页数据的JSON响应,格式为:
{
"records": 用户列表,
"total": 总记录数,
"size": 每页大小,
"current": 当前页码,
"pages": 总页数
}
"""
try:
# 获取分页参数
page_no = int(request.args.get('page', 1))
page_size = int(request.args.get('limit', PAGE_SIZE))
# 应用筛选条件
query = _apply_filters()
# 记录总数
total = query.count()
# 计算总页数
pages = (total + page_size - 1) // page_size if total > 0 else 0
# 分页查询
user_list = query.limit(page_size).offset((page_no - 1) * page_size).all()
# 构建返回数据
page_data = _build_page_data(user_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 = User.query.filter(User.is_delete == 0)
# 用户姓名模糊筛选
realname = request.args.get('realname')
if realname:
query = query.filter(User.realname.like(like_contains(realname), escape='\\'))
# 性别精确筛选
gender = request.args.get('gender')
if gender:
query = query.filter(User.gender == gender)
# 用户状态精确筛选
status = request.args.get('status')
if status:
query = query.filter(User.status == status)
# 按ID降序排列
return query.order_by(User.id.desc())
def _build_page_data(user_list, total, page_size, page_no, pages):
"""
构建分页返回数据
Args:
user_list: 用户对象列表
total: 总记录数
page_size: 每页大小
page_no: 当前页码
pages: 总页数
Returns:
dict: 分页数据,包含 records、total、size、current、pages
"""
# 将模型对象列表转换为字典列表
records = models_to_list(user_list)
# 补充关联数据
records = _enrich_user_records(records)
return {
'records': records,
'total': total,
'size': page_size,
'current': page_no,
'pages': pages
}
def _enrich_user_records(records):
"""
为用户记录补充关联数据(部门、职级、岗位、角色等)
Args:
records: 用户字典列表
Returns:
list: 补充关联数据后的用户字典列表
"""
if not records:
return []
# 缓存关联数据,避免重复查询
dept_map = _get_dept_map()
level_map = _get_level_map()
position_map = _get_position_map()
# 批量查询所有用户的角色关系(1次查询替代N次)
user_ids = [data.get('id') for data in records]
role_map = user_role.get_user_roles_batch(user_ids)
for data in records:
# 城市编码列表
city_list = [data.get('provinceCode'), data.get('cityCode'), data.get('districtCode'), data.get('streetCode')]
# 性别名称
data['genderName'] = GENDER_LIST.get(data.get('gender'))
# 头像URL
data['avatar'] = get_file_url(data.get('avatar'))
# 部门名称
data['deptName'] = dept_map.get(data.get('deptId'))
# 职级名称
data['levelName'] = level_map.get(data.get('levelId'))
# 岗位名称
data['positionName'] = position_map.get(data.get('positionId'))
# 用户角色列表
data['roles'] = role_map.get(data.get('id'), [])
# 行政区划
data['city'] = city_list
return records
def _get_dept_map():
"""获取部门ID到名称的映射字典"""
dept_list = Dept.query.filter(Dept.is_delete == 0).all()
return {dept.id: dept.name for dept in dept_list}
def _get_level_map():
"""获取职级ID到名称的映射字典"""
level_list = Level.query.filter(Level.is_delete == 0).all()
return {level.id: level.name for level in level_list}
def _get_position_map():
"""获取岗位ID到名称的映射字典"""
position_list = Position.query.filter(Position.is_delete == 0).all()
return {position.id: position.name for position in position_list}
# ============================================================
# 用户详情查询
# ============================================================
def get_user_detail(user_id):
"""
根据ID查询用户详情(返回字典格式)
此方法调用 get_info 获取模型对象,然后转换为字典格式返回。
适用于前端接口调用。
Args:
user_id: 用户ID
Returns:
dict/None: 用户详情字典,不存在时返回 None
"""
try:
# 复用 get_info 方法查询用户
user = get_info(user_id)
if not user:
return None
# 转换为字典格式
data = model_to_dict(user)
# 移除密码字段
if data:
data.pop('password', None)
# 补充关联数据
data = _enrich_user_detail(data)
return data
except Exception as e:
logger.error(f"查询用户详情异常,ID: {user_id}, 错误: {str(e)}")
return None
def _enrich_user_detail(data):
"""
为用户详情补充关联数据
Args:
data: 用户字典
Returns:
dict: 补充关联数据后的用户字典
"""
if not data:
return data
# 头像URL
data['avatar'] = get_file_url(data.get('avatar'))
# 获取用户角色数据(复用 user_role 服务)
role_list = user_role.get_user_role_list(data.get('id'))
data['roles'] = [role['id'] for role in role_list]
# 行政区划
city_list = [data.get('provinceCode'), data.get('cityCode'), data.get('districtCode'), data.get('streetCode')]
data['city'] = city_list
return data
# ============================================================
# 用户信息查询(根据ID)- 核心查询方法
# ============================================================
def get_info(user_id: int):
"""
根据ID查询用户信息(返回模型对象)
这是一个通用的用户查询方法,返回用户模型对象而非字典。
与 get_user_detail 的区别:
- get_user_detail: 返回字典格式,用于前端接口
- get_info: 返回模型对象,用于内部服务调用
此方法被以下方法复用:
- get_user_detail: 获取详情字典
- update_user: 验证用户是否存在
- update_user_status: 验证用户是否存在
Args:
user_id: 用户ID
Returns:
User/None: 用户模型对象,不存在或已删除时返回 None
Example:
user = get_info(user_id)
if user:
print(user.realname)
"""
# 参数有效性验证
if not user_id or user_id <= 0:
return None
try:
# 查询未删除的用户
user = User.query.filter(
and_(User.id == user_id, User.is_delete == 0)
).first()
return user
except Exception as e:
logger.error(f"查询用户信息异常,ID: {user_id}, 错误: {str(e)}")
return None
# ============================================================
# 用户添加
# ============================================================
def add_user():
"""
添加用户
流程:
1. 解析请求体JSON数据
2. 表单验证(用户名唯一性、字段格式等)
3. 处理头像、密码加密、行政区划
4. 创建用户对象并保存到数据库
5. 保存用户角色关联关系
Returns:
R: 操作结果
"""
try:
# 获取参数
json_data, error = parse_request_body()
if error:
return R.failed(msg=error)
# 表单验证
form = UserForm(data=json_data)
if not form.validate():
err_msg = regular.get_err(form)
return R.failed(msg=err_msg)
# 图片处理
avatar = form.data.get('avatar')
if avatar:
form.avatar.data = save_file(avatar, "user")
# 密码加密(未设置密码时使用默认密码)
pwd = form.data.get('password') or DEFAULT_PASSWORD
salt = password.generate_salt()
form.password.data = encrypt_password(pwd, salt)
form.salt.data = salt
# 处理行政区划
city = form.data.get('city', [])
if len(city) != 4:
return R.failed("请选择完整的所在城市(省/市/区/街道)")
form.provinceCode.data = city[0]
form.cityCode.data = city[1]
form.districtCode.data = city[2]
form.streetCode.data = city[3]
# 用户角色
roles = form.data.get('roles')
# 移除不需要直接保存到User表的字段
form_data = form.data.copy()
form_data.pop('city', None)
form_data.pop('roles', None)
# 创建用户
user = User(**form_data)
user.create_user = get_username()
user.save()
# 创建用户角色数据
_add_user_role(user.id, roles)
# 清除该用户权限缓存
invalidate_user_cache(user.id)
return R.ok(msg="添加成功")
except Exception as e:
logger.error(f"添加用户异常: {str(e)}")
return R.failed(msg="添加用户失败,请稍后重试")
# ============================================================
# 用户更新
# ============================================================
def update_user():
"""
更新用户
流程:
1. 解析请求体JSON数据
2. 表单验证
3. 验证用户是否存在(复用 get_info)
4. 处理头像、密码加密、行政区划
5. 更新用户信息
6. 更新用户角色关联关系
Returns:
R: 操作结果
"""
try:
# 获取参数
json_data, error = parse_request_body()
if error:
return R.failed(msg=error)
# 表单验证
form = UserForm(data=json_data)
if not form.validate():
return R.failed(msg=regular.get_err(form))
# 获取用户ID
user_id = form.data.get('id')
if not user_id or int(user_id) <= 0:
return R.failed("用户ID无效")
user_id = int(user_id)
# 复用 get_info 方法验证用户是否存在
user = get_info(user_id)
if not user:
return R.failed("用户不存在")
# 图片处理
avatar = form.data.get('avatar')
if avatar:
form.avatar.data = save_file(avatar, "user")
# 密码加密(仅当有传入新密码时)
pwd = form.data.get('password')
if pwd:
salt = password.generate_salt()
form.password.data = encrypt_password(pwd, salt)
form.salt.data = salt
else:
# 密码不填时保持原密码值不做更新
form_data = form.data.copy()
form_data.pop('password', None)
form_data.pop('salt', None)
# 处理行政区划
city = form.data.get('city', [])
if len(city) != 4:
return R.failed("请选择完整的所在城市(省/市/区/街道)")
form.provinceCode.data = city[0]
form.cityCode.data = city[1]
form.districtCode.data = city[2]
form.streetCode.data = city[3]
# 用户角色
roles = form.data.get('roles')
# 移除不需要直接更新到User表的字段
form_data = convert_camel_to_snake(form.data.copy())
form_data.pop('id', None)
form_data.pop('city', None)
form_data.pop('roles', None)
# 更新用户信息
form_data['update_time'] = datetime.now(tz=timezone.utc)
form_data['update_user'] = get_username()
result = User.query.filter_by(id=user_id).update(form_data)
if not result:
return R.failed("更新失败")
# 更新用户角色数据
_add_user_role(user_id, roles)
# 清除该用户权限缓存
invalidate_user_cache(user_id)
return R.ok(msg="更新成功")
except Exception as e:
logger.error(f"更新用户异常: {str(e)}")
return R.failed(msg="更新用户失败,请稍后重试")
def _add_user_role(user_id, roles):
"""
创建/更新用户角色关系
Args:
user_id: 用户ID
roles: 角色ID列表,如 [1, 2, 3]
"""
# 删除旧数据
UserRole.query.filter(UserRole.user_id == user_id).delete()
# 批量插入
if roles:
db.session.bulk_insert_mappings(
UserRole,
[{'user_id': user_id, 'role_id': role_id} for role_id in roles]
)
# ============================================================
# 用户删除
# ============================================================
def delete_users(user_ids):
"""
删除用户(批量删除)
删除
支持逗号分隔的多个ID批量删除。
Args:
user_ids: 用户ID字符串,多个ID用逗号分隔,如 "1,2,3"
Returns:
R: 操作结果
"""
return User.batch_delete_r(user_ids)
# ============================================================
# 用户状态设置
# ============================================================
def update_user_status():
"""
设置用户状态
单独更新用户的启用/禁用状态,不涉及其他字段。
Returns:
R: 操作结果
"""
try:
# 获取参数
json_data, error = parse_request_body()
if error:
return R.failed(msg=error)
# 表单验证
form = UserStatusForm(data=json_data)
if not form.validate():
err_msg = regular.get_err(form)
return R.failed(msg=err_msg)
user_id = int(form.data['id'])
status = int(form.data['status'])
# 复用 get_info 方法验证用户是否存在
user = get_info(user_id)
if not user:
return R.failed("用户不存在")
# 更新状态
update_data = {"status": status, "update_time": datetime.now(tz=timezone.utc), "update_user": get_username()}
result = User.query.filter_by(id=user_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="设置用户状态失败,请稍后重试")
# ============================================================
# 用户信息更新(个人信息)
# ============================================================
def update_user_info():
"""
更新当前用户信息
用于用户修改自己的个人信息,不涉及密码和角色。
Returns:
R: 操作结果
"""
try:
# 获取参数
json_data, error = parse_request_body()
if error:
return R.failed(msg=error)
# 表单验证
form = UserInfoForm(data=json_data)
if not form.validate():
err_msg = regular.get_err(form)
return R.failed(msg=err_msg)
# 用户ID(当前登录用户)
user_id = get_user_id()
# 复用 get_info 方法验证用户是否存在
user = get_info(user_id)
if not user:
return R.failed("用户不存在")
# 更新用户信息
update_data = {
'realname': form.realname.data,
'gender': form.gender.data,
'mobile': form.mobile.data,
'email': form.email.data,
'address': form.address.data,
'intro': form.intro.data,
'update_time': datetime.now(tz=timezone.utc),
'update_user': get_username()
}
result = User.query.filter_by(id=user_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="更新用户信息失败,请稍后重试")
# ============================================================
# 密码修改
# ============================================================
def update_password():
"""
修改当前用户密码
需要验证原始密码正确性。
Returns:
R: 操作结果
"""
try:
# 获取参数
json_data, error = parse_request_body()
if error:
return R.failed(msg=error)
# 表单验证
form = UpdatePwdForm(data=json_data)
if not form.validate():
err_msg = regular.get_err(form)
return R.failed(msg=err_msg)
# 用户ID(当前登录用户)
user_id = get_user_id()
# 根据ID查询用户
user = get_info(user_id)
if not user:
return R.failed("用户不存在")
# 验证原始密码
if not verify_password(form.oldPassword.data, user.salt, user.password):
return R.failed("原始密码不正确")
# 加密新密码
new_salt = generate_salt()
password = encrypt_password(form.newPassword.data, new_salt)
update_data = {"password": password, "salt": new_salt, "update_time": datetime.now(tz=timezone.utc), "update_user": get_username()}
result = User.query.filter_by(id=user_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="修改密码失败,请稍后重试")
# ============================================================
# 密码重置
# ============================================================
def reset_user_password():
"""
重置用户密码
将指定用户的密码重置为默认密码(123456)。
Returns:
R: 操作结果
"""
try:
# 获取参数
json_data, error = parse_request_body()
if error:
return R.failed(msg=error)
# 表单验证
form = ResetPwdForm(data=json_data)
if not form.validate():
err_msg = regular.get_err(form)
return R.failed(msg=err_msg)
user_id = form.userId.data
# 复用 get_info 方法验证用户是否存在
user = get_info(user_id)
if not user:
return R.failed("用户不存在")
# 加密新密码(默认密码123456)
new_salt = generate_salt()
password = encrypt_password(DEFAULT_PASSWORD, new_salt)
update_data = {"password": password, "salt": new_salt, "update_time": datetime.now(tz=timezone.utc), "update_user": get_username()}
result = User.query.filter_by(id=user_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="重置密码失败,请稍后重试")