您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發綜合

iOS 類別擴展實作:用 NSDate+Helpers 收攏所有日期操作

編輯:iOS 開發綜合

日期處理大概是每個 iOS 專案都躲不掉的麻煩事。NSDate 本身只懂「時間點」,年月日怎麼拆、加減幾天幾月怎麼算、格式字串怎麼轉,全都得自己動手。與其把 NSCalendar 與 NSDateFormatter 的樣板程式碼散落在各個 ViewController 裡,不如一次整理成一個類別(Category),讓全專案共用。

下面這份 NSDate+Helpers 就是這個思路的產物,把常用的日期計算與格式化操作全部收攏,使用時只需引入標頭檔:

#import "Date.h"

這份類別大致涵蓋了幾類能力:

  • 拆解:取得年、月、日、小時、分鐘,以及某日期是當年第幾週、當週第幾天。
  • 推算:day 天後、month 個月後的日期;當天/當週/當月的起訖時間點。
  • 相對描述:距今幾天、「今天 / 昨天 / N 天前」這類人類看得懂的講法。
  • 格式化:NSDate 與 NSString 雙向轉換,以及依情境自動挑選合適顯示格式的 stringForDisplayFromDate: 系列方法。

其中 stringForDisplayFromDate:prefixed: 的判斷邏輯值得留意:同一天只顯示時分,一週之內顯示星期名稱,同一年度顯示「Jan 23」,跨年則補上年份。這種依時間距離調整精度的做法,比一律顯示完整時間戳要友善得多。

@implementation NSDate (Helpers)

// 取得年月日,如:19871127
- (NSString *)getFormatYearMonthDay {
    return [NSString stringWithFormat:@"%d%02d%02d", [self getYear], [self getMonth], [self getDay]];
}

// 該日期是當年的第幾週
- (int)getWeekOfYear {
    int i;
    int year = [self getYear];
    NSDate *date = [self endOfWeek];
    for (i = 1; [[date dateAfterDay:-7 * i] getYear] == year; i++) {
    }
    return i;
}

// 返回 day 天後的日期(day 為負數則表示 |day| 天前)
- (NSDate *)dateAfterDay:(int)day {
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSDateComponents *componentsToAdd = [[NSDateComponents alloc] init];
    [componentsToAdd setDay:day];
    NSDate *dateAfterDay = [calendar dateByAddingComponents:componentsToAdd toDate:self options:0];
    [componentsToAdd release];
    return dateAfterDay;
}

// month 個月後的日期
- (NSDate *)dateafterMonth:(int)month {
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSDateComponents *componentsToAdd = [[NSDateComponents alloc] init];
    [componentsToAdd setMonth:month];
    NSDate *dateAfterMonth = [calendar dateByAddingComponents:componentsToAdd toDate:self options:0];
    [componentsToAdd release];
    return dateAfterMonth;
}

// 取得日 / 月 / 年
- (NSUInteger)getDay {
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSDateComponents *c = [calendar components:(NSDayCalendarUnit) fromDate:self];
    return [c day];
}

- (NSUInteger)getMonth {
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSDateComponents *c = [calendar components:(NSMonthCalendarUnit) fromDate:self];
    return [c month];
}

- (NSUInteger)getYear {
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSDateComponents *c = [calendar components:(NSYearCalendarUnit) fromDate:self];
    return [c year];
}

// 取得小時 / 分鐘
- (int)getHour {
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSUInteger unitFlags = NSYearCalendarUnit | NSMonthCalendarUnit | NSDayCalendarUnit | NSHourCalendarUnit | NSMinuteCalendarUnit;
    NSDateComponents *components = [calendar components:unitFlags fromDate:self];
    return (int)[components hour];
}

- (int)getMinute {
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSUInteger unitFlags = NSYearCalendarUnit | NSMonthCalendarUnit | NSDayCalendarUnit | NSHourCalendarUnit | NSMinuteCalendarUnit;
    NSDateComponents *components = [calendar components:unitFlags fromDate:self];
    return (int)[components minute];
}

- (int)getHour:(NSDate *)date {
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSUInteger unitFlags = NSYearCalendarUnit | NSMonthCalendarUnit | NSDayCalendarUnit | NSHourCalendarUnit | NSMinuteCalendarUnit;
    NSDateComponents *components = [calendar components:unitFlags fromDate:date];
    return (int)[components hour];
}

