什么是热修复
热修复就是指不需要重新上架ipa包就修复线上bug的相关机制
解决问题
在我们实际开发中，可能有时候会遇到比较严重的线上bug，影响用户体验，如果修复这个问题需要修改源码，那就得重新发包审核，不能及时解决问题，而且用户还得重新安装，所以热修复就十分必要了。
风险
在没通过审核就修改线上的代码，有可能有审核不通过风险，不过有一些APP有使用，也都过审了，轻量风险系数低，不过不能确保以后Apple政策不让使用。
原理
获取下发JS代码，通过JSCore转换为OC代码，再通过Aspects把原有方法替换（前面执行、后面执行）来实现修复问题代码。
Aspects
Aspects是iOS一个高效简洁的用于AOP（面向切面编程）框架，可以替换（在前执行、在后执行）类或者实例的方法。
+ (id<AspectToken>)aspect_hookSelector:(SEL)selector
withOptions:(AspectOptions)options
usingBlock:(id)block
error:(NSError **)error;
/// Adds a block of code before/instead/after the current `selector` for a specific instance.
- (id<AspectToken>)aspect_hookSelector:(SEL)selector
withOptions:(AspectOptions)options
usingBlock:(id)block
error:(NSError **)error;
具体原理可以看我写的Aspects原理和使用
如何使用热修复
有时候js的方法、变量不能直接转为oc的，所以我们需要提前注册好一些方法，方便调用。
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// Override point for customization after application launch.
[WTCFix fix];
return YES;
}
下面介绍一些我们常遇到的方法：
修复实例方法
- (void)testInstanceMethodCrash:(NSObject *)obj{
NSMutableArray *array = [NSMutableArray array];
[array addObject:obj];
NSLog(@"testInstanceMethodCrash:%@",array);
}
WTCTestModel *test = [WTCTestModel new];
[test testInstanceMethodCrash:nil];//给数组添加nil
当我们调用了这个方法，当我们传了一个nil值进来会闪退，需要加个判断。
修复代码：
model0.js = @"fixInstanceMethod('WTCTestModel','testInstanceMethodCrash:',1,"
"function(instance, invo, args){"
"if(args[0] == null) {"
"fixError('WTCTestModel', 'testInstanceMethodCrash:');"
"} else {"
"runInvocation(invo);"
"}"
"})";
[WTCFix evalString:model0.js];//修复添加nil到数组中
fixInstanceMethod我们已经注册进去，我们evalString执行的时候，走的是下面fixMethodIsClass方法执行了方法替换，testInstanceMethodCrash的方法变成了上面js的逻辑，当调用它时，实际执行的是js里面的逻辑。
JSContext *context = [self context];
context[@"fixInstanceMethod"] = ^(NSString *className, NSString *selectorName, AspectOptions options, JSValue *fixImpl) {
[self fixMethodIsClass:NO className:className opthios:options selector:selectorName fixImp:fixImpl];
};
context[@"runInvocation"] = ^(NSInvocation *invocation) {
[invocation invoke];
};
/*
* 修复方法
* param isClassMethod 是否为类方法（+）
* param className 类名
* param options 修复方式
* param fixImp JS方法
*/
+ (void)fixMethodIsClass:(BOOL)isClassMethod
className:(NSString *)className
opthios:(AspectOptions)options
selector:(NSString *)selector
fixImp:(JSValue *)fixImp {
if(!className){
NSLog(@"WTCFIX hook className is nil.");
return;
}
Class klass = NSClassFromString(className);
if(isClassMethod){
klass = object_getClass(klass);
}
if(!klass){
NSLog(@"WTCFIX hook className: %@ is not exists.", className);
return;
}
SEL sel = NSSelectorFromString(selector);
NSError *error;
[klass aspect_hookSelector:sel withOptions:options usingBlock:^(id<AspectInfo> aspectInfo) {
[fixImp callWithArguments:@[aspectInfo.instance, aspectInfo.originalInvocation, aspectInfo.arguments]];
} error:&error];
if(error){
NSLog(@"WTCFix hook error: %@", error);
}
}
调用实例方法
我们类里面很常见调用某个实例对象的某个方法，比如下面这个方法
- (void)logInfo {
NSLog(@"log");
}
这是一个很简单的打印信息，我们把这个方法换成页面跳转。
model2.js = @"fixInstanceMethod('ViewController','logInfo',1,"
"function(instance, invo, args){"
"fixLog(instance);"
"var vc = runClassMethod('InstanceFuncVC','alloc');"
"vc = runInstanceMethod(vc,'init');"
"var nav = runInstanceMethod(instance,'navigationController');"
"runInstanceMethod(nav,'pushViewController:animated:',new Array(vc,1));"
"})";
[WTCFix evalString:model2.js];//logInfo改为跳转方法 需要注意参数''
这里有个问题，显示的调用了alloc会造成内存泄漏，这里用了内存问题解决，需要特殊处理一下返回值。
runClassMethod、runInstanceMethod都早已注册
context[@"runInstanceMethod"] = ^id(id instance, NSString *selectorName, id arguments) {
id obj = instance;
if([instance isKindOfClass:[WTCFixBox class]]){
obj = [(WTCFixBox *)instance unbox];
}
id rt = [self runWithInstance:obj selector:selectorName arguments:arguments];
return rt;
};
context[@"runClassMethod"] = ^JSValue *(NSString *className, NSString *selectorName, id arguments) {
id obj = [self runWithClassname:className selector:selectorName arguments:arguments];
return obj;
};
调用对应的类和实例方法，WTCFixBox主要是对于weak对象，后面会提到。
调用父类方法
js不能直接调用super的方法。我们可以通过给这个类新增一个方法，把父类对应实例的方法IMP指向该方法。
//调用父类的方法 原理：将父类方法的实现指向子类新增的WTCFIX_SUPER_selector方法
//https://github.com/cyanzhong/RuntimeInvoker/pull/6/commits/f50683b51bb468abfdc67df91f57525044eb41a2
+ (id)runSuperInstanceMethod:(id)instance selector:(NSString *)selector arguments:(NSArray *)arguments {
if(!instance || !selector){
DLog(@"WTCFIX runSuperMethod instance or selector is nil.");
return nil;
}
NSString *superSelectorName = [NSString stringWithFormat:@"WTCFIX_SUPER_%@", selector];
SEL superSelector = NSSelectorFromString(superSelectorName);
Class classForSuperCall = object_getClass(instance);
if (!class_respondsToSelector(classForSuperCall, superSelector)) {
Class superClass = [classForSuperCall superclass];
Method superMethod = class_getInstanceMethod(superClass, NSSelectorFromString(selector));
IMP superIMP = method_getImplementation(superMethod);
class_addMethod(classForSuperCall, superSelector, superIMP, method_getTypeEncoding(superMethod));
}
NSMethodSignature *signature = [instance methodSignatureForSelector:superSelector];
if (signature) {
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:signature];
invocation.selector = superSelector;
invocation.arguments = arguments;
[invocation invokeWithTarget:instance];
return invocation.returnValueObj;
} else {
DLog(@"WTCFIX runSuperMethod instance: %@ selector: %@ not found.", instance, selector);
return nil;
}
}
获取、设置私有成员变量
对于property变量可以通过runInstanceMethod和getter/setter结合的方式访问即可(对应
runInstanceMethod(instance, 'xxx')和runInstanceMethod(instance, 'setXxx:', value))。
对于私有成员变量的获取和设置，可以通过KVC或object_getIvar获取，但是通过object_getIvar获取，当成 员变量是某些类型(比如NSInteger类型)时会因BAD_ACCESS crash并且通过try-catch的方式也解决不了问题。 相比之下，采用KVC的方式更方便，但是如果直接使用valueForKey:和setValue:forKey:，当key不存在的时 候存在一定的crash风险。这个问题有以下四种解决办法：
- 1.重写对应类的setValue:forUndefinedKey:、setNilValueForKey:、valueForUndefineKey:方法。
- 2.swizzling NSObject类的上述三个方法。
- 3.通过try-catch捕获异常。
- 4.先通过查询对象是否存在访问器和变量，然后再调用KVC。
这里采用最简单、最小改动、非侵入式的方式3，具体实现如下，通过try-catch的方式避免carsh并且打印异常信息。不过这个对比4来说性能上面消耗更大一点，不过我们都是少量的，也不要紧。
context[@"getIvarValue"] = ^id(id instance, NSString *key) {
id obj = instance;
if([instance isKindOfClass:[WTCFixBox class]]){
obj = [(WTCFixBox *)instance unbox];
}
id rt = [self getIvarValue:obj key:key];
return rt;
};
context[@"setIvarValue"] = ^(id instance, NSString *key, id value) {
id obj = instance;
if([instance isKindOfClass:[WTCFixBox class]]){
obj = [(WTCFixBox *)instance unbox];
}
[self setIvarValue:obj key:key value:value];
};
+ (id)getIvarValue:(id)instance key:(NSString *)key{
if(!instance || !key){
DLog(@"WTCFIX KVC: getIvarValue instance or key is nil.");
return nil;
}
id obj;
@try {
obj = [instance valueForKey:key];
} @catch (NSException *exception) {
if(exception){
DLog(@"WTCFIX KVC: getIvarValue catch a exception:%@", exception);
}
} @finally {
}
return obj;
}
+ (void)setIvarValue:(id)instance key:(NSString *)key value:(id)value{
if(!instance || !key){
DLog(@"WTCFIX KVC: setIvarValue instance or key is nil");
return;
}
@try {
[instance setValue:value forKey:key];
} @catch (NSException *exception) {
if(exception){
DLog(@"WTCFIX KVC: setIvarValue catch a exception:%@", exception);
}
} @finally {
}
}
+ (void)setIvarValue:(id)instance key:(NSString *)key value:(id)value{
if(!instance || !key){
DLog(@"WTCFIX KVC: setIvarValue instance or key is nil");
return;
}
@try {
[instance setValue:value forKey:key];
} @catch (NSException *exception) {
if(exception){
DLog(@"WTCFIX KVC: setIvarValue catch a exception:%@", exception);
}
} @finally {
}
}
因此，在写热修复代码时，如果遇到要获取和设置私有成员变量的需求，一定要使用getIvarValue和
setIvarValue的方式，请不要直接使用KVC。
创建block
虽然JavaScript有function对应Native的block，但是没法通过JavaScript直接传一个function给Native就会自动转成 block来使用。
这个时候就需要FFI(外部函数接又调用库)帮我们实现一种语言调用另一种语言。利用FFI 可以动 态调用任意C函数，只要知道函数的指针、参数类型和数量以及返回值类型。
我们比如下面需要修复的代码：
- (void)requestVersionInfoWithCompleteBlock:(void(^)(NSString *version))completeBlock {
NSString *appId = @"9093234";
NSString *version = @"1.0.1";
[TestManager appVersionWithAppId:appId currentVersion:version finishBlock:^(NSString * _Nonnull version, BOOL success) {
NSArray *list = @[];
NSLog(@"-----这里会闪退--%@",list[0]);
if(completeBlock) {
completeBlock(version);
}
}];
}
这里我们设置了闪退，热修复代码如下：
model11.js = @"var completeBlock;fixInstanceMethod('ViewController','requestVersionInfoWithCompleteBlock:', 1,"
"function(instance, invo, args){"
"completeBlock = args[0];"
"var appId = '9093234';"
"var version = '1.0.1';"
"var finishBlock = createBlock('v,@','var f = function(vers, success){"
"if(completeBlock) {"
"completeBlock(vers);"
"}"
"};"
"f;');"
"runClassMethod('TestManager','appVersionWithAppId:currentVersion:finishBlock:', new Array(appId,version,finishBlock));"
"})";
[WTCFix evalString:model11.js];//生成block completeBlock必须提前申明 不然会是空的
需要注意的是completeBlock必须提前申明，不然会识别不到这个block。
弱引用和nil
nil处理：在我们项目中很多方法中允许入参是nil，在使用入参obj时也往往会做if(obj)的判断，很少做判断obj是否是null 的判断。我们的热修复方案中动态调用方法时是传入一个参数数组，然后利用NSInvocation来设置参数的。虽然 在JavaScript中用undefined对应Native的nil，但是当我们把undefined放在数组中传给Native时，因为Native不能 把nil插入数组中，JavaScritCore会帮我们把undefined自动转成NSNull对象。如果不解决这个问题，可能会导致 在修复一些方法时传入null导致类型判断和使用异常。
为了解决这个问题，又不影响确实有些地方需要传入null的逻辑，这里新定义了一个WTCFixNil类，专门用来标识 对象为nil的情况。当我们确实需要传一个nil参数时，在参数数组中插入一个WTCFixNil对象，在NSInvocation设 置参数时，加一层判断，如果遇到WTCFixNil类型就不进行设置。
可使用场景:runSuperInstanceMethod、runInstanceMethod、runClassMethod、setInvocationArguments、set InvocationArgumentAtIndex。其他像setInvocationReturnValue只需传单个参数的地方直接使用undefined 即可，不要使用WTCFixNil对象。
弱引用：我们这里把这个弱应用作为另外一个类的属性，这样不需要额外自己释放。
示例代码：
- (void)circularReference{
if(!_alertController){
self.alertController = [UIAlertController alertControllerWithTitle:nil message:@"这里有循环引用" preferredStyle:UIAlertControllerStyleAlert];
UIAlertAction *action = [UIAlertAction actionWithTitle:@"确定" style:UIAlertActionStyleCancel handler:^(UIAlertAction * _Nonnull action) {
self.view.backgroundColor = [UIColor blueColor];
}];
[_alertController addAction:action];
}
[self presentViewController:_alertController animated:YES completion:nil];
}
热修复代码：
model12.js = @"var weakVC; fixInstanceMethod('InstanceFuncVC','circularReference', 1,"
"function(instance, invo, args){"
"weakVC = __weak(instance);"
"var alert = runInstanceMethod(instance,'alertController');"
"if(!alert) {"
"var title = runClassMethod('WTCFixNil','new');"
"alert = runClassMethod('UIAlertController','alertControllerWithTitle:message:preferredStyle:', new Array(title, 'Hook去除这里的循环引用', 1));"
"var actionHandler = createBlock('v,@','var ah = function(action){"
"var view = runInstanceMethod(weakVC,\"view\");"
"var color = runClassMethod(\"UIColor\", \"redColor\");"
"runInstanceMethod(view,\"setBackgroundColor:\",color);"
"};"
"ah;');"
"var action = runClassMethod('UIAlertAction','actionWithTitle:style:handler:',new Array('确定',1,));"
"runInstanceMethod(alert,'addAction:',action);"
"}"
"var completion = runClassMethod('WTCFixNil','new');"//本身为nil作为最后一个参数可省略
"runInstanceMethod(instance,'presentViewController:animated:completion:', new Array(alert,true,completion));"
//不使用WTCFixBox，加上可以释放，但是有延迟
// weakVc = null;"
"})";
[WTCFix evalString:model12.js];//weak和nil的使用 weakVC需要提前申明 不然获取不到 这里释放VC会比较慢（需要等待一会）
需要注意的是weakVC需要提前申明，不然获取不到。这里是JS有自己的释放规则，会比较慢执行dealloc。
其他
还有GCD和struct例如CGRect、CGSize等，这里就不列了，有兴趣可以看下面的demo。
总结
能做到通过 JS 调用和改写 OC 方法最根本的原因是 Objective-C 是动态语言，OC 上所有方法的调用/类的生成都 通过 Objective-C Runtime 在运行时进行，我们可以通过类名/方法名反射得到相应的类和方法，也可以替换某个类的方法为新的实现，理论上你可以在运行时通过类名/方法名调用到任何 OC 方法，替换任何类的实现以及新增任意类。
需要注意的是：当我们需要修复线上的代码时，再下个版本立即用原生代码立即修复，并把下发的修复代码去掉。
详细可以可以看demo;
