Flask로 만드는 블로그

데이터베이스

이전 시간에 우리는 부트스트랩을 이용해서 어플리케이션의 디자인을 조금 세련되게 변경했습니다.

이번에는 사용자와 게시물에 대한 정보를 저장하기 위한 데이터베이스를 만들어보도록 하겠습니다.

Flask는 데이터베이스 기능을 내장하고 있지 않습니다. 따라서 우리는 적합한 데이터베이스를 골라서 사용해야 합니다. 각 데이터베이스마다 사용되는 API도 다르고, SQL 문법도 다릅니다. Python의 객체에 데이터 모델을 정의하고 이를 데이터베이스와 매핑해주는 것을 ORM(Object Relaition Model)이라고 합니다. 덕분에 코드는 특정 데이터베이스에 종속되지 않고, 기본 객체 만으로 데이터를 기술할 수 있기 때문에 조금 더 OOP 스러운 코드를 작성할 수 있습니다.

Python에서 ORM으로 많이 쓰이는 것 중 SQLAlchemy가 있는데, 이를 Flask에서 플러그인 처럼 사용하기 쉽게 만들어진 Flask-SQLALchemy가 있습니다.

Flask-SQLAlchemy를 사용하려면 패키지를 설치해야 합니다.

터미널
(venv) PS flask_blog> pip install flask_sqlalchemy

Flask-SQLAlchemy를 사용하기 위해서는 `flask_sqlalchemy` 패키지를 임포트 해야 합니다.

`app.py`파일에 임포트를 추가합니다.

파일: /app.py
from datetime import datetime

from flask import Flask, render_template
from flask_sqlahcmey import SQLAlchemy

# ...

그 다음 `app`객체에 몇 가지 설정을 추가해야 합니다. 먼저 어플리케이션의 시크릿 키를 추가 합니다. 다음으로는 `SQLAlchemy`에서 사용할 데이터베이스의 위치를 알려줘야 합니다. 마지막으로 `SQLALCHEMY_TRACK_MODIFICATIONS`의 경우에는 추가적인 메모리를 필요로 하므로 꺼두는 것을 추천합니다. 설정을 완료했으면 `SQLAlchemy` 객체를 하나 만듭니다.

파일: /app.py
# ...

app = Flask(__name__)

app.config['SECRET_KEY'] = 'this is secret'
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///site.db'
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False

db = SQLAlchemy(app)

# ...

사용자 모델 추가

본 프로젝트에서 사용자는 사용자 계정 이름을 갖고, 이메일과 암호가 있으며 프로필 사진을 저장할 수 있는 공간이 필요합니다.

먼저 사용자 데이터 모델을 나타내는 객체를 하나 선언 합니다. 그리고 SQLAlchemy의 기능을 사용하기 위해 `db.Model`을 상속 받습니다. 기본적으로 데이터베이스 테이블 이름은 자동으로 정의되지만 `__table_name__`을 이용해 명시적으로 정할 수 있습니다.

파일: /app.py
# ...

class User(db.Model):
    __table_name__ = 'user'

사용자 데이터 모델을 나타내는 객체를 선언했는데, 이제 여기에 모델이 갖고 있어야 하는 필드와 관련된 제약사항들을 적어줘야 합니다.

`id` 필드는 대부분의 모델에서 기본 키로 사용합니다.

`username`, `email`, `password`, `profile_image` 필드는 문자열로 정의를 하고, 최대 길이를 명시하여 공간을 절약할 수 있도록 합니다. 또한 `username`과 `email` 필드는 서로 중복되지 않아야 하고, 비어있지 않아야 합니다. `password` 필드의 경우에는 중복되는 것은 괜찮지만 비어있지 않아야 합니다. 그리고 보안을 위해 평문으로 저장하는 것이 아니라 암호화를 해서 저장을 해야 합니다. `profile_image` 필드는 이미지 데이터를 DB에 직접 저장하는 것이 아니라 파일 시스템에 저장한 다음 그 파일 이름만 저장할 예정입니다. 그리고 프로필 이미지는 모든 사람이 처음부터 넣는 것은 아니기 때문에 기본 이미지 파일을 가리킬 필요가 있습니다. 기본 이미지 파일은 `default.png`로 설정하도록 하겠습니다.

테이블의 컬럼을 만들기 위해서는 `db.Column()`을 이용합니다. 컬럼의 이름은 기본적으로 변수 이름을 사용합니다. `db.Column()`은 데이터 타입에 대한 정보와 제약 조건들을 넣어줄 수 있습니다. 위의 조건들을 바탕으로 작성된 객체는 다음과 같습니다.

파일: /app.py
# ...

