Django - 객체 참조 관계

🚩 문제 발생

우선, 제가 부딪혔었던 이슈는 다음과 같습니다.

유저가 게시글을 생성하는 요청을 할 때, 카테고리를 설정하지 않으면 기본 값으로 '기타'라는 값으로 저장하려고 했습니다.

문제는 '기타'라는 값은 애초에 DB 저장된 값이 아니기 때문에 NOT NULL 문제가 발생하게 된 것이죠.

 

• models.py

class Article(CommonModel):
    author = models.ForeignKey("users.User", on_delete = models.CASCADE, related_name="articles",)
    title = models.CharField(max_length=100, blank=False, null=False)
    context = models.TextField()
    category = models.ForeignKey("boards.Category", on_delete=models.CASCADE, related_name="category")
    
class Category(models.Model):
    name = models.CharField(max_length=10, default='기타')
    

# 가독성을 위해 관련없는 코드는 생략했습니다.

 

만약 이상태로 마이그레이션을 하게되면 다음과 같은 에러가 발생하게 됩니다.

django.db.utils.IntegrityError: NOT NULL constraint failed: boards_article.category_id

 

해당 에러는 게시글을 생성할 때 카테고리 필드에 대한 유효한 값이 없기 때문입니다. 카테고리라는 테이블에 값 자체가 없기 때문에 만들지 못했던 것입니다. 해결 방법으로는 카테고리 필드에 값을 제공하는 방법, NULL을 허용하는 방법이 있습니다.

 

만약 이미 데이터베이스를 돌이킬 수 없는 상황이라면 Null을 허용하고 Blank를 True로 해놓는 전략을 사용합니다. 

저는 아직 초기화를 하지 않는 상황이기 때문에 `default` 값을 넣었습니다. 

 

그리고 view 함수에서는 다음과 같이 빈 값일 경우 기타를 받게끔해서 만약 카테고리가 없는 경우 생성할 수 있게끔 함수를 작성했습니다.

def exist_category(request):
    category_name = request.data.get('category', '기타')
    category, _ = Category.objects.get_or_create(name=category_name)
    return category.id

 

---

🤔 객체 간 참조 관계?

오늘 문제 발생에 대해 생각해야할 부분은 객체 간 참조 관계입니다.

객체 간 참조 관계를 만들기 위해 외래키(Foregin Key)가 필요합니다.

💡 외래키(Foreign Key)
외래키는 다른 테이블의 행을 식별할 수 있는 키를 의미하며 참조되는 다른 테이블의 기본 키(Primary Key)를 가리킨다.
참조되는 테이블의 행을 참조하는 외래키(FK)가 존재하는 한 삭제될 수 없고 기본키(PK) 또한 변경될 수 없다. (참조 무결성)
대표적으로, 1:N 관계를 가지는  예는 게시물과 댓글의 관계 혹은 유저와 게시글 관계가 있다. 한 명의 유저가 여러 게시물을 작성할 수 있으며 한 게시물에는 여러개의 댓글이 달릴 수 있기 때문이다.

 

만약, 하나의 카테고리에 여러 개의 게시물을 포함하고 싶으면 1:N의 관계이고 한 게시물에 여러 개의 카테고리를 가진다면 한 카테고리도 여러 개의 게시물을 가질 수 있기 때문에 N:M의 관계를 가집니다.

 

상황에 따라 관계를 다르게 설정할 수 있습니다.  추가로 유저와 유저의 프로필 모델인 1:1 대응 관계 테이블도 존재합니다.

 

🚀 모델에서 1:N 구현하기

다음 코드를 보면 Memo라는 객체와 Category라는 객체가 1:N 관계를 맺게끔 하려고합니다.

즉, 하나의 카테고리는 여러개의 메모를 가질 수 있다는 것입니다.

1:N 객체 참조 관계

 

해당 객체에 외래키를 갖는 속성은 해당 옵션들을 설정해야 합니다.

	설명
