HOWTO · Django

Django에 객체가 존재하는지 확인

일반적인 문제에 대한 이 설명에서는 객체가 모델에 존재하는지 확인하는 방법과 예외를 처리하여 사용자에게 편리한 오류를 표시하는 방법을 배웁니다.

이 페이지의 내용

필터링된 Django queryset으로 조건에 맞는 행이 있는지 확인하고, 필드가 필요하면 객체를 가져오며, 요청에서 객체가 없으면 404를 반환할 수 있습니다. 첫 번째 질문에는 QuerySet.exists()가 답하고, get_object_or_404()와 DoesNotExist는 객체 누락을 처리하는 일반적인 방법입니다.

exists()로 queryset에 조건에 맞는 행이 있는지 확인

확인하려는 레코드를 나타내는 queryset에 exists()를 호출합니다. 예를 들어 Product.objects.filter(pk=product_id).exists()는 필터링된 queryset에 행이 있으면 True, 없으면 False를 반환합니다. 이는 범용 함수가 아니라 QuerySet 메서드입니다. 필터링 조건도 중요합니다. Product.objects.all().exists()는 특정 상품이 있는지가 아니라 상품이 하나라도 있는지를 확인합니다.

결과가 예 또는 아니요뿐이면 이 방법을 사용하세요. 예를 들어 작업 버튼을 표시할지 결정하거나 중복 생성을 막을 때 유용합니다. Django는 존재 여부 확인에 최적화된 쿼리를 실행할 수 있습니다. 같은 행을 바로 가져오거나 순회할 예정이라면 별도의 존재 여부 확인을 건너뛰고 그 결과를 바로 사용하세요. 그렇지 않으면 데이터베이스 쿼리가 하나 더 발생할 수 있습니다.

조건에 맞는 객체 하나를 가져오고 DoesNotExist 처리

다음 단계에서 객체의 필드가 필요하다면 Product.objects.get(pk=product_id)를 사용하세요. get()은 조건에 맞는 행이 정확히 하나일 것으로 기대합니다. 일치하는 행이 없으면 Product.DoesNotExist를 발생시키고, 여러 행이 일치하면 Product.MultipleObjectsReturned를 발생시킵니다. 코드가 객체 하나를 기대한다면 기본 키처럼 고유한 키를 사용하세요. 애플리케이션이 의미 있게 대응할 수 있을 때만 모델별 DoesNotExist를 처리하세요. 예상치 못한 상황을 성공으로 조용히 간주하지 말고, 그렇지 않으면 오류가 드러나게 두세요.

이 차이를 알면 적절한 작업을 선택하기 쉽습니다. exists()는 불리언 값을 반환하고, get()은 객체를 반환하거나 조회 결과가 정확히 하나가 아니었음을 알립니다. 확인한 뒤 get()을 호출하는 사이에 다른 데이터베이스 변경이 일어날 수도 있으므로, 앞선 불리언 결과가 이후 조회의 성공을 보장한다고 간주하지 마세요.

객체가 없을 때 404 반환

요청에 따른 조회에는 Django의 get_object_or_404() 함수가 간결한 선택지입니다. 예를 들어 product = get_object_or_404(Product, pk=product_id)는 조건에 맞는 상품을 가져오고, 상품이 없으면 Http404를 발생시킵니다. 그러면 프레임워크가 일반적인 찾을 수 없음 응답을 렌더링합니다. django.shortcuts에서 도우미를 가져와, 리소스가 없을 때 찾을 수 없음으로 응답해야 하는 뷰에서 사용하세요.

뷰에 사용자 지정 동작이 필요하다면 조회를 직접 처리할 수 있습니다. try 안에서 Product.objects.get(pk=product_id)를 호출하고, Product.DoesNotExist를 잡아 Http404를 발생시키세요. django.http에서 Http404를 가져옵니다. 이렇게 하면 조회 실패를 HTTP 응답으로 바꾸면서, 조회에 성공한 경우에는 뷰의 나머지 부분에서 상품을 사용할 수 있습니다. 광범위한 예외를 잡지 마세요. 관련 없는 프로그래밍 오류나 데이터베이스 오류를 페이지 누락으로 가장해서는 안 됩니다.

객체가 있는 경우와 없는 경우 테스트

존재하는 것으로 알려진 식별자와 존재하지 않는 식별자를 사용해 두 결과를 모두 확인하세요. 다음 순수 Python 예제는 메모리 내 레코드로 불리언 판단을 보여 줍니다. Django ORM 테스트는 아닙니다. Django 테스트에서는 Product를 생성한 뒤 기본 키로 필터링한 queryset의 exists()가 참인지 확인하고, 사용하지 않은 키에 대해서는 거짓인지 확인하세요. 객체 조회의 경우 생성한 객체가 반환되는지, 사용하지 않은 키에는 Product.DoesNotExist가 발생하는지 확인합니다. get_object_or_404()를 사용하는 뷰라면, 존재하는 상품에 성공 응답을 반환하고 사용하지 않은 키에는 404 응답을 반환하는지 테스트하세요.

이 독립 실행형 조회 예제를 실행해 보세요. 리스트를 사용해 판단 과정을 드러내며, Django 뷰에서는 필터링된 queryset으로 같은 선택을 적용합니다.

이 섹션의 코드와 표시되는 레이블 또는 출력은 영어로 유지됩니다.

products = [{"id": 7, "name": "Notebook"}]
for requested_id in (7, 12):
    matches = [product for product in products if product["id"] == requested_id]
    print(bool(matches))
True
False

첫 번째 결과는 일치하는 항목이 있음을, 두 번째 결과는 없음을 나타냅니다. 여기서 리스트는 필터링된 레코드를 대신해 보여 줄 뿐입니다. Django는 데이터베이스에서 조회하므로 애플리케이션 코드에서는 queryset 메서드를 사용해야 합니다.