[iOS] DateFormat, 열거형으로 좀 더 쉽게 다루기

들어가며

안녕하세요, 태끼입니다 :) 정말 오랜만에 글을 씁니다..😂 요새 번아웃이 올 것만 같아서 아슬아슬 하루를 보내고 있지만 다시금 마음을 다잡고 열심히 해보고자 합니다. 글 쓰는 것을 생각보다 너무 미뤄두고 있었는데, 완벽을 추구하기 보다는 일단 실천을 하는 것에 습관을 들이도록 노력해보겠습니다.

오늘 간단하게 소개할 내용은요. 제가 날짜 형식에 관련해서 사용했던 코드 조각이라고 하면 될까요. 듣고 있는 수업에서도 날짜를 다뤄볼 일이 있었고, 진행 중인 프로젝트 내에서도 제가 캘린더를 맡고 있어서 날짜를 다룰 일이 많은데요. 생각보다 날짜 형식을 관리하기 너무 귀찮습니다. 그래서 열거형을 이용해서 좀 더 깔끔하게 DateFormat을 관리해보도록 해요.

---

우리가 그동안 날짜를 다루면서 했던 행동을 돌이켜볼게요. Date 타입을 String 타입으로 변환하거나, String 타입을 Date 타입으로 변환하는 딱 2가지의 모습을 확인할 수 있어요. 매번 우리는 코드를 어떤 식으로 작성했을까요?

---

기존 날짜 변환 방식

1. Date을 String으로 바꾸기

원하는 형태의 포맷 어떤 것으로든 변환이 가능합니다.

let dateFormatter = DateFormatter()
dateFormatter.locale = Locale(identifier: "ko_KR")
dateFormatter.dateFormat = "yyyy-MM-dd"

let newDate = Date()
return dateFormatter.string(from: newDate)

2. String을 Date로 바꾸기

String의 포맷과 dateFormatter의 dateFormat 타입의 포맷을 맞춰주어야 합니다.

let dateFormatter = DateFormatter()
dateFormatter.locale = Locale(identifier: "ko_KR")
dateFormatter.dateFormat = "yyyy-MM-dd HH:mm"

let dateString = "2022-08-08 22:30"
return dateFormatter.date(from: dateString)

위의 1번, 2번을 적절히 잘 섞으면 String 형태의 Date를 원하는 포맷의 String으로 다시 바꿔줄 수 있을 것 같습니다.

---

그런데 생각해보면 위의 작업이 상당히 번거롭습니다. 날짜 형식을 바꾸려면 매 순간마다 DateFormatter 객체를 만들고(물론 Class나 Struct 내에서 한 번만 만들어놓고 사용해도 됩니다.) dateFormat을 지정해주고 값을 변경해주고 여간 번거로운 일이 아닐 수 없죠. 위의 단점 외에도 프로젝트 내에서 여러 형태의 날짜 형식이 쓰이는 경우라면 곳곳에 흩어진 날짜 형식을 관리하기 어렵습니다. 마치 문자열 리터럴이 곳곳에 퍼져있는 느낌과도 비슷하죠. 그래서 열거형을 이용해서 좀 더 쉽게 날짜 형식을 관리하고, Date와 String의 Extension 메서드를 만들어 쉽게 코드를 작성하고자 합니다.

---

열거형과 Extension을 이용한 코드 개선

1. DateFormatType 열거형 생성

enum DateFormatType {
    case full
    case year
    case utc
    case utcWithSlash
    
    var description: String {
        switch self {
        case .full:
            return "yyyy-MM-dd'T'HH:mm:ss.SSS'Z"
        case .year:
            return "yyyy-MM-dd"
        case .utc:
            return "MM-dd-yyyy"
        case .utcWithSlash:
            return "MM/dd/yyyy"
        }
    }
}

이 description 프로퍼티에 들어있는 String 값이 결국 dateFormatter의 dateFormat 형식으로 들어가게 될 것인데요. 이렇게 열거형으로 한 번에 관리를 하게 되면 프로젝트 내에서 쓰이는 dateFormat에 좀 더 쉽게 접근할 수 있겠죠?

2. Date+Extension

import UIKit

extension Date {
    
    func toString(of type: DateFormatType) -> String {
        let dateFormatter = DateFormatter()
        dateFormatter.locale = Locale(identifier: "ko_KR")
        dateFormatter.dateFormat = type.description
        return dateFormatter.string(from: self)
    }
}

3. String+Extension

import UIKit

extension String {
    
    func toDate(to type: DateFormatType) -> Date? {
        let dateFormatter = DateFormatter()
        dateFormatter.locale = Locale(identifier: "ko_KR")
        dateFormatter.dateFormat = type.description
        return dateFormatter.date(from: self)
    }
}

---

실제 코드 적용

왼쪽에 있는 날짜 형식(yyyy-MM-dd)를 오른쪽에 있는 것처럼 미국식 표기(MM/dd/yyyy)로 바꾸고 싶은 것인데요. 기존 방식을 이용해서도 잘 바꿀 수 있겠지만 위에서 소개한 열거형과 Extension을 이용하면 다음과 같이 코드를 쓸 수 있습니다.

// media.releaseDate는 "2022-08-22" 다음과 같은 형식을 띰
dateLabel.text = media.releaseDate

// 08/22/2022와 같이 날짜 형식을 변경할 수 있음
dateLabel.text = media.releaseDate.toDate(to: .year)?.toString(of: .utcWithSlash)

기존 날짜 변환 방식을 이용했다면 중복된 코드도 많이 쓰고, 너무 머리 아팠을 것 같은데 코드가 잘 개선된 것 같나요? 우리가 알고 있는 기본 개념들을 이용해서 코드를 개선해보았습니다. 좋은 시간이 되었기를 바랍니다.

---

마치며

추가로 이렇게 날짜 형식을 다양하게 표현할 수 있다는 것을 알리며 마칩니다. (조금만.. 줄여서.. 프로젝트에 사용하자...)

enum FormatType {
    case full
    case year
    case day
    case month
    case second
    case time
    case calendar
    case calendarTime
    case calendarWithMonth
    case noticeDay
    
    var description: String {
        switch self {
        case .full:
            return "yyyy-MM-dd'T'HH:mm:ss.SSS'Z"
        case .year:
            return "yyyy-MM-dd"
        case .day:
            return "M월 d일 EEEE"
        case .month:
            return "M월"
        case .second:
            return "HH:mm:ss"
        case .time:
            return "a h:mm"
        case .calendar:
            return "yyyy년 MM월 dd일"
        case .calendarTime:
            return "a HH:mm"
        case .calendarWithMonth:
            return "yyyy년 M월"
        case .noticeDay:
            return "yyyy.MM.dd"
        }
    }
}