Swfit 常用特性（Attribute）关键字

2024-02-28 10:43:16

Swift中的Attribute相当于Java中的注解，但是可惜的是目前Swift不支持自定义Attribute
Swfit的特性关键字一般用于声明或者用于类型
使用形式 @属性关键字 或者带参数@属性（参数）

@availabel

@available用来标识计算属性(不包含储存属性)、函数、类、结构体、枚举等声明周期（依赖特定版本或者Swift语言版本）

该特性总是以一个或者多个以下列表字段开始

平台参数或Swift版本

iOS
iOSApplicationExtension
macOS
macOSApplicationExtension
watchOS
watchOSApplicationExtension
tvOS
tvOSApplicationExtension
swift

如果你想全平台通用，可以使用*

使用模板

@available(平台 版本号, *) 
@available(swift 版本号)
@available(*)

示例

@available(iOS 10.0, macOS 10.12, *)
class MyClass {
    // class definition
}

@available(swift 3.0.2)
@available(macOS 10.12, *)
struct MyStruct {
    // struct definition
}

@available其他附加参数, 可按 Esc进行提醒（除了obsoleted）

unavailable:表示指定平台不可用，但是不能指定swift 某版本号不可用

@available(*, unvailable)
func unavailableMethod() {} // 表示这个方法全平台不可用

introduced ：从哪个版本开始被声明

introduced: 版本号

deprecated ：从哪个版本开始准备被删除，但不影响使用，告诉开发者接下来版本中可能会被删除

deprecated: 版本号

obsoleted : 从哪个版本中被删除，以后都不能使用了

obsoleted: 版本号

message : 提示信息，编译器会根据版本号提示对于信息

message: "description"

renamed : 被重命名为，当对应标记被调用时，编译器就会提示修改为新名字

renamed: 新名字

示例

// 历史协议
@available(*, unavailable, renamed: "MyRenamedProtocol")
protocol MyProtocol {
 // protocol definition
}
// 替代协议，信息协议
protocol MyRenamedProtocol {
    // protocol definition
}
class person: MyProtocol { // 提示错误，并且可以快捷修复
  // 实现  
}

如下图：

以上代码优化版本，使用typealias

@available(*, unavailable, renamed: "MyRenamedProtocol")
typealias MyProtocol = MyRenamedProtocol

全参数使用示例

@available(swift, introduced: 3.0, deprecated: 4.2, obsoleted: 5.0, renamed: "newFunction", message:  "本方法已在swift 5.0删除，请使用新方法替换")
func oldFunction() {
    print("this is old method")
}
func newFunction() {
    
}

oldFunction()

编译器提示如下图

@discardableResult

字面理解不关心结果，表示被标记的方法可以不使用返回结果，标记过后，调用时如果方法有返回值，且在调用的使用没有设置使用到返回值，编译器不会提示警告 ⚠️

@dynamicCallable

Swift5引入的语法糖（动态可调用），作用是可以像调用函数一样去调用类型。
参考:Swift学习之@dynamicCallable
How to use @dynamicCallable in Swift

@dynamicMemberLookup

swift4.2引入的动态可查找属性。作用访问对象未定义属性。
可以用来标记类、结构体、枚举、协议，实现subscript(dynamicMember member: String)方法后,我们就可以访问对象不存在的属性。如果访问属性不存在，就会调用实现的subscript方法，属性值作为member传入这个方法。
比如下面结构体：

@dynamicMemberLookup
struct Person {
    var gender: String = "男"
    subscript(dynamicMember member: String) -> String {
        let properties = ["nickname": "Zhuo", "city": "Hangzhou"]
        return properties[member, default: "undefined"]
    }
    // 可以实现多个subscript方法，但是要返回不同类型值,且调用时需要指定返回值类型
    //subscript(dynamicMember member: String) -> Int {
    //    return 18
    //}
}
//执行以下代码
let p = Person()
print(p.gender)    // 男
// 不存在的属性，Xcode不会提示，也不会报错
print(p.city)      // Hangzhou
print(p.nickname)  // Zhou
print(p.name)      // undefined

注意：为了保证Swift语言安全性，动态查找subscript方法不能返回可选值。
@dynamicCallable和 @dynamicMemberLookup 目前作用实现swift动态性及与动态语言的衔接，比如与Phone和javaScript联用。
解释参考Swift新特性 dynamicMemberLookup和dynamicCallable
Swfit git仓库进度-dynamicMemberLookup介绍
 How to use Dynamic Member Lookup in Swift
