這里的教程為Swift官方教程中文版。

方法(Methods)


1.0 翻譯:pp-prog 校對:zqp

2.0 翻譯+校對:DianQK

2.1 翻譯:DianQKRealank 校對:shanks,2016-01-18

2.2 校對:SketchK 2016-05-13 3.0.1,shanks,2016-11-13

本頁包含內(nèi)容:

方法是與某些特定類型相關(guān)聯(lián)的函數(shù)。類、結(jié)構(gòu)體、枚舉都可以定義實例方法;實例方法為給定類型的實例封裝了具體的任務(wù)與功能。類、結(jié)構(gòu)體、枚舉也可以定義類型方法;類型方法與類型本身相關(guān)聯(lián)。類型方法與 Objective-C 中的類方法(class methods)相似。

結(jié)構(gòu)體和枚舉能夠定義方法是 Swift 與 C/Objective-C 的主要區(qū)別之一。在 Objective-C 中,類是唯一能定義方法的類型。但在 Swift 中,你不僅能選擇是否要定義一個類/結(jié)構(gòu)體/枚舉,還能靈活地在你創(chuàng)建的類型(類/結(jié)構(gòu)體/枚舉)上定義方法。

實例方法 (Instance Methods)

實例方法是屬于某個特定類、結(jié)構(gòu)體或者枚舉類型實例的方法。實例方法提供訪問和修改實例屬性的方法或提供與實例目的相關(guān)的功能,并以此來支撐實例的功能。實例方法的語法與函數(shù)完全一致,詳情參見函數(shù)。

實例方法要寫在它所屬的類型的前后大括號之間。實例方法能夠隱式訪問它所屬類型的所有的其他實例方法和屬性。實例方法只能被它所屬的類的某個特定實例調(diào)用。實例方法不能脫離于現(xiàn)存的實例而被調(diào)用。

下面的例子,定義一個很簡單的Counter類,Counter能被用來對一個動作發(fā)生的次數(shù)進行計數(shù):

class Counter {
    var count = 0
    func increment() {
        count += 1
    }
    func increment(by amount: Int) {
        count += amount
    }
    func reset() {
        count = 0
    }
}

Counter類定義了三個實例方法:

  • increment讓計數(shù)器按一遞增;
  • increment(by: Int)讓計數(shù)器按一個指定的整數(shù)值遞增;
  • reset將計數(shù)器重置為0。

Counter這個類還聲明了一個可變屬性count,用它來保持對當前計數(shù)器值的追蹤。

和調(diào)用屬性一樣,用點語法(dot syntax)調(diào)用實例方法:

let counter = Counter()
// 初始計數(shù)值是0
counter.increment()
// 計數(shù)值現(xiàn)在是1
counter.increment(by: 5)
// 計數(shù)值現(xiàn)在是6
counter.reset()
// 計數(shù)值現(xiàn)在是0

函數(shù)參數(shù)可以同時有一個局部名稱(在函數(shù)體內(nèi)部使用)和一個外部名稱(在調(diào)用函數(shù)時使用),詳情參見指定外部參數(shù)名。方法參數(shù)也一樣,因為方法就是函數(shù),只是這個函數(shù)與某個類型相關(guān)聯(lián)了。

self 屬性

類型的每一個實例都有一個隱含屬性叫做self,self完全等同于該實例本身。你可以在一個實例的實例方法中使用這個隱含的self屬性來引用當前實例。

上面例子中的increment方法還可以這樣寫:

func increment() {
    self.count += 1
}

實際上,你不必在你的代碼里面經(jīng)常寫self。不論何時,只要在一個方法中使用一個已知的屬性或者方法名稱,如果你沒有明確地寫self,Swift 假定你是指當前實例的屬性或者方法。這種假定在上面的Counter中已經(jīng)示范了:Counter中的三個實例方法中都使用的是count(而不是self.count)。

使用這條規(guī)則的主要場景是實例方法的某個參數(shù)名稱與實例的某個屬性名稱相同的時候。在這種情況下,參數(shù)名稱享有優(yōu)先權(quán),并且在引用屬性時必須使用一種更嚴格的方式。這時你可以使用self屬性來區(qū)分參數(shù)名稱和屬性名稱。

下面的例子中,self消除方法參數(shù)x和實例屬性x之間的歧義:

struct Point {
    var x = 0.0, y = 0.0
    func isToTheRightOfX(x: Double) -> Bool {
        return self.x > x
    }
}
let somePoint = Point(x: 4.0, y: 5.0)
if somePoint.isToTheRightOfX(1.0) {
    print("This point is to the right of the line where x == 1.0")
}
// 打印 "This point is to the right of the line where x == 1.0"

