SnapKit 源碼解讀（二）：DSLs

與 Masonry 不同，SnapKit 充分利用了 Swift 的語(yǔ)言特性，用更優(yōu)雅的方式實(shí)現(xiàn)了一套 DSL。而這一切的開(kāi)始，源于 ConstraintDSL。

ConstraintDSL

ConstraintDSL 是一個(gè)協(xié)議：

public protocol ConstraintDSL {
    
    var target: AnyObject? { get }
    
    func setLabel(_ value: String?)
    func label() -> String?
    
}

public

public 的作用是，即使兩部分代碼處于兩個(gè)不同的 module，也能使用這個(gè)協(xié)議。在尋常的項(xiàng)目中，默認(rèn)的權(quán)限級(jí)別是 internal，即在同一個(gè) module 內(nèi)可以使用。如果是寫(xiě)三方庫(kù)，則要用 public 來(lái)標(biāo)記提供給外界的 API 了。

協(xié)議擴(kuò)展

與 Objective-C 中的協(xié)議不同，Swift 中的協(xié)議可以通過(guò)擴(kuò)展為協(xié)議添加默認(rèn)的實(shí)現(xiàn)，如下所示，為 setLabel ,label 協(xié)議方法提供了默認(rèn)的實(shí)現(xiàn)：

extension ConstraintDSL {
    
    public func setLabel(_ value: String?) {
        objc_setAssociatedObject(self.target as Any, &labelKey, value, .OBJC_ASSOCIATION_COPY_NONATOMIC)
    }
    public func label() -> String? {
        return objc_getAssociatedObject(self.target as Any, &labelKey) as? String
    }
    
}

關(guān)聯(lián)對(duì)象

提供給 ConstraintDSL 協(xié)議的默認(rèn)實(shí)現(xiàn)其實(shí)是實(shí)現(xiàn)了關(guān)聯(lián)對(duì)象的效果，關(guān)聯(lián)對(duì)象是通過(guò)擴(kuò)展實(shí)現(xiàn)屬性的一種方式，set 方法使用的 API 為：

@available(iOS 3.1, *)
public func objc_setAssociatedObject(_ object: Any, _ key: UnsafeRawPointer, _ value: Any?, _ policy: objc_AssociationPolicy)

object 參數(shù)表示關(guān)聯(lián)的源對(duì)象，在這里是 self.target as Any，因?yàn)?Swift 是一門(mén)強(qiáng)類(lèi)型的語(yǔ)言，所以需要做一個(gè)類(lèi)型轉(zhuǎn)換。

key 參數(shù)表示關(guān)聯(lián)對(duì)象的鍵，SnapKit 是聲明了一個(gè) private var labelKey: UInt8 = 0 來(lái)作為 key，使用的時(shí)候需要配合 & 操作符一起使用。

value 參數(shù)表示與對(duì)象的關(guān)鍵鍵關(guān)聯(lián)的值。

policy 參數(shù)表示關(guān)聯(lián)的策略，是一個(gè)枚舉，取值如下：

public enum objc_AssociationPolicy : UInt {

    
    /**< Specifies a weak reference to the associated object. */
    case OBJC_ASSOCIATION_ASSIGN

    /**< Specifies a strong reference to the associated object. 
     *   The association is not made atomically. */
    case OBJC_ASSOCIATION_RETAIN_NONATOMIC

    
    /**< Specifies that the associated object is copied. 
     *   The association is not made atomically. */
    case OBJC_ASSOCIATION_COPY_NONATOMIC

    
    /**< Specifies a strong reference to the associated object.
     *   The association is made atomically. */
    case OBJC_ASSOCIATION_RETAIN

    
    /**< Specifies that the associated object is copied.
     *   The association is made atomically. */
    case OBJC_ASSOCIATION_COPY
}

與 Objective-C 屬性的對(duì)應(yīng)關(guān)系是一致的，在此不再贅述。

關(guān)聯(lián)引用的 get 的 API 如下：

@available(iOS 3.1, *)
public func objc_getAssociatedObject(_ object: Any, _ key: UnsafeRawPointer) -> Any?

所需的兩個(gè)參數(shù)與 set 中的一致。

ConstraintBasicAttributesDSL

