初探 Swift 中的 KVC
Key-Value Coding
- Info:
- macOS 10.12.1 Beta 4
- Xcode 8.1 Beta 3
- Swift 3
前言
这两天（2016-10-27），苹果一言不合更新了官网的文档，有些文档上次的更新日期甚至为 2012 年，说明这次的更新十分重要且稳定，并且将 Swift 版本更新到 3.0.1，本文中的一些写法虽仍能运行，但已经过时，并非最佳实践，为此以及一些本文未涉及的内容，可以参照另一文——初探 Swift 中的 KVC 之补充。
Key-Value Coding 中文译为「键值编码」，简称 KVC。是 iOS 开发中极其重要且基础的概念。苹果官网对于 KVC 有详细的编程指南，但均是基于 Objective-C 语言。Swift 也继承了该特性，KVC 常用于从网络获取请求进行处理，这次只是简单探究下 Swift 中的 KVC。
在 Swift 中想要兼容 KVC，需要该类继承 NSObject。下面是 KVC 中常用的几个方法：
- 根据传入的
key，设置value：
func setValue(_ value: Any?, forKey key: String)
- 根据传入的
keyPath，设置value，keyPath即键路径可利用.遍历至键：
func setValue(_ value: Any?, forKeyPath keyPath: String)
- 根据传入的字典，设值，如果字典中有对象不存在的属性，则会抛出异常：
func setValuesForKeys(_ keyedValues: [String : Any])
- 当为不存在的某个键设值时，默认调用该方法抛出
NSUndefinedKeyException异常，子类可重写该方法：
func setValue(_ value: Any?, forUndefinedKey key: String)
- 设置特定键的值为
nil时，默认调用该方法抛出NSInvalidArgumentException，子类可重写该方法（注：官方称该方法针对标量值（scalar value），例如整型和浮点型）对于其他类型没有提到，在 Demo 中有详细的列出是否支持）：
func setNilValueForKey(_ key: String)
- 返回传入指定键的对应值：
func value(forKey key: String) -> Any?
- 返回传入指定键路径的对应值：
func value(forKeyPath keyPath: String) -> Any?
- 返回传入未定义的键路径的对应值：
func value(forUndefinedKey key: String) -> Any?
Demo
KVC 兼容的类，需要继承自 NSObject。在学习 KVC 的过程中，发现并不是所有的数据类型都支持通过 KVC 设值。KVC 设值的方便之处在于可以动态的设值，即使封装在内部的细节也可以设值，而且可以自动将类型转换（注意：有些类型是不可行的）。这种特性使得从网络获取的数据可以轻松设置到模型中。以下的 Demo，选取了几个常用的 Swift 中的数据类型，测试一下是否支持 KVC 以及是否在设置 nil 值时调用 setNilValueForKey 方法。
DataType.swift
class DataType: NSObject {
var aInt: Int = 0
var bUInt: UInt = 0
var cFloat: Float = 0.0
var dDouble: Double = 0.0
var eBool: Bool = false
var fCharacter: Character = "f"
var gString: String = ""
var hArray: [Any] = [0]
var iDictionary: [String: Any] = ["0": 0]
var jTuple: (Int, Int) = (0, 0)
var kOptional: Int?
var lObject: Type = Type()
var mNSDictionary: NSDictionary = ["0": 0]
var nNSArray: NSArray = [0, "0"]
var oArrayAny: Array<Any> = [0, "0"]
override func setNilValueForKey(_ key: String) {
print("You set nil for \(key)")
}
}
class Type: NSObject {
var prop = 0
}
main.swift
let o = DataType()
Int
main.swift
o.setValue("1", forKeyPath: "aInt")
print("aInt: \(o.aInt)")
o.setValue(nil, forKeyPath: "aInt")
// aInt: 1
// You set nil for aInt
Int 支持 setValue 自动转换设值，且支持设值为 nil 时调用 setNilValueForKey 方法。
UInt
main.swift
// 不支持通过自动转换
// Error: -[Swift._NSContiguousString unsignedLongLongValue]: unrecognized selector sent to instance
// o.setValue("1", forKeyPath: "bUInt")
o.setValue(1, forKeyPath: "bUInt")
print(o.bUInt)
o.setValue(nil, forKeyPath: "bUInt")
// 1
// You set nil for bUInt
UInt 支持 setValue 设值，但不支持自动转换，且支持设值为 nil 时调用 setNilValueForKey 方法。
Float
main.swift
o.setValue("1", forKeyPath: "cFloat")
print(o.cFloat)
o.setValue(nil, forKeyPath: "cFloat")
// 1.0
// You set nil for cFloat
Float 支持 setValue 自动转换设值，且支持设值为 nil 时调用 setNilValueForKey 方法。
Double
main.swift
o.setValue("1", forKeyPath: "dDouble")
print(o.dDouble)
o.setValue(nil, forKeyPath: "dDouble")
// 1.0
// You set nil for dDouble
Double 支持 setValue 自动转换设值，且支持设值为 nil 时调用 setNilValueForKey 方法。
Bool
main.swift
// 不支持通过自动转换
// Error: -[Swift._NSContiguousString charValue]: unrecognized selector sent to instance
// o.setValue("true", forKeyPath: "eBool")
o.setValue(true, forKeyPath: "eBool")
print(o.eBool)
o.setValue(nil, forKeyPath: "eBool")
// true
// You set nil for eBool
Bool 支持 setValue 设值，但不支持自动转换，且支持设值为 nil 时调用 setNilValueForKey 方法。
Character
main.swift
// 不支持 setValue
// Error: [<DataType> setValue:forUndefinedKey:]: this class is not key value coding-compliant for the key fCharacter.
// let b: Character = "b"
// o.setValue(b, forKeyPath: "fCharacter")
// o.setValue(nil, forKeyPath: "fCharacter")
Character 不支持 setValue。
String
main.swift
o.setValue("gString", forKeyPath: "gString")
print(o.gString)
o.setValue(nil, forKeyPath: "gString")
print(o.gString)
// gString
//
String 支持 setValue 设值，设值为 nil 时不调用 setNilValueForKey 方法，但可以清空。
Array<Int>
main.swift
// 不支持自动转换
// Error: -[Swift._NSContiguousString count]: unrecognized selector sent to instance
// o.setValue("1", forKeyPath: "hArray")
o.setValue([1], forKeyPath: "hArray")
print(o.hArray)
o.setValue(nil, forKeyPath: "hArray")
print(o.hArray)
// [1]
// []
Array<Int> 支持 setValue 设值，但不支持自动转换，设值为 nil 时不调用 setNilValueForKey 方法，但可以清空。
Dictionary
main.swift
// 不支持自动转换
// Error: -[Swift._NSContiguousString count]: unrecognized selector sent to instance
// o.setValue("[\"2\": 2]", forKeyPath: "iDictionary")
o.setValue(["2": 2], forKeyPath: "iDictionary")
print(o.iDictionary)
o.setValue(nil, forKeyPath: "iDictionary")
print(o.iDictionary)
// ["2": 2]
// [:]
Dictionary 支持 setValue 设值，但不支持自动转换，设值为 nil 时不调用 setNilValueForKey 方法，但可以清空。
Tuple
main.swift
// 不支持 setValue
// Error: [<DataType> setValue:forUndefinedKey:]: this class is not key value coding-compliant for the key jTuple.
// let t = (1, 1)
// o.setValue(t, forKeyPath: "jTuple")
// o.setValue(nil, forKeyPath: "jTuple")
Tuple 不支持 setValue。
Optional
main.swift
// 不支持 setValue
// Error: [<DataType> setValue:forUndefinedKey:]: this class is not key value coding-compliant for the key kOptional.
// o.setValue(1, forKeyPath: "kOptional")
// o.setValue(nil, forKeyPath: "kOptional")
Optional 不支持 setValue。
自定义类
main.swift
o.setValue("1", forKeyPath: "lObject.prop")
print(o.lObject.prop)
// 不支持设值 nil
// Error: [<Type> setNilValueForKey]: could not set nil as the value for the key prop.
//o.setValue(nil, forKeyPath: "lObject.prop")
// 1
自定义类的对象的属性支持 setValue 自动转换设值，但不支持设值为 nil。
NSDictionary
main.swift
let nsDict: NSDictionary = ["1": 1]
o.setValue(nsDict, forKeyPath: "mNSDictionary")
print(o.mNSDictionary["1"])
let swiftDict = ["2": 2]
o.setValue(swiftDict, forKeyPath: "mNSDictionary")
print(o.mNSDictionary["2"])
o.setValue(nil, forKeyPath: "mNSDictionary")
print(o.mNSDictionary["2"])
// Optional(1)
// Optional(2)
// nil
NSDictionary 支持 setValue 设值（支持 Swift 中的 Dictionary 以及 NSDictionary），但不支持自动转换，设值为 nil 时不调用 setNilValueForKey 方法，但可以清空。
NSArray
main.swift
o.setValue("a", forKeyPath: "nNSArray")
print(o.nNSArray)
o.setValue(nil, forKeyPath: "nNSArray")
print(o.nNSArray == nil)
// a
// true
NSArray 支持 setValue 设值（NSArray 存储 Any 类型，因此不存在自动转换），设值为 nil 时不调用 setNilValueForKey 方法，但会设值为 nil。
后记
这次将 Swift 中的一些数据类型拿出来单独测试了 KVC，结果来看有部分类型对此支持并不完全，所以在往后从网络获取数据一定要进行相应的处理再 setValue。也最好重写 func setValue(_ value: Any?, forUndefinedKey key: String)，必要时重写 func setNilValueForKey(_ key: String)。Swift 是一门强类型语言，就要求程序员多加注意类型转换等其他问题，以减少或避免程序崩溃，带来不好的用户体验。
