Если вам нужна разница (в годах, месяцах, днях) численно, тогда вычислите NSDateComponents как в Быстрые дни между два NSDates или ответ Раджана.

Если вам нужна разница в виде (локализованной) строки, чтобы представить ее пользователю, используйте NSDateComponentsFormatter, как это

let form = NSDateComponentsFormatter()
form.maximumUnitCount = 2
form.unitsStyle = .Full
form.allowedUnits = [.Year, .Month, .Day]
let s = form.stringFromDate(date1, toDate: date2)

Как уже упоминалось в комментариях, вычисление разницы из чистого интервала времени между датами не может дать правильных результатов, поскольку теряется большая часть информации о датах.

Обновление для Swift 3:

let form = DateComponentsFormatter()
form.maximumUnitCount = 2
form.unitsStyle = .full
form.allowedUnits = [.year, .month, .day]
let s = form.string(from: date1, to: date2)

Мы можем использовать эту функцию в Swift 2.0.

func yearsBetweenDate(startDate: NSDate, endDate: NSDate) -> Int
{
    let calendar = NSCalendar.currentCalendar()

    let components = calendar.components([.Year], fromDate: startDate, toDate: endDate, options: [])

    return components.year
}

Вы можете вернуть все, что я вернул год в этой функции. Это вернет количество лет между двумя датами.
Вы можете просто написать месяцы, дни и т. д., чтобы найти разницу между двумя датами в месяцах и днях соответственно.

Изменить

Swift 3.0 и выше

func yearsBetweenDate(startDate: Date, endDate: Date) -> Int {

    let calendar = Calendar.current

    let components = calendar.dateComponents([.year], from: startDate, to: endDate)

    return components.year!
}

В Swift 5 и iOS 12 вы можете использовать одно из трех приведенных ниже решений, чтобы вычислить разницу (в годах, месяцах, днях) между двумя датами.

№1. Использование метода dateComponents(_:from:to:) Calendar

Calendar имеет метод с именем dateComponents(_:from:to:). dateComponents(_:from:to:) имеет следующее объявление:

func dateComponents(_ components: Set<Calendar.Component>, from start: DateComponents, to end: DateComponents) -> DateComponents

Возвращает разницу между двумя датами, указанными как DateComponents.

Пример Playground ниже показывает, как использовать dateComponents(_:from:to:) для вычисления разницы между двумя датами:

import Foundation

let calendar = Calendar.current
let startComponents = DateComponents(year: 2010, month: 11, day: 22)
let endComponents = DateComponents(year: 2015, month: 5, day: 1)

let dateComponents = calendar.dateComponents([.year, .month, .day], from: startComponents, to: endComponents)
print(dateComponents) // prints: year: 4 month: 5 day: 9 isLeapMonth: false

№ 2. Использование метода dateComponents(_:from:to:) Calendar

Calendar имеет метод с именем dateComponents(_:from:to:). dateComponents(_:from:to:) имеет следующее объявление:

func dateComponents(_ components: Set<Calendar.Component>, from start: Date, to end: Date) -> DateComponents

Возвращает разницу между двумя датами.

Пример Playground ниже показывает, как использовать dateComponents(_:from:to:) для вычисления разницы между двумя датами:

import Foundation

let calendar = Calendar.current
let startDate = calendar.date(from: DateComponents(year: 2010, month: 11, day: 22))!
let endDate = calendar.date(from: DateComponents(year: 2015, month: 5, day: 1))!

let dateComponents = calendar.dateComponents([.year, .month, .day], from: startDate, to: endDate)
print(dateComponents) // prints: year: 4 month: 5 day: 9 isLeapMonth: false

№3. Использование метода string(from:to:) DateComponentsFormatter

DateComponentsFormatter имеет метод с именем string(from:to:). string(from:to:) имеет следующее объявление:

func string(from startDate: Date, to endDate: Date) -> String?

Возвращает отформатированную строку на основе разницы во времени между двумя датами.

Пример Playground ниже показывает, как использовать string(from:to:) для вычисления разницы между двумя датами:

import Foundation

let calendar = Calendar.current
let startDate = calendar.date(from: DateComponents(year: 2010, month: 11, day: 22))!
let endDate = calendar.date(from: DateComponents(year: 2015, month: 5, day: 1))!

let formatter = DateComponentsFormatter()
formatter.unitsStyle = .full
formatter.allowedUnits = [.year, .month, .day]
let string = formatter.string(from: startDate, to: endDate)!
print(string) // prints: 4 years, 5 months, 9 days

Попробуй это

func calculateDiffInTwoDate (date1: NSDate, date2: NSDate) -> NSInteger {

        //var userAge : NSInteger = 0
        let calendar : NSCalendar = NSCalendar.currentCalendar()
        let unitFlags : NSCalendarUnit = [ .Year , .Month, .Day]
        let dateComponentNow : NSDateComponents = calendar.components(unitFlags, fromDate: date2)
        let dateComponentBirth : NSDateComponents = calendar.components(unitFlags, fromDate: date1)

        if ( (dateComponentNow.month < dateComponentBirth.month) ||
            ((dateComponentNow.month == dateComponentBirth.month) && (dateComponentNow.day < dateComponentBirth.day))
            )
        {
            return dateComponentNow.year - dateComponentBirth.year - 1
        }
        else {
            return dateComponentNow.year - dateComponentBirth.year
        }
    }

По этому вы можете получить разницу между двумя датами в годах

Почему бы вам не использовать встроенный метод, чтобы найти разницу между двумя датами в секундах, а затем написать метод для преобразования секунд в годы, месяцы и дни.

let diff = date1.timeIntervalSinceDate(date2)