ConstraintBasicAttributesDSL 是一個(gè)繼承于 ConstraintDSL 的協(xié)議，如下所示：

public protocol ConstraintBasicAttributesDSL : ConstraintDSL {
}

進(jìn)而又通過(guò)擴(kuò)展為其添加了一些計(jì)算屬性，會(huì)返回對(duì)象和其相關(guān)的布局屬性的模型對(duì)象，屬于 ConstraintItem 類(lèi)型，如下所示：

extension ConstraintBasicAttributesDSL {
    
    // MARK: Basics
    
    public var left: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.left)
    }
    
    public var top: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.top)
    }
    
    public var right: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.right)
    }
    
    public var bottom: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.bottom)
    }
    
    public var leading: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.leading)
    }
    
    public var trailing: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.trailing)
    }
    
    public var width: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.width)
    }
    
    public var height: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.height)
    }
    
    public var centerX: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.centerX)
    }
    
    public var centerY: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.centerY)
    }
    
    public var edges: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.edges)
    }
    
    public var size: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.size)
    }
    
    public var center: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.center)
    }
    
}

ConstraintAttributesDSL

ConstraintAttributesDSL 是一個(gè)繼承于 ConstraintBasicAttributesDSL 的協(xié)議，如下所示：

public protocol ConstraintAttributesDSL : ConstraintBasicAttributesDSL {
}

進(jìn)而又通過(guò)擴(kuò)展為其添加了一些計(jì)算屬性，會(huì)返回對(duì)象和其相關(guān)的布局屬性（baseline 和 margin 相關(guān)）的模型對(duì)象，屬于 ConstraintItem 類(lèi)型，如下所示：

extension ConstraintAttributesDSL {
    
    // MARK: Baselines
    
    @available(*, deprecated:3.0, message:"Use .lastBaseline instead")
    public var baseline: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.lastBaseline)
    }
    
    @available(iOS 8.0, OSX 10.11, *)
    public var lastBaseline: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.lastBaseline)
    }
    
    @available(iOS 8.0, OSX 10.11, *)
    public var firstBaseline: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.firstBaseline)
    }
    
    // MARK: Margins
    
    @available(iOS 8.0, *)
    public var leftMargin: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.leftMargin)
    }
    
    @available(iOS 8.0, *)
    public var topMargin: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.topMargin)
    }
    
    @available(iOS 8.0, *)
    public var rightMargin: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.rightMargin)
    }
    
    @available(iOS 8.0, *)
    public var bottomMargin: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.bottomMargin)
    }
    
    @available(iOS 8.0, *)
    public var leadingMargin: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.leadingMargin)
    }
    
    @available(iOS 8.0, *)
    public var trailingMargin: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.trailingMargin)
    }
    
    @available(iOS 8.0, *)
    public var centerXWithinMargins: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.centerXWithinMargins)
    }
    
    @available(iOS 8.0, *)
    public var centerYWithinMargins: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.centerYWithinMargins)
    }
    
    @available(iOS 8.0, *)
    public var margins: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.margins)
    }
    
    @available(iOS 8.0, *)
    public var centerWithinMargins: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.centerWithinMargins)
    }
    
}

ConstraintViewDSL

ConstraintViewDSL 是一個(gè)遵守了 ConstraintAttributesDSL 協(xié)議的結(jié)構(gòu)體，定義如下：

public struct ConstraintViewDSL: ConstraintAttributesDSL {
    
    ...
    
}

ConstraintViewDSL 初始化方法只需要一個(gè)參數(shù)，配合內(nèi)部的一個(gè)屬性 view 存儲(chǔ)需要布局的視圖：

internal let view: ConstraintView
    
internal init(view: ConstraintView) {
    self.view = view
        
}

ConstraintViewDSL 真正需要自己實(shí)現(xiàn)的代理中的屬性只有一個(gè)，就是 target，這是一個(gè)用來(lái)返回布局對(duì)應(yīng)的視圖的計(jì)算屬性，相關(guān)實(shí)現(xiàn)如下：

public var target: AnyObject? {
    return self.view
}

ConstraintViewDSL 聲明了一些關(guān)鍵方法，內(nèi)部都是通過(guò)調(diào)用 ConstraintMaker 類(lèi)的相關(guān)方法實(shí)現(xiàn)的：