- (int)getMinute:(NSDate *)date {
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSUInteger unitFlags = NSYearCalendarUnit | NSMonthCalendarUnit | NSDayCalendarUnit | NSHourCalendarUnit | NSMinuteCalendarUnit;
    NSDateComponents *components = [calendar components:unitFlags fromDate:date];
    return (int)[components minute];
}

// 距今幾天
- (NSUInteger)daysAgo {
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSDateComponents *components = [calendar components:(NSDayCalendarUnit) fromDate:self toDate:[NSDate date] options:0];
    return [components day];
}

// 以午夜為基準計算距今幾天
- (NSUInteger)daysAgoAgainstMidnight {
    NSDateFormatter *mdf = [[NSDateFormatter alloc] init];
    [mdf setDateFormat:@"yyyy-MM-dd"];
    NSDate *midnight = [mdf dateFromString:[mdf stringFromDate:self]];
    [mdf release];
    return (int)[midnight timeIntervalSinceNow] / (60 * 60 * 24) * -1;
}

- (NSString *)stringDaysAgo {
    return [self stringDaysAgoAgainstMidnight:YES];
}

- (NSString *)stringDaysAgoAgainstMidnight:(BOOL)flag {
    NSUInteger daysAgo = (flag) ? [self daysAgoAgainstMidnight] : [self daysAgo];
    NSString *text = nil;
    switch (daysAgo) {
        case 0: text = @"Today"; break;
        case 1: text = @"Yesterday"; break;
        default: text = [NSString stringWithFormat:@"%d days ago", daysAgo];
    }
    return text;
}

// 一週中的第幾天(週日為第一天)
- (NSUInteger)weekday {
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSDateComponents *weekdayComponents = [calendar components:(NSWeekdayCalendarUnit) fromDate:self];
    return [weekdayComponents weekday];
}

// 字串與 NSDate 的雙向轉換
+ (NSDate *)dateFromString:(NSString *)string {
    return [NSDate dateFromString:string withFormat:[NSDate dbFormatString]];
}

+ (NSDate *)dateFromString:(NSString *)string withFormat:(NSString *)format {
    NSDateFormatter *inputFormatter = [[NSDateFormatter alloc] init];
    [inputFormatter setDateFormat:format];
    NSDate *date = [inputFormatter dateFromString:string];
    [inputFormatter release];
    return date;
}

- (NSString *)stringFromDate:(NSDate *)date withFormat:(NSString *)format {
    return [date stringWithFormat:format];
}

- (NSString *)stringFromDate:(NSDate *)date {
    return [date string];
}

// 依情境自動挑選顯示格式
- (NSString *)stringForDisplayFromDate:(NSDate *)date prefixed:(BOOL)prefixed {
    NSDate *today = [NSDate date];
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSDateComponents *offsetComponents = [calendar components:(NSYearCalendarUnit | NSMonthCalendarUnit | NSDayCalendarUnit) fromDate:today];
    NSDate *midnight = [calendar dateFromComponents:offsetComponents];

    NSDateFormatter *displayFormatter = [[NSDateFormatter alloc] init];
    NSString *displayString = nil;

    if ([date compare:midnight] == NSOrderedDescending) {
        // 今天:只顯示時分
        if (prefixed) {
            [displayFormatter setDateFormat:@"'at' h:mm a"];
        } else {
            [displayFormatter setDateFormat:@"h:mm a"];
        }
    } else {
        NSDateComponents *componentsToSubtract = [[NSDateComponents alloc] init];
        [componentsToSubtract setDay:-7];
        NSDate *lastweek = [calendar dateByAddingComponents:componentsToSubtract toDate:today options:0];
        [componentsToSubtract release];

        if ([date compare:lastweek] == NSOrderedDescending) {
            [displayFormatter setDateFormat:@"EEEE"];   // 一週內:顯示星期
        } else {
            NSInteger thisYear = [offsetComponents year];
            NSDateComponents *dateComponents = [calendar components:(NSYearCalendarUnit | NSMonthCalendarUnit | NSDayCalendarUnit) fromDate:date];
            NSInteger thatYear = [dateComponents year];
            if (thatYear >= thisYear) {
                [displayFormatter setDateFormat:@"MMM d"];
            } else {
                [displayFormatter setDateFormat:@"MMM d, yyyy"];
            }
        }
        if (prefixed) {
            NSString *dateFormat = [displayFormatter dateFormat];
            NSString *prefix = @"'on' ";
            [displayFormatter setDateFormat:[prefix stringByAppendingString:dateFormat]];
        }
    }
    displayString = [displayFormatter stringFromDate:date];
    [displayFormatter release];
    return displayString;
}