참조할 테이블	가장 첫번째 파라미터로 연결할 모델 클래스를 가리키며 해당 외래키에서 어떤 테이블을 참조할지를 의미한다.
관계상 이름(`related_name`)	개체 관계에 사용할 이름을 나타내는데 역방향에서 참조할 때 사용하는 이름이다.
개체 수정 삭제시 수행 동작(`on_delete / on_update`)	카테고리 모델을 삭제될 때 Memo 모델이 미치는 영향을 말한다.
DB 필드 이름(`db_colum`)	테이블에 정의되는 이름을 말하며 Memo 테이블의 category 필드가 "categoty"라는 이름으로 지정된다.

 

관계상 이름?

여기서, 관계상 이름?이라는 말을 이해하기 어려우실 것입니다.

 

자식이 부모를 참조하고자 할때 역참조를 한다.

 

만약 Memo라는 모델이 Category 모델을 참조하게된다면 이를 정참조라고 하고 반대로, Category 모델이 Memo 모델을 참조하는 것을 역참조라고 합니다. 

 

정참조

정참조는 특별하게 뭐 없이 다음 쿼리셋 API로 필드를 접근할 수 있습니다.

memo = Memo.objects.get(pk=10)
memo.category.name # 일상

 

역참조

반대로 역참조는 `테이블명_set`을 통해 데이터 객체를 참조하거나 아까 나왔던 `related_name` 옵션을 통해 다음과 같이 참조할 수 있다.

cate = Category.objects.get(pk=1)
cate.memos.all() # <QuerySet [<Memo: Memo object (9)>, <Memo: Memo object (10)>]>
cate.memos.get(pk=9) #  <Memo: Memo object (9)>

 

실습

이번에는 실전으로 카테고리를 생성하고 수정 및 삭제를 해보는 실습을 진행해보겠습니다.

중요한건 "운동"이라는 카테고리를 만들었을 때 해당 카테고리를 `memo1`이라는 메모 객체에 카테고리를 넣어줍니다.

다음과 같이 쿼리를 요청하면 `memo1`이라는 객체에 운동이라는 카테고리가 등록됩니다.

 

 

하지만, 여기서 중요한 게 있어요!

 

메모를 생성할 때 "운동"이라는 카테고리도 새로 생성하려 했는데 이미 "운동"이라는 카테고리가 존재했을 때의 경우입니다.

만약 운동이라는 카테고리가 있는 경우에도 불구하고 새로 만들게 되면 Unique한 값과 유효하지 않기 때문에 필터링을 할 필요가 있습니다.

 

여기서, `get()` 대신 `first()`로 데이터를 가져온 이유는 만약에 존재하는 카테고리가 없는 경우 `first`일 경우 None을 반환하기 때문입니다.

---

🚀 M:N 관계

이번에는 하나의 테이블에 하나 이상 레코드가 다른 테이블의 하나 이상의 레코드와 참조하는 관계(ManyToMany)입니다. 대표적으로, 좋아요 기능을 구현할 때 유저가 여러 게시물을 누를 수 있는 경우에 사용하죠.

 

외래키로 M:N를 구현한다고?

만약 학생이 영어 수업도 듣고 컴퓨터 수업을 듣는다고 가정할 때 외래키 참조 관계를 만들면 어떤 일이 벌어질까요?

lecture1 = Lecture.objects.create(name='english')
lecture2 = Lecture.objects.create(name='computer')
student1 = Stuendt.objects.create(name='dustin', lecture=lecture1)
student1 = Stuendt.objects.create(name='dustin', lecture=lecture2) #?

 

1NF 위반이 되어 버립니다. 하나의 속성에 여러개 값을 넣는 것은 애초에 불가능한 일입니다.

 

M:N 관계를 구현하기 위해 다양한 방법들이 존재합니다.

• 중개 테이블
• ManyToManyField 

중개 테이블

