10월 28일 원티드 프리온보딩 백엔드 3일차 TIL

:one: 진행상황

Payment API 설계

:two: 진행상황리뷰

class PaymentUpdateCommonSerializer(serializers.ModelSerializer):
 
    ESSENTIAL_FIELDS: str = ""
    COMPARE_FIELDS: str = ""
 
    def validate(self, attrs: ATTRS_TYPE) -> ATTRS_TYPE:
        # 필수 필드 검사
        if attrs.get(self.ESSENTIAL_FIELDS, None) is None:
            raise serializers.ValidationError(f"{self.ESSENTIAL_FIELDS}가 없습니다.")
        if attrs.get(self.COMPARE_FIELDS, None) is None:
            raise serializers.ValidationError(f"{self.COMPARE_FIELDS}가 없습니다.")
        if attrs.get(self.COMPARE_FIELDS) <= attrs.get(self.ESSENTIAL_FIELDS):
            return attrs
        raise serializers.ValidationError(
            f"{self.ESSENTIAL_FIELDS}가 {self.COMPARE_FIELDS}보다 이전입니다."
        )
 
 
class PaymentSuccessSerializer(PaymentUpdateCommonSerializer):
 
    ESSENTIAL_FIELDS: Final = SUCCESSED_AT
    COMPARE_FIELDS: Final = CREATED_AT
 
    class Meta:
        model: Final = Payment
        fields: Final = (SUCCESSED_AT,)
 
 
class PaymentCancelSerializer(PaymentUpdateCommonSerializer):
 
    ESSENTIAL_FIELDS: Final = CANCELED_AT
    COMPARE_FIELDS: Final = CREATED_AT
 
    class Meta:
        model: Final = Payment
        fields: Final = (CANCELED_AT,)

다형성을 이용한 검증 메소드 생성

:three: Today I Learned

Field

내용

Field 란?

Field is an abstract class that represents a database table column. Django uses fields to create the database table (db_type()), to map Python types to database (get_prep_value()) and vice-versa (from_db_value()).

Field 란 데이터베이스 테이블의 열을 표현한 추상적 클래스이다. Django는 field를 이용하여 데이터베이스 테이블을 생성하고(db_type()), Python 타입을 데이터베이스에 매핑하고(get_prep_value()), 역으로도 매핑한다(from_db_value()).

Field의 종류

주로 사용하는 Field는 Bold 처리.

데이터 타입에 따른 Field

수
- 0을 포함한 자연수
  - PositiveBigIntegerField
    
    0 이상의 64bit 정수 지원.(0 ~ 9223372036854775807)
  - PositiveIntegerField
    
    0 이상의 32bit 정수 지원.(0 ~ 2147483647)
  - PositiveSmallIntegerField
    
    0 이상의 16bit 정수 지원.(0 ~ 32767)
- 정수
  - BigIntegerField
    
    IntegerField 64bit 정수까지 지원. (-9223372036854775808 ~ 9223372036854775807)
  - IntegerField
    
    32bit 정수 지원.(-2147483648 ~ 2147483647)
  - SmallIntegerField
    
    16bit 정수 지원. (-32768 ~ 32767)
- 실수
  - DecimalField
    
    Decimal 지원.
  - FloatField
    
    부동 소수점 값 지원.
- 자동 생성
  - AutoField
    
    ID 등을 위해 자동으로 증가하는 Field. 32bit 정수 지원.(1 ~ 2147483647)
  - BigAutoField
    
    AutoField와 동일하나 64bit 정수 지원. (1 ~ 9223372036854775807)
  - SmallAutoField
    
    AutoField와 동일하나 16bit 정수 지원. (1 ~ 32767)
문자열
- 기본
  - CharField
    
    문자열 지원. 긴 문자열을 지원해야한다면 TextField 권장.
  - TextField
    
    긴 문자열 지원.
- 형식이 있는 문자열
  - EmailField
    
    EmailValidator로 검증하는 이메일 형식 문자열 지원
  - FilePathField
    
    파일 경로를 포함한 파일 이름 형식의 문자열 지원.
    - FilePathField.path
      
      기본 절대 경로 문자열 혹은 Callable 객체. 필수 인자.
  - GenericIPAddressField
    
    IPv4 혹은 IPv6 형식의 문자열 지원.
  - SlugField
    
    문자, 숫자, _, -만으로 이루어진 문자열. URL의 마지막을 주로 사용
  - URLField
    
    로 검증된 URL 형식의 문자열 지원.
  - UUIDField
    
    UUID 혹은 UUID 형식의 32자 문자열 지원.
