对Swift协议RawRepresentable的理解

前言

对于枚举原始值，系统默认只能是字符串、整型、浮点型字面量，那么我们能不能增加其它类型呢？

答案是可以的，通过协议RawRepresentable就可以实现

正文

首先定义一个枚举

enum Terrain: String {
    case forest = "F"
    case mountain = "M"
    case water = "W"
}

1、RawRepresentable协议

该协议定义了一个初始化构造器，当传入无效的原始值时构造器会返回nil；还定义了一个rawValue计算属性。

当定义上述枚举时，编译器将生成如下等价的代码：

enum Terrain {
    case forest
    case mountain
    case water
}

extension Terrain: RawRepresentable {
    typealias RawValue = String

    init?(rawValue: RawValue) {
        switch rawValue {
        case "F": self = .forest
        case "M": self = .mountain
        case "W": self = .water
        default: return nil
        }
    }

    var rawValue: RawValue {
        switch self {
        case .forest: return "F"
        case .mountain: return "M"
        case .water: return "W"
        }
    }
}

2、rawValue本质

rawValue本质是一个计算属性

enum Terrain: String {
    case forest = "F"
    case mountain = "M"
    case water = "W"
}
let tt = Terrain.forest
print(tt.rawValue)

0x104e32fe2 <+130>: movq   %rdx, -0x50(%rbp)
0x104e32fe6 <+134>: callq  0x104e330b0               ; Test.Terrain.rawValue.getter : Swift.String at <compiler-generated>
0x104e32feb <+139>: movq   0x6056(%rip), %rsi        ; (void *)0x00007fff879c41c8: type metadata for Swift.String

通过断点调试汇编可以看到，底层call调用了rawValue的getter方法

而对rawValue进行赋值则会报错

let tt = Terrain.forest
tt.rawValue = "M" //Cannot assign to property: 'rawValue' is immutable

3、原始值不会改变枚举的内存

1、原始值是不会存储到枚举变量中去的，并且只占用一个字节（严格的说当枚举成员个数小于256）

方法（1）通过函数MemoryLayout可以验证

MemoryLayout.size(ofValue: Terrain.forest) // → 1个字节
MemoryLayout.size(ofValue: "F") // → 16个字节

方法（2）通过xcode调试View Memory可以查看枚举变量在内存中具体存放的内容（已有不少文章介绍，就不细说了）

4、增加原始值类型

RawRepresentable的RawValue关联类型可以是任何类型，前提是字面量，即它们在编译时必须是静态已知的。

并且实际原始值可以在运行时动态创建。举一个用于颜色的枚举示例：

import UIKit

// 默认这里不能直接用UIColor作为原始值
enum Color {
    case red
    case green
    case blue
}

// 通过遵守协议RawRepresentable可以把UIColor作为原始值
extension Color: RawRepresentable {
    typealias RawValue = UIColor

    init?(rawValue: RawValue) {
        switch rawValue {
        case UIColor.red: self = .red
        case UIColor.green: self = .green
        case UIColor.blue: self = .blue
        default: return nil
        }
    }

    var rawValue: RawValue {
        switch self {
        case .red: return UIColor.red
        case .green: return UIColor.green
        case .blue: return UIColor.blue
        }
    }
}

// 可以使用UIColor
Color.blue.rawValue is UIColor

最后

1、RawRepresentable协议不仅仅用在枚举上，还有Swift中的选项集合OptionSet（该协议继承自RawRepresentable），应用于位掩码操作

2、原始值和关联值是不同的；原始值是在定义枚举时被预先填充的值，像上述三个字符串。对于一个特定的枚举成员，它的原始值始终不变。关联值是创建一个基于枚举成员的常量或变量时才设置的值，枚举成员的关联值可以变化。底层以及应用它们的区别还有很多，这里就不细说了。

参考：https://oleb.net/blog/2016/11/rawrepresentable/