SQL 사용을 위한 매우 편리한 Python 아티팩트!

Background

사실 처음에는 pymysql을 사용했는데 유지관리가 번거롭고 코드 인젝션의 위험이 있다는 것을 알고 그냥 ORM 프레임워크를 직접 사용했습니다.

ORM은 간단히 말해서 데이터베이스 테이블과 Python 클래스 간의 매핑으로 이해하면 되는 Object Relational Mapper입니다. Python 클래스를 조작하여 간접적으로 데이터베이스를 조작할 수 있습니다.

더 유명한 Python ORM 프레임워크는 SQLAlchemy와 Peewee입니다. 여기서는 비교하지 않고 SQLAlchemy의 개인적인 용도에 대해 간단히 설명하겠습니다.

• sqlalchemy 버전: 1.3.15
• pymysql 버전: 0.9.3
• mysql 버전: 5.7

초기화 작업

일반적으로 ORM 프레임워크를 사용하면 데이터베이스 연결, 기본 매핑 정의 등

MySQL을 예로 들어 데이터베이스 연결을 생성하려면 DSN 문자열만 전달하면 됩니다. Echo는 해당 SQL 문을 출력할지 여부를 나타내며 이는 디버깅에 도움이 됩니다.

from sqlalchemy import create_engine
engine = create_engine('mysql+pymysql://$user:$password@$host:$port/$db?charset=utf8mb4', echo=True)

개인 디자인

저는 개인적으로 ORM 프레임워크를 소개할 때 내 프로젝트에서 다음 디자인에 대해 MVC 패턴을 참조하게 됩니다. 그 중 모델은 일부 데이터베이스 모델을 저장합니다. 즉, 데이터베이스 테이블에 매핑된 Python 클래스는 호출자(예: main.py)에 해당하는 작업, 즉 추가, 삭제, 확인 및 수정을 저장합니다. 데이터베이스 작업을 수행하고, model_op 레이어만 호출하면 되며, 디커플링을 달성하기 위해 모델 레이어에 신경 쓸 필요가 없습니다.

├── main.py
├── model
│ ├── __init__.py
│ ├── base_model.py
│ ├── ddl.sql
│ └── py_orm_model.py
└── model_op
├── __init__.py
└── py_orm_model_op.py

매핑문(모델 소개)

예를 들어 이런 테스트 테이블이 있다고 해보자.

create table py_orm (
`id` int(11) NOT NULL AUTO_INCREMENT COMMENT '唯一id',
`name` varchar(255) NOT NULL DEFAULT '' COMMENT '名称',
`attr` JSON NOT NULL COMMENT '属性',
`ct` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
`ut` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON update CURRENT_TIMESTAMP COMMENT '更新时间',
PRIMARY KEY(`id`)
)ENGINE=InnoDB COMMENT '测试表';

ORM 프레임워크에서 매핑 결과는 아래 Python 클래스입니다.

# py_orm_model.py
from .base_model import Base
from sqlalchemy import Column, Integer, String, TIMESTAMP, text, JSON
class PyOrmModel(Base):
__tablename__ = 'py_orm'
id = Column(Integer, autoincrement=True, primary_key=True, comment='唯一id')
name = Column(String(255), nullable=False, default='', comment='名称')
attr = Column(JSON, nullable=False, comment='属性')
ct = Column(TIMESTAMP, nullable=False, server_default=text('CURRENT_TIMESTAMP'), comment='创建时间')
ut = Column(TIMESTAMP, nullable=False, server_default=text('CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP'), comment='更新时间')

먼저 PyOrmModel이 sqlalchemy에서 제공하는 기본 클래스인 Base 클래스를 상속하는 것을 볼 수 있습니다. 이는 우리가 선언한 Python 클래스에 대해 몇 가지 검사를 수행하고 이를 base_model에 넣습니다.

# base_model.py
# 一般base_model做的都是一些初始化的工作
from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
engine = create_engine("mysql+pymysql://root:123456@127.0.0.1:33306/orm_test?charset=utf8mb4", echo=False)

두 번째로, 각 Python 클래스에는 __tablename__ 속성이 포함되어야 합니다. 그렇지 않으면 해당 테이블을 찾을 수 없습니다.

셋째, 데이터 테이블을 생성하는 방법에는 두 가지가 있습니다. 첫 번째는 물론 Python 클래스 정의에 문제가 없으면 정상적으로 작동할 수 있습니다. 아래와 같은 ORM 프레임워크를 통해.