@discardableResult
public func prepareConstraints(_ closure: (_ make: ConstraintMaker) -> Void) -> [Constraint] {
    return ConstraintMaker.prepareConstraints(item: self.view, closure: closure)
}
    
public func makeConstraints(_ closure: (_ make: ConstraintMaker) -> Void) {
    ConstraintMaker.makeConstraints(item: self.view, closure: closure)
}
    
public func remakeConstraints(_ closure: (_ make: ConstraintMaker) -> Void) {
    ConstraintMaker.remakeConstraints(item: self.view, closure: closure)
}
    
public func updateConstraints(_ closure: (_ make: ConstraintMaker) -> Void) {
    ConstraintMaker.updateConstraints(item: self.view, closure: closure)
}
    
public func removeConstraints() {
    ConstraintMaker.removeConstraints(item: self.view)
}

@discardableResult

有的時(shí)候，方法有一個(gè)返回值，但我們經(jīng)常性的會(huì)忽視這個(gè)返回值，這時(shí)可以在方法前加上 @discardableResult 標(biāo)記，可以在這種情況下不出現(xiàn)警告。

最后，聲明了一些計(jì)算屬性，作為一些設(shè)置 view 相關(guān)屬性的 shortcut：

public var contentHuggingHorizontalPriority: Float {
    get {
        return self.view.contentHuggingPriority(for: .horizontal).rawValue
    }
    set {
        self.view.setContentHuggingPriority(LayoutPriority(rawValue: newValue), for: .horizontal)
    }
}
    
public var contentHuggingVerticalPriority: Float {
    get {
        return self.view.contentHuggingPriority(for: .vertical).rawValue
    }
    set {
        self.view.setContentHuggingPriority(LayoutPriority(rawValue: newValue), for: .vertical)
    }
}
    
public var contentCompressionResistanceHorizontalPriority: Float {
    get {
        return self.view.contentCompressionResistancePriority(for: .horizontal).rawValue
    }
    set {
        self.view.setContentCompressionResistancePriority(LayoutPriority(rawValue: newValue), for: .horizontal)
    }
}
    
public var contentCompressionResistanceVerticalPriority: Float {
    get {
        return self.view.contentCompressionResistancePriority(for: .vertical).rawValue
    }
    set {
        self.view.setContentCompressionResistancePriority(LayoutPriority(rawValue: newValue), for: .vertical)
    }
}

ConstraintLayoutGuideDSL

ConstraintLayoutGuideDSL 是一個(gè)遵守了 ConstraintAttributesDSL 協(xié)議的結(jié)構(gòu)體，作用是替 UILayoutGuide 提供了一些 DSLs，與 ConstraintViewDSL 唯一的區(qū)別在于，target 屬性返回的對(duì)象不同：

public struct ConstraintLayoutGuideDSL: ConstraintAttributesDSL {
    
    ...
    
    public var target: AnyObject? {
        return self.guide
    }
    
    internal let guide: ConstraintLayoutGuide
    
    internal init(guide: ConstraintLayoutGuide) {
        self.guide = guide
        
    }
    
}

ConstraintLayoutSupportDSL

ConstraintLayoutSupportDSL 是一個(gè)遵守了 ConstraintDSL 協(xié)議的結(jié)構(gòu)體，作用是替 ConstraintLayoutSupport 提供了一些 DSLs：

@available(iOS 8.0, *)
public struct ConstraintLayoutSupportDSL: ConstraintDSL {
    
    public var target: AnyObject? {
        return self.support
    }
    
    internal let support: ConstraintLayoutSupport
    
    internal init(support: ConstraintLayoutSupport) {
        self.support = support
        
    }
    
    public var top: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.top)
    }
    
    public var bottom: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.bottom)
    }
    
    public var height: ConstraintItem {
        return ConstraintItem(target: self.target, attributes: ConstraintAttributes.height)
    }
}

原文地址：SnapKit 源碼解讀（二）：DSLs

如果覺(jué)得我寫(xiě)的還不錯(cuò)，請(qǐng)關(guān)注我的微博@小橘爺，最新文章即時(shí)推送~

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容