class User(db.Model):
    __table_name__ = 'user'

    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(100), unique=True, nullable=False)
    email = db.Column(db.String(120), unique=True, nullable=False)
    password = db.Column(db.String(100), nullable=False)
    profile_image = db.Column(db.String(100), default='default.png')

    def __repr__(self):
        return f"<User('{self.id}', '{self.username}', '{self.email}')>"

데이터 모델 객체의 경우에도 일반적인 Python 객체처럼 `__repr__`과 같은 메소드를 사용할 수 있습니다.

이제 비밀번호를 평문이 아닌 암호화된 해시로 저장해보겠습니다.

`werkzeug.security`에 있는 `generate_password_hash`와 `check_password_hash`를 이용해 비밀번호를 암호화 할 수 있습니다.

`generate_password_hash`함수는 문자열을 암호화된 해시로 바꿔주는 역할을 합니다. `check_password_hash` 함수는 함호화된 해시와 문자열을 비교해서 이 문자열이 동일한 해시를 갖는 경우 참을 반환합니다.

다음은 터미널 상에서 `generate_password_hash`함수와 `check_password_hash`를 사용해본 결과입니다. 먼저 `password`라는 비밀번호를 `generate_password_hash` 함수로 암호화 하고, `check_password_hash` 함수를 이용해 맞는 비밀번호화 틀린 비밀번호를 넣었을 경우 결과 값을 비교했습니다.

Python shell
>>> from werkzeug.security import generate_password_hash, check_password_hash
>>> hash = generate_password_hash('password')
>>> print(hash)
pbkdf2:sha256:50000$97whKFrP$22cd755cfd64564252a44588b74579428502883399325d266398179ff3c61790
>>> check_password_hash(hash, 'password')
True
>>> check_password_hash(hash, 'wrong password')
False
>>>

맞는 경우에는 `True`를 틀린 경우에는 `False`를 반환하는 것을 알 수 있는데요.

이제 코드 상에서 비밀번호를 암호화, 복호화 하는 코드를 작성하겠습니다. 먼저 `app.py` 파일에 `werkzeug.security`에서 `generate_password_hash`와 `check_password_hash`를 임포트 합니다.

파일: /app.py
from datetime import datetime

from flask import Flask, render_template
from flask_sqlahcmey import SQLAlchemy
from werkzeug.security import generate_password_hash, check_password_hash

# ...

사용자를 추가해야할 필요가 있을 때마다 개발자가 비밀번호를 암호화해서 저장하는 로직을 넣어줄 수도 있지만 이 경우에는 사람이 하는 일이다 보니 실수하여 빼먹을 가능성이 높습니다. 따라서 암호화하는 과정은 객체를 생성할 때 해주는 것이 좋은데, `__init__`을 하는 과정에서 암호화를 할 수 있도록 객체를 수정하겠습니다.

파일: /app.py
# ...

class User(db.Model):
  __table_name__ = 'user'

    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(100), unique=True, nullable=False)
    email = db.Column(db.String(120), unique=True, nullable=False)
    password = db.Column(db.String(100), nullable=False)
    profile_image = db.Column(db.String(100), default='default.png')

  def __init__(self, username, email, password, **kwargs):
      self.username = username
      self.email = email

      self.set_password(password)

  def __repr__(self):
        return f"<User('{self.id}', '{self.username}', '{self.email}')>"

  def set_password(self, password):
    self.password = generate_password_hash(password)

  def check_password(self, password):
    return check_password_hash(self.password, password)

게시물 모델 추가

이제 게시물을 저장하는 객체에 대해 생각해보겠습니다. 게시물은 제목과 내용으로 이루어 질 것이고, 추가적으로 언제 게시되었는지, 누가 게시했는지에 대한 정보가 필요합니다.

이 중 게시자에 대한 정보는 사용자 데이터 모델에서 참조할 수 있습니다. 데이터 베이스에서 관계라고 하는데, 지금 같은 경우는 하나의 유저가 여러 게시물을 갖을 수 있는 관계가 형성됩니다.

이를 코드로 나타내면 다음과 같습니다.

파일: /app.py

# ...

class User(db.Model):
  __table_name__ = 'user'

    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(100), unique=True, nullable=False)
    email = db.Column(db.String(120), unique=True, nullable=False)
    password = db.Column(db.String(100), nullable=False)
    profile_image = db.Column(db.String(100), default='default.png')

    posts = db.relationship('Post', backref='author', lazy=True)

  def __init__(self, username, email, password, **kwargs):
      self.username = username
      self.email = email

      self.set_password(password)

  def __repr__(self):
        return f"<User('{self.id}', '{self.username}', '{self.email}')>"

  def set_password(self, password):
    self.password = generate_password_hash(password)

  def check_password(self, password):
    return check_password_hash(self.password, password)

