💻 Today I Learned

오늘은 ORM을 하던 중 역참조 관계의 데이터를 가져오는 과정에서 헷갈려서 다시 한 번 리마인드 차원에서 정리를 해본다.

📌 Django ORM

Object-Relational-Mapping의 약자로 객체(Object)와 관계형 데이터베이스(Relational Database)의 데이터를 매핑(Mapping)해주는 것을 의미하며, 객체 간의 관계를 바탕으로 SQL을 자동 생성하여 sql쿼리문 없이도 데이터베이스의 데이터를 다룰 수 있게 해준다.

class Person(models.Model)
	name = models.CharField(max_length=10)
    
class Dog(models.Model)
	owner = models.ForeignKey(Person)
    name = models.CharField(max_length=20)

위와 같이 모델이 정의되어 있을 때 사람과 개는 1:N 관계이다.
Dog가 ForeignKey로 Person에 연결 되어있기 때문에 Person은 여러 Dog를 가질 수 있다.
반대로 Dog는 여러 Person을 가질 수 없다.

또 다른 예제로 유저과 게시글이 대표적인데 유저는 여러 게시글을 가질 수 있지만, 게시글은 여러 유저를 가질 수 없다.
이것이 one to many 관계이다.

📌 정참조

정참조는 현재 모델에서 Foreignkey 필드로 연결된 모델을 참조하는 것이다. (one to one 관계도 포함된다)
즉, Foreignkey가 있는 object에서 연결된 Foreignkey 속성이 없는 object를 참조하는 것이 정참조이다.

위의 예제로 보면 Dog가 Foreignkey로 Person을 참조하고 있는데 Person의 object를 가져오는 것이 정참조이다.

설명한 방법으로 개의 주인 이름을 가져와 본다.

# Dog 모델로 생성된 id가 1번인 객체를 dog 변수에 담음
dog = Dog.objects.get(pk=1)

# 객체의 owner는 Person 모델을 참조하고 있고 Person 모델의 이름을 가져온다.
주인 = dog.owner.name

📌 역참조

역참조는 반대로 ForeignKey 속성이 없지만 연결된 모델을 참조하는 경우이다.
즉, 참조를 당한 모델에서 참조를 한 모델의 object를 가져오는 것이 역참조이다.

예제로 보면 Person 모델은 ForeignKey 필드가 없지만 Dog와 연결되어 있고, 연결된 Dog의 객체를 가져오는 것이 역참조이다.

역참조를 하는 방법은 두 가지가 있는데 하나는 set_manager를 사용하여 역참조 하는 방법이고, 또 다른 방법은 related_name을 사용하는 것이다.

위에서 설명한 두 가지 방법으로 주인이 가진 개를 가져와 본다.

# Person 모델로 생성된 id가 1번인 객체를 person으로 지정
person = Person.objects.get(pk=1)

# person 객체를 참조하고 있는 Dog 모델을 dog_set을 사용하여 역으로 가져오고 get이나 all을 통해 가져온 Dog 모델의 객체를 가져옴
1번 개 = person.dog_set.get(id=1)
주인의 모든 개 = person.dog_set.all()

# related_name 사용(related_name='dogs')
1번 개  = person.dogs.get(id=1)
주인의 모든 개 = person.dogs.all()

set_manager를 사용하는 방법은 현재 모델에서 참조를 한 모델을 찾아가는 방식인데 만약 현재 모델에서 참조를 한 모델이 여러개라면 어떤 모델을 참조하는지 찾을 수 없는 에러가 발생한다.

하지만 related_name을 사용하면 현재 모델을 참조한 필드를 찾아가기 때문에 보다 직관적이며 사용하기도 간편하고, 위에서 말한 에러를 피할 수 있기 때문에 related_name을 사용하는 것이 더욱 안전하다.

추가적으로 오늘 테스트 하면서 겪은 경험인데, related_name이 설정된 상태에서 set_manager를 사용하면 에러난다.