1076 lines
46 KiB
Python
Raw Normal View History

2025-04-11 08:54:28 +08:00
#!/usr/bin/python
# -*- coding: utf-8 -*-
# @version : 1.0
# @Create Time : 2022/2/24 10:21
# @File : crud.py
# @IDE : PyCharm
# @desc : 增删改查
from typing import Any
from redis.asyncio import Redis
from fastapi import UploadFile
from sqlalchemy.exc import StatementError
from sqlalchemy.orm import joinedload, aliased
from sqlalchemy.orm.strategy_options import _AbstractLoad, contains_eager
from core.exception import CustomException
from fastapi.encoders import jsonable_encoder
from sqlalchemy import select, false, and_
from core.crud import DalBase
from sqlalchemy.ext.asyncio import AsyncSession
from core.validator import vali_telephone
from utils.file.aliyun_oss import AliyunOSS, BucketConf
from utils.excel.import_manage import ImportManage, FieldType
from utils.excel.write_xlsx import WriteXlsx
from utils.send_email import EmailSender
from utils.sms.reset_passwd import ResetPasswordSMS
from .params import UserParams
from utils.tools import test_password
from . import models, schemas
from application import settings
from utils.excel.excel_manage import ExcelManage
from apps.vadmin.system import crud as vadmin_system_crud
from apps.vadmin.help import models as vadmin_help_models
import copy
from utils import status
from utils.wx.oauth import WXOAuth
from datetime import datetime
class UserDal(DalBase):
import_headers = [
{"label": "姓名", "field": "name", "required": True},
{"label": "昵称", "field": "nickname", "required": False},
{"label": "手机号", "field": "telephone", "required": True, "rules": [vali_telephone]},
{"label": "性别", "field": "gender", "required": False},
{"label": "关联角色", "field": "role_ids", "required": True, "type": FieldType.list},
]
def __init__(self, db: AsyncSession):
super(UserDal, self).__init__()
self.db = db
self.model = models.VadminUser
self.schema = schemas.UserSimpleOut
async def recursion_get_dept_ids(
self,
user: models.VadminUser,
depts: list[models.VadminDept] = None,
dept_ids: list[int] = None
) -> list:
"""
递归获取所有关联部门 id
:param user:
:param depts: 所有部门实例
:param dept_ids: 父级部门 id 列表
:return:
"""
if not depts:
depts = await DeptDal(self.db).get_datas(limit=0, v_return_objs=True)
result = []
for i in user.depts:
result.append(i.id)
result.extend(await self.recursion_get_dept_ids(user, depts, result))
return list(set(result))
elif dept_ids:
result = [i.id for i in filter(lambda item: item.parent_id in dept_ids, depts)]
result.extend(await self.recursion_get_dept_ids(user, depts, result))
return result
else:
return []
async def update_login_info(self, user: models.VadminUser, last_ip: str) -> None:
"""
更新当前登录信息
:param user: 用户对象
:param last_ip: 最近一次登录 IP
:return:
"""
user.last_ip = last_ip
user.last_login = datetime.now()
await self.db.flush()
async def create_data(
self,
data: schemas.UserIn,
v_options: list[_AbstractLoad] = None,
v_return_obj: bool = False,
v_schema: Any = None
) -> Any:
"""
创建用户
:param data:
:param v_options:
:param v_return_obj:
:param v_schema:
:return:
"""
unique = await self.get_data(telephone=data.telephone, v_return_none=True)
if unique:
raise CustomException("手机号已存在!", code=status.HTTP_ERROR)
password = data.telephone[5:12] if settings.DEFAULT_PASSWORD == "0" else settings.DEFAULT_PASSWORD
data.password = self.model.get_password_hash(password)
data.avatar = data.avatar if data.avatar else settings.DEFAULT_AVATAR
obj = self.model(**data.model_dump(exclude={'role_ids', "dept_ids"}))
if data.role_ids:
roles = await RoleDal(self.db).get_datas(limit=0, id=("in", data.role_ids), v_return_objs=True)
for role in roles:
obj.roles.add(role)
if data.dept_ids:
depts = await DeptDal(self.db).get_datas(limit=0, id=("in", data.dept_ids), v_return_objs=True)
for dept in depts:
obj.depts.add(dept)
await self.flush(obj)
return await self.out_dict(obj, v_options, v_return_obj, v_schema)
async def put_data(
self,
data_id: int,
data: schemas.UserUpdate,
v_options: list[_AbstractLoad] = None,
v_return_obj: bool = False,
v_schema: Any = None
) -> Any:
"""
更新用户信息
:param data_id:
:param data:
:param v_options:
:param v_return_obj:
:param v_schema:
:return:
"""
obj = await self.get_data(data_id, v_options=[joinedload(self.model.roles), joinedload(self.model.depts)])
data_dict = jsonable_encoder(data)
for key, value in data_dict.items():
if key == "role_ids":
if value:
roles = await RoleDal(self.db).get_datas(limit=0, id=("in", value), v_return_objs=True)
if obj.roles:
obj.roles.clear()
for role in roles:
obj.roles.add(role)
continue
elif key == "dept_ids":
if value:
depts = await DeptDal(self.db).get_datas(limit=0, id=("in", value), v_return_objs=True)
if obj.depts:
obj.depts.clear()
for dept in depts:
obj.depts.add(dept)
continue
setattr(obj, key, value)
await self.flush(obj)
return await self.out_dict(obj, None, v_return_obj, v_schema)
async def reset_current_password(self, user: models.VadminUser, data: schemas.ResetPwd) -> None:
"""
重置密码
:param user:
:param data:
:return:
"""
if data.password != data.password_two:
raise CustomException(msg="两次密码不一致", code=400)
result = test_password(data.password)
if isinstance(result, str):
raise CustomException(msg=result, code=400)
user.password = self.model.get_password_hash(data.password)
user.is_reset_password = True
await self.flush(user)
async def update_current_info(self, user: models.VadminUser, data: schemas.UserUpdateBaseInfo) -> Any:
"""
更新当前用户基本信息
:param user:
:param data:
:return:
"""
if data.telephone != user.telephone:
unique = await self.get_data(telephone=data.telephone, v_return_none=True)
if unique:
raise CustomException("手机号已存在!", code=status.HTTP_ERROR)
else:
user.telephone = data.telephone
user.name = data.name
user.nickname = data.nickname
user.gender = data.gender
await self.flush(user)
return await self.out_dict(user)
async def export_query_list(self, header: list, params: UserParams) -> dict:
"""
导出用户查询列表为 excel
:param header:
:param params:
:return:
"""
datas = await self.get_datas(
**params.dict(),
v_return_objs=True,
v_options=[joinedload(self.model.depts), joinedload(self.model.roles)]
)
# 获取表头
row = list(map(lambda i: i.get("label"), header))
rows = []
options = await self.get_export_headers_options()
for user in datas:
data = []
for item in header:
field = item.get("field")
# 通过反射获取对应的属性值
value = getattr(user, field, "")
if field == "is_active":
value = "可用" if value else "停用"
elif field == "is_staff":
value = "" if value else ""
elif field == "gender":
result = list(filter(lambda i: i["value"] == value, options["gender_options"]))
value = result[0]["label"] if result else ""
elif field == "roles":
value = ",".join([i.name for i in value])
elif field == "depts":
value = ",".join([i.name for i in value])
data.append(value)
rows.append(data)
em = ExcelManage()
em.create_excel("用户列表")
em.write_list(rows, row)
remote_file_url = em.save_excel().get("remote_path")
em.close()
return {"url": remote_file_url, "filename": "用户列表.xlsx"}
async def get_export_headers_options(self, include: list[str] = None) -> dict[str, list]:
"""
获取导出所需选择项
:param include: 包括的选择项
:return:
"""
options = {}
# 性别选择项
if include is None or 'gender' in include:
gender_objs = await vadmin_system_crud.DictTypeDal(self.db).get_dicts_details(["sys_vadmin_gender"])
sys_vadmin_gender = gender_objs.get("sys_vadmin_gender", [])
gender_options = [{"label": i["label"], "value": i["value"]} for i in sys_vadmin_gender]
options["gender_options"] = gender_options
return options
async def get_import_headers_options(self) -> None:
"""
补全表头数据选项
:return:
"""
# 角色选择项
role_options = await RoleDal(self.db).get_datas(limit=0, v_return_objs=True, disabled=False, is_admin=False)
role_item = self.import_headers[4]
assert isinstance(role_item, dict)
role_item["options"] = [{"label": role.name, "value": role.id} for role in role_options]
# 性别选择项
gender_options = await vadmin_system_crud.DictTypeDal(self.db).get_dicts_details(["sys_vadmin_gender"])
gender_item = self.import_headers[3]
assert isinstance(gender_item, dict)
sys_vadmin_gender = gender_options.get("sys_vadmin_gender")
gender_item["options"] = [{"label": item["label"], "value": item["value"]} for item in sys_vadmin_gender]
async def download_import_template(self) -> dict:
"""
下载用户最新版导入模板
:return:
"""
await self.get_import_headers_options()
em = WriteXlsx()
em.create_excel(sheet_name="用户导入模板", save_static=True)
em.generate_template(copy.deepcopy(self.import_headers))
em.close()
return {"url": em.get_file_url(), "filename": "用户导入模板.xlsx"}
async def import_users(self, file: UploadFile) -> dict:
"""
批量导入用户数据
:param file:
:return:
"""
await self.get_import_headers_options()
im = ImportManage(file, copy.deepcopy(self.import_headers))
await im.get_table_data()
im.check_table_data()
for item in im.success:
old_data_list = item.pop("old_data_list")
data = schemas.UserIn(**item)
try:
await self.create_data(data)
except ValueError as e:
old_data_list.append(e.__str__())
im.add_error_data(old_data_list)
except Exception:
old_data_list.append("创建失败,请联系管理员!")
im.add_error_data(old_data_list)
return {
"success_number": im.success_number,
"error_number": im.error_number,
"error_url": im.generate_error_url()
}
async def init_password(self, ids: list[int]) -> list:
"""
初始化所选用户密码
将用户密码改为系统默认密码并将初始化密码状态改为false
:param ids:
:return:
"""
users = await self.get_datas(limit=0, id=("in", ids), v_return_objs=True)
result = []
for user in users:
# 重置密码
data = {"id": user.id, "telephone": user.telephone, "name": user.name, "email": user.email}
password = user.telephone[5:12] if settings.DEFAULT_PASSWORD == "0" else settings.DEFAULT_PASSWORD
user.password = self.model.get_password_hash(password)
user.is_reset_password = False
self.db.add(user)
data["reset_password_status"] = True
data["password"] = password
result.append(data)
await self.db.flush()
return result
async def init_password_send_sms(self, ids: list[int], rd: Redis) -> list:
"""
初始化所选用户密码并发送通知短信
将用户密码改为系统默认密码并将初始化密码状态改为false
:param ids:
:param rd:
:return:
"""
result = await self.init_password(ids)
for user in result:
if not user["reset_password_status"]:
user["send_sms_status"] = False
user["send_sms_msg"] = "重置密码失败"
continue
password = user.pop("password")
sms = ResetPasswordSMS([user.get("telephone")], rd)
try:
send_result = (await sms.main_async(password=password))[0]
user["send_sms_status"] = send_result
user["send_sms_msg"] = "" if send_result else "短信发送失败,请联系管理员"
except CustomException as e:
user["send_sms_status"] = False
user["send_sms_msg"] = e.msg
return result
async def init_password_send_email(self, ids: list[int], rd: Redis) -> list:
"""
初始化所选用户密码并发送通知邮件
将用户密码改为系统默认密码并将初始化密码状态改为false
:param ids:
:param rd:
:return:
"""
result = await self.init_password(ids)
for user in result:
if not user["reset_password_status"]:
user["send_sms_status"] = False
user["send_sms_msg"] = "重置密码失败"
continue
password: str = user.pop("password")
email: str = user.get("email", None)
if email:
subject = "密码已重置"
body = f"您好,您的密码已经重置为{password},请及时登录并修改密码。"
es = EmailSender(rd)
try:
send_result = await es.send_email([email], subject, body)
user["send_sms_status"] = send_result
user["send_sms_msg"] = "" if send_result else "短信发送失败,请联系管理员"
except CustomException as e:
user["send_sms_status"] = False
user["send_sms_msg"] = e.msg
else:
user["send_sms_status"] = False
user["send_sms_msg"] = "未获取到邮箱地址"
return result
async def update_current_avatar(self, user: models.VadminUser, file: UploadFile) -> str:
"""
更新当前用户头像
:param user:
:param file:
:return:
"""
result = await AliyunOSS(BucketConf(**settings.ALIYUN_OSS)).upload_image("avatar", file)
user.avatar = result
await self.flush(user)
return result
async def update_wx_server_openid(self, code: str, user: models.VadminUser, redis: Redis) -> bool:
"""
更新用户服务端微信平台openid
:param code:
:param user:
:param redis:
:return:
"""
wx = WXOAuth(redis, 0)
openid = await wx.parsing_openid(code)
if not openid:
return False
user.is_wx_server_openid = True
user.wx_server_openid = openid
await self.flush(user)
return True
async def delete_datas(self, ids: list[int], v_soft: bool = False, **kwargs) -> None:
"""
删除多个用户软删除
删除后清空所关联的角色
:param ids: 数据集
:param v_soft: 是否执行软删除
:param kwargs: 其他更新字段
"""
options = [joinedload(self.model.roles)]
objs = await self.get_datas(limit=0, id=("in", ids), v_options=options, v_return_objs=True)
for obj in objs:
if obj.roles:
obj.roles.clear()
return await super(UserDal, self).delete_datas(ids, v_soft, **kwargs)
class RoleDal(DalBase):
def __init__(self, db: AsyncSession):
super(RoleDal, self).__init__()
self.db = db
self.model = models.VadminRole
self.schema = schemas.RoleSimpleOut
async def create_data(
self,
data: schemas.RoleIn,
v_options: list[_AbstractLoad] = None,
v_return_obj: bool = False,
v_schema: Any = None
) -> Any:
"""
创建数据
:param data:
:param v_options:
:param v_return_obj:
:param v_schema:
:return:
"""
obj = self.model(**data.model_dump(exclude={'menu_ids', 'dept_ids'}))
if data.menu_ids:
menus = await MenuDal(db=self.db).get_datas(limit=0, id=("in", data.menu_ids), v_return_objs=True)
for menu in menus:
obj.menus.add(menu)
if data.dept_ids:
depts = await DeptDal(db=self.db).get_datas(limit=0, id=("in", data.dept_ids), v_return_objs=True)
for dept in depts:
obj.depts.add(dept)
await self.flush(obj)
return await self.out_dict(obj, v_options, v_return_obj, v_schema)
async def put_data(
self,
data_id: int,
data: schemas.RoleIn,
v_options: list[_AbstractLoad] = None,
v_return_obj: bool = False,
v_schema: Any = None
) -> Any:
"""
更新单个数据
:param data_id:
:param data:
:param v_options:
:param v_return_obj:
:param v_schema:
:return:
"""
obj = await self.get_data(data_id, v_options=[joinedload(self.model.menus), joinedload(self.model.depts)])
obj_dict = jsonable_encoder(data)
for key, value in obj_dict.items():
if key == "menu_ids":
if value:
menus = await MenuDal(db=self.db).get_datas(limit=0, id=("in", value), v_return_objs=True)
if obj.menus:
obj.menus.clear()
for menu in menus:
obj.menus.add(menu)
continue
elif key == "dept_ids":
if value:
depts = await DeptDal(db=self.db).get_datas(limit=0, id=("in", value), v_return_objs=True)
if obj.depts:
obj.depts.clear()
for dept in depts:
obj.depts.add(dept)
continue
setattr(obj, key, value)
await self.flush(obj)
return await self.out_dict(obj, None, v_return_obj, v_schema)
async def get_role_menu_tree(self, role_id: int) -> list:
role = await self.get_data(role_id, v_options=[joinedload(self.model.menus)])
return [i.id for i in role.menus]
async def get_select_datas(self) -> list:
"""
获取选择数据全部数据
:return:
"""
sql = select(self.model)
queryset = await self.db.scalars(sql)
return [schemas.RoleOptionsOut.model_validate(i).model_dump() for i in queryset.all()]
async def delete_datas(self, ids: list[int], v_soft: bool = False, **kwargs) -> None:
"""
删除多个角色硬删除
如果存在用户关联则无法删除
:param ids: 数据集
:param v_soft: 是否执行软删除
:param kwargs: 其他更新字段
"""
user_count = await UserDal(self.db).get_count(v_join=[["roles"]], v_where=[models.VadminRole.id.in_(ids)])
if user_count > 0:
raise CustomException("无法删除存在用户关联的角色", code=400)
return await super(RoleDal, self).delete_datas(ids, v_soft, **kwargs)
class MenuDal(DalBase):
def __init__(self, db: AsyncSession):
super(MenuDal, self).__init__()
self.db = db
self.model = models.VadminMenu
self.schema = schemas.MenuSimpleOut
async def get_tree_list(self, mode: int) -> list:
"""
1获取菜单树列表
2获取菜单树选择项添加/修改菜单时使用
3获取菜单树列表角色添加菜单权限时使用
:param mode:
:return:
"""
if mode == 3:
sql = select(self.model).where(self.model.disabled == 0, self.model.is_delete == false())
else:
sql = select(self.model).where(self.model.is_delete == false())
queryset = await self.db.scalars(sql)
datas = list(queryset.all())
roots = filter(lambda i: not i.parent_id, datas)
if mode == 1:
menus = self.generate_tree_list(datas, roots)
elif mode == 2 or mode == 3:
menus = self.generate_tree_options(datas, roots)
else:
raise CustomException("获取菜单失败,无可用选项", code=400)
return self.menus_order(menus)
async def get_routers(self, user: models.VadminUser) -> list:
"""
获取路由表
declare interface AppCustomRouteRecordRaw extends Omit<RouteRecordRaw, 'meta'> {
name: string
meta: RouteMeta
component: string
path: string
redirect: string
children?: AppCustomRouteRecordRaw[]
}
:param user:
:return:
"""
if any([i.is_admin for i in user.roles]):
sql = select(self.model) \
.where(self.model.disabled == 0, self.model.menu_type != "2", self.model.is_delete == false())
queryset = await self.db.scalars(sql)
datas = list(queryset.all())
else:
options = [joinedload(models.VadminUser.roles).subqueryload(models.VadminRole.menus)]
user = await UserDal(self.db).get_data(user.id, v_options=options)
datas = set()
for role in user.roles:
for menu in role.menus:
# 该路由没有被禁用,并且菜单不是按钮
if not menu.disabled and menu.menu_type != "2":
datas.add(menu)
roots = filter(lambda i: not i.parent_id, datas)
menus = self.generate_router_tree(datas, roots)
return self.menus_order(menus)
def generate_router_tree(self, menus: list[models.VadminMenu], nodes: filter, name: str = "") -> list:
"""
生成路由树
:param menus: 总菜单列表
:param nodes: 节点菜单列表
:param name: name拼接切记Name不能重复
:return:
"""
data = []
for root in nodes:
router = schemas.RouterOut.model_validate(root)
router.name = name + "".join(name.capitalize() for name in router.path.split("/"))
router.meta = schemas.Meta(
title=root.title,
icon=root.icon,
hidden=root.hidden,
alwaysShow=root.alwaysShow,
noCache=root.noCache
)
if root.menu_type == "0":
sons = filter(lambda i: i.parent_id == root.id, menus)
router.children = self.generate_router_tree(menus, sons, router.name)
data.append(router.model_dump())
return data
def generate_tree_list(self, menus: list[models.VadminMenu], nodes: filter) -> list:
"""
生成菜单树列表
:param menus: 总菜单列表
:param nodes: 每层节点菜单列表
:return:
"""
data = []
for root in nodes:
router = schemas.MenuTreeListOut.model_validate(root)
if root.menu_type == "0" or root.menu_type == "1":
sons = filter(lambda i: i.parent_id == root.id, menus)
router.children = self.generate_tree_list(menus, sons)
data.append(router.model_dump())
return data
def generate_tree_options(self, menus: list[models.VadminMenu], nodes: filter) -> list:
"""
生成菜单树选择项
:param menus:总菜单列表
:param nodes:每层节点菜单列表
:return:
"""
data = []
for root in nodes:
router = {"value": root.id, "label": root.title, "order": root.order}
if root.menu_type == "0" or root.menu_type == "1":
sons = filter(lambda i: i.parent_id == root.id, menus)
router["children"] = self.generate_tree_options(menus, sons)
data.append(router)
return data
@classmethod
def menus_order(cls, datas: list, order: str = "order", children: str = "children") -> list:
"""
菜单排序
:param datas:
:param order:
:param children:
:return:
"""
result = sorted(datas, key=lambda menu: menu[order])
for item in result:
if item[children]:
item[children] = sorted(item[children], key=lambda menu: menu[order])
return result
async def delete_datas(self, ids: list[int], v_soft: bool = False, **kwargs) -> None:
"""
删除多个菜单
如果存在角色关联则无法删除
:param ids: 数据集
:param v_soft: 是否执行软删除
:param kwargs: 其他更新字段
:return:
"""
count = await RoleDal(self.db).get_count(v_join=[["menus"]], v_where=[self.model.id.in_(ids)])
if count > 0:
raise CustomException("无法删除存在角色关联的菜单", code=400)
await super(MenuDal, self).delete_datas(ids, v_soft, **kwargs)
class DeptDal(DalBase):
def __init__(self, db: AsyncSession):
super(DeptDal, self).__init__()
self.db = db
self.model = models.VadminDept
self.schema = schemas.DeptSimpleOut
async def get_tree_list(self, mode: int) -> list:
"""
1获取部门树列表
2获取部门树选择项添加/修改部门时使用
3获取部门树列表用户添加部门权限时使用
:param mode:
:return:
"""
if mode == 3:
sql = select(self.model).where(self.model.disabled == 0, self.model.is_delete == false())
else:
sql = select(self.model).where(self.model.is_delete == false())
queryset = await self.db.scalars(sql)
datas = list(queryset.all())
roots = filter(lambda i: not i.parent_id, datas)
if mode == 1:
menus = self.generate_tree_list(datas, roots)
elif mode == 2 or mode == 3:
menus = self.generate_tree_options(datas, roots)
else:
raise CustomException("获取部门失败,无可用选项", code=400)
return self.dept_order(menus)
def generate_tree_list(self, depts: list[models.VadminDept], nodes: filter) -> list:
"""
生成部门树列表
:param depts: 总部门列表
:param nodes: 每层节点部门列表
:return:
"""
data = []
for root in nodes:
router = schemas.DeptTreeListOut.model_validate(root)
sons = filter(lambda i: i.parent_id == root.id, depts)
router.children = self.generate_tree_list(depts, sons)
data.append(router.model_dump())
return data
def generate_tree_options(self, depts: list[models.VadminDept], nodes: filter) -> list:
"""
生成部门树选择项
:param depts: 总部门列表
:param nodes: 每层节点部门列表
:return:
"""
data = []
for root in nodes:
router = {"value": root.id, "label": root.name, "order": root.order}
sons = filter(lambda i: i.parent_id == root.id, depts)
router["children"] = self.generate_tree_options(depts, sons)
data.append(router)
return data
@classmethod
def dept_order(cls, datas: list, order: str = "order", children: str = "children") -> list:
"""
部门排序
:param datas:
:param order:
:param children:
:return:
"""
result = sorted(datas, key=lambda dept: dept[order])
for item in result:
if item[children]:
item[children] = sorted(item[children], key=lambda dept: dept[order])
return result
class TestDal(DalBase):
def __init__(self, db: AsyncSession):
super(TestDal, self).__init__()
self.db = db
self.model = models.VadminUser
async def test_session_cache(self):
"""
SQLAlchemy 会话Session缓存机制
当你通过一个会话查询数据库时SQLAlchemy 首先检查这个对象是否已经在会话缓存中如果是它会直接从缓存中返回对象而不是从数据库重新加载
在一个会话中对于具有相同主键的实体会话缓存确保只有一个唯一的对象实例这有助于维护数据的一致性
会话Session缓存https://blog.csdn.net/k_genius/article/details/135491059
:return:
"""
print("==================================会话缓存====================================")
await self.test_session_cache1()
print("=============查询出单个对象结果后,即使没有通过.访问属性,同样会产生缓存=============")
await self.test_session_cache2()
print("=============================数据列表会话缓存==================================")
await self.test_session_cache3()
print("=============================expire 单个对象过期==============================")
await self.test_session_cache4()
print("=========expire 单个对象过期后,重新访问之前对象的属性也会重新查询数据库,但是不会重新加载关系==========")
await self.test_session_cache5()
async def test_session_cache1(self):
"""
SQLAlchemy 会话Session缓存机制
当你通过一个会话查询数据库时SQLAlchemy 首先检查这个对象是否已经在会话缓存中如果是它会直接从缓存中返回对象而不是从数据库重新加载
在一个会话中对于具有相同主键的实体会话缓存确保只有一个唯一的对象实例这有助于维护数据的一致性
会话Session缓存https://blog.csdn.net/k_genius/article/details/135491059
示例会话缓存
:return:
"""
# 第一次查询,并加载用户的所有关联部门项
sql1 = select(models.VadminUser).where(models.VadminUser.id == 1).options(joinedload(models.VadminUser.depts))
queryset1 = await self.db.scalars(sql1)
user1 = queryset1.unique().first()
print(f"用户编号:{user1.id} 用户姓名:{user1.name} 关联部门 {[i.name for i in user1.depts]}")
# 第二次即使没有加载用户关联的部门,同样可以访问,因为这里会默认从会话缓存中获取
sql2 = select(models.VadminUser).where(models.VadminUser.id == 1)
queryset2 = await self.db.scalars(sql2)
user2 = queryset2.first()
print(f"用户编号:{user2.id} 用户姓名:{user2.name} 关联部门 {[i.name for i in user2.depts]}")
async def test_session_cache2(self):
"""
SQLAlchemy 会话Session缓存机制
当你通过一个会话查询数据库时SQLAlchemy 首先检查这个对象是否已经在会话缓存中如果是它会直接从缓存中返回对象而不是从数据库重新加载
在一个会话中对于具有相同主键的实体会话缓存确保只有一个唯一的对象实例这有助于维护数据的一致性
会话Session缓存https://blog.csdn.net/k_genius/article/details/135491059
示例查询出单个对象结果后即使没有通过.访问属性同样会产生缓存
:return:
"""
# 第一次查询,并加载用户的所有关联部门项,但是不访问用户的属性
sql1 = select(models.VadminUser).where(models.VadminUser.id == 1).options(joinedload(models.VadminUser.depts))
queryset1 = await self.db.scalars(sql1)
user1 = queryset1.unique().first()
print(f"没有访问属性,也会产生缓存")
# 第二次即使没有加载用户关联的部门,同样可以访问,因为这里会默认从会话缓存中获取
sql2 = select(models.VadminUser).where(models.VadminUser.id == 1)
queryset2 = await self.db.scalars(sql2)
user2 = queryset2.first()
print(f"用户编号:{user2.id} 用户姓名:{user2.name} 关联部门 {[i.name for i in user2.depts]}")
async def test_session_cache3(self):
"""
SQLAlchemy 会话Session缓存机制
当你通过一个会话查询数据库时SQLAlchemy 首先检查这个对象是否已经在会话缓存中如果是它会直接从缓存中返回对象而不是从数据库重新加载
在一个会话中对于具有相同主键的实体会话缓存确保只有一个唯一的对象实例这有助于维护数据的一致性
会话Session缓存https://blog.csdn.net/k_genius/article/details/135491059
示例数据列表会话缓存
:return:
"""
# 第一次查询出所有用户,并加载用户的所有关联部门项
sql1 = select(models.VadminUser).options(joinedload(models.VadminUser.depts))
queryset1 = await self.db.scalars(sql1)
datas1 = queryset1.unique().all()
for data in datas1:
print(f"用户编号:{data.id} 用户姓名:{data.name} 关联部门 {[i.name for i in data.depts]}")
# 第二次即使没有加载用户关联的部门,同样可以访问,因为这里会默认从会话缓存中获取
sql2 = select(models.VadminUser)
queryset2 = await self.db.scalars(sql2)
datas2 = queryset2.all()
for data in datas2:
print(f"用户编号:{data.id} 用户姓名:{data.name} 关联部门 {[i.name for i in data.depts]}")
async def test_session_cache4(self):
"""
SQLAlchemy 会话Session缓存机制
当你通过一个会话查询数据库时SQLAlchemy 首先检查这个对象是否已经在会话缓存中如果是它会直接从缓存中返回对象而不是从数据库重新加载
在一个会话中对于具有相同主键的实体会话缓存确保只有一个唯一的对象实例这有助于维护数据的一致性
会话Session缓存https://blog.csdn.net/k_genius/article/details/135491059
示例expire 单个对象过期
:return:
"""
# 第一次查询,并加载用户的所有关联部门项
sql1 = select(models.VadminUser).where(models.VadminUser.id == 1).options(joinedload(models.VadminUser.depts))
queryset1 = await self.db.scalars(sql1)
user1 = queryset1.unique().first()
print(f"用户编号:{user1.id} 用户姓名:{user1.name} 关联部门 {[i.name for i in user1.depts]}")
# 使当前会话Session中的 user1 对象过期,再次访问就会重新查询数据库数据
self.db.expire(user1)
# 第二次查询会发现会话中没有该对象的缓存,会重新在数据库中查询
sql2 = select(models.VadminUser).where(models.VadminUser.id == 1)
queryset2 = await self.db.scalars(sql2)
user2 = queryset2.first()
try:
print(f"用户编号:{user2.id} 用户姓名:{user2.name} 关联部门 {[i.name for i in user2.depts]}")
except StatementError:
print("访问部门报错了!!!!!")
async def test_session_cache5(self):
"""
SQLAlchemy 会话Session缓存机制
当你通过一个会话查询数据库时SQLAlchemy 首先检查这个对象是否已经在会话缓存中如果是它会直接从缓存中返回对象而不是从数据库重新加载
在一个会话中对于具有相同主键的实体会话缓存确保只有一个唯一的对象实例这有助于维护数据的一致性
会话Session缓存https://blog.csdn.net/k_genius/article/details/135491059
示例expire 单个对象过期后重新访问之前对象的属性也会重新查询数据库但是不会重新加载关系
:return:
"""
# 第一次查询,并加载用户的所有关联部门项
sql = select(models.VadminUser).where(models.VadminUser.id == 1).options(joinedload(models.VadminUser.depts))
queryset = await self.db.scalars(sql)
user = queryset.unique().first()
print(f"用户编号:{user.id} 用户姓名:{user.name} 关联部门 {[i.name for i in user.depts]}")
# 使当前会话Session中的 user9 对象过期,再次访问就会重新查询数据库数据
self.db.expire(user)
# 第二次查询会发现会话中没有该对象的缓存,会重新在数据库中查询,但是不会重新加载关系
try:
print(f"用户编号:{user.id} 用户姓名:{user.name} 关联部门 {[i.name for i in user.depts]}")
except StatementError:
print("访问部门报错了!!!!!")
async def test_join_form(self):
"""
join_form 使用示例通过关联表的查询条件反查询出主表的数据
官方描述在当前 Select 的左侧不符合我们想要从中进行连接的情况下可以使用 Select.join_from() 方法
官方文档https://docs.sqlalchemy.org/en/20/orm/queryguide/select.html#setting-the-leftmost-from-clause-in-a-join
查询条件获取指定用户所关联的所有部门列表数据只返回关联的部门列表数据
:return:
"""
# 设定用户编号为1
user_id = 1
sql = select(models.VadminDept).where(models.VadminDept.is_delete == false())
sql = sql.join_from(models.VadminUser, models.VadminUser.depts).where(models.VadminUser.id == user_id)
queryset = await self.db.scalars(sql)
result = queryset.unique().all()
for dept in result:
print(f"部门编号:{dept.id} 部门名称:{dept.name} 部门负责人:{dept.owner}")
# 转换后的 SQL
# SELECT
# vadmin_auth_dept.NAME,
# vadmin_auth_dept.dept_key,
# vadmin_auth_dept.disabled,
# vadmin_auth_dept.order,
# vadmin_auth_dept.desc,
# vadmin_auth_dept.OWNER,
# vadmin_auth_dept.phone,
# vadmin_auth_dept.email,
# vadmin_auth_dept.parent_id,
# vadmin_auth_dept.id,
# vadmin_auth_dept.create_datetime,
# vadmin_auth_dept.update_datetime,
# vadmin_auth_dept.delete_datetime,
# vadmin_auth_dept.is_delete
# FROM
# vadmin_auth_user
# JOIN vadmin_auth_user_depts ON vadmin_auth_user.id = vadmin_auth_user_depts.user_id
# JOIN vadmin_auth_dept ON vadmin_auth_dept.id = vadmin_auth_user_depts.dept_id
# WHERE
# vadmin_auth_dept.is_delete = FALSE
# AND vadmin_auth_user.id = 1
async def test_left_join(self):
"""
多对多左连接查询示例
查询出所有用户信息并加载用户关联所有部门左连接条件只需要查询出该用户关联的部门负责人为"张伟"的部门即可其他部门不需要显示
:return:
"""
# 封装查询语句
dept_alias = aliased(models.VadminDept)
v_options = [contains_eager(self.model.depts, alias=dept_alias)]
v_outer_join = [
[models.vadmin_auth_user_depts, self.model.id == models.vadmin_auth_user_depts.c.user_id],
[dept_alias, and_(dept_alias.id == models.vadmin_auth_user_depts.c.dept_id, dept_alias.owner == "张伟")]
]
datas: list[models.VadminUser] = await self.get_datas(
limit=0,
v_outer_join=v_outer_join,
v_options=v_options,
v_return_objs=True,
v_expire_all=True
)
for data in datas:
print(f"用户编号:{data.id} 用户名称:{data.name} 共查询出关联的部门负责人为‘张伟’的部门有如下:")
for dept in data.depts:
print(f" 部门编号:{dept.id} 部门名称:{dept.name} 部门负责人:{dept.owner}")
# 原查询语句:
# DeptAlias = aliased(models.VadminDept)
# sql = select(self.model).where(self.model.is_delete == false())
# sql = sql.options(contains_eager(self.model.depts, alias=DeptAlias))
# sql = sql.outerjoin(models.vadmin_auth_user_depts, self.model.id == models.vadmin_auth_user_depts.c.user_id)
# sql = sql.outerjoin(
# DeptAlias,
# and_(DeptAlias.id == models.vadmin_auth_user_depts.c.dept_id, DeptAlias.owner == "张伟")
# )
# self.db.expire_all()
# queryset = await self.db.scalars(sql)
# result = queryset.unique().all()
# for data in result:
# print(f"用户编号:{data.id} 用户名称:{data.name} 共查询出关联的部门负责人为‘张伟’的部门有如下:")
# for dept in data.depts:
# print(f" 部门编号:{dept.id} 部门名称:{dept.name} 部门负责人:{dept.owner}")
async def get_user_depts(self):
"""
获取用户部门列表
:return:
"""
sql1 = select(models.VadminUser).options(joinedload(models.VadminUser.depts))
queryset1 = await self.db.scalars(sql1)
datas1 = queryset1.unique().all()
for data in datas1:
print(f"用户编号:{data.id} 用户姓名:{data.name} 关联部门 {[i.name for i in data.depts]}")
async def relationship_where_operations_any(self):
"""
关系运算符操作any 方法使用示例
官方文档 https://docs.sqlalchemy.org/en/20/orm/queryguide/select.html#relationship-where-operators
any 方法用于一对多关系中允许在 any 方法中指定一个条件该条件会生成一个 SQL 表达式只有满足该条件的元素才会被查询出来
:return:
"""
print("==============================any 方法使用案例1=========================================")
# 用户表models.VadminUser与 部门表VadminDept为多对多关系
# 查找出只有满足关联了部门名称为 "人事一部" 的所有用户,没有关联的则不会查询出来
sql1 = select(models.VadminUser).where(models.VadminUser.depts.any(models.VadminDept.name == "人事一部"))
queryset1 = await self.db.scalars(sql1)
result1 = queryset1.unique().all()
for data in result1:
print(f"用户编号:{data.id} 用户名称:{data.name}")
print("==============================any 方法使用案例2=========================================")
# 案例1 取反,查找出只有满足没有关联了部门名称为 "人事一部" 的所有用户,关联的则不会查询出来
sql2 = select(models.VadminUser).where(~models.VadminUser.depts.any(models.VadminDept.name == "人事一部"))
queryset2 = await self.db.scalars(sql2)
result2 = queryset2.unique().all()
for data in result2:
print(f"用户编号:{data.id} 用户名称:{data.name}")
print("==============================any 方法使用案例3=========================================")
# 查询出没有关联部门的所有用户
sql3 = select(models.VadminUser).where(~models.VadminUser.depts.any())
queryset3 = await self.db.scalars(sql3)
result3 = queryset3.unique().all()
for data in result3:
print(f"用户编号:{data.id} 用户名称:{data.name}")
async def relationship_where_operations_has(self):
"""
关系运算符操作 has 方法使用示例
官方文档 https://docs.sqlalchemy.org/en/20/orm/queryguide/select.html#relationship-where-operators
has 方法用于多对一关系中 any 方法使用方式同理只有满足条件的元素才会被查询出来
对多关系中使用 has 方法会报错报错内容如下
sqlalchemy.exc.InvalidRequestError: 'has()' not implemented for collections. Use any().
:return:
"""
print("==============================has 方法使用案例1=========================================")
# 用户models.VadminUser与 帮助问题models.VadminIssue为多对一关系
# 查找出只有满足关联了用户名称为 "kinit" 的所有帮助问题,没有关联的则不会查询出来
sql1 = select(vadmin_help_models.VadminIssue).where(
vadmin_help_models.VadminIssue.create_user.has(models.VadminUser.name == "kinit")
)
queryset1 = await self.db.scalars(sql1)
result1 = queryset1.unique().all()
for data in result1:
print(f"问题编号:{data.id} 问题标题:{data.title}")