class Post(db.Model):
    __table_name__ = 'post'

    id = db.Column(db.Integer, primary_key=True)
    title = db.Column(db.String(120), unique=True, nullable=False)
    content = db.Column(db.Text)
    date_posted = db.Column(db.DateTime, default=datetime.utcnow())

    user_id = db.Column(db.Integer, db.ForeignKey('user.id'))

    def __repr__(self):
        return f"<Post('{self.id}', '{self.title}')>"

위 코드를 보면 기본적으로 게시물에 대한 데이터 모델 객체를 선언합니다. `title`은 게시물 제목을, `content`는 게시물 내용을, `date_posted`는 게시일을 나타냅니다. 게시일의 경우에는 기본값을 `datetime.utcnow()`를 사용함으로써 명시적으로 게시일을 나타내지 않은 경우 현재 시간을 게시일로 하도록 하였습니다. 그 다음 게시자에 대한 내용을 나타내기 위해 `user` 테이블의 id를 외래키로 하는 `user_id`라는 컬럼을 만들었습니다. 여기서 중요한 점은 `db.ForeignKey`는 테이블 이름을 인자로 받습니다. SQLAlchemy에서 테이블 이름은 기본적으로 소문자를 사용하고 여러 단어의 조합인 경우에는 스네이크 케이스를 사용합니다.

`User` 객체를 보면 `posts` 컬럼이 추가되어 있는 것을 확인할 수 있습니다. `posts` 컬럼은 `db.relationship`를 사용하는데 이는 실제 데이터베이스에 나타나는 필드는 아닙니다. 이 가상 필드는 데이터베이스를 좀 더 높은 추상화 수준에서 바라볼 수 있게 도와주는 역할을 하는데요. 예를 들어 사용자를 `user`이라는 변수에 저장했다고 한다면, 이 사용자가 작성했던 모든 게시물에 대한 정보는 `user.posts`를 이용해 접근할 수 있습니다. `db.relationship`의 첫 번째 인자는 `db.ForeignKey`와는 다르게 객체 이름을 받습니다.
그리고 `backref`는 `Posts` 객체에 삽입되는 가상 필드 이름입니다. 즉, 게시물을 `post`라는 변수에 저장했다고 한다면 이 게시물을 작성한 게시자를 `post.author`을 이용해 접근할 수 있음을 의미합니다. 이를 통해 데이터베이스의 데이터를 Python 코드 상에서 접근할 때, 고수준의 추상화된 레벨에서 사용할 수 있습니다.

데이터베이스 초기화 및 데이터 추가

데이터베이스에 어떤 내용을 체워 넣을지 구조적인 부분을 코드상으로 나타내었습니다. 하지만 실제 데이터베이스에 테이블을 만들고 데이터를 넣어준 것은 아니라 데이터베이스에서 데이터를 접근하려 하면 에러를 나타낼 것입니다. 따라서 데이터베이스를 초기화해 줄 필요가 있습니다.

먼저 프로젝트 디렉터리에서 python 터미널을 열어줍니다.

