Swift底层探索3 - 属性

在 Swift 中属性可以分为两大类：存储属性（Stored Property），计算属性（Computed Property）

1、存储属性

存储属性是一个作为特定类和结构体实例一部分的常量或变量。存储属性要么是变量存储属性 (由 var 关键字引入)，要么是常量存储属性(由 let 关键字引入)。

• let 用来声明常量，常量的值一旦设置好便不能再被更改
• var 用来声明变量，变量的值可以在将来设置为不同的值。

在创建类或结构体的实例时，必须为所有的存储属性设置一个初始值。可以在初始化器里为存储属性设置一个初始值，可以分配一个默认的属性值作为定义的一部分。如：

struct People {
    var age = 12
    let name = "小明"

}

class Person {
    var age: Int
    let name: String

    init(_ age: Int, name: String) {
        self.age = age
        self.name = name
    }
}

let point = People()
let person = Person(18, name: "小明")

接下来声明以下两个变量来进行查看

var age = 18
let age1 = 20

1.1 汇编分析 let 和 var

结论：可以发现两者都是一样的，直接把值复制到寄存器中。

1.2 lldb分析 let 和 var

结论：可以发现两者存储的地址是连续的，而且都在__DATA.__common这个全局区内。

1.3 SIL分析 let 和 var

从SIL文件中可以发现两者都是存储属性，都有初始值，唯一的不同就死age有set方法，age1没有。

结论：var 修饰的属性有 get 和 set 方法，而let 修饰的属性只有 get 方法，这就是 let 修饰的属性不能修改的原因。

2、计算属性

计算属性注意事项：

• 除了存储属性，类、结构体和枚举也能够定义计算属性，计算属性并不存储值
• 他们提供 getter 和 setter 来修改和获取值。
• 如果只提供 getter 方法的计算属性叫做只读计算属性
• 对于存储属性来说可以是常量或变量，但计算属性必须定义为变量。
• 书写计算属性时候必须包含类型，因为编译器需要知道期望返回值是什么。

2.1 SIL探索

struct Square{
    //实例当中占据内存
    var width: Double
    
    //隐藏set方法，struct外部只读
    private(set) var height : Double
    
    //本质是方法，不占据内存
    var area: Double{
        get{
            return width * height
        }set{
            //系统默认新参数newValue，可通过传参的模式更改参数名
            self.width = newValue
        }
    }
}

var s = Square(width: 10,height: 10)
s.area = 30

从SIL文件中可以发现height拥有@_hasStorage标记，本质仍然是存储属性，而area属性没有。

结论：计算属性的本质就是get和set方法。

3、属性观察者

属性观察者会观察用来观察属性值的变化

• willSet 当属性将被改变调用，即使这个值与原有的值相同
• didSet 在属性已经改变之后调用
• 在初始化期间设置属性时不会调用 willSet 和 didSet 观察者，只有在为完全初始化的实例分配新值时才会调用
• 属性观察者只是对存储属性起作用
• 当有属性观察者有继承时，调用顺序为：
  override willSet -> willSet -> 赋值 -> didSet -> override didSet

3.1 SIL探索

class SubjectName {
    var subjectName: String = ""{
        //在初始化期间设置属性时不会调用
        willSet{
            print("subjectName will set value \(newValue)")
        }
        didSet{
            print("subjectName has been changed \(oldValue)")
        }
    }
    
    init(_ subjectName:String){
        self.subjectName = subjectName
    }
}

print("begin")
let s = SubjectName("swift")
print("middle")
s.subjectName = "Swift"
print("end")

//打印结果
//begin
//middle
//subjectName will set value Swift
//subjectName has been changed swift
//end

从SIL文件中可以发现：

• 在调用subjectName的 setter 时候，赋值之前会先调用 willSet 赋值完成之后会调用 didSet
• 在SubjectName 的初始化函数中，subjectName是取地址直接赋值而不是调用其自身的 setter 方法

4、延迟存储属性

• 延迟存储属性的初始值在其第一次使用时才进行计算。
• 用关键字 lazy 来标识一个延迟存储属性。
• lazy 属性必须是 var，不能是 let，因为 let 必须在实例的初始化方法完成之前就拥有值。
• lazy无法保证线程安全，多线程下。
• 当结构体包含一个延迟存储属性时，只有 var 实例变量才能访问延迟存储属性，因为延迟属性初始化时需要改变结构体的内存。

4.1 SIL探索

class Subject{
    lazy var age : Int = 18
}

var subject = Subject()

从SIL中可以发现

