「本月的第一天與最後一天」是報表統計、區間查詢、訂閱續約計算中反覆出現的需求。直覺的做法是先判斷大小月再逐一減一天,但用 NSCalendar 的日期運算反而更簡潔也更不容易出錯。本文整理三組可直接複用的方法。
關鍵是「以月初為基準,加上一個月再往回退一天」。因為所有月份的第一天都是 1 號,只要組出月初日期,月末就能透過 dateByAddingComponents 推導出來,完全不必知道該月有幾天。
// 本月開始日期
func startOfCurrentMonth() -> NSDate {
let date = NSDate()
let calendar = NSCalendar.currentCalendar()
let components = calendar.components([.Year, .Month], fromDate: date)
let startOfMonth = calendar.dateFromComponents(components)!
return startOfMonth
}
// 本月結束日期
// returnEndTime 為 true 時回傳 23:59:59,否則回傳 00:00:00
func endOfCurrentMonth(returnEndTime: Bool = false) -> NSDate {
let calendar = NSCalendar.currentCalendar()
let components = NSDateComponents()
components.month = 1
if returnEndTime {
components.second = -1
} else {
components.day = -1
}
let endOfMonth = calendar.dateByAddingComponents(components,
toDate: startOfCurrentMonth(), options: [])!
return endOfMonth
}
測試:
// 建立日期格式器
let dateFormatter = NSDateFormatter()
dateFormatter.dateFormat = "yyyy年MM月dd日 HH:mm:ss"
// 本月第一天
let startDate = startOfCurrentMonth()
print("本月開始時間:", dateFormatter.stringFromDate(startDate))
// 本月最後一天(當日 00:00:00)
let endDate1 = endOfCurrentMonth()
print("本月結束時間1:", dateFormatter.stringFromDate(endDate1))
// 本月最後一天(當日 23:59:59)
let endDate2 = endOfCurrentMonth(true)
print("本月結束時間2:", dateFormatter.stringFromDate(endDate2))
這裡的 returnEndTime 參數是個實用的小設計:報表統計通常需要「23:59:59」才能涵蓋全天資料,而日期顯示則要「00:00:00」,一個參數就能兼顧兩種情境。
邏輯與月份完全相同,只是把 month 換成 year:
// 本年開始日期
func startOfCurrentYear() -> NSDate {
let date = NSDate()
let calendar = NSCalendar.currentCalendar()
let components = calendar.components([.Year], fromDate: date)
let startOfYear = calendar.dateFromComponents(components)!
return startOfYear
}
// 本年結束日期
func endOfCurrentYear(returnEndTime: Bool = false) -> NSDate {
let calendar = NSCalendar.currentCalendar()
let components = NSDateComponents()
components.year = 1
if returnEndTime {
components.second = -1
} else {
components.day = -1
}
let endOfYear = calendar.dateByAddingComponents(components,
toDate: startOfCurrentYear(), options: [])!
return endOfYear
}
測試:
let dateFormatter = NSDateFormatter()
dateFormatter.dateFormat = "yyyy年MM月dd日 HH:mm:ss"
let startDate = startOfCurrentYear()
print("本年度開始時間:", dateFormatter.stringFromDate(startDate))
let endDate1 = endOfCurrentYear()
print("本年度結束時間1:", dateFormatter.stringFromDate(endDate1))
let endDate2 = endOfCurrentYear(true)
print("本年度結束時間2:", dateFormatter.stringFromDate(endDate2))
把年、月抽成參數,就能查詢任意區間:
// 指定年月的開始日期
func startOfMonth(year: Int, month: Int) -> NSDate {
let calendar = NSCalendar.currentCalendar()
let startComps = NSDateComponents()
startComps.day = 1
startComps.month = month
startComps.year = year
let startDate = calendar.dateFromComponents(startComps)!
return startDate
}
// 指定年月的結束日期
func endOfMonth(year: Int, month: Int, returnEndTime: Bool = false) -> NSDate {
let calendar = NSCalendar.currentCalendar()
let components = NSDateComponents()
components.month = 1
if returnEndTime {
components.second = -1
} else {
components.day = -1
}
let endOfMonth = calendar.dateByAddingComponents(components,
toDate: startOfMonth(year, month: month), options: [])!
return endOfMonth
}
測試:
let dateFormatter = NSDateFormatter()
dateFormatter.dateFormat = "yyyy年MM月dd日 HH:mm:ss"
let startDate = startOfMonth(2016, month: 8)
print("2016 年 8 月的開始時間:", dateFormatter.stringFromDate(startDate))
let endDate1 = endOfMonth(2016, month: 8)
print("2016 年 8 月的結束時間1:", dateFormatter.stringFromDate(endDate1))
let endDate2 = endOfMonth(2016, month: 8, returnEndTime: true)
print("2016 年 8 月的結束時間2:", dateFormatter.stringFromDate(endDate2))
timeZone 與 calendarIdentifier,否則使用者跨區旅行時,「本月第一天」可能落在預期之外的時間點。Calendar.current.dateInterval(of: .month, for: Date()),一行就能取回整個區間的 start 與 end,省去自己組 DateComponents。維護舊專案時本文寫法仍可直接沿用。