1
2
3
4
cordova create testHotCodePush com.examplde.testhotcodepush testHotCodePush
cd testHotCodePush
cordova platform add ios

1
2
npm install cordova-hot-code-push-cli -g

1
2
cordova plugin add cordova-hot-code-push-plugin

1
2
cordova-hcp init

1
2
3
4
5
6
7
<chcp>
	<auto-download enabled="true" />
    <auto-install enabled="true" />
    <native-interface version="1" />
    <config-file url="这里写服务器chcp.json的地址" />
</chcp>

1
2
cordova-hcp build

1
2
npm install serve -g

1
2
serve -p 8080

1
2
cordova-hcp build

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
pluginNativeMethod = {
    // 初始化
    INITIALIZE: 'jsInitPlugin',
    // 下载更新
    FETCH_UPDATE: 'jsFetchUpdate',
    // 安装更新
    INSTALL_UPDATE: 'jsInstallUpdate',
    // 修改热更新配置
    CONFIGURE: 'jsConfigure',
    // 请求用户更新
    REQUEST_APP_UPDATE: 'jsRequestAppUpdate',
    // 是否有更新需安装
    IS_UPDATE_AVAILABLE_FOR_INSTALLATION: 'jsIsUpdateAvailableForInstallation',
    // 获取版本信息（APP版本、build版本、当前版本、上一个版本、准备安装的版本等）
    GET_INFO: 'jsGetVersionInfo'
  };

1
2
3
4
5
6
7
8
9
10
document.addEventListener(chcp.event.UPDATE_LOAD_FAILED, this.onUpdateLoadFailed, false)

onUpdateLoadFailed(eventData){
    let error = eventData.detail.error
    if(error && error.code == chcp.error.APPLICATION_BUILD_VERSION_TOO_LOW) {
        // 需要重新下载应用安装，更新原生代码
        console.log("应用版本过低，需升级")
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
error: {
    NOTHING_TO_INSTALL: 1,
    NOTHING_TO_UPDATE: 2,

    FAILED_TO_DOWNLOAD_APPLICATION_CONFIG: -1,
    APPLICATION_BUILD_VERSION_TOO_LOW: -2,
    FAILED_TO_DOWNLOAD_CONTENT_MANIFEST: -3,
    FAILED_TO_DOWNLOAD_UPDATE_FILES: -4,
    FAILED_TO_MOVE_LOADED_FILES_TO_INSTALLATION_FOLDER: -5,
    UPDATE_IS_INVALID: -6,
    FAILED_TO_COPY_FILES_FROM_PREVIOUS_RELEASE: -7,
    FAILED_TO_COPY_NEW_CONTENT_FILES: -8,
    LOCAL_VERSION_OF_APPLICATION_CONFIG_NOT_FOUND: -9,
    LOCAL_VERSION_OF_MANIFEST_NOT_FOUND: -10,
    LOADED_VERSION_OF_APPLICATION_CONFIG_NOT_FOUND: -11,
    LOADED_VERSION_OF_MANIFEST_NOT_FOUND: -12,
    FAILED_TO_INSTALL_ASSETS_ON_EXTERNAL_STORAGE: -13,
    CANT_INSTALL_WHILE_DOWNLOAD_IN_PROGRESS: -14,
    CANT_DOWNLOAD_UPDATE_WHILE_INSTALLATION_IN_PROGRESS: -15,
    INSTALLATION_ALREADY_IN_PROGRESS: -16,
    DOWNLOAD_ALREADY_IN_PROGRESS: -17,
    ASSETS_FOLDER_IN_NOT_YET_INSTALLED: -18,
    NEW_APPLICATION_CONFIG_IS_INVALID: -19
  },

// Plugin events
  event: {
    BEFORE_ASSETS_INSTALLATION: 'chcp_beforeAssetsInstalledOnExternalStorage',
    ASSETS_INSTALLATION_FAILED: 'chcp_assetsInstallationError',
    ASSETS_INSTALLED: 'chcp_assetsInstalledOnExternalStorage',

    NOTHING_TO_UPDATE: 'chcp_nothingToUpdate',
    UPDATE_LOAD_FAILED: 'chcp_updateLoadFailed',
    UPDATE_IS_READY_TO_INSTALL: 'chcp_updateIsReadyToInstall',

    BEFORE_UPDATE_INSTALLATION: 'chcp_beforeInstall',
    UPDATE_INSTALLATION_FAILED: 'chcp_updateInstallFailed',
    UPDATE_INSTALLED: 'chcp_updateInstalled',
    NOTHING_TO_INSTALL: 'chcp_nothingToInstall'
  },

1
2
3
4
5
6
7
8
// chcp.js 
channel.onCordovaReady.subscribe(function() {
  // 初始化 js Event
  ensureCustomEventExists();
  // 执行Native端 jsInitPlugin 接口
  exec(nativeCallback, null, PLUGIN_NAME, pluginNativeMethod.INITIALIZE, []);
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// HCPPlugin.m
-(void)pluginInitialize {
	// 插件的变量的初始化，如xml配置、文件结构等
    [self doLocalInit];
    // NSNotification 方式添加应用回到前台的监听看是否需要安装更新、以及下载和安装事件的监听
    [self subscribeToEvents];
    
    // install www folder if it is needed
    if ([self isWWwFolderNeedsToBeInstalled]) {
        [self installWwwFolder];
        return;
    }
    
    // cleanup file system: remove older releases, except current and the previous one
    [self cleanupFileSystemFromOldReleases];
    
    _isPluginReadyForWork = YES;
    [self resetIndexPageToExternalStorage];
    [self loadApplicationConfig];
    
    // install update if any exists
    if (_pluginXmlConfig.isUpdatesAutoInstallationAllowed &&
        _pluginInternalPrefs.readyForInstallationReleaseVersionName.length > 0) {
        [self _installUpdate:nil];
    }
}

1
2
3
4
5
6
7
// HCPPlugin.m
- (void)jsInitPlugin:(CDVInvokedUrlCommand *)command {
	...
	[self _fetchUpdate:nil withOptions:nil];
	...
}

1
2
3
4
5
6
- (BOOL)_fetchUpdate:(NSString *)callbackId withOptions:(HCPFetchUpdateOptions *)options {
	...
	[[HCPUpdateLoader sharedInstance] executeDownloadRequest:request error:&error];
	...
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// HCPUpdateLoaderWorker.m
- (void)runWithComplitionBlock:(void (^)(void))updateLoaderComplitionBlock {
	...
	[self notifyUpdateDownloadSuccess:newAppConfig];
	...
}

/**
 *  发送通知，下载已完成，可以进行安装操作
 *
 *  @param config application config that was used for download
 */
- (void)notifyUpdateDownloadSuccess:(HCPApplicationConfig *)config {
    if (_complitionBlock) {
        _complitionBlock();
    }
    
    NSNotification *notification = [HCPEvents notificationWithName:kHCPUpdateIsReadyForInstallationEvent applicationConfig:config taskId:self.workerId];
    
    [[NSNotificationCenter defaultCenter] postNotification:notification];
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
// HCPPlugin.m
/**
 *  Method is called when update is loaded and ready for installation.
 *
 *  @param notification captured notification with event details
 */
- (void)onUpdateIsReadyForInstallation:(NSNotification *)notification {
    ...
    // send notification to the associated callback
    CDVPluginResult *pluginResult = [CDVPluginResult pluginResultForNotification:notification];
    if (_downloadCallback) {
        [self.commandDelegate sendPluginResult:pluginResult callbackId:_downloadCallback];
        _downloadCallback = nil;
    }
    
    // send notification to the default callback
    [self invokeDefaultCallbackWithMessage:pluginResult];
    
    // 如果更新策略为 now，立即更新
    if (_pluginXmlConfig.isUpdatesAutoInstallationAllowed &&
        newConfig.contentConfig.updateTime == HCPUpdateNow &&
        ![HCPUpdateLoader sharedInstance].isDownloadInProgress &&
        ![HCPUpdateInstaller sharedInstance].isInstallationInProgress) {
        [self _installUpdate:nil];
    }
}
/**
 *  通知 JS 模块发生的事件. 
 *  For that we will use callback, received on plugin initialization stage.
 *
 *  @param result message to send to web side
 *  @return YES - 返回web页面; NO - otherwise
 */
- (BOOL)invokeDefaultCallbackWithMessage:(CDVPluginResult *)result {
    ...
    [self.commandDelegate sendPluginResult:result callbackId:_defaultCallbackID];
    
    return YES;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
//  HCPFilesStructure.h

#import <Foundation/Foundation.h>

/**
 *  Model for plugins file structure.
 *  Each release has it's own folder, so we need to initialize this object with release version.
 *  每一个版本都有自己的文件夹，我们需要为新的版本初始化这个对象。
 *  
 *  @see HCPFileStructure
 */
@interface HCPFilesStructure : NSObject

/**
 *  Constructor.
 *
 *  @param releaseVersion for what version this file structure
 *
 *  @return object instance
 */
- (instancetype)initWithReleaseVersion:(NSString *)releaseVersion;

/**
 *  Absolute path to plugins working directory.
 */
@property (nonatomic, strong, readonly) NSURL *contentFolder;

/**
 *  Absolute path to the folder on the external storage where all web content is placed.
 *  From this folder we will show web pages.
 *  Think of this as an bundle folder on the external storage.
 */
@property (nonatomic, strong, readonly) NSURL *wwwFolder;

/**
 *  Absolute path to the temporary folder where we will put files during the update download.
 *  放置下载文件的临时文件夹
 */
@property (nonatomic, strong, readonly) NSURL *downloadFolder;

/**
 *  Getter for the name of the application config file.
 */
@property (nonatomic, strong, readonly) NSString *configFileName;

/**
 *  Getter for the name of the manifest file.
 */
@property (nonatomic, strong, readonly) NSString *manifestFileName;

/**
 *  Get root folder for this plugin. 
 *  In it all releases are located.
 *  对应文件夹为：
 *  Library/Application Support/APP对应的bundle id/cordova-hot-code-push-plugin
 *
 *  @return url on the external storage to the plugins root folder.
 */
+ (NSURL *)pluginRootFolder;

/**
 *  Default application config file name.
 *  Should be equal to the config name, that is bundled with the app.
 *
 *  @return default application config file name.
 */
+ (NSString *)defaultConfigFileName;

/**
 *  Default name of the manifest file.
 *  Should be equal to the manifest name, that is bundled with the app.
 *
 *  @return default manifest file name.
 */
+ (NSString *)defaultManifestFileName;

@end

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
// HCPUpdateLoaderWorker.m
- (void)runWithComplitionBlock:(void (^)(void))updateLoaderComplitionBlock {
    _complitionBlock = updateLoaderComplitionBlock;
    
    // initialize before the run
    NSError *error = nil;
    // 加载本地配置文件
    if (![self loadLocalConfigs:&error]) {
        [self notifyWithError:error applicationConfig:nil];
        return;
    }
    
    HCPDataDownloader *configDownloader = [[HCPDataDownloader alloc] init];
    
    // 读取服务器上的chcp.json ，内部实现是用的 NSURLSession
    [configDownloader downloadDataFromUrl:_configURL requestHeaders:_requestHeaders completionBlock:^(NSData *data, NSError *error) {
        HCPApplicationConfig *newAppConfig = [self getApplicationConfigFromData:data error:&error];
        if (newAppConfig == nil) {
            // 获取新的配置为空，说明下载失败，返回通知给HCPPlugin，HCPPlugin会发送对应事件给js端
            [self notifyWithError:[NSError errorWithCode:kHCPFailedToDownloadApplicationConfigErrorCode descriptionFromError:error]
                applicationConfig:nil];
            return;
        }
        
        // 检查是否有更新
        if ([newAppConfig.contentConfig.releaseVersion isEqualToString:_oldAppConfig.contentConfig.releaseVersion]) {
            [self notifyNothingToUpdate:newAppConfig];
            return;
        }
        
        // 检查当前原生代码版本是否支持新的资源内容
        if (newAppConfig.contentConfig.minimumNativeVersion > _nativeInterfaceVersion) {
            [self notifyWithError:[NSError errorWithCode:kHCPApplicationBuildVersionTooLowErrorCode
                                             description:@"Application build version is too low for this update"]
                applicationConfig:newAppConfig];
            return;
        }
        
        // 读取服务器上的chcp.manifest
        NSURL *manifestFileURL = [newAppConfig.contentConfig.contentURL URLByAppendingPathComponent:_pluginFiles.manifestFileName];
        [configDownloader downloadDataFromUrl:manifestFileURL requestHeaders:_requestHeaders completionBlock:^(NSData *data, NSError *error) {
            HCPContentManifest *newManifest = [self getManifestConfigFromData:data error:&error];
            if (newManifest == nil) {
                // 获取chcp.manifest为空，说明下载失败，返回通知给HCPPlugin，HCPPlugin会发送对应事件给js端
                [self notifyWithError:[NSError errorWithCode:kHCPFailedToDownloadContentManifestErrorCode
                                        descriptionFromError:error]
                    applicationConfig:newAppConfig];
                return;
            }
            
            // 对比服务器下载的和本地的manifest，看是否有文件修改，
            // manifestDiff 有四个变量 updateFileList（包含新增和修改的文件）、deletedFiles（新版本删除的文件）、addedFiles（新增）、changedFiles（修改）；
            // 其中 addedFiles、changedFiles 只是赋值，并未使用
            HCPManifestDiff *manifestDiff = [_oldManifest calculateDifference:newManifest];
            if (manifestDiff.isEmpty) {
                // 如果没有文件修改，将新的chcp.json 和 chcp.manifest 存到本地，发送无更新通知给HCPPlugin，HCPPlugin会发送对应事件给js端
                [_manifestStorage store:newManifest inFolder:_pluginFiles.wwwFolder];
                [_appConfigStorage store:newAppConfig inFolder:_pluginFiles.wwwFolder];
                [self notifyNothingToUpdate:newAppConfig];
                return;
            }
            
            // switch file structure to new release
            _pluginFiles = [[HCPFilesStructure alloc] initWithReleaseVersion:newAppConfig.contentConfig.releaseVersion];
            
            // 创建 downloadFolder
            [self createNewReleaseDownloadFolder:_pluginFiles.downloadFolder];
            
            // 如果有文件新增或更新，就下载对应的文件到 downloadFolder，
            // 并将服务器的chcp.json 和 chcp.manifest 存到downloadFolder，发送下载成功通知给HCPPlugin，HCPPlugin会发送对应事件给js端
            NSArray *updatedFiles = manifestDiff.updateFileList;
            if (updatedFiles.count > 0) {
                // 具体的下载可参考 HCPFileDownloader.m,是调用 NSSession 的 downloadTaskWithURL
                [self downloadUpdatedFiles:updatedFiles appConfig:newAppConfig manifest:newManifest];
                return;
            }
            
            // 否则 - 只有需要删除的文件;
            // 将服务器的chcp.json 和 chcp.manifest 存到downloadFolder，发送下载成功通知给HCPPlugin，HCPPlugin会发送对应事件给js端
            [_manifestStorage store:newManifest inFolder:_pluginFiles.downloadFolder];
            [_appConfigStorage store:newAppConfig inFolder:_pluginFiles.downloadFolder];
            
            [self notifyUpdateDownloadSuccess:newAppConfig];
        }];
    }];
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
// HCPPlugin.m
/**
 *  Method is called when update is loaded and ready for installation.
 *
 *  @param notification captured notification with event details
 */
- (void)onUpdateIsReadyForInstallation:(NSNotification *)notification {
    // new application config from server
    HCPApplicationConfig *newConfig = notification.userInfo[kHCPEventUserInfoApplicationConfigKey];
    
    NSLog(@"Update is ready for installation: %@", newConfig.contentConfig.releaseVersion);
    
    // 将版本信息保存到 NSUserDefault
    _pluginInternalPrefs.readyForInstallationReleaseVersionName = newConfig.contentConfig.releaseVersion;
    [_pluginInternalPrefs saveToUserDefaults];
    
    // send notification to the associated callback
    CDVPluginResult *pluginResult = [CDVPluginResult pluginResultForNotification:notification];
    if (_downloadCallback) {
        [self.commandDelegate sendPluginResult:pluginResult callbackId:_downloadCallback];
        _downloadCallback = nil;
    }
    
    // 发送回调给js
    [self invokeDefaultCallbackWithMessage:pluginResult];
    
    // 如果自动更新为 YES 并且 update method设置为 now，直接更新
    if (_pluginXmlConfig.isUpdatesAutoInstallationAllowed &&
        newConfig.contentConfig.updateTime == HCPUpdateNow &&
        ![HCPUpdateLoader sharedInstance].isDownloadInProgress &&
        ![HCPUpdateInstaller sharedInstance].isInstallationInProgress) {
        [self _installUpdate:nil];
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
// HCPInstallationWorker.m
...
// 下面的注释以新版本和旧版本代指
HCPFilesStructure *_newReleaseFS; // 服务器上新版本的文件结构
HCPFilesStructure *_currentReleaseFS; // 当前设备上正在使用的版本的文件结构
...
- (void)runWithComplitionBlock:(void (^)(void))updateInstallationComplitionBlock {
    // 安装前，返回到js event
    [self dispatchBeforeInstallEvent];

    NSError *error = nil;
    // 操作主要在 if 条件中
    // initBeforeRun 查看新旧配置文件是否都在
    // isUpdateValid 确认更新文件是否存在、更新文件的hash是否与chcp.manifest中的一致
    // copyFilesFromCurrentReleaseToNewRelease 将旧版本 wwwFolder的内容 复制到 新版本 的wwwFolder
    // deleteUnusedFiles 删除新版本没有的文件
    // moveDownloadedFilesToWwwFolder 将需要新增或更新的文件从 新版本的 downloadFolder 复制到 新版本的 wwwFolder
    if (![self initBeforeRun:&error] ||
        ![self isUpdateValid:&error] ||
        ![self copyFilesFromCurrentReleaseToNewRelease:&error] ||
        ![self deleteUnusedFiles:&error] ||
        ![self moveDownloadedFilesToWwwFolder:&error]) {
            NSLog(@"%@. Error code %ld", [error underlyingErrorLocalizedDesription], (long)error.code);
            // 删除 新版本的 contentFolder 内容
        	[self cleanUpOnFailure];
        	// 安装失败，发送安装失败通知给HCPPlugin，HCPPlugin会发送对应事件给js端
            [self dispatchEventWithError:error];
        
            return;
    }
    // 删除 新版本的 download文件夹的内容
    [self cleanUpOnSucess];
    // 保存新版本的 chcp.json chcp.manifest 到新版本的 wwwFolder
    [self saveNewConfigsToWwwFolder];
    // 安装成功，发送安装成功通知给HCPPlugin，HCPPlugin会发送对应事件给js端
    [self dispatchSuccessEvent];
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
// HCPPlugin.m
/**
 *  Method is called when update has been installed.
 *
 *  @param notification captured notification with the event details
 */
- (void)onUpdateInstalledEvent:(NSNotification *)notification {
    // 更新appconfig
    _appConfig = notification.userInfo[kHCPEventUserInfoApplicationConfigKey];
    // 将新版本置为当前版本，旧版本置为上一个版本
    _pluginInternalPrefs.readyForInstallationReleaseVersionName = @"";
    _pluginInternalPrefs.previousReleaseVersionName = _pluginInternalPrefs.currentReleaseVersionName;
    _pluginInternalPrefs.currentReleaseVersionName = _appConfig.contentConfig.releaseVersion;
    [_pluginInternalPrefs saveToUserDefaults];
    
    _filesStructure = [[HCPFilesStructure alloc] initWithReleaseVersion:_pluginInternalPrefs.currentReleaseVersionName];
    
    CDVPluginResult *pluginResult = [CDVPluginResult pluginResultForNotification:notification];
    
    // send notification to the caller from the JavaScript side of there was any
    if (_installationCallback) {
        [self.commandDelegate sendPluginResult:pluginResult callbackId:_installationCallback];
        _installationCallback = nil;
    }
    
    // 发送回调给js
    [self invokeDefaultCallbackWithMessage:pluginResult];
    
    // 重新加载html
    [self loadURL:[self indexPageFromConfigXml]];
    // 删除旧版本文件
    [self cleanupFileSystemFromOldReleases];
}