#!/usr/bin/python # -*- coding: utf-8 -*- # @version : 1.0 # @Creaet Time : 2021/10/18 22:18 # @File : crud.py # @IDE : PyCharm # @desc : 数据库 增删改查操作 # sqlalchemy 查询操作:https://segmentfault.com/a/1190000016767008 # sqlalchemy 查询操作(官方文档): https://www.osgeo.cn/sqlalchemy/orm/queryguide.html # sqlalchemy 增删改操作:https://www.osgeo.cn/sqlalchemy/tutorial/orm_data_manipulation.html#updating-orm-objects # SQLAlchemy lazy load和eager load: https://www.jianshu.com/p/dfad7c08c57a # Mysql中内连接,左连接和右连接的区别总结:https://www.cnblogs.com/restartyang/articles/9080993.html # SQLAlchemy INNER JOIN 内连接 # selectinload 官方文档: # https://www.osgeo.cn/sqlalchemy/orm/loading_relationships.html?highlight=selectinload#sqlalchemy.orm.selectinload # SQLAlchemy LEFT OUTER JOIN 左连接 # joinedload 官方文档: # https://www.osgeo.cn/sqlalchemy/orm/loading_relationships.html?highlight=selectinload#sqlalchemy.orm.joinedload import datetime from typing import List from fastapi import HTTPException from fastapi.encoders import jsonable_encoder from sqlalchemy import func, delete, update, or_ from sqlalchemy.future import select from sqlalchemy.ext.asyncio import AsyncSession from starlette import status from core.logger import logger from sqlalchemy.sql.selectable import Select from typing import Any class DalBase: # 倒叙 ORDER_FIELD = ["desc", "descending"] def __init__(self, db: AsyncSession, model: Any, schema: Any, key_models: dict = None): self.db = db self.model = model self.schema = schema self.key_models = key_models async def get_data( self, data_id: int = None, v_options: list = None, v_join_query: dict = None, v_order: str = None, v_return_none: bool = False, v_schema: Any = None, **kwargs ): """ 获取单个数据,默认使用 ID 查询,否则使用关键词查询 :param data_id: 数据 ID :param v_options: 指示应使用select在预加载中加载给定的属性。 :param v_join_query: 外键字段查询,内连接 :param v_order: 排序,默认正序,为 desc 是倒叙 :param v_return_none: 是否返回空 None,否认 抛出异常,默认抛出异常 :param v_schema: 指定使用的序列化对象 :param kwargs: 查询参数 """ sql = select(self.model).where(self.model.is_delete == False) if data_id: sql = sql.where(self.model.id == data_id) sql = self.add_filter_condition(sql, v_join_query, v_options, **kwargs) if v_order and (v_order in self.ORDER_FIELD): sql = sql.order_by(self.model.create_datetime.desc()) queryset = await self.db.execute(sql) data = queryset.scalars().unique().first() if not data and v_return_none: return None if data and v_schema: return v_schema.from_orm(data).dict() if data: return data raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="未找到此数据") async def get_datas( self, page: int = 1, limit: int = 10, v_join_query: dict = None, v_options: list = None, v_order: str = None, v_order_field: str = None, v_return_objs: bool = False, v_start_sql: Any = None, v_schema: Any = None, **kwargs ): """ 获取数据列表 :param page: 页码 :param limit: 当前页数据量 :param v_join_query: 外键字段查询 :param v_options: 指示应使用select在预加载中加载给定的属性。 :param v_schema: 指定使用的序列化对象 :param v_order: 排序,默认正序,为 desc 是倒叙 :param v_order_field: 排序字段 :param v_return_objs: 是否返回对象 :param v_start_sql: 初始 sql :param kwargs: 查询参数 """ if not isinstance(v_start_sql, Select): v_start_sql = select(self.model).where(self.model.is_delete == False) sql = self.add_filter_condition(v_start_sql, v_join_query, v_options, **kwargs) if v_order_field and (v_order in self.ORDER_FIELD): sql = sql.order_by(getattr(self.model, v_order_field).desc(), self.model.id.desc()) elif v_order_field: sql = sql.order_by(getattr(self.model, v_order_field), self.model.id) elif v_order in self.ORDER_FIELD: sql = sql.order_by(self.model.id.desc()) if limit != 0: sql = sql.offset((page - 1) * limit).limit(limit) queryset = await self.db.execute(sql) if v_return_objs: return queryset.scalars().unique().all() return [await self.out_dict(i, v_schema=v_schema) for i in queryset.scalars().unique().all()] async def get_count(self, v_join_query: dict = None, v_options: list = None, **kwargs): """ 获取数据总数 :param v_join_query: 外键字段查询 :param v_options: 指示应使用select在预加载中加载给定的属性。 :param kwargs: 查询参数 """ sql = select(func.count(self.model.id).label('total')).where(self.model.is_delete == False) sql = self.add_filter_condition(sql, v_join_query, v_options, **kwargs) queryset = await self.db.execute(sql) return queryset.one()['total'] async def create_data(self, data, v_options: list = None, v_return_obj: bool = False, v_schema: Any = None): """ 创建数据 :param data: 创建数据 :param v_options: 指示应使用select在预加载中加载给定的属性。 :param v_schema: ,指定使用的序列化对象 :param v_return_obj: ,是否返回对象 """ if isinstance(data, dict): obj = self.model(**data) else: obj = self.model(**data.dict()) 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: Any, v_options: list = None, v_return_obj: bool = False, v_schema: Any = None ): """ 更新单个数据 :param data_id: 修改行数据的 ID :param data: 数据内容 :param v_options: 指示应使用select在预加载中加载给定的属性。 :param v_return_obj: ,是否返回对象 :param v_schema: ,指定使用的序列化对象 """ obj = await self.get_data(data_id, v_options=v_options) obj_dict = jsonable_encoder(data) for key, value in obj_dict.items(): setattr(obj, key, value) await self.flush(obj) return await self.out_dict(obj, None, v_return_obj, v_schema) async def delete_datas(self, ids: List[int], v_soft: bool = False, **kwargs): """ 删除多条数据 :param ids: 数据集 :param v_soft: 是否执行软删除 :param kwargs: 其他更新字段 """ if v_soft: await self.db.execute( update(self.model).where(self.model.id.in_(ids)).values( delete_datetime=datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"), is_delete=True, **kwargs ) ) else: await self.db.execute(delete(self.model).where(self.model.id.in_(ids))) def add_filter_condition(self, sql: select, v_join_query: dict = None, v_options: list = None, **kwargs) -> select: """ 添加过滤条件,以及内连接过滤条件 :param sql: :param v_join_query: 外键字段查询,内连接 :param v_options: 指示应使用select在预加载中加载给定的属性。 :param kwargs: 关键词参数 """ if v_join_query and self.key_models: for key, value in v_join_query.items(): foreign_key = self.key_models.get(key) if foreign_key and foreign_key.get("model"): # 当外键模型在查询模型中存在多个外键时,则需要添加onclause属性 sql = sql.join(foreign_key.get("model"), onclause=foreign_key.get("onclause", None)) for v_key, v_value in value.items(): if v_value is not None and v_value != "": v_attr = getattr(foreign_key.get("model"), v_key, None) sql = self.filter_condition(sql, v_attr, v_value) else: logger.error(f"外键查询报错:{key}模型不存在,无法进行下一步查询。") elif v_join_query and not self.key_models: logger.error(f"外键查询报错:key_models 外键模型无配置项,无法进行下一步查询。") for field in kwargs: value = kwargs.get(field) if value is not None and value != "": attr = getattr(self.model, field, None) sql = self.filter_condition(sql, attr, value) if v_options: sql = sql.options(*[load for load in v_options]) return sql @classmethod def filter_condition(cls, sql: Any, attr: Any, value: Any): """ 过滤条件 """ if not attr: return sql if isinstance(value, tuple): if len(value) == 1: if value[0] == "None": sql = sql.where(attr.is_(None)) elif value[0] == "not None": sql = sql.where(attr.isnot(None)) elif len(value) == 2 and value[1] is not None: if value[0] == "date": # 根据日期查询, 关键函数是:func.time_format和func.date_format sql = sql.where(func.date_format(attr, "%Y-%m-%d") == value[1]) elif value[0] == "like": sql = sql.where(attr.like(f"%{value[1]}%")) elif value[0] == "or": sql = sql.where(or_(i for i in value[1])) elif value[0] == "in": sql = sql.where(attr.in_(value[1])) elif value[0] == "between" and len(value[1]) == 2: sql = sql.where(attr.between(value[1][0], value[1][1])) elif value[0] == "month": sql = sql.where(func.date_format(attr, "%Y-%m") == value[1]) elif value[0] == "!=": sql = sql.where(attr != value[1]) elif value[0] == ">": sql = sql.where(attr > value[1]) else: sql = sql.where(attr == value) return sql async def flush(self, obj: Any = None): """ 刷新到数据库 """ if obj: self.db.add(obj) await self.db.flush() if obj: await self.db.refresh(obj) async def out_dict(self, obj: Any, v_options: list = None, v_return_obj: bool = False, v_schema: Any = None): """ 序列化 :param obj: :param v_options: 指示应使用select在预加载中加载给定的属性。 :param v_return_obj: ,是否返回对象 :param v_schema: ,指定使用的序列化对象 :return: """ if v_options: obj = await self.get_data(obj.id, v_options=v_options) if v_return_obj: return obj if v_schema: return v_schema.from_orm(obj).dict() return self.schema.from_orm(obj).dict()