Swift4.2新特性：Dynamic Member Lookup

@NSCopying

标记类的可变储存属性，类似OC的copy属性，SwiftGG关于@NSCoping

@objc

作用为告诉编译器，这个声明在Objective-C中是可用的。
objc特性效果会在下面情况隐式添加

声明是子类的重写，父类有objc特性
声明满足的需求来自拥有objc特性的协议
声明有 IBAction, IBOutlet, IBDesignable, IBInspectable, NSManaged或者 GKInspectable标记的
拥有objcMembers标记的类。
如果你用@objc标记枚举，在Objctive-C中，将以枚举名+成员名串起来暴露给Objective-C代码

@objc
enum OrderStatus: Int {
    case willPay   // OC形式 OrderStatusWillPay
    case finished  // OC形式 OrderStatusFinished
}

@objc可以接受一个参数，作为OC替换名字

@objc(ObjectiveCClass)    // OC 中为 ObjectiveCClass
class ExampleClass: NSObject {
    var enabled: Bool {
        @objc(isEnabled) get {  // OC 中为isEnabled
            // Return the appropriate value
        }
    }
}

@objcMembers

如果类被标记，那么objc特性效果将隐式添加到类的OC 兼容成员、扩展、子类以及所有子扩展。如果你的代码不是100%支持OC,建议单独使用@objc, 因为会增加二进制体积包和性能。

@具备Interface Builder使用声明

nterface Builder 特性是用于 Interface Builder 和 Xcode 同步的声明特性。Swift 提供了下列 Interface Builde r特性： IBAction ， IBOutlet ， IBDesignable ,和 IBInspectable 。这些特性概念上和 Objective-C 中的相同。

你可以把 IBOutlet 和 IBInspectable 特性应用于一个类的属性声明中。把 IBAction 特性用于一个类的方法声明，把 IBDesignable 特性用于类的声明。

IBAction 和 IBOutlet 特性都隐含 objc 特性。
类型特性

类型特性只能用于类型中，包括@autoclosure, @escaping, @convention。

@autoclosure

这个特性用于，通过自动包装没有实际参数的表达式来延迟对表达式的求值。这个特性用于一个方法或函数声明的形式参数类型中，该形式参数是一个函数类型，这个函数类型不接受实际参数并且返回一个表达式的类型的值。有关如何使用 autoclosure 特性的示例，参见自动闭包和函数类型。

@convention

把这个特性应用于一个函数的类型以指明它的调用约定,以达到swift 调用兼容OC ,C 闭包作用。

convention 特性总是和下列特性实际参数中的一个同时出现：

swift 实际参数用于指明一个 Swift 函数引用。在 Swift 中，这是函数值的标准调用约定。
block 实际参数用于指明一个 Objective-C 兼容的闭包引用。函数值表示为对闭包对象的一个引用，它是一个兼容 id 的、在其中嵌入它的调用函数的 Objective-C 对象。调用函数用 C 调用约定。
c 实际参数用于指明一个 C 函数引用。函数值不携带上下文并且使用 C 调用确定
除了少数例外，当需要任何其他调用约定的函数时，可以使用任何调用约定的函数。非泛型全局函数，和局部函数或不捕获任何局部变量的闭包，可以转换为 C 调用约定。其他 Swift 函数不能转换为 C 调用约定。一个带有 Objective-C 闭包调用约束的函数不能转换为 C 调用约定

简而言之，通过携带参数来修饰闭包：

@convention(swift) : 表明这个是一个swift的闭包
@convention(block) ：表明这个是一个兼容oc的block的闭包

运用参考： Swift的@convention

SwiftGG介绍@convention特性

@escaping

将这个特性应用到一个方法或函数声明的形式参数类型中，以指明可以存储该形式参数值用于稍后执行。这意味着允许那个值超过调用它的范围而存在。 escaping 类型特性的函数类型形式参数需要为属性或方法显式使用 self. 。有关如何使用 explicit 特性，参见逃逸闭包。

@unknown

给 switch 的 case 应用这个特性来表示在代码编译后这个情况不应被枚举中已知的任何情况匹配。如何使用 unknown 属性

码农公寓