介绍

1. __attribute__ 是一个用于在声明时指定一些特性的编译器指令，它可以让我们进行更多的错误检查和高级优化工作。
2. 使用这个关键字的语法是 __attribute__ ，前后跟两组_（两个_可以让它很容易在宏里面使用，特别是有多个属性的时候）。
3. __attribute__ 指令可以放在函数，变量和类型声明之后，即可以设置函数属性（Function Attribute）、变量属性（Variable Attribute）和类型属性（Type Attribute）
4. __attribute__ 是GCC的特性，LLVM借鉴过来，又对其进行了扩展。

语法

__attribute__ 语法格式为: __attribute__ ((attribute-list)) 在括号里面是用逗号分隔的属性列表

分类

• 函数属性 Function Attribute （修饰在函数声明中）
• 变量属性Variable Attribute
• 类型属性Type Attribute
  具体支持的属性可以点进去查看

这里简单介绍几个属性：

GCC

• format

format 属性用于指定一个函数接收类似 printf， scanf， strftime 和 strfmon 风格的参数，应该按照参数对格式化字符串进行类型检查。
Objective-C 程序员还可以使用 NSString 来使用跟 NSString stringWithFormat: 和 NSLog() 一样的格式化字符串规则。

extern int
my_printf (void *my_object, const char *my_format, ...)
  __attribute__((format(printf, 2, 3)));

extern int 
my_printf (void *my_object, const NSString *my_format, ...) 
  __attribute__ ((format (NSString, 2, 3)));

//在上面的示例中，format string（my_format）是函数my_print的第二个参数，
//要检查的参数从第三个参数开始，因此format属性的正确参数是2和3。

• nonnull

nonnull 属性表明一些函数参数应该是非空的指针。

//使编译器检查在调用my_memcpy时，参数dest和src是否为非空
extern void *
my_memcpy (void *dest, const void *src, size_t len)
  __attribute__((nonnull (1, 2)));

//如果没有为non null属性提供参数索引列表，则所有指针参数都标记为non null。为了说明，下面的声明与前面的示例等效：
extern void *
my_memcpy (void *dest, const void *src, size_t len)
  __attribute__((nonnull));

• unused

当一个函数增加了这个属性声明的时候，意味着它可能不会被使用，GCC 不会对这个函数产生警告。
使用 __unused 关键字可以达到同样的效果，可以在方法实现中声明没有被使用的参数。

extern void *
my_memcpy (void *dest, const void *src, size_t len)
  __attribute__((unused));

void my_memcpy (__unused void *dest, const void *src, size_t len) {
  ...  
}

//OC 中使用__unused关键字
- (instancetype)initWithDict:(NSDictionary * __unused)dict{
  ...
  __unused int a = 0;
}

LLVM

和其他 GCC 特性一样，Clang 支持了 attribute， 还加入了一小部分扩展特性。
要检查能否使用特定的属性，可以用 __has_attribute 这个指令。

• availability

void f(void) __attribute__((availability(macosx,introduced=10.4,deprecated=10.6,obsoleted=10.7)));

availability 属性指出 f 在 OS X Tiger 中被引入，在 OS X Snow Leopard 中被废弃，在 OS X Lion 中被淘汰。

Clang 使用这些信息来判断使用 f 是不是安全的：举个例子，如果 Clang 需要为 OS X Leopard 编译代码，调用 f() 没有问题。如果 Clang 为 OS X Snow Leopard 编译代码，调用仍然会成功，不过 Clang 会发出警告，表明这个函数已经废弃了。最后，如果 Clang 为 OS X Lion 平台编译代码，调用会失败，因为 f() 已经不可用了。

availability 属性是用一个逗号分隔的列表，列表的第一项是平台名称，然后是指出声明的生命周期当中重要的里程碑时间（如果有的话）的语句，最后是额外的信息。

• introduced: 声明被引入的第一个版本。
• deprecated: 声明被废弃的第一个版本，意味着用户应当从这个 API 迁移到另外的方法。
• obsoleted: 声明被废弃的第一个版本，意味着它被彻底删除不能使用了。
• unavailable: 声明不可用
• message: 额外的文本信息，Clang 在对于废弃和淘汰声明给出警告或者错误的时候会提供这些信息，可以用于指导用户进行 API 替换。

