Seok Min, Lee

Seok Min, Lee

거북이처럼 느리지만 꾸준히

반갑습니다 : )

[Django] 장고 Models를 활용한 데이터베이스 처리 - 1

Update:     Updated:

카테고리:

태그:

장고 모델(ORM) 소개

어플리케이션의 다양한 데이터 저장방법

데이터베이스 : RDBMS, NoSQL 등
파일 : 로컬, 외부 정적 스토리지
캐시서버 : memcached, redis 등

데이터베이스와 SQL

데이터베이스의 종류

  • RDBMS(관계형 데이터베이스 관리 시스템)
    – PostgreSQL, MySQL, SQLite, MS-SQL, Oracle 등
  • NoSQL : MongoDB, Cassandra, CouchDB, Goggle BigTable 등

데이터베이스에 쿼리하기 위한 언어 -> SQL

  • 같은 작업을 하더라도, 보다 적은 수의 SQL, 보다 높은 성능의 SQL
  • 직접 SQL을 만들어내기도 하지만, ORM(Object-relational mapping)을 통해 SQL을 생성/실행하기도 한다.
  • 중요) ORM을 쓰더라도, 내가 작성된 ORM코드를 통해 어떤 SQL이 실행되고 있는 지, 파악을 하고 이를 최적화할 수 있어야 한다. -> django-debug-toolbar 적극 활용

장고 ORM인 모델은 RDB만을 지원

다양한 파이썬 ORM(awesome-python#orm)

Relational Databases

  • Django Models, SQLAlchemy, Orator, Peewee, PonyORM 등

NoSQL Databases

  • django-mongodb-engine, hot-redis, MongoEngine, PynamoDB 등

장고의 강점은 Model과 Form

물론, 장고에서도 다양한 ORM, 라이브러리 사용 가능

강력한 Model/Form

물론, 적잘하게 섞어쓸수도 있다.

SQL을 직접 실행할 수도 있지만, 가능하면 ORM 사용

  • 직접 SQL문자열을 조합하지말고, 인자로 처리 -> SQL Injection 방지
from django.db import connection, connections # connections['default']와 connection 은 동일

with connection.cursor() as cursor:
    cursor.execute("UPDATE bae SET foo = 1 WHERE baz = %s", [self.baz])
    cursor.execute("SELECT foo FROM bar WHERE baz = %s", [self.baz])
    row = cursor.fetchone()
    print(row)

Django Model(장고 내장 ORM)

데이터베이스 테이블과 파이썬 클래스를 1:1로 매핑

  • 모델 클래스명은 단수형으로 지정 - 예) Posts(x), Post(O)
    – 클래스이기에 필히 ‘첫 글자가 대문자인 PascalCase 네이밍’
  • 매핑되는 모델 클래스는 DB 테이블 필드 내역이 일채해야 한다.
  • 모델을 만들기 전에, 서비스에 맞게 데이터베이스 설계 필수
  • 이는 데이터베이스 영역 -> 관계형 데이터베이스 학습도 필요하다.
from django.db import models

class Post(models.Model):
    title = models.CharField(max_length=100)
    content = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)

모델 활용 순서

장고 모델을 통해, 데이터베이스 형상을 관리할 경우

  1. 모델 클래스 작성
  2. 모델 클래스로부터 마이그레이션 파일 생성 -> makemigrations 명령
  3. 마이그레이션 파일을 데이터베이스에 적용 -> migrate 명령
  4. 모델 활용

장고 외부에서, 데이터베이스 형상을 관리할 경우

  • 데이터베이스로부터 모델 클래스 소스 생성 -> inspectdb 명령
  • 모델 활용

모델명과 DB 테이블명

DB 테이블명 : 디폴트 “앱이름_모델명”

예

  • blog 앱
    – Post 모델 -> “blog_post”
    – Comment 모델 -> “blog_comment”

  • shop 앱
    – item 모델 -> “shop_item”
    – Review 모델 -> “shop_review”

