关于iOS 13 中KVC 访问限制的一些处理

1. 前言

1. 本篇主要是解决iOS 13 中KVC 访问限制，即访问私有属性遇到access prohibited异常的问题。
2. 本篇主要是为了适配已经使用了大量存在KVC限制的项目，对于新幼项目笔者建议还是按照官方要求来处理，毕竟后期官方再做变动，这些方法就不一定有效果了
3. 声明：本篇核心代码来自QMUIKit,欲知更多请前往QMUIKit

2. 解决方案

本篇提供了三种处理方式，且均是采用给分类关联属性或方法替换的方式实现(具体请查看下方代码)

1. 通过全局的宏定义阀值来全局忽略KVC 访问限制
2. 通过封装好的kvc方法来替换系统自带的方法，局部忽略KVC 访问限制
3. 通过线程来忽略某代码片段中对KVC 的访问限制

3. 代码

1. 代码依赖关系：NSObject -依赖于-> NSThread -依赖于-> NSException
2. 将完整的代码拷贝到项目中即可进行测试和使用

// 分类声明

#import <UIKit/UIKit.h>

NS_ASSUME_NONNULL_BEGIN

// MARK: - 宏定义
/// 通过该宏来 全局忽略系统的  KVC 访问限制
#define IgnoreKVCAccessProhibited YES

/// 快捷书写
/// 将 KVC 代码包裹在这个宏中，可局部忽略系统的  KVC 访问限制, IgnoreKVCAccessProhibited == NO时有效
#define BeginIgnoreUIKVCAccessProhibited if (@available(iOS 13.0, *)) NSThread.currentThread.shouldIgnoreUIKVCAccessProhibited = YES;
#define EndIgnoreUIKVCAccessProhibited if (@available(iOS 13.0, *)) NSThread.currentThread.shouldIgnoreUIKVCAccessProhibited = NO;



// MARK: - NSThread
@interface NSThread (KVC)
/// 是否将当前线程标记为忽略系统的 KVC access prohibited 警告，默认为 NO，当开启后，NSException 将不会再抛出 access prohibited 异常
/// @see BeginIgnoreUIKVCAccessProhibited、EndIgnoreUIKVCAccessProhibited
@property(nonatomic, assign) BOOL shouldIgnoreUIKVCAccessProhibited;

@end


// MARK: - NSObject
@interface NSObject (KVC)
/**
 iOS 13 下系统禁止通过 KVC 访问私有 API，因此提供这种方式在遇到 access prohibited 的异常时可以取代 valueForKey: 使用。
 
 对 iOS 12 及以下的版本，等价于 valueForKey:。
 
 @note 本篇提供2种方式兼容系统的 access prohibited 异常：
 1. 通过将 IgnoreKVCAccessProhibited 置为 YES 来全局屏蔽系统的异常警告，代码中依然正常使用系统的 valueForKey:、setValue:forKey:，当开启后再遇到 access prohibited 异常时，将会用 NSAssert 来提醒，Release模式下不再中断 App，这是首选推荐方案。
 2. 使用 ousi_valueForKey:、ousi_setValue:forKey: 代替系统的 valueForKey:、setValue:forKey:，
 适用于不希望全局屏蔽，只针对某个局部代码自己处理的场景。
 
 @link https://github.com/Tencent/QMUI_iOS/issues/617
 
 @param key ivar 属性名，支持下划线或不带下划线
 @return key 对应的 value，如果该 key 原本是非对象的值，会被用 NSNumber、NSValue 包裹后返回
 */
- (nullable id)ousi_valueForKey:(NSString *)key;