시간
- DateField
  
  날짜(datetime.date) 지원.
- DateTimeField
  
  날짜와 시간(datetime.date) 지원.
  - DateField.auto_now
    
    오브젝트가 저장될 때 자동 업데이트. 수정된 시각을 저장할 때 유용.
  - DateField.auto_now_add
    
    오브젝트가 생성될 때 자동 생성. 생성된 시각을 저장할 때 유용.
- DurationField
  
  기간(datetime.timedelta) 지원
- TimeField
  
  시각(datetime.time) 지원.
파일
- FileField
  
  파일 지원.
  - FileField.upload_to
    
    파일 저장경로 인자. 시각 포맷팅(strftime())을 지원.
- ImageField
  
  이미지 형식의 파일 지원.
기타
- BinaryField
  
  바이너리 데이터(bytes, bytearray, memoryview) 지원.
- BooleanField
  
  True/False 지원.
- JSONField
  
  JSON 데이터 지원.

관계에 따른 Field

ForeignKey

외래키. 다대일 관계 시 사용. 외래키를 가져올 모델(to)과 참조한 개체가 사라졌을 때 처리할 방법(on_delete) 필수.
- ForeignKey.to
  
  모델 클래스 혹은 해당 클래스를 표현하는 문자열. 'self'지정 시 재귀적 관계 가능.
- ForeignKey.on_delete
  
  참조개체가 삭제되었을 때 처리하는 방법.
  - CASCADE
    
    참조된 개체 삭제 시 참조한 개체도 모두 삭제.
  - PROTECT
    
    참조하고 있는 개체가 존재할 경우 삭제 방지.
  - RESTRICT
    
    기본적으로는 PROTECT와 동일. 참조된 개체와 참조한 개체가 동시에 참조하는 공통 참조 개체가 존재하고, 해당 개체에 대해 두 개체 모두 CASCADE이며, 공통 참조 개체가 삭제되는 경우 삭제 허용.
```
class Artist(models.Model):
    name = models.CharField(max_length=10)
 
class Album(models.Model):
    artist = models.ForeignKey(Artist, on_delete=models.CASCADE)
 
class Song(models.Model):
    artist = models.ForeignKey(Artist, on_delete=models.CASCADE)
    album = models.ForeignKey(Album, on_delete=models.RESTRICT)
 
# Album이 삭제될 경우 참조한 Song이 존재한다면 RestrictedError 발생
# Artist가 삭제될 경우 참조한 Album과 Song 모두 문제 없이 삭제
```
  - SET_NULL
    
    참조된 개체 삭제시 null로 설정. null로 설정 가능해야함.(null=True)
  - SET_DEFAULT
    
    참조된 개체 삭제시 default 값으로 설정.
    
    default인자가 지정되어 있어야함.(default=...)
  - SET(...)
    
    SET_DEFAULT과 동일하나 Callable 객체 전달 가능.
```
def get_sentinel_user():
    return AnotherModel.objects.get_or_create(username='deleted')[0]
 
class MyModel(models.Model):
    user = models.ForeignKey(
        AnotherModel,
        on_delete=models.SET(get_sentinel_user),
    )
```
```
- DO_NOTHING

  참조된 개체가 사라져도 아무 변경 없음. [IntegrityError](https://docs.djangoproject.com/ko/4.1/ref/exceptions/#django.db.IntegrityError) 발생 가능.
```
- ForeignKey.to_field
  
  키 값으로 참조할 값. 기본적으로 primary 키 값. 만약 다른 값을 지정한다면 해당 값은 유일해야함.(unique=True)

ManyToManyField

다대다 관계.

ManyToManyField.through

다대다 관계에서 추가적인 값을 저장할 때 필요. 추가 모델을 만들어 지정.

# https://baecode.tistory.com/44
class User(models.Model):
   ...         
 
class Post(models.Model):
    like = models.ManyToManyField(User,through="Like")
    ...
  
  class Like(models.Model):
    user = models.ForignKey(User, on_delete=models.CASCADE)
    post = models.ForignKey(Post, on_delete=models.CASCADE)
    created_at = models.DateField(auto_now_add = True)
    ...

OneToOneField

일대일 관계. 유일성이 보장된 외래키 필드(ForeignKey(..., unique=True))와 비슷하나 역추적이 가능.

Chomu's Blog.

Posts

10월 28일 원티드 프리온보딩 백엔드 3일차 TIL

목차

:one: 진행상황

:two: 진행상황리뷰

:three: Today I Learned

Field 란?

Field의 종류

데이터 타입에 따른 Field

관계에 따른 Field