커스텀 지정

  • 모델 Meta 클래스의 db_table 속성

새로운 모델 적용 순서

  1. Item 모델 정의

  2. 마이그레이션 파일 생성
    • python manage.py makemigrations APP_NAME
  3. 마이그레이션 파일 적용
    • python manage.py migrate
  4. 데이터베이스 확인
    • DB 종류에 따라 다양한 방법

새로운 모델을 만들어보자.

  1. 새로운 어플리케이션 생성

     python manage.py startapp instagram

  2. settings.py에 새로 만든 어플리케이션 추가

     INSTALLED_APPS = [
     # Default APPS..
     'blog1',
     'instagram',
 ]

  3. instagram/urls.py 생성 후, 수정

     urlpatterns = [
    
 ]

  4. PROJECT_NAME/urls.py 수정

     urlpatterns = [
     path('admin/', admin.site.urls),
     path('blog1/', include('blog1/urls'))
     path('instagram/', include('instagram.urls')),
 ]

  5. instagram/models.py 수정

     from django.db import models

 class Post(models.Model):
     message = models.TextField()
     created_at = models.DateTimeField(auto_now_add=True)
     updated_at = models.DateTimeField(auto_now=True)

  6. migrations 진행

     python manage.py makemigrations instagram
 python manage.py migrate instagram
 python manage.py sqlmigrate instagram 0001_initial

장고 모델 필드

기본 지원되는 모델필드 타입 (1)

Primary Key : AutoField, BigAutoField
문자열 : CharField, TextField, SlugField
날짜/시간 : DateField, TimeField, DateTimeField, DurationField
참/거짓 : BooleanField, NullBooleanField
숫자 : IntegerField, SmallIntegerField, PositiveIntegerField, PositiveSmallIntegerfield, BigIntegerField, DecimalField, FloatField
파일 : BinaryField, FileField, ImageField, FilePathField

기본 지원되는 모델필드 타입 (2)

이메일 : EmailField
URL : URLField
UUID : UUIDField
아이피 : GenericIPAddressField
Relationship Types

모델필드들은 DB 필드타입을 반영

DB에서 지원하는 필드들을 반영

  • Varchar 필드타입 -> CharField, SlugField, URLField, EmailField 등

파이썬 데이터타입과 데이터베이스 데이터타입을 매핑

  • AutoField -> int
  • BinaryField -> bytes
  • BooleanField -> bool
  • CharField/SlugField/URLField/EmailField -> str : 디폴트 적용된 유효성 검사 등의 차이

같은 모델필드라 할지라도, DB에 따라 다른 타입이 될 수도 있다.

  • DB에 따라 지원하는 기능이 모두 다르다.

자주 쓰는 필드 공통 옵션

blank : 장고 단에서 validation시에 empty 허용 여부 (디폴트: False)
null (DB 옵션) : null 허용 여부 (디폴트 : False)
db_index (DB 옵션) : 인덱스 필드 여부 (디폴트 : False)
default : 디폴트 값 지정, 혹은 값을 리턴해줄 함수 지정

  • 사용자에게 디폴트값을 제공하고자 할 때
    unique (DB 옵션) : 현재 테이블 내에서 유일성 여부 (디폴트 : False)
    choices : select 박스 소스로 사용
    validators : validators를 수행할 함수를 다수 지정
  • 모델 필드에 따라 고유한 validators들이 등록 (ex- 이메일만 받기)
    verbose_name : 필드 레이블, 미지정시 필드명이 사용
    help_text : 필드 입력 도움말
from django.conf import settings
from django.db import models

class Profile(models.Model):
    user = models.OneToOneField(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
    blog_url = models.URLField(blank=True)
    
class Post(models.Model):
    author = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
    title = models.CharField(max_length=100, db_index=True)
    slug = models.SlugField(allow_unicode=True, db_index=True) # ModelAdmin.prepopulated_fields 편리
    desc = models.TextField(blank=True)
    image = models.ImageField(blank=True) # Pillow 설치가 필요
    comment_count = models.PositiveIntegerField(default=0)
    tag_set = models.ManyToManyField('Tag', blank=True)
    is_publish = models.BooleanField(default=False)
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)
    