在同一个声明上可以添加多个可用性属性，它们可能是针对不同平台的。只有当前和目标平台对应的平台可用性属性会发挥作用，其他的属性会被忽略掉。如果没有和当前目标苹果对应的可用性属性，整个可用性属性会被忽略。

支持的平台：
ios: 苹果 iOS 操作系统。最低的部署目标通过 -mios-version-min=version 或者 -miphoneos-version-min=version 命令行参数指定。
macosx: 苹果 OS X 操作系统。最低的部署目标通过 -mmacosx-version-min=version 命令行参数指定。

• overloadable

Clang 在 C 语言中提供了 C++ 函数重载支持，通过 overloadable 这个属性实现。例如我们要提供多个不同重载版本的 tgsin 函数，它会调用合适的标准库函数，分别提供对 float，double 和 long double 精度的值计算 sine 值。

float __attribute__((overloadable)) tgsin(float x) { return sinf(x); }
double __attribute__((overloadable)) tgsin(double x) { return sin(x); }
long double __attribute__((overloadable)) tgsin(long double x) { return sinl(x); }

在iOS中的应用

上面的 __attribute__ 使用方法是在GCC中使用的在OC中有些是禁用的。下面是一些OC中使用的例子和用法。

常用属性

• availability：使用版本、平台情况及相关说明信息
• unavailable：告诉编译器某方法不可用，如果强行调用编译器会提示错误
• nonnull：编译器对函数参数进行检查，不能为null，参数类型必须为指针类型（包括对象）
• cleanup：用于修饰一个变量，在它的作用域结束时可以自动执行一个指定的方法
• objc_root_class：顾名思义，表示我们这个类是一个基类
• objc_designated_initializer：指定类的初始化方法，并不是对使用者，而是对类内部的实现
• objc_requires_super：表示子类在重写父类的方法的时候，必须要调用super方法，否则会有警告
• objc_subclassing_restricted：表示该类不能被继承
• objc_runtime_name：用于 @interface 或 @protocol，将类或协议的名字在编译时指定成另一个。
• objc_method_family : 以alloc, new, copy, mutableCopy开头的函数都会被作为生成新对象的函数对返回对象retainCount自增1，objc_method_family可以使其他方法也能达到同样的效果
• objc_boxable : OC中常见的 @(10)这样的写法，它的实现方式就是利用该Function attributes

• availability

//availability 属性指出 testAvailability 在iOS 2.0 中引入，在iOS 7.0 中被废弃，在iOS11.0 进行移除
- (void)testAvailability __attribute__((availability(ios,introduced=2_0,deprecated=7_0,obsoleted=11_0,message="该方法将在ios11进行移除")));

//availability 属性指出 testUnavailableAvailability 无法在iOS平台使用
- (void)testUnavailableAvailability __attribute__((availability(ios,unavailable,message="iOS平台无法使用")));

• unavailable

//unavailable在系统中也有与其相关的宏定义，如我们可以直接使用NS_UNAVAILABLE
- (void)function1 NS_UNAVAILABLE;
//也可以直接使用unavailable，并且可以在后面追加一些参数提示
- (void) function2 __attribute__((unavailable("这个方法已经不能使用了")));

• nonnull

使用_Nonnull 关键字可以达到同样的效果

//参数类型必须为指针类型
- (instancetype)initWithDict:(NSDictionary *)dict __attribute__((nonnull(1)));

//会报警告 'nonnull' attribute applied to function with no pointer arguments
- (instancetype)initWithCount:(NSInteger)count __attribute__((nonnull(1)));

//使用_Nonnull关键字
- (instancetype)initWithDict:(NSDictionary * _Nonnull )dict;

• cleanup

