Date and Time Formatting in Kotlin with the DateTime Library

최근 회사 서비스 개발 중, 서버에서 내려주는 DateFormat(”2024-03-11 07:18:25”)과

디자인쪽에서 원하는 DateFormat(”03/11/2024 07:18:25”)이 달라 반나절을 삽질한 경험이 있어서,,

이 주제를 선택하게 되었습니다…🥹

 

kotlinx-datetime 라이브러리는 “v0.6.0-RC”에서 업데이트 되었습니다.

 

기존의 날짜 및 시간에 관한 Formatting Options

예를들어 “March 1, 2024, at 9:15 AM”을 코드로 나타내고 싶다면,
LocalDateTime(2024, 3, 1, 9, 15, 0, 0) 으로 작성할 수 있습니다.

 

• LocalDateTime
  • LocalDateTime.Formats.ISO → 2024-03-01T09:15:00
• LocalDate
  • LocalDate.Formats.ISO → 2024-03-01
  • LocalDate.Formats.ISO_BASIC → 20240301
• LocalTime
  • LocalTime.Formats.ISO → 09:15:00

kotlinx-datetime 라이브러리를 쓰기위해서는
build.gradle 또는 gradle/libs.versions.toml 에 dependency를 추가하면 됩니다.

implementation "org.jetbrains.kotlinx:kotlinx-datetime:0.6.0-RC.2"

 

Formatting

날짜와 시간을 Formatting 하는 방법은 2가지가 있습니다.

1. Unicode Pattern
2. Kotlin DSL

이와같은 방법을 사용하려면 format(...) 함수를 사용해야 합니다.

val currentDateTime = LocalDateTime(2024, 3, 1, 9, 15, 0, 0)
val currentDate = currentDateTime.date
val currentTime = currentDateTime.time

currentDateTime.format(LocalDateTime.Format { 
    // Unicode Pattern 또는 Kotlin DSL
})

currentDate.format(LocalDate.Format { 
    // Unicode Pattern 또는 Kotlin DSL
})

currentTime.format(LocalTime.Format { 
    // Unicode Pattern 또는 Kotlin DSL
})

 

Unicode Pattern

val currentDateTime = LocalDateTime(2024, 3, 1, 9, 15, 0, 0)
val currentDate = currentDateTime.date
val currentTime = currentDateTime.time

// 2024 03 01 - 09:15
currentDateTime.format(LocalDateTime.Format { byUnicodePattern("yyyy MM dd - HH:mm") })

// 2024/03/01
currentDate.format(LocalDate.Format { byUnicodePattern("yyyy/MM/dd") })

// 09:15 
currentTime.format(LocalTime.Format { byUnicodePattern("HH:mm") })

 

Kotlin DSL

val currentDateTime = LocalDateTime(2024, 3, 1, 9, 15, 0, 0)
val currentDate = currentDateTime.date
val currentTime = currentDateTime.time

// Mar 01 2024 - 09:15
currentDateTime.format(
    LocalDateTime.Format {
        date(
            LocalDate.Format {
                monthName(MonthNames.ENGLISH_ABBREVIATED)
                char(' ')
                dayOfMonth()
                chars(" ")
                year()
            }
        )
        chars(" - ")
        time(
            LocalTime.Format {
                hour(); char(':'); minute()
            }
        )
    }
)

// Mar 01, 2024
currentDate.format(LocalDate.Format {
    monthName(MonthNames.ENGLISH_ABBREVIATED)
    char(' ')
    dayOfMonth()
    chars(", ")
    year()
})

// 09:15
currentTime.format(LocalTime.Format {
    hour()
    char(':')
    minute()
})

• hour() 함수는 0에서 23시까지 시간을 리턴합니다.
• 만약 12시간제로 시간을 표시하려면 amPmHour() 함수를 사용해야 합니다.

 

Kotlin DSL 방식을 사용하면, padding 매개변수로 year() monthNumber() dayOfMonth() hour() minute() 와 같은 함수들을 전달할 수 있고, 이를 통해 패딩 스타일을 변경할 수 있습니다.

val time = LocalTime(hour = 9, minute = 8)

// "9:8"
time.format(LocalTime.Format { 
    hour(padding = Padding.NONE)
    char(':')
    minute(padding = Padding.NONE) 
})

// "09:08"
time.format(LocalTime.Format { 
    hour(padding = Padding.ZERO)
    char(':')
    minute(padding = Padding.ZERO) 
})

// " 9: 8"
time.format(LocalTime.Format { 
    hour(padding = Padding.SPACE)
    char(':')
    minute(padding = Padding.SPACE) 
})

 

Parsing

Formatting된 날짜와 시간은 parse 함수를 사용할 수 있습니다.

val formattedDateTime = "2024 03 01 - 09:15"
LocalDateTime.parse(
    input = formattedDateTime,
    format = LocalDateTime.Format { byUnicodePattern("yyyy MM dd - HH:mm") }
)

val formattedDate = "2024/03/01"
LocalDate.parse(
    input = formattedDate,
    format = LocalDate.Format { byUnicodePattern("yyyy/MM/dd") }
)

val formattedTime = "09:15"
LocalTime.parse(
    input = formattedTime,
    format = LocalTime.Formats.ISO
)

 

즉, Unicode Pattern 또는 Kotlin DSL로 날짜와 시간을 Formatting → parse 함수로 적절한 곳에 사용!

 

Reference

https://alexzh.com/date-and-time-formatting-in-kotlin-with-the-datetime-library/

Date and Time Formatting in Kotlin with the DateTime Library