[ Flask ] Flask에서 SQLAlchemy 사용하기! [ Flask ORM ]

플라스크에서 SQLAlchemy 사용해보기!

SQLAlchemy 란?

SQLAlchemy는 파이썬을 위한 ORM(Object-relational-mapping) 중 하나입니다.
ORM을 사용하면 SQL 질의어를 쓰지 않고, CRUD 등을 공통된 접근 기법으로 사용할 수 있습니다.
Flask에서는 사용하기 쉽게 만들어진 Flask-SQLAlchemy가 있습니다.

이때 ORM 이란 무엇일까?

ORM은 Object Relational Mapping 즉, 객체-관계 매핑의 줄임말입니다.

객체-관계 매핑을 풀어서 설명하자면 우리가 객체지향 프로그래밍(Object Oriented Programming)에서 쓰이는 객체라는 개념을 구현한 클래스와 관계형 데이터베이스(Relational DataBase)에서 쓰이는 데이터인 테이블을 자동으로 매핑(연결)하는 것을 의미합니다.

그러나 클래스와 테이블은 서로가 기존부터 호환가능성을 두고 만들어진 것이 아니기 때문에 불일치가 발생하는데, 이를 ORM을 통해 객체 간의 관계를 바탕으로 SQL문을 자동으로 생성하여 불일치를 해결합니다. 따라서 ORM을 이용하면 따로 SQL문을 짤 필요 없이 객체를 통해 간접적으로 데이터베이스를 조작할 수 있게 됩니다.

---

위의 설명을 간단하게 말하면 데이터베이스를 사용하려면 SQL 쿼리(query)라는 구조화된 질의를 작성하고 실행하는 등의 복잡한 과정이 필요하지만 이때 ORM을 이용하면 파이썬 문법만으로도 데이터베이스를 다룰 수 있게됩니다.

즉, ORM을 이용하면 개발자가 쿼리를 직접 작성하지 않아도 데이터베이스의 데이터를 처리할 수 있습니다.

---

ORM의 장점👍

 

• 객체 지향적 코드로 인해 더 직관적이고 비즈니스 로직에 집중할 수 있도록 도와준다.
  • CRUD을 위한 긴 SQL 문장을 작성할 필요가 없다. (여전히 쿼리 작성은 필요하지만)
  • 각 객체(Model) 별로 코드를 작성하여 가독성을 높여 준다.
  • SQL의 절차적 접근이 아닌 객체적인 접근으로 생산성을 높여 준다.

• 재사용 및 유지보수의 편리성이 증가한다.
  • 매핑 정보가 명확하여, ERD를 보는 것에 대한 의존도를 낮출 수 있다.
  • ORM은 독립적으로 작성이 되어 있고 해당 객체들은 재사용이 가능하다.
• DBMS에 대한 종속성이 줄어든다.
  • 대부분의 ORM은 DB에 종속적이지 않다.
  • 개발자는 Object에 집중함으로 DBMS를 교체하는 극단적인 작업에도 비교적 적은 리스크와 시간이 소요된다.
  • 종속적이지 않다는 것은 구현 방법뿐만 아니라 많은 설루션에서 자료형 타입까지 유효하다.
  (종속성이란? : 프로그램 구조가 데이터 구조에 영향을 받는 것을 의미한다!.)
  
• DBMS(DataBase Management System) 종속성 하락
  • 객체 간의 관계를 바탕으로 SQL문을 자동으로 생성하고, 객체의 자료형 타입까지 사용할 수 있기 때문에 RDBMS의 데이터 구조와 객체지향 모델 사이의 간격을 좁힐 수 있다. 객체에만 집중할 수 있기 때문에 DBMS를 교체하는 큰 작업에도 리스크가 적고 드는 시간도 줄어든다.

ORM 단점🤦‍♂️

• 완벽한 ORM만으로는 구현하기가 어렵다.
  • 사용하기에는 편하지만 설계에는 매우 신중해야 한다.
  • 프로젝트의 복잡성이 높아질 경우 난이도 또한 올라갈 수 있다.
  • 잘못 구현된 경우 속도 저하 및 심한 경우 일관성이 무너지는 문제점이 생길 수 있다.
• 프로시저가 많은 시스템에서는 ORM의 객체 지향적인 장점을 활용하기 어렵다.
  • 이미 프로시저가 많은 시스템에서는 다시 객체로 바꿔야 하며, 그 과정에서 생산성 저하 혹은 리스크가 발생할 수 있다.
    (프로시저란? : 특정 작업을 위한 프로그램의 일부. 함수와 같은 의미)

• 객체-관계 간의 불일치
  • 세분 성(Granularity)
    
    • 경우에 따라서 데이터베이스에 있는 테이블 수보다 더 많은 클래스를 가진 모델이 생길 수 있다.
  • 상속 성(Inheritance)
    
    • RDBMS는 객체지향 프로그래밍 언어의 특징인 상속 개념이 없다.