printTestString需要是C方法，同时printTestString方法需要有参数，并且参数为指向指针的指针
当我们在同一个作用域有多个cleanup变量的时候，执行顺序是先入后出的的顺序
Reactive Cocoa 用这个特性实现了神奇的 @onExit，关于这个 attribute，在sunnyxx的这篇博客中有非常详细的介绍。

void function {
    ...
    NSString *testCleanString1 __attribute__((cleanup(printTestString))) = @"测试一下";
    NSString *testCleanString2 __attribute__((cleanup(printTestString))) = @"测试二下";
    NSString *testCleanString3 __attribute__((cleanup(printTestString))) = @"测试三下";
}

void printTestString(NSString **string){
        NSLog(@" 打印信息string:%@",*string);
}
//输出结果为
打印信息string:测试三下
打印信息string:测试二下
打印信息string:测试一下

• objc_root_class

身为基类就不能再继承自其他类了，但可以遵循协议

OBJC_ROOT_CLASS
@interface BankModel <NSObject>
@end

• objc_designated_initializer

如果该方法为指定初始化方法，则其他的便利初始化方法都需要调用该方法
包括子类，子类的初始化方法也需要调用父类的指定初始化
如NSObject类对-init方法添加了objc_designated_initializer，则NSObject类提供的其他便利init方法与所有继承自NSObject的类都需要先调用-init方法来初始化自己

//objc_designated_initializer在系统中也有与其相关的宏定义，如我们可以直接使用NS_DESIGNATED_INITIALIZER
- (instancetype)initWithDict:(NSDictionary *)dict NS_DESIGNATED_INITIALIZER;
//或者直接使用objc_designated_initializer
- (instancetype)initWithDict:(NSDictionary *)dict __attribute__((objc_designated_initializer));

//因为本类有了objc_designated_initializer方法，所以在initWithDict：andStyle：方法的内部实现需要调用initWithDict：方法
- (instancetype)initWithDict:(NSDictionary *)dict  andStyle:(NSString *)style;

#pragma mark - 华丽的分割线 下面为.m文件部分实现
- (instancetype)initWithDict:(NSDictionary *)dict {
  self = [self init];
  if (self){
     ....
  }
}

- (instancetype)initWithDict:(NSDictionary *)dict  andStyle:(NSString *)style{
  self = [self initWithDict:dict];
  if (self){
     ....
  }
}

• objc_requires_super

//表示子类在重写的时候 必须先调用父类的方法
- (void)function __attribute__((objc_requires_super));

#pragma mark - 华丽的分割线 下面为子类.m文件部分实现
- (void) function{
  [super function];
  ...
}

• objc_subclassing_restricted

//这样我们的BaseUIViewController就无法被继承了
__attribute__((objc_subclassing_restricted))
@interface BaseUIViewController : UIViewController
@end

• objc_runtime_name

也可以用于@protocol

__attribute__((objc_runtime_name("UIViewController")))
@interface BaseUIViewController : UIViewController
@end

//这时如果调用
NSLog(@" 打印信息:%@",NSStringFromClass([BaseUIViewController class]));
//输出结果
打印信息: UIViewController

• objc_method_family

在支持ARC后，clang有一些对于内存管理的命名规范。
如果方法名以alloc, new, copy, mutableCopy开头的函数都会被作为生成新对象的函数对返回对象retainCount自增1.
如果作为普通对象可以在property后加attribute((objc_method_family(none)))
用法：attribute((objc_method_family(X))，其中X是none、alloc、copy、init、mutableCopy或new之一。此属性只能放在方法声明的末尾：

@property (nonatomic, strong) NSArray *initArray;
- (NSArray *)initArray __attribute__((objc_method_family(none)));

//当然你也可以使不满足编译器命名规则的方法成为生成新对象的方法，如：
+ (instancetype) createObject __attribute__((objc_method_family(alloc)));

• objc_boxable

struct __attribute__((objc_boxable)) some_struct {
    int i;
};
-  (void)function {
    some_struct ss;
    __unused NSValue *boxed = @(ss);
}

参考资料

• https://www.jianshu.com/p/e2dfccc32c80
• https://nshipster.cn/__attribute__/
• https://www.jianshu.com/p/abeee47e82d8