JSPatch集成以及写js中遇到的问题

1、摘要

由于iOS应该审核周期过长，运气不好时会遇到各种被拒，有时候上传的新版�基于上版本只修改了一小部分代码，这时候完全可以用hotfix来实现。这里主要介绍：JSPatch，它是一款用于iOS开发第三方热修复引擎。

2、集成

笔者采用的是cocoapods，只需在Podfile文件中添加：pod 'JSPatch', '~> 1.1'

platform :ios, "7.0"
target :'timeLineCellList' do
pod 'Masonry'
pod 'SDWebImage'
pod 'JSPatch', '~> 1.1'
end

3、代码集成

由于可以通过js文件来调用你的任何OC方法，若js受到攻击被更改，那么会严重影响到app，这样我们肯定不能允许此类事情发生。一般在js文件提交到仓库以后后端应该对这一段js代码进行 md5或者更高手段的编码。这里，我们采用的是des加密，js文件加密后再给运营去上传到后台管理系统。我们再把下载下来的二进制文件对称解密再执行引擎即可。

• AppDelegate中集成如下

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    
    // 启动修复引擎
    [self runJSPatch];//运行补丁
    ...//其它代码
    return YES;
}
#pragma mark - 运行补丁
- (void)runJSPatch
{
    NSString *config = @"";
#if DEBUG
    config = @"debug";
#else
    config = @"release";
#endif
    
    NSInteger v = [[[NSBundle mainBundle] objectForInfoDictionaryKey:(NSString *)kCFBundleVersionKey] integerValue];//bundle内部版本号
    NSString *version = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleShortVersionString"];//发布版本号,3位如:1.1.0
    NSString *fileName = [NSString stringWithFormat:@"patch.%@.%ld.luac",version,(long)v];
    NSString *docuPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
    NSString *filepath = [docuPath stringByAppendingPathComponent:fileName];
    NSURL *url = [NSURL URLWithString:[NSString stringWithFormat:@"http://app.***.com/myapp/%@/%@",config,fileName]];
    
    
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url
                                                           cachePolicy:NSURLRequestReloadIgnoringCacheData
                                                       timeoutInterval:3];
    NSError *error;
    NSHTTPURLResponse *response;

    NSData *data = [NSURLConnection sendSynchronousRequest:request returningResponse:&response error:&error];
    
    if(!error && response.statusCode == 200)
    {
        // 写入到沙盒中
        [data writeToFile:filepath atomically:YES];//这里还可以做删除旧的，只保留最新的js文件的处理，不帖代码了。
    }
    else
    {
        data = [NSData dataWithContentsOfFile:filepath];
    }
    
    if(data)
    {
        data = [data decryptWithKey:[JSPatchEncryptKey stringOfHexString]  iv:[JSPatchEncryptIV stringOfHexString]];//des解密
        if(!error)
        {
            NSString *js = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
            if(js)
            {
                [JPEngine startEngine];
                [JPEngine evaluateScript:js];
            }
        }
    }
}

• js文件正确性测试

把下面这段代码添加到上面的方法的最前面，
NSString *jsFilePath = @"/Users/***/Desktop/release.1.1.40.js";//我这里是直接放在桌面上
NSString *js = [[NSString alloc] initWithContentsOfFile:jsFilePath encoding:NSUTF8StringEncoding error:nil];
if(js)
{
        [JPEngine startEngine];
       [JPEngine evaluateScript:js];
}
return;

• 加密给后台以供客户端下载

如果你测试上面的写的js代码没问题后，那么就手动加密，然后把加密文件给运营或后台上传到后台管理系统中，这样你就可以下载修复bug了。
//------- js加密---加密后给运营的
NSString *toEncptyPath = @"/Users/***/Desktop/release.1.1.40.js";//桌面上js路径
NSData *toEncptyData = [NSData dataWithContentsOfFile:toEncptyPath];
NSData *encptyData = [toEncptyData encryptWithKey:[JSPatchEncryptKey stringOfHexString] iv:[JSPatchEncryptIV stringOfHexString]];//des加密
// 写到桌面，到时候给运营上传到后台管理系统
[encptyData writeToFile:@"/Users/***/Desktop/release.toService.data" atomically:YES];// 写到桌面