# main.py
# 注意这里的导入路径，Base创建表时会寻找继承它的子类，如果路径不对，则无法创建成功
from sqlachlemy_lab import Base, engine
if __name__ == '__main__':
Base.metadata.create_all(engine)

생성 효과:

...
2020-04-04 10:12:53,974 INFO sqlalchemy.engine.base.Engine
CREATE TABLE py_orm (
id INTEGER NOT NULL AUTO_INCREMENT,
name VARCHAR(255) NOT NULL DEFAULT '' COMMENT '名称',
attr JSON NOT NULL COMMENT '属性',
ct TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
ut TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
PRIMARY KEY (id)
)

넷째, 필드 속성에 대해:

1.primary_key 및 자동 증가는 이해하기 쉽고 MySQL의 기본 키이자 증분 속성입니다.

2. int형일 경우 길이를 지정하지 않으셔도 되지만, varchar형일 경우 길이를 지정해주셔야 합니다.

3.nullable은 MySQL의 NULL 및 NOT NULL에 해당합니다

4. default 및 server_default 정보: default는 ORM 프레임워크 수준의 기본값을 나타냅니다. 즉, 삽입 시 필드에 값이 할당되지 않은 경우 정의는 기본값은 server_default로 데이터베이스 수준의 기본값, 즉 DDL 문의 기본 키워드를 나타냅니다.

세션 소개

SQLAlchemy 문서에는 데이터베이스에 대한 추가, 삭제, 수정이 세션을 통해 수행된다고 언급되어 있습니다.

>>> from sqlalchemy.orm import sessionmaker
>>> Session = sessionmaker(bind=engine)
>>> session = Session()
>>> orm = PyOrmModel(id=1, name='test', attr={})
>>> session.add(orm)
>>> session.commit()
>>> session.close()

위와 같이 각 작업에 대해 세션을 획득, 제출 및 해제해야 함을 알 수 있습니다. 이는 너무 중복되고 번거롭기 때문에 일반적으로 캡슐화 계층을 수행합니다.

1. 비정상적인 롤백 및 세션 종료를 처리하려면 컨텍스트 관리자를 사용하세요. 이 부분은 참조된 기사와 거의 일치합니다.

# base_model.py
from contextlib import contextmanager
from sqlalchemy.orm import sessionmaker, scoped_session
def _get_session():
"""获取session"""
return scoped_session(sessionmaker(bind=engine, expire_on_commit=False))()
# 在这里对session进行统一管理，包括获取，提交，回滚和关闭
@contextmanager
def db_session(commit=True):
session = _get_session()
try:
yield session
if commit:
session.commit()
except Exception as e:
session.rollback()
raise e
finally:
if session:
session.close()

2. 모델과 사전 간 변환을 위해 PyOrmModel에 두 가지 메서드를 추가합니다.

class PyOrmModel(Base):
...
@staticmethod
def fields():
return ['id', 'name', 'attr']
@staticmethod
def to_json(model):
fields = PyOrmModel.fields()
json_data = {}
for field in fields:
json_data[field] = model.__getattribute__(field)
return json_data
@staticmethod
def from_json(data: dict):
fields = PyOrmModel.fields()
model = PyOrmModel()
for field in fields:
if field in data:
model.__setattr__(field, data[field])
return model

3. 데이터베이스 작업의 캡슐화. 참조 기사와 달리 세션을 직접 호출하므로 호출자가 모델 계층에 주의를 기울일 필요가 없으며 결합도가 줄어듭니다.

# py_orm_model_op.py
from sqlachlemy_lab.model import db_session
from sqlachlemy_lab.model import PyOrmModel
class PyOrmModelOp:
def __init__(self):
pass
@staticmethod
def save_data(data: dict):
with db_session() as session:
model = PyOrmModel.from_json(data)
session.add(model)
# 查询操作，不需要commit
@staticmethod
def query_data(pid: int):
data_list = []
with db_session(commit=False) as session:
data = session.query(PyOrmModel).filter(PyOrmModel.id == pid)
for d in data:
data_list.append(PyOrmModel.to_json(d))
return data_list

4. 발신자:

# main.py
from sqlachlemy_lab.model_op import PyOrmModelOp
if __name__ == '__main__':
PyOrmModelOp.save_data({'id': 1, 'name': 'test', 'attr': {}})

.

위 내용은 SQL 사용을 위한 매우 편리한 Python 아티팩트!의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!