터미널
(venv) PS flask_blog> python
Python 3.7.0 (v3.7.0:1bf9cc5093, Jun 27 2018, 04:59:51) [MSC v.1914 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>>

Python 터미널 상에서 우리의 Flask 어플리케이션과 데이터베이스, 사용자 모델, 게시물 모델을 불러옵니다.
그 다음 `db.create_all()`을 이용해 데이터베이스를 초기화할 수 있습니다.

>>> from app import app, db, User, Post
>>> db.create_all()

프로젝트 디렉터리를 보면 `site.db`라는 파일이 하나 생겼습니다. 그리고 DB를 열어보면 우리가 만든 사용자 모델과 게시물 모델에 대한 테이블이 만들어져 있는 것을 확인할 수 있습니다.

flask_blog/
├── templates/
│   ├── about.html
│   ├── index.html
│   └── layout.html
├── static/
│   └── layout.css
├── venv/
├── app.py
└── site.db

데이터베이스를 초기화했으면 테스트를 위한 데이터를 한 번 작성해보도록 하겠습니다. 터미널을 이용하여 사용자를 하나 추가하겠습니다.

>>> user = User(username='user', email='user@blog.com', password='password')
>>> db.session.add(user)
>>> db.session.commit()

`user` 변수에 `User` 데이터 모델에 대한 인스턴스를 만들어 저장한 다음 이를 데이터 베이스에 저장하기 위해 `db.session`을 이용합니다. 데이터베이스를 수정하는 작업이 끝나면 `db.session.commit()`을 이용해 변경 내용을 저장할 수도 있고, `db.session.rollback()`을 이용해 변경 사항을 취소할 수도 있습니다. 여기서 `db.session.add()`를 통해 데이터베이스에 객체를 추가했더라도 실제 데이터가 저장되는 시점은 `db.session.commit()`를 수행한 다음입니다.

이제 게시물을 2개 추가해보도록 하겠습니다.

>>> post1 = Post(title='첫 번째 게시물', content='첫 번째 게시물 내용', author=user)
>>> post2 = Post(title='두 번째 게시물', content='두 번째 게시물 내용', author=user)
>>> db.session.add(post1)
>>> db.session.add(post2)
>>> db.session.commit()

게시물을 추가할 때 자세히 보면 `user_id`를 넣어주지 않는 것을 확인할 수 있습니다. 우리가 `Post` 데이터 모델을 만들 때, 게시자에 대한 정보를 넣어주기 위해 외래 키로 `user_id` 필드를 삽입했지만 `User` 데이터 모델에 관계에서 `backref`를 이용해 `author`에 대한 정보도 넣어줬습니다. 따라서 `User` 모델에서 만들어진 가상의 `author` 필드를 사용해 `user_id` 필드에 직접 데이터를 넣어주지 않아도 게시자에 대한 정보를 쉽게 추적할 수 있습니다.

데이터베이스에 저장한 데이터를 가져오기 위해서는 각 모델에 `query`를 이용합니다. 예를 들어 전체 사용자를 가져오고 싶으면 `User.query.all()`을 입력하면 됩니다.

>>> User.query.all()
[<User('user', 'user@blog.com')>]
>>> Post.query.all()
[<Post('1', '첫 번째 포스트')>, <Post('2', '두 번째 포스트')>]

더미 데이터 삭제

게시물을 더미 데이터로 처리 했던 것을 db에 있는 데이터로 바꿔주도록 하겠습니다. `app.py`에 작성되었던 더미 데이터를 삭제하고, `db.query` 명령을 이용해 데이터베이스에 저장되어 있는 모든 게시물 데이터를 불러와 `render_template` 함수에 전달합니다.

from datetime import datetime

from flask import Flask, render_template
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

app.config['SECRET_KEY'] = 'this is secret'
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///site.db'
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False

db = SQLAlchemy(app)

@app.route('/')
@app.route('/index')
def index():
    posts = Post.query.all()

    return render_template('index.html', posts=posts)

# ...

그리고 `index.html` 파일을 수정해 `holder.js`를 통해 이미지를 보여줄 공간만 마련했던 것을 실제 데이터와 연결 하도록 하겠습니다.

{% for post in posts %}
<article>
  <hr>
  <div class="row">
    <div class="col">
      <a class="h1" href="#">{{ post.title }}</a>
      <p class="text-justify">{{ post.content }}</p>
    </div>
    <div class="col-md-2 d-flex flex-column">
      <img class="rounded-circle mx-auto" src="{{ url_for('static', filename='profile_imgs/' + post.author.profile_image)}}" data-src="holder.js/64x64" width="64px" height="64px">
      <p class="text-muted text-center">{{ post.author.username }}</p>
    </div>
  </div>
  <small class="text-muted">{{ post.date_posted.strftime('%Y-%m-%d') }}</small>
</article>
{% endfor %}

`<article>` 태그가 있는 부분에 `<img>` 태그를 보면 `src="#"`로 비어있는 것을 확인할 수 있습니다.
이를 `static/profile_imgs` 하위에 저장 되어 있는 프로필 사진들로 연결합니다.

기본 프로필 이미지 저장

`User` 모델에 기본 프로필 이미지로 `default.png`를 적어주었습니다. 이 사진 파일을 저장하기 위해서 `static` 디렉터리 하위에 `profile_imgs` 디렉터리를 만들고 프로필 이미지 파일들을 저장하겠습니다. 폴더를 나누는 이유는 `static` 폴더에는 프로필 사진 뿐 아니라 다양한 자바스크립트 파일, css 스타일 시트 파일 등이 저장될텐데 여러 파일들이 혼합되면 정리하는데 불편하기 때문입니다.

기본 사진 파일은 github 저장소에서 다운받아 저장해주세요.

사진 파일은 링크에서 다운로드 받았으며 CC0 라이선스임을 밝힙니다.

flask_blog/
├── templates/
│   ├── about.html
│   ├── index.html
│   └── layout.html
├── static/
│   ├── profile_imgs/
│   │   └── default.png
│   └── layout.css
├── venv/
├── app.py
└── site.db

현재까지 작성된 전체 코드는 Flask blog tutorial Chapter4에서 확인할 수 있습니다.

Python 인터렉티브 쉘에서 작성했던 코드는 `scripts.py`라는 파일에 넣어두었습니다.

댓글

댓글 본문
작성자
비밀번호
  1. 김플라스크
    flask 내용에 대해 잘 없는데 좋은 글 잘 봤어요!
버전 관리
a476548
현재 버전
선택 버전
graphittie 자세히 보기