如果不使用self前綴,Swift 就認為兩次使用的x都指的是名稱為x的函數(shù)參數(shù)。

在實例方法中修改值類型

結(jié)構(gòu)體和枚舉是值類型。默認情況下,值類型的屬性不能在它的實例方法中被修改。

但是,如果你確實需要在某個特定的方法中修改結(jié)構(gòu)體或者枚舉的屬性,你可以為這個方法選擇可變(mutating)行為,然后就可以從其方法內(nèi)部改變它的屬性;并且這個方法做的任何改變都會在方法執(zhí)行結(jié)束時寫回到原始結(jié)構(gòu)中。方法還可以給它隱含的self屬性賦予一個全新的實例,這個新實例在方法結(jié)束時會替換現(xiàn)存實例。

要使用可變方法,將關(guān)鍵字mutating 放到方法的func關(guān)鍵字之前就可以了:

struct Point {
    var x = 0.0, y = 0.0
    mutating func moveByX(deltaX: Double, y deltaY: Double) {
        x += deltaX
        y += deltaY
    }
}
var somePoint = Point(x: 1.0, y: 1.0)
somePoint.moveByX(2.0, y: 3.0)
print("The point is now at (\(somePoint.x), \(somePoint.y))")
// 打印 "The point is now at (3.0, 4.0)"

上面的Point結(jié)構(gòu)體定義了一個可變方法 moveByX(_:y:) 來移動Point實例到給定的位置。該方法被調(diào)用時修改了這個點,而不是返回一個新的點。方法定義時加上了mutating關(guān)鍵字,從而允許修改屬性。

注意,不能在結(jié)構(gòu)體類型的常量(a constant of structure type)上調(diào)用可變方法,因為其屬性不能被改變,即使屬性是變量屬性,詳情參見常量結(jié)構(gòu)體的存儲屬性

let fixedPoint = Point(x: 3.0, y: 3.0)
fixedPoint.moveByX(2.0, y: 3.0)
// 這里將會報告一個錯誤

在可變方法中給 self 賦值

可變方法能夠賦給隱含屬性self一個全新的實例。上面Point的例子可以用下面的方式改寫:

struct Point {
    var x = 0.0, y = 0.0
    mutating func moveBy(x deltaX: Double, y deltaY: Double) {
        self = Point(x: x + deltaX, y: y + deltaY)
    }
}

新版的可變方法moveBy(x:y:)創(chuàng)建了一個新的結(jié)構(gòu)體實例,它的 x 和 y 的值都被設(shè)定為目標值。調(diào)用這個版本的方法和調(diào)用上個版本的最終結(jié)果是一樣的。

枚舉的可變方法可以把self設(shè)置為同一枚舉類型中不同的成員:

enum TriStateSwitch {
    case Off, Low, High
    mutating func next() {
        switch self {
        case .Off:
            self = .Low
        case .Low:
            self = .High
        case .High:
            self = .Off
        }
    }
}
var ovenLight = TriStateSwitch.Low
ovenLight.next()
// ovenLight 現(xiàn)在等于 .High
ovenLight.next()
// ovenLight 現(xiàn)在等于 .Off

上面的例子中定義了一個三態(tài)開關(guān)的枚舉。每次調(diào)用next()方法時,開關(guān)在不同的電源狀態(tài)(Off,LowHigh)之間循環(huán)切換。

類型方法

實例方法是被某個類型的實例調(diào)用的方法。你也可以定義在類型本身上調(diào)用的方法,這種方法就叫做類型方法。在方法的func關(guān)鍵字之前加上關(guān)鍵字static,來指定類型方法。類還可以用關(guān)鍵字class來允許子類重寫父類的方法實現(xiàn)。

注意
在 Objective-C 中,你只能為 Objective-C 的類類型(classes)定義類型方法(type-level methods)。在 Swift 中,你可以為所有的類、結(jié)構(gòu)體和枚舉定義類型方法。每一個類型方法都被它所支持的類型顯式包含。

類型方法和實例方法一樣用點語法調(diào)用。但是,你是在類型上調(diào)用這個方法,而不是在實例上調(diào)用。下面是如何在SomeClass類上調(diào)用類型方法的例子:

class SomeClass {
    class func someTypeMethod() {
        // 在這里實現(xiàn)類型方法
    }
}
SomeClass.someTypeMethod()

在類型方法的方法體(body)中,self指向這個類型本身,而不是類型的某個實例。這意味著你可以用self來消除類型屬性和類型方法參數(shù)之間的歧義(類似于我們在前面處理實例屬性和實例方法參數(shù)時做的那樣)。