학생과 수업 사이에 중개테이블을 만드는 방법입니다.

이렇게 되면 `Student`나 `Lecture` 테이블에서 역참조를 통해 객체 관계를 확인할 수 있습니다.

# models.py
class StuLec(models.Model):
	student = models.ForeignKey(Student, on_delete=models.CASCADE)
	lecture = models.ForeignKey(Lecture, on_delete=models.CASCADE)
    
# views.py
StuLec.objects.create(student=student1, lecture=lecture1)
StuLec.objects.create(student=student1, lecture=lecture2)

student1.StuLec_set.all()
lecture1.StuLec_set.all()

중개테이블을 만드는 경우

 

ManyToMany

이번에는 중개테이블을 만들지 않아도 자동으로 테이블을 생성해주는 방법이 있습니다.

굳이 중개테이블을 만들지 않아도 바로 접근이 가능하죠.

class Student(models.Model):
    lecture = models.ManyToManyField(Lecture, related_name="students")
    name = models.TextField(null=True)

 

	설명
참조할 테이블	가장 첫번째 파라미터로 어떤 테이블을 참조할지를 의미한다.
관계상 이름(`related_name`)	개체 관계에 사용할 이름을 나타내는데 역방향에서 참조할 때 사용하는 이름이다.
through	커스텀으로 중개테이블을 지정해줄 수 있는 옵션이다. (그냥 중개테이블을 만들 때 쓰입니다.)
through_field	구체적인 필드를 설정할 때 쓰인다. `through_fields = (A.field, B.field)

 

위 상태로 마이그레이션 하게되면 아래처럼 `app_student_lecture`라는 새로운 테이블이 생성됩니다.

 

관계 형성하기

`add()`와 `remove()`를 통해 관계를 형성하고 제거할 수 있습니다.

그리고 관계를 제거했을 때 해당 데이터는 사라지지않고 관계만 제거됩니다.

 

만약 도중 다음과 같은 에러가 발생할 수 있습니다.

해당 에러는 M2M 테이블에서 중개테이블로 변경했을 때 발생하는 에러입니다.

이런 경우에는 `app.Student.lecture` 컬럼을 마이그레이션 파일에서 지우고 다시 생성하면 해결됩니다. 물론 기존 데이터가 존재한다면 우선 dump하고 import하는 방식으로도 해결할 수 있을 것 같습니다.

 ValueError: Cannot alter field app.Student.lecture into app.Student.lecture - they are not compatible types (you cannot alter to or from M2M fields, or add or remove through= on M2M fields)

---

📌 1:1 관계(OnetoOneField)

1:1 관계(일대일 관계)는 한개의 모델이 또 다른 한개의 모델과 연결할 때 사용합니다.

예를 들어, User라는 모델이 있을 때, User모델의 UserProfile 모델을 생성하는 경우입니다.

 

1:N과 마찬가지로 역참조 관계를 갖는 경우엔 `related_name`을 통해 지정할 수 있습니다.

class User(models.Model):
	username = models.CharField(max_length=100)
    
class UserProfile(models.Model):
	user = models.OneToOneField(User, on_delete=models.CASCADE) # 1:1
    bio = models.TextField()

 

📌 GenericForeignKey(GFK)

외래키이긴 한데 Generic한 외래키? 이것은 무엇일까요?

어떠한 데이터 형식에 의존하지 않고 여러 타입을 가질 수 있다는 점을 두어 외래키를 모든 모델에 연결해줄 수 있다는 의미입니다.

 

아래 그림처럼, 커다란 메모보드에 메모를 붙일 수 있고 이미지를 붙일수도 있습니다. 그 메모지나 이미지에 코멘트를 붙일 수 있다고 모델을 설계한다면 `comment`라는 모델은 `Memo`와 `Image`모델에도 각각 존재할 수 있다는 것입니다.

대충 이런 느낌.

 

class Memo(models.Model):
    title = models.CharField(max_length=30)
    content = models.TextField()

class Image(models.Model):
    title = models.CharField(max_length=100)
    image = models.ImageField(upload_to='images/')

class comment(models.Model):
    text = models.CharField(max_length=100)

 

ForeginKey를 생성하여 Memo나 Image에 덧붙일 수 있게 만든다면 코드가 복잡해지고 컬럼을 의도치 않게 생성해야한다는 단점이 있습니다. 이를 해결하기 위해 GenericForeignKey를 사용합니다.

 

ContentType

Django에서는 기본적으로 GFK를 사용하기 위해 Contenttypes를 제공하고 있습니다.

처음 마이그레이션을 하게되면 `django_content_type`이라는 테이블을 생성됩니다. 자, 이 Contenttype이라는 것을 잘만 활용하면 일일히 모델과 FK를 맺을 필요 없이 ContentType과 FK를 맺으면 관계를 쉽게 맺을 수 있습니다.

 

content_type 테이블

 

실습

앞선 모델들을 GFK와 ContentType 모델을 이용해 재정의 해보았습니다. 아직까지 이해하기 어려우실 것입니다.

우선, 기존의 모델에 `GenericRelation`이라는 것이 생겨난 것을 볼 수 있습니다. 이는 코멘트 객체를 역참조할 때 사용합니다. 반드시 필요한 것은 아닙니다. 그리고 대망의 코멘트 객체엔 기존 `text` 필드를 제외한 세가지의 특별한 필드가 생겨났습니다.

• content_type : ContentType 모델과 FK로 연결되는 필드이다.
• object_id : 관련된 모델의 PK을 저장할 수 있는 필드 이다.
• content_object :  위 두 필드의 이름을 인자로 넘겨준다. 기본 값이므로 생략이 가능하다.

from django.contrib.contenttypes.models import ContentType
from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelation

class Memo(models.Model):
    title = models.CharField(max_length=30)
    content = models.TextField()
    comment = GenericRelation('comment', related_query_name='memo') # 역참조할 때 사용

class Image(models.Model):
    title = models.CharField(max_length=100)
    image = models.ImageField(upload_to='images/')
    comment = GenericRelation('comment', related_query_name='image') # 역참조할 때 사용

class comment(models.Model):
    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
    object_id = models.PositiveIntegerField()
    content_object = GenericForeignKey('content_type', 'object_id')
    text = models.CharField(max_length=100)

 

 

💡 content_object는 DB에 반영되지 않는다.
마찬가지로 GenericForeignKey는 DB Table에 컬럼으로 존재하지 않는다. 

 

실제로 모델을 사용해보면 다음과 같이 작성할 수 있습니다.

comment = Comment.objects.filter(memo__title='1시에 회의합니다:)')
comment = Comment.objects.create(content_object=memo, text="3시로 변경")

 

그러면..

우선, GFK를 이해하고 나서 들었던 생각은 ContentType을 거쳐 특정 모델을 찾아가야하기 때문에 일반적으로 사용하는 FK 보다는 성능이 좋지 않을 것이라 생각한다. 객체를 한번에 가져오지 못하고 여러번 거쳐 가져와야 하기 때문이다.  그러면 `prefetch_related`를 사용하면 되지 않을까?  앞서 설명했듯이 GFK는 없는 필드이기 때문에 실패할 것이다. 즉, 무분별하게 사용하면 안될 것 같다. 일단 인지하기만 하자..

---

☕️ 포스팅이 도움이 되었던 자료

• GenericForeginKey의 문제점 - Leffe_pt님의 블로그
• Avoid Django's GenericForeignKey - Luke Plant
• ForeignKey - Django Docs
• Generic Relations - Django Docs

오늘도 저의 포스트를 읽어주셔서 감사합니다.

설명이 부족하거나 이해하기 어렵거나 잘못된 부분이 있으면 부담없이 댓글로 남겨주시면 감사하겠습니다.