Django: Many-to-One Relationships

1:N 관계 이해하기

1:N 관계는 데이터베이스 설계에서 매우 흔히 사용되는 관계로, 한 개의 엔티티가 여러 개의 다른 엔티티와 관련될 수 있는 경우를 말합니다.

예시

• 하나의 Article은 여러 개의 Comment를 가질 수 있습니다.
• 하나의 Comment는 반드시 하나의 Article에 속합니다.

Foreign Key란?

• 외래 키(Foreign Key)는 한 테이블(A)의 필드가 다른 테이블(B)의 특정 행을 참조하도록 설정된 키입니다.
• Django에서는 models.ForeignKey를 사용해 이러한 관계를 설정합니다.

class Comment(models.Model):
    article = models.ForeignKey(Article, on_delete=models.CASCADE)
    content = models.CharField(max_length=255)
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)

    def __str__(self):
        return self.content

on_delete 옵션

• on_delete는 참조된 객체가 삭제될 때의 동작을 정의합니다.
  • CASCADE: 부모 객체가 삭제되면 참조 객체도 삭제됩니다.
  • PROTECT: 참조 객체가 존재할 경우 삭제를 방지합니다.
  • SET_NULL: 부모 객체가 삭제될 때 참조 필드 값을 NULL로 설정합니다.

공식문서에서 더 많은 옵션을 확인하세요.

실습: 댓글 기능 구현하기

1. 댓글 모델 정의하기

• articles/models.py

class Comment(models.Model):
    article = models.ForeignKey(Article, on_delete=models.CASCADE)
    content = models.CharField(max_length=255)
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)

    def __str__(self):
        return self.content

2. 댓글 생성 폼 만들기

• forms.py

from django import forms
from .models import Comment

class CommentForm(forms.ModelForm):
    class Meta:
        model = Comment
        fields = "__all__"
        exclude = ("article",)  # article은 뷰에서 설정

3. 댓글 생성 로직 추가하기

• articles/views.py

from django.shortcuts import get_object_or_404, redirect
from django.views.decorators.http import require_POST
from .models import Article, Comment
from .forms import CommentForm

@require_POST
def comment_create(request, pk):
    article = get_object_or_404(Article, pk=pk)
    form = CommentForm(request.POST)
    if form.is_valid():
        comment = form.save(commit=False)
        comment.article = article
        comment.save()
    return redirect("articles:article_detail", article.pk)

4. URL 설정하기

• articles/urls.py

from django.urls import path
from . import views

urlpatterns = [
    path("<int:pk>/comments/", views.comment_create, name="comment_create"),
]

5. 템플릿에서 댓글 작성 폼 렌더링하기

• articles/templates/articles/article_detail.html

<h3>댓글</h3>
<form action="{% url 'articles:comment_create' article.pk %}" method="POST">
    {% csrf_token %}
    {{ comment_form.as_p }}
    <input type="submit" value="댓글작성">
</form>

<ul>
    {% for comment in article.comments.all %}
        <li>{{ comment.content }}</li>
    {% endfor %}
</ul>

6. Comment 모델의 역참조 설정

• Django는 ForeignKey 필드를 통해 역참조 매니저를 자동으로 생성합니다.
• 기본적으로 comment_set 이름을 가지며, related_name 옵션을 통해 사용자 정의 이름으로 변경할 수 있습니다.

class Comment(models.Model):
    article = models.ForeignKey(Article, on_delete=models.CASCADE, related_name="comments")
    # 이제 article.comments로 접근 가능

7. ORM으로 댓글 생성하기

• Django Shell을 활용해 ORM으로 데이터를 생성하고 조회할 수 있습니다.

$ python manage.py shell_plus
>>> article = Article.objects.get(pk=1)
>>> comment = Comment(article=article, content="첫 번째 댓글")
>>> comment.save()
>>> article.comments.all()
<QuerySet [<Comment: 첫 번째 댓글>]>

추가

1. 댓글 삭제 기능 구현하기
   • URL 설정: path("<int:pk>/comments/delete/", views.comment_delete, name="comment_delete"),
   • 뷰 함수 작성:

@require_POST
def comment_delete(request, pk):
    comment = get_object_or_404(Comment, pk=pk)
    comment.delete()
    return redirect("articles:article_detail", comment.article.pk)

1. 전체 댓글 수 출력하기
   • article.comments.count()를 활용해 출력합니다.

<p>총 댓글 수: {{ article.comments.count }}</p>