美文网首页ReactNative
iOS CodePush热更新

iOS CodePush热更新

作者: percivals | 来源:发表于2018-05-11 10:17 被阅读0次

最近在研究热更新的相关内容,看了很多文档,或多或少都有不少的坑没有解释清楚,无法走通,就自己总结了下相关的集成和使用流程,亲测可用

关于CodePush集成之前的准备工作,React native的集成和使用见文档 https://www.jianshu.com/p/142d153a0377

CodePush简介

CodePush 是微软提供的一套用于热更新 React Native 和 Cordova 应用的服务。

CodePush 是提供给 React Native 和 Cordova 开发者直接部署移动应用更新给用户设备的云服务。CodePush 作为一个中央仓库,开发者可以推送更新 (JS, HTML, CSS and images),应用可以从客户端 SDK 里面查询更新。CodePush 可以让应用有更多的可确定性,也可以让你直接接触用户群。在修复一些小问题和添加新特性的时候,不需要经过二进制打包,可以直接推送代码进行实时更新。

一、安装CodePush

  1. 安装codepush客户端
npm install -g code-push-cli

检查是否安装成功: code-push -v

查看历史版本: npm view npm versions

如果一直安装失败,考虑用 cnpm install -g code-push-cli安装,未安装cnpm使用 cnpm install -g rnpm 安装

2.注册codePush账号,获取access key

code-push register  在打开的浏览器中完成注册工作,会得到一串钥匙串,保存下来

3.使用获取到的access key进行登录

code-push login

成功后你的 session 文件将会写在 /Users/你的用户名/.code-push.config

相关命令:

npm install -g code-push-cli //安装codepush客户端

code-push register  //注册codepush账号

code-push login //登录

code-push loout //注销

code-push access-key ls     //列出登陆的token

code-push access-key rm <accessKye> //删除某个 access-key

4.在CodePush服务器注册app

code-push app add <appName>

或者  code-push app add <appName> <os> <platform> 

例:code-push app add appName   或  code-push app add appName ios react-native

注册成功之后会返回一套 deployment key 给你,生产环境和开发环境的

PS:相关命令

code-push app add 在账号里面添加一个新的 App
code-push app remove 或者 rm 在账号里移除一个 App
code-push app rename 重命名一个存在 App
code-push app list 或则 ls 列出账号下面的所有 App
code-push app transfer 把 App 的所有权转移到另外一个账号

二、项目中集成CodePush

找到项目中的node_modules文件夹,进入到与该文件夹同级的路径下,执行指令

npm install --save react-native-code-push

此时会在node_modules文件夹中生成react-native-code-push文件夹

CodePush官方提供RNPM、CocoaPods与手动三种在iOS项目中集成CodePush的方式,任选其一,如果不行可以尝试另外的方法

1.RNPM

找到项目中的node_modules文件夹,进入到与该文件夹同级的路径下,通过命令自动在 iOS 中链接、配置好设置: 

** React Native v0.27 版本开始使用 : react-native link react-native-code-push

** 版本低于 v0.27 的 React Native使用 : rnpm link react-native-code-push

如果需要安装 RNPM :  npm i -g rnpm

按提示填入获取到的deployment key - Staging 完成配置

2.CocoaPods

在Podfile文件中添加:

pod 'CodePush', :path => '../node_modules/react-native-code-push'//路径根据自己的文件目录修改

安装 :  pod install 

需要继续完成配置

1.打开调用main.jsbundle文件的地方,一般在AppDelegate.m 文件,并引入 CodePush 头文件:
#import <CodePush/CodePush.h>

2.找到以下代码行:
jsCodeLocation = [[NSBundle mainBundle] URLForResource:@"main" withExtension:@"jsbundle"]; 

3.将其替换为此行:
jsCodeLocation = [CodePush bundleURL];

此更改将应用配置为始终加载应用的  jsbundle的最新版本 。在通过 CodePush 推送更新前,他只会使用应用程序编译的文件。但是,在通过 CodePush 推送更新后,它将返回最近安装更新的位置。

