背景
目前大多数hotfix框架都是通过runtime+其他语言引擎来实现的,当然也有像手Q这样自己编译、解析字节码的,目前我知道的一些公司在用的有ruby、lua、javascript,基本原理就是利用这些语言引擎与OC通信,再通过runtime完成方法调用,这样就能用其他语言来写OC的代码了。仔细想想这里的引擎起到了什么作用?无非是一个代码运行的环境,简单来说就是栈+基本语法支持,这里的栈是用来记录方法运行产生的变量的,另外在OC中,大部分实现都是通过调用OC方法以及配合if-else、循环来实现的,所以下面要介绍的热修复框架的基本思想就是当修复一个方法时,为这个方法生产一个环境池,用来存放方法内部产生的变量;方法的实现是N条消息组成,相当于N个方法调用,这些调用产生的变量和参数通过环境池存取;再加上if-else、while的支持,就实现了一个简易版的热修复框架。
InstructionPatch
InstructionPatch是一个不依赖其他语言引擎的热修复框架,通过下发json文件,再利用runtime来完成热修复。它的基本原理是修改forwardInvocation:
,使其指向自己的实现,当要修复某个方法时,让它转发到自己实现的forwardInvocation:
中。方法的实现由一系列消息组成,消息之间的参数、变量通过一个环境池(Map)传递,这个环境池会在方法结束时自动清空。
不依赖其他语言引擎好处有:
- 不需要引入多余的引擎
- 支持的系统版本更多
- 可控性强,无论是对象转换还是引用管理,当然做的也多
坏处:
- 基本语法不支持,诸如if-else、while也需要自己实现
- 热修复代码可读性差,当然可以通过脚本自动生成json来优化
- 修复的方法内部实现只能是OC方法的调用
示例
@implementation IPViewController
- (void)viewDidLoad {
[super viewDidLoad];
}
+ (NSString *)returnClassMethod {
return NSStringFromSelector(_cmd);
}
- (void)logObject:(NSString *)obj {
NSLog(@"%@", obj);
}
@end
现在需要在viewDidLoad中打印returnClassMethod中返回的字符串只需要以下指令:
{
// 所有修复指令
"instructions": [
{
// 被修复的类
"cls": "IPViewController",
// 被修复方法
"methodList": [
{
// 修复的方法selector
"method": "viewDidLoad",
"isStatic": false,
// 修复后的方法实现
"messages": [
{
// [super viewDidLoad]
"receiver": "super",
"message": "viewDidLoad"
},
{
// NSString *logStr = [IPViewController returnClassMethod];
// logStr将会被存入环境池
"returnType": "NSString",
"returnObj": "logStr",
"receiver": "IPViewController",
"isStatic":true,
"message": "returnClassMethod"
},
{
// [self logObject:logStr];
"receiver": "self",
"message": "logObject:",
"args": [
{
// 从环境池中取logStr这个对象
"valueKey": "logStr"
}
]
}
]
}
]
}
]
}
详情使用方式参见使用文档。
技术实现
EnvironmentPool
环境池实际上就是一个全局的静态Map,用key-value的形式存取,当进入一个方法时,自动为这个方法开辟一块空间来存放产生的变量,退出方法时再清空这块空间。但实际上,方法实现中经常有异步的block,这时候方法结束了并不能立即清空,否则block真正在执行的时候就没地方去取相应的变量了。为了解决这个问题,借鉴了一下OC的引用计数,当方法开始时引用+1,发现有block时引用也+1,方法执行结束、block执行结束引用-1,这样就能避免环境池过早释放的问题了。但是这又引出了另外一个问题,像一个网络请求一般有success和failure两个block,但是最终却只有一个能被执行,这就导致引用计数始终大于0,而且在代码上并不能判断一个block会不会被执行,所以只能是让用户手动在json的message中手动指定引用的次数environmentPoolRefCount。
既然environmentPool是个Map,那么就只能存取id类型的变量,所以对一些基本类型的变量要做一层包装,在使用的时候再解包。变量类型主要通过NSMethodSignature中的信息根据Type Encodings来判断。
Block的实现
在具体的业务中,block要么作为被修复方法参数要被调用,要么作为被调用方法的参数要被构造,这样问题就变成了:
- 如何调用参数、返回值不确定的block变量
- 如何构造参数类型、个数不确定block变量
要确定一个方法的参数、返回值信息,首先就要知道这个方法签名,block也一样,所以第一个问题的核心就是拿到block变量的签名。虽然系统没提供,不过github很多库和runtime源码中都有相关的实现,具体代码如下:
struct IPBlockLayout {
void *isa;
int flags;
int reserved;
void (*invoke)(void *, ...);
struct IPBlockDescriptor *descriptor;
};
struct IPBlockDescriptor {
unsigned long int reserved;
unsigned long int size;
void (*copy)(void *dst, void *src);
void (*dispose)(void *src);
const char *signature;
};
enum {
IP_BLOCK_HAS_COPY_DISPOSE = (1 << 25),
IP_BLOCK_HAS_SIGNATURE = (1 << 30)
};
static NSMethodSignature * _IPBlockSignature(id block) {
struct IPBlockLayout *bp = (__bridge struct IPBlockLayout *)block;
if (bp && (bp->flags & IP_BLOCK_HAS_SIGNATURE)) {
void *signatureLocation = bp->descriptor;
signatureLocation += sizeof(unsigned long int);
signatureLocation += sizeof(unsigned long int);
if (bp->flags & IP_BLOCK_HAS_COPY_DISPOSE) {
signatureLocation += sizeof(void(*)(void *dst, void *src));
signatureLocation += sizeof(void (*)(void *src));
}
const char *signature = (*(const char **)signatureLocation);
NSMethodSignature *blockSignature = [NSMethodSignature signatureWithObjCTypes:signature];
return blockSignature;
}
return nil;
}
拿到签名后,一切就变得简单了,直接利用NSInvocation
来调用就好。不过这里仍要注意一点:一般方法的参数都是都是从index=2开始设置的,前两个分别是self和selector,但是blcok因为没有selector(这里没找到什么资料,仅仅是我猜测的原因),所以要从index=1开始设置。
第二个问题就很麻烦了,没有签名,也没有一个通用的类型来代表id、int、double、float等等,只能退而求其次,使用void *
,且最多支持4个参数,这点和JSPatch遇到的问题一样。这样block就有很大的限制了,但是看起来也是够用了。
数据结构
@protocol IPIntructionArgumentModelProtocol<NSObject>
@property (nonatomic, copy) NSString *type;
@property (nonatomic, copy) NSString *valueKey;
@property (nonatomic, copy) NSString *stringValue;
@property (nonatomic, assign) double digital;
@property (nonatomic, copy) NSString *digitalType;
@property (nonatomic, copy) NSArray *blockParameterTypes;
@property (nonatomic, copy) NSString *blockParameterPrefix;
@property (nonatomic, copy) NSArray<id<IPIntructionMessageModelProtocol>> *innerMessage;
@end
@protocol IPIntructionMessageModelProtocol<NSObject>
@property (nonatomic, copy) NSString *returnType;
@property (nonatomic, copy) NSString *returnObj;
@property (nonatomic, copy) NSString *receiver;
@property (nonatomic, copy) NSString *message;
@property (nonatomic, assign) BOOL isStatic;
@property (nonatomic, assign) BOOL isBlock;
@property (nonatomic, assign) BOOL isIfSnippet;
@property (nonatomic, assign) BOOL isWhileSnippet;
@property (nonatomic, assign) BOOL isReturnSnippet;
@property (nonatomic, assign) NSInteger environmentPoolRefCount;
@property (nonatomic, copy) NSString *blockKey;
@property (nonatomic, copy) NSArray<id<IPIntructionArgumentModelProtocol>> *args;
@end
@protocol IPIntructionMethodModelProtocol<NSObject>
@property (nonatomic, copy) NSString *method;
@property (nonatomic, assign) BOOL isStatic;
@property (nonatomic, assign) BOOL isMsgForwardStret;
@property (nonatomic, copy) NSArray<id<IPIntructionMessageModelProtocol>> *messages;
@end
@protocol IPIntructionClassModelProtocol<NSObject>
@property (nonatomic, copy) NSString *cls;
@property (nonatomic, copy) NSArray<id<IPIntructionMethodModelProtocol>> *methodList;
@end
@protocol IPIntructionModelProtocol<NSObject>
@property (nonatomic, copy) NSArray<id<IPIntructionClassModelProtocol>> *instructions;
@end
IPIntructionArgumentModelProtocol
这里有个innerMessage
,这是实现block
、if-else
、while
的关键,在代码实现上其实就是递归调用,借助环境池,使每次调用都能捕获上一层的变量。
TODO
- 一个自动生成json文件的脚本,提高代码可读性,更接近OC
- 更友好方式去支持自定义Model
- 支持GCD
- 支持更多除了if-else、while的基本语法,并实现热插拔
......
总结
大致思路说完了,单测测例、技术细节处理在慢慢完善中,整体实现也非常简单。这里多说一句,热修复已经被苹果一棒子打死了,现在在用的一些热修复框架也是主要是靠绕过苹果审核,但是我没找到很好的介绍苹果审核手段相关技术文章,求!
开源地址:InstructionPatch
网友评论