- (NSString *)stringForDisplayFromDate:(NSDate *)date {
    return [self stringForDisplayFromDate:date prefixed:NO];
}

- (NSString *)stringWithFormat:(NSString *)format {
    NSDateFormatter *outputFormatter = [[NSDateFormatter alloc] init];
    [outputFormatter setDateFormat:format];
    NSString *timestamp_str = [outputFormatter stringFromDate:self];
    [outputFormatter release];
    return timestamp_str;
}

- (NSString *)string {
    return [self stringWithFormat:[NSDate dbFormatString]];
}

- (NSString *)stringWithDateStyle:(NSDateFormatterStyle)dateStyle timeStyle:(NSDateFormatterStyle)timeStyle {
    NSDateFormatter *outputFormatter = [[NSDateFormatter alloc] init];
    [outputFormatter setDateStyle:dateStyle];
    [outputFormatter setTimeStyle:timeStyle];
    NSString *outputString = [outputFormatter stringFromDate:self];
    [outputFormatter release];
    return outputString;
}

// 週日的起始時間
- (NSDate *)beginningOfWeek {
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSDate *beginningOfWeek = nil;
    BOOL ok = [calendar rangeOfUnit:NSWeekCalendarUnit startDate:&beginningOfWeek interval:NULL forDate:self];
    if (ok) {
        return beginningOfWeek;
    }
    // 無法用 range 計算時,退而求其次抓週日
    NSDateComponents *weekdayComponents = [calendar components:NSWeekdayCalendarUnit fromDate:self];
    NSDateComponents *componentsToSubtract = [[NSDateComponents alloc] init];
    [componentsToSubtract setDay:0 - ([weekdayComponents weekday] - 1)];
    beginningOfWeek = [calendar dateByAddingComponents:componentsToSubtract toDate:self options:0];
    [componentsToSubtract release];
    // 正規化到午夜
    NSDateComponents *components = [calendar components:(NSYearCalendarUnit | NSMonthCalendarUnit | NSDayCalendarUnit) fromDate:beginningOfWeek];
    return [calendar dateFromComponents:components];
}

// 當天零點
- (NSDate *)beginningOfDay {
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSDateComponents *components = [calendar components:(NSYearCalendarUnit | NSMonthCalendarUnit | NSDayCalendarUnit) fromDate:self];
    return [calendar dateFromComponents:components];
}

// 當月第一天
- (NSDate *)beginningOfMonth {
    return [self dateAfterDay:-[self getDay] + 1];
}

// 當月最後一天
- (NSDate *)endOfMonth {
    return [[[self beginningOfMonth] dateafterMonth:1] dateAfterDay:-1];
}

// 本週週末
- (NSDate *)endOfWeek {
    NSCalendar *calendar = [NSCalendar currentCalendar];
    NSDateComponents *weekdayComponents = [calendar components:NSWeekdayCalendarUnit fromDate:self];
    NSDateComponents *componentsToAdd = [[NSDateComponents alloc] init];
    [componentsToAdd setDay:(7 - [weekdayComponents weekday])];
    NSDate *endOfWeek = [calendar dateByAddingComponents:componentsToAdd toDate:self options:0];
    [componentsToAdd release];
    return endOfWeek;
}

// 常用格式字串
- (NSString *)dateFormatString    { return @"yyyy-MM-dd"; }
- (NSString *)timeFormatString    { return @"HH:mm:ss"; }
- (NSString *)timestampFormatString { return @"yyyy-MM-dd HH:mm:ss"; }

+ (NSString *)dbFormatString {
    return [NSDate timestampFormatString];
}

@end

使用上有幾點提醒。第一,這份程式碼走的是 MRC 語彙(手動 release),若專案開啟 ARC,把 release 相關行拿掉即可。第二,其中的 NSCalendarUnit 常數(如 NSDayCalendarUnit、NSWeekCalendarUnit)在新版 SDK 已被 NSCalendarUnitDay、NSCalendarUnitWeekOfYear 等取而代之,維護時建議一併遷移,並改用 NSCalendar 的 dateByAddingUnit:value:toDate:options: 這類新介面。第三,所有日期運算都應該留意時區與 locale,尤其是跨時區的伺服器資料,明確指定 timeZone 能省下不少追查問題的時間。

把這些邏輯集中在一個類別裡,最大的好處不是少寫幾行,而是當格式需求改變時,你只需要改一個地方。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved