README.md

AutoPropertyCocoa

简介

• 完整的objc的属性懒加载和属性自动化事务。
• 关键词 :iOS懒加载 属性钩子 macOS cocoa class_removeMethods runtimelock
• English documentation

引用

• 使用cocoapods(推荐) 或者 拖拽文件夹AutoPropertyCocoa到项目

#import "AutoPropertyCocoa.h"

目标

- (id)lazyloadProperty{
    if(_lazyloadProperty == nil){
        _lazyloadProperty = [OneClass new];
    }
    return _lazyloadProperty;
}

==变化=>

1.
APCClassLazyload(OneClass, lazyloadProperty);

2.
APCLazyload(instance, lazyloadProperty);

示例

针对类的懒加载

///通常使用在+load, +initialize, -init, -viewDidLoad中。
///只要在属性访问前调用，就会正常工作。

1.
APCClassLazyload(OneClass, propertyA, propertyB, ...);

APCClassUnbindLazyload(OneClass, propertyA, propertyB, ...);

2.
[OneClass apc_lazyLoadForProperty:@"property" usingBlock:^id(id_apc_t instance){
    return [OneClass initWork];
}];

3.
[OneClass apc_lazyLoadForProperty:@"arrayProperty" selector:@selector(array)];

仅针对一个实例对象的懒加载。

///实例对象通常是控制器，模型等。
///通常使用在 -init, -viewDidLoad中。
APCLazyload(instance, propertyA, propertyB, ...);

[instance apc_lazyLoadForProperty:@"property" usingBlock:^id(id_apc_t instance){
    return [OneClass initWork];
}];

支持解绑'针对实例'的懒加载。

APCUnbindLazyload(instance, propertyA, propertyB, ...);

[instance apc_unbindLazyLoadForProperty:@"property"];

属性前触事务.

[anyone apc_willGet:@"key" bindWithBlock:^(id_apc_t instance, id value) {
    ///Before getter of property called.
}];

属性后触事务.

[anyone apc_didSet:@"key" bindWithBlock:^(id_apc_t instance, id value) {
    ///After setter of property called.
}];

属性条件事务.

[anyone apc_set:@"key" bindUserCondition:^BOOL(id_apc_t instance, id value) {
    ///Your condition when setter called...
} withBlock:^(id_apc_t instance, id value) {
    ///If your condition has been triggered.
}];

基础值类型

目前支持的结构体类型有: XReact, XPoint, XSize, XEdgeinsets, NSRange.

• 针对类型的钩子属性如果是基础值类型，那么将会是无效的并且会报错。但是针对实例的基础值类型是支持懒加载的，它和对象类型那种判断对象是否存在不同，它只在该属性第一次被访问时触发懒加载。

调用用户的super方法.

• APCUserEnvironment提供了用户环境，支持用户调用父级的业务方法。
• id_apc_t标记了这个id对象是支持APCUserEnvironment的。

[Person apc_lazyLoadForProperty:@"key"  usingBlock:^id (id_apc_t instance) {

    return @"Person.gettersetterobj";
}];

[Man apc_lazyLoadForProperty:@"key"  usingBlock:^id (id_apc_t instance) {
    //调用上方 ↑
    return APCSuperPerformedAsId(instance);
}];

[Superman apc_lazyLoadForProperty:@"key" usingBlock:^id (id_apc_t instance) {
    //调用上方 ↑
    return APCSuperPerformedAsId(instance);
}];

针对实例的钩子的线程安全.

• 如果你不会在绑定/解绑实例属性钩子的同时访问这个属性，可以完全忽略此处的说明。
• 测试表明 : 在及其大量的多线程访问中，绑定/解绑实例属性钩子的同时访问这个属性有非常小的概率产生异常： 'Attempt to use unknown class.'。这是由于object_setClass()还没有执行完的时候访问了实例对象。该问题除了进行同步没有办法解决。项目中已经钩住了runtimelock，使用它会影响效率，所以推荐下列的可靠的方案来解决多线程的问题：

///Thread-A...
apc_safe_instance(instance, ^(id object) {
    APCLazyload(object, property);
});

///Thread-B...
apc_safe_instance(instance, ^(id object) {
    APCUnbindLazyload(object, property);
});


///Thread-C...
apc_safe_instance(instance, ^(SomeClass* object) {
    [object accessProperty];
});

实际开发中几乎不需要考虑这种情况

针对类的钩子的线程安全.

• 如果你没有对针对类的钩子进行解绑操作的需求，可以完全忽略此处说明。
• 针对类的钩子是线程安全的。
• 对针类的钩子进行解绑操作建议在main()方法中实现apc_main_classHookFullSupport().

int main(int argc, const char * argv[]) {

    /*
        1.在应用启动器或在runtime加载前调用.
        2.该方法实现了删除runtiem中method的功能。如果不调用该方法则会采用模拟删除方法的策略，
        也就是用一个空方法来占据本应删除的方法，该方法将调用向父级传递。
        但是这会影响method swizzle，影响获取method ，影响从类中获取imp。
        具体表现在使用这几类沿着继承链查找方法相关的API的时候会获取到APC项目提供的占位方法。
        解决方案就是，使用准确的类型或者实现apc_main_classHookFullSupport()：
        class_replaceMethod(CorrectClass, ...);
        class_getInstanceMethod(CorrectClass, ...);
    */
    apc_main_classHookFullSupport();
    return ... ...(argc, argv);
}