class Comment(models.Model):
    author = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
    post = models.ForeignKey(Post, on_delete=models.CASCADE)
    message = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)
    
class Tag(models.Model):
    name = models.CharField(max_length=50, unique=True)

추천 사항

설계한 데이터 베이스 구조에 따라, 최대한 필드타입을 타이트하게 지정해주는 것이, 입력값 오류를 막을 수 있음.

  • blank, null 지정은 최소화 -> manage.py inspect 명령을 통해 생성된 모델 코드는 초안이다.
  • validators 들이 다양하게/타이트하게 지정된다.
  • 필요하다면, validators들을 추가로 타이트하게 지정
  • 프론트엔드에서의 유효성 검사는 사용자 편의를 위해서 수행하며, 백엔드에서의 유효성 검사는 필수이다.
  • 직접 유효성 로직을 만들지 말자. 이미 잘 구성된 Features들을 가져다 쓰자. 장고의 Form/Model을 통해 지원되며, django-rest-framwork의 Serializer를 통해서도 지원된다.

ORM은 SQL 쿼리를 만들어주는 역할일 뿐, 보다 성능높은 어플리케이션을 위해서는, 사용할 데이터베이스에 대한 깊은 이해가 필요하다.

장고 admin을 통한 데이터 관리

django admin

django.contrib.admin 앱을 통해 제공

  • 디폴트 경로 : /admin/ -> 실제 서비스에서는 다른 주소로 변경 권장
  • 혹은 django-admin-honeypot 앱을 통해, 가짜 admin 페이지 노출

모델 클래스 등록을 위해, 조회/추가/수정/삭제 웹 UI를 제공

  • 서비스 초기에, 관리도구로서 사용하기에 제격
  • 관리도구 만들 시간을 줄이고, End-User 서비스에 집중

내부적으로 Django Form을 적극적으로 사용

모델 클래스를 admin에 등록하는 방법 3가지

from django.contrib import admin
from .models import Item

# 등록법 #1
admin.site.register(Item) # 기본 ModelAdmin으로 동작

# 등록법 #2
class ItemAdmin(admin.ModelAdmin):
    pass
admin.site.register(Item, ItemAdmin) # 지정한 ModelAdmin으로 동작

# 등록법 #3
@admin.register(Item)
class ItemAdmin(admin.ModelAdmin):
    pass

  1. instagram/models.py 수정

     from django.db import models
    
 class Post(models.Model):
     message = models.TextField()
     created_at = models.DateTimeField(auto_now_add=True)
     updated_at = models.DateTimeField(auto_now=True)

  2. instagram/admin.py 수정

     from django.contrib import admin
 from .models import post
    
 @admin.register(Post) # Wrapping
 class PostAdmin(admin.ModelAdmin):
     pass

모델 클래스에 str 구현

admin 모델 리스트에서 “모델명 object”를 원하는 대로 변경하기 위해

객체를 출력할 때, 객체.str()의 리턴값을 활용

  1. instagram/models.py 수정

     from django.db import models
    
 class Post(models.Model):
     message = models.TextField()
     created_at = models.DateTimeField(auto_now_add=True)
     updated_at = models.DateTimeField(auto_now=True)
    
     # Java의 toString > Message Post 제목 변경
     def __str__(self):
         # return f"Custom Post object ({self.id})"
         return self.message

list_display 속성 정의

모델 리스트에 출력할 컬럼 지정

  1. instagram/admin.py 수정

     from django.contrib import admin
 from .models import Item
    
 @admin.register(Item)
 class ItemAdmin(admin.ModelAdmin):
     list_display = ['pk', 'name', 'short_desc', 'price', 'is_publish']
    
     def short_desc(self, item):
         return item.desc[:20]

