阅读 UIColor-Hex-Swift 源码

由于种种原因，等第三方平台博客不再保证能够同步更新，欢迎移步 GitHub：https://github.com/kingcos/Perspective/。谢谢！

Read the mind behind the code.

• Info:
• Swift 3.0
• Xcode 8.2.1
• UIColor Hex Swift 3.0.2

前言

yeahdongcn/UIColor-Hex-Swift

yeahdongcn/UIColor-Hex-Swift 是一个使用 Swift 3.0 编写并开源在 GitHub 上的 iOS 第三方库。核心为不到 200 行代码，即可以使用 RGBA 十六进制数／字符串创建颜色（UIColor）。其支持通过 CocoaPods 管理，目前在 GitHub 上已经拥有 683 Stars，说明该库已经帮助了不少开发者使用在了项目中。而我作为一个新手，就来仔细阅读一下该库的源码，看看是否有值得借鉴的地方。

错误处理

利用枚举，通过遵守 Error 协议，来定义统一的错误处理。Swift 中的 Error 协议也有说明，通过遵守该协议即可使错误在 Swift 的错误处理系统中保持一致性。

public enum UIColorInputError : Error {
    case missingHashMarkAsPrefix,
    unableToScanHexValue,
    mismatchedHexStringLength
}

扩展

Swift 中的扩展（extension）能够很方便地扩充而不破坏原有的类。特别是在官方提供的类上，使用 extension 可以很容易的加上我们的自定义方法以及计算属性（扩展不支持存储属性）。

extension UIColor {
}

便利构造器

便利构造器（Convenience initializers）与指定构造器（Designated initializers）不同。便利构造器是次要的，即不是必需的。也可以在便利构造器的内部调用指定构造器。

public convenience init(hex3: UInt16, alpha: CGFloat = 1) {
    let divisor = CGFloat(15)
    let red     = CGFloat((hex3 & 0xF00) >> 8) / divisor
    let green   = CGFloat((hex3 & 0x0F0) >> 4) / divisor
    let blue    = CGFloat( hex3 & 0x00F      ) / divisor
    self.init(red: red, green: green, blue: blue, alpha: alpha)
}

注释

一般的单行注释和多行注释都已为人所知。但如何与官方注释保持一致性和规范性，我个人却在之前没有了解到。在 Xcode 8 支持了 markdown 语法后，有人已经开始通过 Playground 制作很多带样式的代码教程。结合 Xcode 自带的规范，可以达到和官方保持一致的效果。关于具体的标记样式可以查看文末的参考。

带样式的 Xcode 注释

     /**
     The shorthand three-digit hexadecimal representation of color.
     #RGB defines to the color #RRGGBB.
     
     - parameter hex3: Three-digit hexadecimal value.
     - parameter alpha: 0.0 - 1.0. The default is 1.0.
     */
    public convenience init(hex3: UInt16, alpha: CGFloat = 1) {
        let divisor = CGFloat(15)
        let red     = CGFloat((hex3 & 0xF00) >> 8) / divisor
        let green   = CGFloat((hex3 & 0x0F0) >> 4) / divisor
        let blue    = CGFloat( hex3 & 0x00F      ) / divisor
        self.init(red: red, green: green, blue: blue, alpha: alpha)
    }

Travis CI

Travis CI，是一个专门为开源项目打造的持续集成环境。最为显著的标示就是在很多 GitHub 等开源的项目 README 中，有很多简介项目的标签。我也正准备将自己的项目建立 Travis CI。

Travis CI 标签

十六进制转 RGB

以六位十六进制转换 RGB 为例。& 是按位与运算符。>> 是右移运算符。通过 (hex6 & 0xFF0000) >> 16，(hex6 & 0x00FF00) >> 8，hex6 & 0x0000FF，分别把 RR、GG、BB 位上的数字提取。由于 RGB 最大值为 255.0，iOS 中 UIColor 的初始化方法必须按与 255.0 的比例作为参数，因此比上除数 255.0。

/**
     The six-digit hexadecimal representation of color of the form #RRGGBB.
     
     - parameter hex6: Six-digit hexadecimal value.
     */
    public convenience init(hex6: UInt32, alpha: CGFloat = 1) {
        let divisor = CGFloat(255)
        let red     = CGFloat((hex6 & 0xFF0000) >> 16) / divisor
        let green   = CGFloat((hex6 & 0x00FF00) >>  8) / divisor
        let blue    = CGFloat( hex6 & 0x0000FF       ) / divisor
        self.init(red: red, green: green, blue: blue, alpha: alpha)
    }

参考资料

Error Handling
Extensions
Initialization
Markup Formatting Reference