---

위에선 이제 ORM에 대한 설명과 장점, 단점에 대해 알아보았습니다.

이제 직접 ORM 중 하나인 SQLAlchemy를 사용해보겠습니다.

SQLAlchemy는 여러 가지 일반적인 관계형 데이터베이스(mysql, Postgres, oracle, mssql, sqlite 등)를 지원합니다.

저는 Python의 기본 패키지에 포함되어 있는 sqlite를 사용하겠습니다.

---

Flask SQLAlchemy 설치하기

Flask에서 SQLAlchemy를 사용하기 위해 먼저 설치합니다.

# flask-sqlalchemy 설치
pip install flask-sqlalchemy

 

모델 추가하기

from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()


class Vegan(db.Model):
    __tablename__ = "vegan"  # 기본적으로 테이블 이름은 자동으로 정의되지만 이 처럼 명시적으로 정할 수 있다.

    id = db.Column(db.Integer, primary_key=True)
    shop = db.Column(db.String(30))
    address = db.Column(db.String(50))
    sector = db.Column(db.String(10))
    menu = db.Column(db.String(255))
    latitude = db.Column(db.String(30))
    longitude = db.Column(db.String(30))

위처럼 models.py 파일을 만들어준 후, SQLAlchemy의 기능을 사용하기 위해 db.Model을 상속받습니다.

기본적으로 데이터베이스 테이블 이름은 자동으로 정의되지만 __table_name__을 이용해 명시적으로 정할 수 있습니다.

테이블의 칼럼을 만들기 위해서는 db.Column()을 이용합니다.
db.Column()은 데이터 타입에 대한 정보와 제약 조건들을 넣어줄 수 있습니다.

저는 식당 이름을 넣을 shop, 도로명 주소를 넣을 address, 업종을 넣을 sector 식당 판매 메뉴인 menu,

그리고 위,경도를 저장할 latitude와 longitude 를 넣어줬습니다.

DB 연동하기

# app.py
# 현재있는 파일의 디렉토리 절대경로
base_dir = os.path.abspath(os.path.dirname(__file__))

# basdir 경로안에 DB파일 만들기
db_file = os.path.join(base_dir, 'db.sqlite')

# SQLAlchemy 설정

# 내가 사용 할 DB URI
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' + db_file
# 비지니스 로직이 끝날때 Commit 실행(DB반영)
app.config['SQLALCHEMY_COMMIT_ON_TEARDOWN'] = True
# 수정사항에 대한 TRACK
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
# SECRET_KEY

secret_file = os.path.join(base_dir, 'secrets.json')  # secrets.json 파일 위치를 명시
with open(secret_file) as f:
    secrets = json.loads(f.read())['SECRET_KEY']
app.config['SECRET_KEY'] = secrets

db.init_app(app)
db.app = app
db.create_all()

기존에 있던 app.py 에 위와 같은 코드를 추가해줍니다.
app.config ['SQLALCHEMY_DATABASE_URI']에서 SQLAlchemy에서 사용할 데이터베이스를 설정하고 연결한다.

이때 각 데이터베이스 별 연결방법은 여기! 를 클릭해서 참고하시면 됩니다! 

또한 여러 가지 config 설정에 대해 알아보고 싶다면 여기! 를 클릭해서 참고해주세요!
SQLALCHEMY_TRACK_MODIFICATIONS의 경우에는 추가적인 메모리를 필요로 하므로 False로 둡니다.

설정하지 않으면 최신 버전에서는 Warning 메시지가 발생합니다.

---

전체 코드

import os
import json
from flask import Flask
from models import db

app = Flask(__name__)

# 현재있는 파일의 디렉토리 절대경로
base_dir = os.path.abspath(os.path.dirname(__file__))

# basdir 경로안에 DB파일 만들기
db_file = os.path.join(base_dir, 'db.sqlite')

# SQLAlchemy 설정

# 내가 사용 할 DB URI
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' + db_file
# 비지니스 로직이 끝날때 Commit 실행(DB반영)
app.config['SQLALCHEMY_COMMIT_ON_TEARDOWN'] = True
# 수정사항에 대한 TRACK
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
# SECRET_KEY

secret_file = os.path.join(base_dir, 'secrets.json')  # secrets.json 파일 위치를 명시
with open(secret_file) as f:
    secrets = json.loads(f.read())['SECRET_KEY']
app.config['SECRET_KEY'] = secrets

db.init_app(app)
db.app = app
db.create_all()


if __name__ == '__main__':
    app.run()

위처럼 작성하고 python app.py 명령어로 flask 서버를 실행시키면 project 폴더 안에 db.sqlite 파일이 생깁니다!