• des加密方法

@implementation NSData (Des)

// 解密
- (NSData *)decryptWithKey:(NSString *)key iv:(NSString *)iv
{
    return [self crypto:kCCDecrypt key:key.UTF8String iv:iv.UTF8String];
}

// 加密
- (NSData *)encryptWithKey:(NSString *)key iv:(NSString *)iv
{
    return [self crypto:kCCEncrypt key:key.UTF8String iv:iv.UTF8String];
}

- (NSData *)crypto:(CCOperation)operation  key:(const char *)key iv:(const char *)iv
{
    if(!self.length)
    {
        return nil;
    }
    
    //密文长度
    size_t size = self.length + kCCKeySizeDES;
    
    Byte *buffer = (Byte *)malloc(size * sizeof(Byte));
    
    //结果的长度
    size_t numBytes = 0;
    
    //CCCrypt函数 加密/解密
    CCCryptorStatus cryptStatus = CCCrypt(
                                          operation,//  加密/解密
                                          kCCAlgorithmDES,//  加密根据哪标准（des3desaes）
                                          kCCOptionPKCS7Padding,//  选项组密码算(des:每块组加密  3DES：每块组加三同密)
                                          key,//密钥    加密解密密钥必须致
                                          kCCKeySizeDES,//  DES 密钥（kCCKeySizeDES=8）
                                          iv,//  选初始矢量
                                          self.bytes,// 数据存储单元
                                          self.length,// 数据
                                          buffer,// 用于返数据
                                          size,
                                          &numBytes
                                          );
    
    
    NSData *result = nil;
    
    if(cryptStatus == kCCSuccess)
    {
        result = [NSData dataWithBytes:buffer length:numBytes];
    }
    
    //释放指针
    free(buffer);
    
    return result;
}

@end

4、修复示例

-> JSPatch语法，官方文档讲的很清楚，点击查看中文文档
-> 一般情况下，我们使用oc自动转js工具来实现大部分修复代码，然后再自己修改一下就ok了。

下面介绍两个修改示例，在这里碰到的语法问题在5、碰到问题中会列出。

• 修改MyBeautyPlanDailyViewController控制器中viewDidLoad方法

OC方法如下:
- (void)viewDidLoad {
    [super viewDidLoad];
    self.title = @"时间轴式cell展示";
    
    _tableView = [[UITableView alloc] initWithFrame:self.view.frame style:UITableViewStylePlain];
    _tableView.separatorStyle = UITableViewCellSeparatorStyleNone;
    _tableView.dataSource = self;
    _tableView.delegate = self;
    [self.view addSubview:_tableView];
}

JS代码:
// 修改控制器中viewDidLoad方法
require('UIView,UIColor,UITableView,UITableViewStyle')
defineClass('MyBeautyPlanDailyViewController',{
            // 1、改变导航栏的标题
            viewDidLoad:function() {
                self.super().viewDidLoad();
                self.setTitle("JSPatch修改的标题");
                _tableView = UITableView.alloc().initWithFrame_style(self.view().frame(), 0);
                _tableView.setSeparatorStyle(0);//枚举变量直接用数值
                _tableView.setDataSource(self);
                _tableView.setDelegate(self);
                self.view().addSubview(_tableView);
            }        
});

• 修改BeautyDailyTableViewCell中setModel:方法

