开发中经常用到KVC(key-value-coding),比如常用的MJExtension
、模型字典互转工具等。今天简单写一下 KVC。
引用一下概念:
Key-Value-Coding, 即键值编码. 它是一种不通过存取方法, 而是通过属性名称字符串间接访问属性的机制.是指在 iOS 开发中,允许开发者通过 字符串键和键路径直接访问或赋值对象属性.
先来定义两个类,雇员类KY_Employee
,和车辆类KY_Car
,在后面的代码使用。如下:
@objc class KY_Employee: NSObject {
/// 姓名
@objc var name: String = ""
/// 年龄
@objc var age: String = ""
/// 家乡
@objc var hometown: String = ""
/// 生日
@objc var birthday: String = ""
/// 书籍
@objc var books: [String] = []
/// 车辆
@objc var car: KY_Car?
}
@objc class KY_Car: NSObject {
/// 车牌号
@objc var plateNum: String = ""
/// 车辆颜色
@objc var color: UIColor?
}
// swift
open func setValue(_ value: Any?, forKey key: String)
open func setValue(_ value: Any?, forKeyPath keyPath: String)
// OC
- (void)setValue:(nullable id)value forKey:(NSString *)key;
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;
普通的属性赋值使用前者即可:
var emp = KY_Employee()
emp.setValue("小明", forKey: "name")
但,对car
中的属性赋值时,需要使用后者的赋值方法,该方法在链式赋值时使用。例如我们定义的雇员类中,其属性car
是另一个自定义的类,则,需要使用setValue: forKeyPath:
:
// KVC链式赋值
var emp = KY_Employee()
var car = KY_Car()
emp.car = car
emp.setValue("京A8888", forKeyPath: "car.plateNum")
(入门级提示)使用路径赋值时,需要将属性类初始化,如:emp.car = KY_Car()
。
###(2)字典转模型
字典转模型,需要字典中的key
和类属性相对应,如果字典中的key
值在模型类中未找到,会抛出异常。
// 定义一个字典,准备赋值给 KY_Employee
var dict: [String: Any] = ["name": "康鹏鹏", "age": "25", "hometown": "河北邯郸魏县", "birthday": "1993-01-28", "car": ["plateNum": "京A1111", "color": UIColor.white], "books": ["钢铁是怎样炼成的", "iOS高级开发指南", "乔布斯传"]];
// 使用字典给模型赋值
var emp = KY_Employee()
emp.setValuesForKeys(dict)
上面两个说的都是key
可以在Class
模型中找到对应的属性。当key
值无法在模型中找到对应的属性时,会调用下面这个方法:
open func setValue(_ value: Any?, forUndefinedKey key: String)
为了保证程序不崩溃,需要在模型类中重写该方法做异常处理!
- 在OC中:setter方法没找到对应的key属性, 那么按 _key, _isKey, key, iskey 的顺序搜索成员名。
- 在Swift中:因为swift语法没有成员变量,所以不会如上OC中搜索。
有博客说:给属性赋值nil
会调用方法 func setNilValueForKey(_ key: String)
。根据我的实测:
// 给属性赋值nil
var emp = KY_Employee()
emp.setValue(nil, forKey: "name")
而func setNilValueForKey(_ key: String)
并没有被调用。
若使用setNilsetNilValueForKey
方法,需要重写该方法,否则默认会抛出异常。
KVC读取属性值常用的方法也就下面几个:
// 直接读取属性值
open func value(forKey key: String) -> Any?
// 根据链式路径读取属性值,如读取emp.car中的属性
open func value(forKeyPath keyPath: String) -> Any?
// 获取数组类型属性的值,
open func mutableArrayValue(forKey key: String) -> NSMutableArray
// 根据路径获取数组类型属性的值,如获取emp.car中一个数组类型属性的值
open func mutableArrayValue(forKeyPath keyPath: String) -> NSMutableArray
// 根据传入的key数组,返回key-value字典
open func dictionaryWithValues(forKeys keys: [String]) -> [String : Any]
找不到与key
对应的属性时,会调用value(forUndefinedKey key: String) -> Any?
,该方法默认抛出异常。可以重写该方法做容错处理。
##3、字典转模型框架实现(Dict to Model)
字典和模型的相互转换,需要配合Runtime使用。日后抽时间再写。