注意:
该 bundleURL 方法假定应用程序的 jsbundle 为默认的 main.jsbundle 。如果你更改了应用程序 jsbundle 的文件名,则只需调用方法 bundleURLForResource:或 bundleURLForResource:withExtension: 以覆盖默认的行为。

关于jsbundle文件的生成可以参考文档 https://www.jianshu.com/p/142d153a0377

 建议使用 DEBUG 宏预处理器,实现在开发模式下调试 和 在生产模式下使用 CodePush 热更新之间动态切换。具体代码如下:

NSURL *jsCodeLocation;

ifdef DEBUG

    jsCodeLocation = [[RCTBundleURLProvider sharedSettings]     jsBundleURLForBundleRoot:@"index.ios" fallbackResource:nil];
    
else
    jsCodeLocation = [CodePush bundleURL];
endif   

4.找到项目的 Project栏 -> info

在 Configurations 节点下面点击 +,选择 Duplicate “Release”,输入Staging

再点击 +,选择 Duplicate “Debug”,输入Production

5.选择 Build Settings 单击Levels与搜索框之间的 “+” (如果没有发现,记得拉伸xcode的宽度,可能因为宽度不够隐藏了), 然后选择添加 User-Defined Setting,输入 CODEPUSH_KEY

展开CODEPUSH_KEY,配置对应的Deployment Key,对应值为 CodePush CLI注册app时申请获得的Deployment Key,可以通过code-push deployment ls <appName> -k 查询

6.在应用程序Info.plist文件中添加 CodePushDeploymentKey,对应值为 $(CODEPUSH_KEY)

3.手动集成

1.在 Xcode 中打开应用项目,将工程文件目录下 "../node_modules/react-native-code-push/ios" 中的 "CodePush.xcodeproj" 文件拖动到 Xcode 工程节点 Libraries 里;

2.在 Xcode 中选择项目节点,并选择项目配置的 "Build Phases" 选项卡;

   从 "Libraries/CodePush.xcodeproj/Products" 拖动 "libCodePush.a" 到项目"Build Phases" 的 "Link Binary With Libraries";

   单击 "Link Binary With Libraries" 列表下方的加号,添加 "libz.tbd";

3. 需要继续完成配置,步骤与上述CocoaPods配置步骤一致

三、设置更新控制策略

在使用CodePush更新你的应用之前需要,先配置一下更新控制策略,即:

  • 什么时候检查更新?(在APP启动的时候?在设置页面添加一个检查更新按钮?)
  • 什么时候可以更新,如何将更新呈现给终端用户?

最简单的方式是在根component中进行上述策略控制。

import codePush from 'react-native-code-push'
class MyApp extends Component {
       componentDidMount() {
             codePush.sync({updateDialog:{title:"An update is available!"}});
       }
}

如果可以进行更新,CodePush会在后台静默地将更新下载到本地,等待APP下一次启动的时候应用更新,以确保用户看到的是最新版本。注意修改MyApp为项目名。

如果更新是强制性的,更新文件下载好之后会立即进行更新。

如果你期望更及时的获得更新,可以在每次APP从后台进入前台的时候去主动的检查更新:

在应用的根component的componentDidMount中添加如下代码:

import codePush from 'react-native-code-push'

class MyApp extends Component {

    componentDidMount() {
            AppState.addEventListener("change", (newState) => {
newState === "active" && codePush.sync();
        });
    }
}

或者:

let codePushOptions = { checkFrequency: codePush.CheckFrequency.ON_APP_RESUME };

class MyApp extends Component {

}

MyApp = codePush(codePushOptions)(MyApp);

注意修改MyApp为项目名。

四、发布更新

1.简单方式:(将打包与发布两个命令合二为一,建议使用)

基本用法:

code-push release-react <appName> <platform>

eg:

