Django CharField blank or null?

💭 Intro

💁‍♂️ Known Fact

🤿 Deep Dive

⛳ Conclusion

Intro

Django 모델 클래스의 문자열 기반 필드에 blank 또는 null 옵션을 지정하는 조건에 대해 알아보겠습니다.

Known Fact

처음 Django를 접하고 Django 관련 내용을 검색 하다보면, Vitor Freitas의 SimpleIsBetterThanComplex라는 블로그를 자주 볼 수 있습니다.

초보자들에게 유용한 내용이 많은 매우 좋은 블로그입니다.

위 블로그에 모델의 문자열 필드 옵션으로 blank와 null을 어떻게 지정해야 하는지 잘 설명되어 있습니다.

원문을 간단하게 요약하면 다음과 같습니다:

•

blank: Validation과 관련 있습니다. Form(또는 Serializer)에 값을 필수로 입력해야 하는지 아닌지

•

null: 데이터베이스와 관련 있습니다. 데이터베이스의 column에 null 값을 허용할 것인지 아닌지

문자열 기반의 필드(CharField와 TextField 등)에 null=True 옵션을 주었을 때, 해당 필드의 데이터가 없는 상황을 두 가지(빈 문자열 또는 null)로 해석할 수 있기 때문에 null=True 사용을 지양하라고 합니다.

CharField에 데이터가 없는 상태를 빈 문자열('')로 나타내는 것이 Django Convention입니다.

Avoid using null on string-based fields such as CharField and TextField. If a string-based field has null=True, that means it has two possible values for “no data”: NULL, and the empty string. In most cases, it’s redundant to have two possible values for “no data;” the Django convention is to use the empty string, not NULL. — Django docs

그렇다면 문자열 기반 필드에 대해 절대로 null=True를 사용해서는 안 되는 것 일까요?

Deep Dive

휴대폰 번호를 유저 프로필에 추가한다고 해보겠습니다.

내부 정책에 의해 휴대폰 번호 입력이 필수는 아니지만, 휴대폰 번호는 반드시 unique 하다고 가정합시다.

필수 입력이 아니라는 것이 중요합니다! 해당 값이 필수라면 blank=False로 지정하면 그만입니다.

휴대폰 번호는 CharField로 저장할 것이기 때문에 null=True 대신 blank=True만 적용합시다:

class UserProfile(models.Model):
		...
		mobile = models.CharField(max_length=11, unique=True, blank=True)
Python
복사

위의 코드로 migration을 적용하려고 하면, unique constraint violations가 발생합니다.

쉽게 말해unique=True 옵션이 충돌한다는 뜻입니다.

원인을 분석 해봅시다.

mobile 필드는 blank=True이고 null=False 입니다.

따라서 입력이 없으면 Django는 해당 필드의 값을 빈 문자열("")로 취급합니다.

문제는 unique=True 옵션으로 인해, 다수의 빈 문자열('')을 갖는 행이 존재할 수 없습니다.

위의 필드의 입력이 필수가 아니기 때문에 unique=True와 충돌하지 않는 빈 값이 허용 되어야합니다.

따라서 위와 같은 상황(blank=True & unique=True)에서는 null=True가 반드시 필요합니다.

class UserProfile(models.Model):
		...
		mobile = models.CharField(max_length=15, unique=True, blank=True, null=True)
Python
복사

다수의 null 값은 unique constraint violations에 걸리지 않습니다.

다수의 null이 허용되는 이유는 null은 특정한 값이 아니기 때문입니다.

A null should not be confused with a value of 0. A null value indicates a lack of a value, which is not the same thing as a value of zero. — Wikipedia(Null)

Conclusion

정리하면 다음과 같습니다:

•

문자열 기반 필드에는 빈 값을 나타내기 위해 null=True 대신 blank=True를 사용하자.

•

다만 unique=True인 경우에 빈 값을 허용해야 한다면 null=True가 반드시 필요하다.