/**
 iOS 13 下系统禁止通过 KVC 访问私有 API，因此提供这种方式在遇到 access prohibited 的异常时可以取代 setValue:forKey: 使用。
 
 对 iOS 12 及以下的版本，等价于 setValue:forKey:。
 
 @note QMUI 提供2种方式兼容系统的 access prohibited 异常：
 1. 通过将 IgnoreKVCAccessProhibited 置为 YES 来全局屏蔽系统的异常警告，代码中依然正常使用系统的 valueForKey:、setValue:forKey:，当开启后再遇到 access prohibited 异常时，将会用 NSAssert 来提醒，Release模式下不再中断 App 的运行，这是首选推荐方案。
 2. 使用 ousi_valueForKey:、ousi_setValue:forKey: 代替系统的 valueForKey:、setValue:forKey:，
 适用于不希望全局屏蔽，只针对某个局部代码自己处理的场景。
 
 @link https://github.com/Tencent/QMUI_iOS/issues/617
 
 @param key ivar 属性名，支持下划线或不带下划线
 */
- (void)ousi_setValue:(nullable id)value forKey:(NSString *)key;
@end


// MARK: - NSException
@interface NSException (KVC)
@end


NS_ASSUME_NONNULL_END

// 分类实现

#import <objc/message.h>

// MARK: - NSThread
@implementation NSThread (KVC)
- (void)setShouldIgnoreUIKVCAccessProhibited:(BOOL)shouldIgnoreUIKVCAccessProhibited {
    objc_setAssociatedObject(
                             self,
                             @selector(shouldIgnoreUIKVCAccessProhibited),
                             @(shouldIgnoreUIKVCAccessProhibited),
                             OBJC_ASSOCIATION_RETAIN_NONATOMIC
                             );
}

- (BOOL)shouldIgnoreUIKVCAccessProhibited {
    return [objc_getAssociatedObject(self, _cmd) boolValue];
}
@end


// MARK: - NSObject
@implementation NSObject (KVC)
- (id)ousi_valueForKey:(NSString *)key {
    if (@available(iOS 13.0, *)) {
        if ([self isKindOfClass:[UIView class]] && !IgnoreKVCAccessProhibited) {
            BeginIgnoreUIKVCAccessProhibited
            id value = [self valueForKey:key];
            EndIgnoreUIKVCAccessProhibited
            return value;
        }
    }
    return [self valueForKey:key];
}

- (void)ousi_setValue:(id)value forKey:(NSString *)key {
    if (@available(iOS 13.0, *)) {
        if ([self isKindOfClass:[UIView class]] && !IgnoreKVCAccessProhibited) {
            BeginIgnoreUIKVCAccessProhibited
            [self setValue:value forKey:key];
            EndIgnoreUIKVCAccessProhibited
            return;
        }
    }
    
    [self setValue:value forKey:key];
}
@end


// MARK: - NSException
@implementation NSException (KVC)
+ (void)load {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        Class cls = [self class];

        Method method1 = class_getClassMethod(cls, @selector(raise: format:));
        Method method2 = class_getClassMethod(cls, @selector(ousi_raise: format:));
        method_exchangeImplementations(method1, method2);
    });
}

+ (void)ousi_raise:(NSExceptionName)name format:(NSString *)format,...{
    if (name == NSGenericException && [format isEqualToString:@"Access to %@'s %@ ivar is prohibited. This is an application bug"]) {

        BOOL shouldIgnoreUIKVCAccessProhibited = IgnoreKVCAccessProhibited || NSThread.currentThread.shouldIgnoreUIKVCAccessProhibited;
    
        if (shouldIgnoreUIKVCAccessProhibited) return;

        NSAssert(NO,  @"使用 KVC 访问了 UIKit 的私有属性，会触发系统的 NSException，建议尽量避免此类操作，仍需访问可使用 BeginIgnoreUIKVCAccessProhibited 和 EndIgnoreUIKVCAccessProhibited 把相关代码包裹起来，或者直接使用 ousi_valueForKey: 、ousi_setValue:forKey:");
        
    }
    
    va_list args;
    va_start(args, format);
    
    NSString *reason =  [[NSString alloc] initWithFormat:format arguments:args];
//    NSDictionary *userInfo = nil;
//    @throw [NSException exceptionWithName:name reason:reason userInfo:userInfo];
    [self ousi_raise:name format:reason];
    va_end(args);
}
@end