code-push release-react ReactNativeTestDemo ios # iOS版

code-push release-react ReactNativeTestDemo android #Android版

命令后面可以带上各种参数来控制更新的版本、是否强制更新等等,更多参数可以在终端输入code-push release-react进行查看

具体可参照官方文档:https://www.npmjs.com/package/code-push-cli

遇到的问题:

[Error]  Unable to find either of the following plist files in order to infer your app's binary version: "ios/ReactNativeTestDemo/Info.plist", "ios/Info.plist". If your plist has a different name, or is located in a different directory, consider using either the "--plistFile" or "--plistFilePrefix" parameters to help inform the CLI how to find it.

解析:找不到plist文件所在位置,通过添加参数来解决 -p代表info.plist文件  

--mandatory  代表强制更新

code-push release-react ReactNativeTestDemo ios -p "./ReactNativeTestDemo/Info.plist" --mandatory

**注意info.plist文件里的版本号要与需要热更新的app版本一致
   

2.复杂方式:先需要打包才能发布

   首先将 js 与 图片资源 打包成 bundle,再通过命令 code-push release 发布

   打包bundle  
   
   cd 到工程目录,新增 bundles 文件夹
   
   $ mkdir bundles
   
   运行命令打包
   
    $ react-native bundle --platform <平台> --entry-file <启动文件> --bundle-output <打包js输出文件> --assets-dest <资源输出目录> --dev <是否调试>

   eg:

   $ react-native bundle --platform ios --entry-file index.ios.js --bundle-output ./bundles/index.ios.bundle --dev false

发布更新 

 $ code-push release <应用名称> <bundle所在目录> <对应的应用版本> -d <更新环境> --des <更新描述说明> -m <是否强制更新>

   eg:

   $ code-push release CodePushDemo-ios ./bundles/index.ios.bundle 1.0.0 -d Production  --des "更新描述说明" -m true

<对应的应用版本> 为 app 的版本号,不是 CodePush 所更新的 js 的版本号
   -d <更新环境> 默认值是更新 staging 环境的

3.可以通过code-push deployment ls <appName> -k 查询发布状态

五.其他命令

1.code-push 账号管理 相关命令

# 注册
$ code-push register

# 登录
$ code-push login
$ code-push login http://服务器IP:3000

# 注销
$ code-push logout

# 当前登录账号
$ code-push whoami

# 列出登录的 token
$ code-push access-key ls 

# 删除某个 key 值
$ code-push access-key rm <accessKye>

2.code-push app 相关命令

# 添加 app
$ code-push app add <appName>

# 重命名 app
$ code-push app rename <appName> <newAppName>

# 移除 app
$ code-push app remove <appName>

# 列出所有 app
$ code-push app list

# app 所有权转移
$ code-push app transfer <appName> <newOwnerEmail>

3.code-push deployment 相关命令

# 添加部署环境
$ code-push deployment add <appName> <deploymentName>

# 重命名部署环境名称
$ code-push deployment rename <appName> <deploymentName> <newDeploymentName>

# 删除部署环境
$ code-push deployment rm <appName> <deploymentName>

# 列出应用的所有部署环境
$ code-push deployment ls <appName>

# 列出应用的所有部署环境及 key
$ code-push deployment ls <appName> -k 

# 查看历史版本(Production 或者 Staging) 
$ code-push deployment history <appName> <deploymentName>

# 清除某个部署环境的更新记录
$ code-push deployment clear <appName> <deploymentName>
  • 更多命令,可以在终端输入 code-push 进行查看

参考:

https://www.jianshu.com/p/19f23d66286f

https://www.jianshu.com/p/7e6c3edce494

https://www.jianshu.com/p/9e3b4a133bcc

https://www.jianshu.com/p/88532d265202

https://www.jianshu.com/p/c979024dc62c

相关文章

网友评论

    本文标题:iOS CodePush热更新

    本文链接:https://www.haomeiwen.com/subject/nznxdftx.html