一般來說,在類型方法的方法體中,任何未限定的方法和屬性名稱,可以被本類中其他的類型方法和類型屬性引用。一個類型方法可以直接通過類型方法的名稱調(diào)用本類中的其它類型方法,而無需在方法名稱前面加上類型名稱。類似地,在結(jié)構(gòu)體和枚舉中,也能夠直接通過類型屬性的名稱訪問本類中的類型屬性,而不需要前面加上類型名稱。

下面的例子定義了一個名為LevelTracker結(jié)構(gòu)體。它監(jiān)測玩家的游戲發(fā)展情況(游戲的不同層次或階段)。這是一個單人游戲,但也可以存儲多個玩家在同一設(shè)備上的游戲信息。

游戲初始時,所有的游戲等級(除了等級 1)都被鎖定。每次有玩家完成一個等級,這個等級就對這個設(shè)備上的所有玩家解鎖。LevelTracker結(jié)構(gòu)體用類型屬性和方法監(jiān)測游戲的哪個等級已經(jīng)被解鎖。它還監(jiān)測每個玩家的當前等級。

struct LevelTracker {
    static var highestUnlockedLevel = 1
    var currentLevel = 1

    static func unlock(_ level: Int) {
        if level > highestUnlockedLevel { highestUnlockedLevel = level }
    }

    static func isUnlocked(_ level: Int) -> Bool {
        return level <= highestUnlockedLevel
    }

    @discardableResult
    mutating func advance(to level: Int) -> Bool {
        if LevelTracker.isUnlocked(level) {
            currentLevel = level
            return true
        } else {
            return false
        }
    }
}

LevelTracker監(jiān)測玩家已解鎖的最高等級。這個值被存儲在類型屬性highestUnlockedLevel中。

LevelTracker還定義了兩個類型方法與highestUnlockedLevel配合工作。第一個類型方法是unlock(_:),一旦新等級被解鎖,它會更新highestUnlockedLevel的值。第二個類型方法是isUnlocked(_:),如果某個給定的等級已經(jīng)被解鎖,它將返回true。(注意,盡管我們沒有使用類似LevelTracker.highestUnlockedLevel的寫法,這個類型方法還是能夠訪問類型屬性highestUnlockedLevel

除了類型屬性和類型方法,LevelTracker還監(jiān)測每個玩家的進度。它用實例屬性currentLevel來監(jiān)測每個玩家當前的等級。

為了便于管理currentLevel屬性,LevelTracker定義了實例方法advance(to:)。這個方法會在更新currentLevel之前檢查所請求的新等級是否已經(jīng)解鎖。advance(to:)方法返回布爾值以指示是否能夠設(shè)置currentLevel。因為允許在調(diào)用advance(to:)時候忽略返回值,不會產(chǎn)生編譯警告,所以函數(shù)被標注為@ discardableResult屬性,更多關(guān)于屬性信息,請參考屬性章節(jié)。

下面,Player類使用LevelTracker來監(jiān)測和更新每個玩家的發(fā)展進度:

class Player {
    var tracker = LevelTracker()
    let playerName: String
    func complete(level: Int) {
        LevelTracker.unlock(level + 1)
        tracker.advance(to: level + 1)
    }
    init(name: String) {
        playerName = name
    }
}

Player類創(chuàng)建一個新的LevelTracker實例來監(jiān)測這個用戶的進度。它提供了complete(level:)方法,一旦玩家完成某個指定等級就調(diào)用它。這個方法為所有玩家解鎖下一等級,并且將當前玩家的進度更新為下一等級。(我們忽略了advance(to:)返回的布爾值,因為之前調(diào)用LevelTracker.unlock(_:)時就知道了這個等級已經(jīng)被解鎖了)。

你還可以為一個新的玩家創(chuàng)建一個Player的實例,然后看這個玩家完成等級一時發(fā)生了什么:

var player = Player(name: "Argyrios")
player.complete(level: 1)
print("highest unlocked level is now \(LevelTracker.highestUnlockedLevel)")
// 打印 "highest unlocked level is now 2"

如果你創(chuàng)建了第二個玩家,并嘗試讓他開始一個沒有被任何玩家解鎖的等級,那么試圖設(shè)置玩家當前等級將會失?。?/p>

player = Player(name: "Beto")
if player.tracker.advance(to: 6) {
    print("player is now on level 6")
} else {
    print("level 6 has not yet been unlocked")
}
// 打印 "level 6 has not yet been unlocked"
? 屬性 下標 ?
?