OC方法如下:
- (void)setModel:(BeautyDailyModel *)model
{
    _model = model;
    _timeLabel.text = model.time;
    
    NSMutableParagraphStyle *paragraphStyle = [[NSMutableParagraphStyle alloc]init];
    [paragraphStyle setLineSpacing:4];//调整行间距
    NSDictionary *attributes = @{NSFontAttributeName:self.contentLabel.font,NSParagraphStyleAttributeName:paragraphStyle};
    NSAttributedString *attrString = [[NSAttributedString alloc] initWithString:model.content attributes:attributes];
    _contentLabel.attributedText = attrString;
    
    if ([model.imgUrl isEqualToString:@""] || model.imgUrl == nil) {
        _recordImageView.hidden = YES;
        [_recordImageView mas_remakeConstraints:^(MASConstraintMaker *make) {
            make.top.equalTo(_contentLabel.mas_bottom).offset(10);
            make.centerX.equalTo(_contentLabel);
            make.height.width.equalTo(@0);
        }];
    } else {
        _recordImageView.hidden = NO;
        [_recordImageView setImageWithURL:[NSURL URLWithString:model.imgUrl] placeholderImage:[UIImage imageNamed:@"point"]];
        [_recordImageView mas_remakeConstraints:^(MASConstraintMaker *make) {
            make.top.equalTo(_contentLabel.mas_bottom).offset(10);
            make.centerX.equalTo(_contentLabel);
            make.height.width.equalTo(@100);
        }];
    }
    _lineView.hidden = model.isLast ? YES : NO;

}

JS代码：
// 修改cell中的setModel方法
require('NSMutableParagraphStyle,NSAttributedString,NSURL,UIImage,UIFont');
defineClass('BeautyDailyTableViewCell', {
            setModel: function(model) {
            _model = model;
            // 改日期为自己写的，不用后台返回的
            self.timeLabel().setText("JSPatch日期");// model.time()
            
            var paragraphStyle = NSMutableParagraphStyle.alloc().init();
            paragraphStyle.setLineSpacing(4); //调整行间距
            var attributes = {
            "NSFont":self.contentLabel().font(),//NSFontAttributeName-->"NSFont"
            "NSParagraphStyle": paragraphStyle// NSParagraphStyleAttributeName-->"NSParagraphStyle"
            };
            var attrString = NSAttributedString.alloc().initWithString_attributes(model.content(), attributes);
            self.contentLabel().setAttributedText(attrString);
            
            if (model.imgUrl()=="") {
            self.recordImageView().setHidden(YES);
            self.recordImageView().mas__remakeConstraints(block('MASConstraintMaker*', function(make) {
                                                         make.top().equalTo()(self.contentLabel().mas__bottom()).offset()(10);//mas_bottom()-->mas__bottom()要多加一个下划线
                                                         make.centerX().equalTo()(self.contentLabel());
                                                         make.height().width().equalTo()(0);
                                                         }));
            } else {
            self.recordImageView().setHidden(NO);
            self.recordImageView().setImageWithURL_placeholderImage(NSURL.URLWithString(model.imgUrl()), UIImage.imageNamed("point"));
            self.recordImageView().mas__remakeConstraints(block('MASConstraintMaker*', function(make) {
                                                         make.top().equalTo()(self.contentLabel().mas__bottom()).offset()(10);
                                                         make.centerX().equalTo()(self.contentLabel());
                                                         make.height().width().equalTo()(100);
                                                         }));
            }
            self.lineView().setHidden(model.isLast() ? YES : NO);
            
            },
});

5、碰到的问题

• 1、 oc中的枚举变量在js中直接报错
  我们采取直接写数值，先在oc中查看该枚举值为多少，在js中直接用int类型常量替换即可
• 2、 oc中常量字符串，如:NSFontAttributeName在js中报错
  先在oc中，用NSLog打印出该字符串常量的值，然后在js中直接写即可，例如NSFontAttributeName我们打印出来是NSFont，那么在js中写"NSFont"即可
• 3、Masonry在js中自动转换后报错
  如：mas_bottom()等，报找不到变量等，这里查看jspatch基础语法可知：若原 OC 方法名里包含下划线 _，在 JS 使用双下划线 __ 代替

本文demo地址:JSPatchFixbug-Demo

未完待续...