list_display 지정된 이름 중에, detail 링크를 걸 속성 리스트

  1. instagram/admin.py 수정

     from django.contrib import main
 from .models import Post
    
 @admin.register(Post) # Wrapping
 class PostAdmin(admin.ModelAdmin):
     list_display = ['id', 'message', 'created_at', 'updated_at']
     list_display_links = ['message']

  2. instagram/models.py 수정

    Message Post 제목 변경

     from django.db import models
    
 class Post(models.Model):
     message = models.TextField()
     created_at = models.DateTimeField(auto_now_add=True)
     updated_at = models.DateTimeField(auto_now=True)
    
     # Java의 toString > Message Post 제목 변경
     def __str__(self):
         # return f"Custom Post object ({self.id})"
         return self.message
    
     def message_length(self):
         return len(self.message)
     message_length.short_description = "메세지 글자수"

  3. instagram/admin.py 수정

    message_length 반영

     from django.contrib import main
 from .models import Post
    
 @admin.register(Post) # Wrapping
 class PostAdmin(admin.ModelAdmin):
     list_display = ['id', 'message', 'message_length', 'created_at', 'updated_at']
     list_display_links = ['message']

admin 단에서 관리하는 방법

  1. instagram/models.py 수정

    message_length 함수 부분 주석 처리

     from django.db import models
    
 class Post(models.Model):
     message = models.TextField()
     created_at = models.DateTimeField(auto_now_add=True)
     updated_at = models.DateTimeField(auto_now=True)
    
     # Java의 toString > Message Post 제목 변경
     def __str__(self):
         # return f"Custom Post object ({self.id})"
         return self.message
    
     # def message_length(self):
     #     return len(self.message)
     # message_length.short_description = "메세지 글자수"

  2. instagram/admin.py 수정

    admin 단에 message_length 함수 추가

     from django.contrib import main
 from .models import Post
    
 @admin.register(Post) # Wrapping
 class PostAdmin(admin.ModelAdmin):
     list_display = ['id', 'message', 'message_length', 'created_at', 'updated_at']
     list_display_links = ['message']
    
     def message_length(self, post):
         return f"{len(post.message)} 글자"

search_fields 속성 정의

admin내 검색 UI를 통해, DB를 통한 where 쿼리 대상 필드 리스트

  1. instagram/admin.py 수정

     from django.contrib import admin
 from .models import Post
    
 @admin.register(Post)
 class PostAdmin(admin.ModelAdmin):
     list_display = ['id', 'message', 'message_length', 'created_at', 'updated_at']
     list_display_links = ['message']
     search_fields = ['message']
        
     def message_length(self, post):
         return f"{len(post.message)} 글자"

list_fileter 속성 정의

저장 필드값으로 필터링 옵션 제공

  1. instagram/admin.py 수정

     from django.contrib import admin
 from .models import Post
    
 @admin.register(Post)
 class PostAdmin(admin.ModelAdmin):
     list_display = ['id', 'message', 'message_length', 'created_at', 'updated_at']
     list_display_links = ['message']
     list_filter = ['created_at', ]
     search_fields = ['message']
        
     def message_length(self, post):
         return f"{len(post.message)} 글자"

  2. instagram/models.py 수정

     from django.db import models
    
 class Post(models.Model):
     message = models.TextField()
     is_publish = models.BooleanField(default=False, Verbose_name='공개여부')
     created_at = models.DateTimeField(auto_now_add=True)
     updated_at = models.DateTimeField(auto_now=True)
    
     def __str__(self):
         return self.message

  3. 아래 명령어 실행

     python manage.py makemigrations instagram
 python manage.py migrate instagram

🐢 현재 공부하고 있는 파이썬/장고 웹서비스 개발 완벽 가이드 with 리액트 - 이진석 강사 의 강의를 학습하며 기록 및 정리를 하기위한 내용들입니다. 🐢

감사합니다.😊

Django 카테고리 내 다른 글 보러가기

댓글남기기

최근 글 10 개 :)