• 存储属性在添加了 lazy 修饰后，该属性拥有 final 修饰符，说明 lazy 修饰的属性不能被重写。并且，它是一个可选项，意味着这个值可以是Optional.none，也就是nil。

5、类型属性

• 类型属性其实就是一个全局变量
• 类型属性只会被初始化一次

5.1 SIL探索

class Teacher {
    // 只被初始化一次
    static var age: Int = 18
}
Teacher.age =  20

从SIL文件可以发现属性前用了static修饰，同时生成了两个全局变量token和age，也就说类型属性其实就是一个全局变量

从main函数中可以发现访问age变量是通过Teacher.age.unsafeMutableAddressor函数来访问，函数名为s4main7TeacherC3ageSivau，定位到该函数

通过这个函数，可以发现整个过程其实就是就是获取了token和age两个全局变量地址转化后返回。
其中:
age创建函数s4main7TeacherC3age_WZ

builtin "once" 实际上是调用了GCD中的dispatch_once_f，因此保证了只会被初始化一次。
在SIL文件中无法找到说明，直接转化成IR文件可以发现函数s4main7TeacherC3age_Wz的调用是swift_once

在swift源码中Once.h中，可以发现

所以可以得出结论builtin "once" 实际上是调用了GCD中的dispatch_once_f，因此保证了只会被初始化一次

5.2 单例

class Teacher {
    static let sharedInstance = Teacher()
    // 指定初始化器私有化，外界访问不到
    private init(){}
}
Teacher.sharedInstance

6、属性在MachO文件的位置

6.1 源码探索

swift 类的本质是HeapObject，他有两个成员变量 Metadata 和 Refcount，其中Metadata中存放了 Description，Swift 类的属性就存放在Description的 fieldDescriptor 中

struct Metadata{ 
    var kind: Int
    var superClass: Any.Type
    var cacheData: (Int, Int)
    var data: Int
    var classFlags: Int32
    var instanceAddressPoint: UInt32 var instanceSize: UInt32
    var instanceAlignmentMask: UInt16
    var reserved: UInt16
    var classSize: UInt32
    var classAddressPoint: UInt32
    var typeDescriptor:TargetClassDescriptor 
    var iVarDestroyer: UnsafeRawPointer
}

class TargetClassDescriptor {
    var flags: UInt32
    var parent: UInt32
    var name: Int32
    var accessFunctionPointer: Int32
    var fieldDescriptor: Int32
    var superClassType: Int32
    var metadataNegativeSizeInWords: UInt32
    var metadataPositiveSizeInWords: UInt32
    var numImmediateMembers: UInt32
    var numFields: UInt32
    var fieldOffsetVectorOffset: UInt32
    var Offset: UInt32
    // var size: UInt32
    //V-Table
}

在源码中 TargetClassDescriptor是继承自 TargetTypeContextDescriptor ，在这个类中发现了FieldDescriptor

可以推断出FieldDescriptor 的结构体大致如下

class FieldDescriptor {
    MangledTypeName int32
    Superclass int32
    Kind uint16
    FieldRecordSize uint16
    NumFields uint32
    FieldRecords [FieldRecord]
}

其中 NumFields 代表当前有多少个属性， FieldRecords 记录了每个属性的信息，对于FieldRecords源码中其实就是FieldRecordIterator

通过源码不难发现FieldRecordIterator就是个迭代器，其中存放着FieldRecord类型的变量，

由源码不难推断出FieldRecord的数据结构为

struct FieldRecord{
    Flags uint32 
    MangledTypeName int32 
    FieldName int32
}

6.2 Mach-O源码探索

class Person {
    var age: Int = 18
    var name : String = "小明"
}

计算 ClassDescriptor 在Mach-O 中的偏移地址,然后减去虚拟基地址，找到 ClassDescriptor 的偏移

0x3F00 + 0xFFFFFF40 - 0x100000000 = 0x3E40

FieldDescriptor 在 ClassDescriptor 中是第五个属性，所以需要向后偏移 16 字节也就是3E50的位置

再次读取四个字节就是 fieldDescriptor的偏移信息，所以 fieldDescriptor 在Mach-O的位置为

0x3E50 + 0x88 = 3ED8

此时要找到FieldRecords的信息，根据结构体信息可知需要偏移16个字节，即3EE8开始分别是flag、MangledTypeName、FieldName，其中FieldName存的是偏移信息

那么可以计算出FieldName的在Mach-O的位置是

0x3EE8 + 8 + 0xFFFFFFDD - 0x100000000 = 0x3ECD

可以发现 0x3ECD 在 Mach-O 文件 reflstr 的位置，存储的是属性名称。