代码Push 的原生模块

[注]

比特立斯维持着自己的叉子 已停止代码Push React 原生 SDK 并投资于其长期未来.

更多细节即将到来,但与此同时,你可以期待的是:

• 发表于 @bitrise/code-push-sdk 打开 无
• 公共API仍然与其他SDK叉兼容,我们计划只扩展现有的API表面,而不去除或更改现有的API.
• 正在获取开始的指南 主位点文件,而 API 引用在此 repo 中 文件文件夹

叉子概览 :

微软/反应-内在-编码-推:关闭并存档于2025年3月31日

└─ 代码PushNext/反应Native-code-push: 后来转到 代码Magic的管理

    └─ bitrise/ react-native-code-推: 前进 页:1

原读如下:

此插件提供了客户端集成 代码Push服务,允许您在您的 React Industrial app(s) 中轻松添加动态更新体验.

• 怎么会这样?
• 支持的反应原生平台
• 支助构成部分
• 开始
  • iOS 设置
  • Android 设置
• 插件使用
  • 库存准则遵守情况
• 发布更新
• 多部署测试
  • 机器人
  • iOS系统
• 动态部署任务
• API 参考
  • Java 脚本 API
  • 参考(iOS)
  • Java API 参考 (Android)
• 调试/ 解决问题
• 示例 Apps / 启动器
• 持续整合/交付
• 类型脚本消耗

怎么会这样?

反应原生应用程序由 JavaScript 文件及任何随附文件组成 图像,它们被捆绑在一起 地铁捆绑器 并作为特定平台二进制(即: .ipa 或者说 .apk 存档). 应用程序发布后,更新JavaScript代码(如制作错误修正,添加新功能)或图像资产,需要您重新编译并再分配整个二进制,这当然包括与您正在出版的商店相关的任何审查时间.

代码Push插件帮助在终端用户面前立即获得产品改进,方法是保持您的JavaScript和图像与您向代码Push服务器发布的更新同步. 这样,你的应用程序就能从离线移动体验中获得好处,以及一旦获得副载更新的"网状"敏捷性. 这是一个双赢!

为了保证您的终端用户总是有一个功能化的应用程序版本,CodePush插件维护了上一个更新的复制件,这样,如果您不小心推了包含崩溃的更新,就可以自动回滚. 这样,你可以放心,你的新发现的发布敏捷性不会导致用户在有机会之前被屏蔽 倒车 在服务器上。 双赢!

注意: 任何产品更改, 触及本地代码( 例如修改您的本地代码) AppDelegate.m编号 :MainActivity.java 文件,添加了一个新的插件)无法通过 CodePush 发布,因此,必须通过适当的商店更新.

支持的 React 本地平台

• iOS( 7+)
• TLS 1.2相容设备上的Android(4.1+)

我们尽力保持我们的插件与之前版本的React Industrial相容,但由于平台的性质,以及发行间出现突破变化,你可能需要使用代码Push插件的特定版本,以支持你正在使用的React Industrial的准确版本. 下表概述了哪些CodePush插件版本正式支持各自的回放原生版本:

支助构成部分

当使用反应原生资产系统时(即使用 require("./foo.png") 语法),以下列表代表了支持通过CodePush更新其被引用的图像和视频的核心组件(和道具)的一组:

以下列表代表了目前不支持其资产通过CodePush更新的一组组件(和道具),因为它们依赖于静态图像和视频(即使用 { uri: "foo" } 语法 :

随着新的核心组件被发布,这些组件支持引用资产,我们将更新这个列表,以确保用户能够确切地知道他们可以期待使用CodePush更新什么.

注意: 代码Push仅在使用视频组件时工作 require 来源道具。 例如:

<Video source={require("./foo.mp4")} />

开始

一旦你遵循了通用标准 "开始" 设置 CodePush 账户的指令,您可以通过在应用程序的根目录中运行以下命令来启动 CodePush-fying 您的 React Natural app :

yarn add @bitrise/code-push-sdk

和所有其他 React Endroid 插件一样,iOS和Android的集成体验也不同,因此根据您选择的平台执行以下设置步骤. 注意,如果针对两个平台,建议为每个平台创建单独的CodePush应用程序.

如果您想了解其他项目是如何与 CodePush 合并的, 您可以查看其中的优秀 示例应用程序 由社区提供。 此外,如果你想快速熟悉 CodePush + React Industrial, 你可以检查一下 令人赞叹的开始视频 由 比拉尔·布达尼 和(或) 迪帕克·西索迪亚 。 。 。 .

注: 本指南假定您使用了 react-native init 命令以初始化您的 React 原生项目。 截至2017年3月,指挥部 create-react-native-app 也可以用来初始化一个React Industrial项目. 如果使用此命令, 请运行 npm run eject 在您的项目主目录中获取一个非常类似于什么的项目 react-native init 本来会创造的.

然后继续安装本地模块

• iOS 设置
• Android 设置

插件使用

有了CodePush插件下载和链接,你的应用程序要求CodePush从哪里得到正确的JS捆绑,唯一剩下的是将必要的代码添加到你的应用程序中来控制以下政策:

1. 何时(和多久)检查更新? (例如应用启动,在设置页面中点击按钮时,在一定固定的间隔内定期启动)

2. 当更新可用时,如何向最终用户展示?

最简单的方法是"代码Push-fy"你的应用的根部组件. 为此,您可以选择以下两个选项之一:

• 备选案文1:用 codePush 高序组件 :

  • 类组件

    import codePush from "@bitrise/code-push-sdk";
    
    class MyApp extends Component {}
    
    MyApp = codePush(MyApp);
    

  • 职能部分

    import codePush from "@bitrise/code-push-sdk";
    
    let MyApp: () => React$Node = () => {};
    
    MyApp = codePush(MyApp);
    

• 备选案文2:使用 ES7 装饰器 语法 :

  注:尚未在 Babel 6.x 中支持更新提案. 您可能需要安装并使用 bail- preset- react-native-statement-0 预选赛 预选赛 预选赛 预选赛。 。 。 .

  • 类组件

    import codePush from "@bitrise/code-push-sdk";
    
    @codePush
    class MyApp extends Component {}
    

  • 职能部分

    import codePush from "@bitrise/code-push-sdk";
    
    const MyApp: () => React$Node = () => {};
    
    export default codePush(MyApp);
    

默认情况下, CodePush 将会检查每个应用程序启动时的更新. 如果有更新可用,它将被静默地下载,并在下一次重启应用程序时安装(要么由终端用户明确,要么由OS),这保证了您的终端用户的入侵经验最少. 如果已有的更新是强制性的,则将立即安装,确保最终用户尽快得到.

如果您希望您的应用程序能更快地发现更新,您也可以选择在每次应用程序从背景恢复时与 CodePush 服务器同步.

• 类组件

  let codePushOptions = {
    checkFrequency: codePush.CheckFrequency.ON_APP_RESUME,
  };
  
  class MyApp extends Component {}
  
  MyApp = codePush(codePushOptions)(MyApp);
  

• 职能部分

  let codePushOptions = {
    checkFrequency: codePush.CheckFrequency.ON_APP_RESUME,
  };
  
  let MyApp: () => React$Node = () => {};
  
  MyApp = codePush(codePushOptions)(MyApp);
  

或者,如果想要对检查发生时进行精细控制(如按下按钮或计时间隔),可以拨打 CodePush.sync() 随时随地 SyncOptions自动检查,并指定手册 checkFrequency数字 :

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

class MyApp extends Component {
  onButtonPress() {
    codePush.sync({
      updateDialog: true,
      installMode: codePush.InstallMode.IMMEDIATE,
    });
  }

  render() {
    return (
      <View>
        <TouchableOpacity onPress={this.onButtonPress}>
          <Text>Check for updates</Text>
        </TouchableOpacity>
      </View>
    );
  }
}

MyApp = codePush(codePushOptions)(MyApp);

如果您想要显示更新确认对话框( “ 主动安装 ” ) , 在安装可用的更新时配置( 如强制立即重新启动) , 或以任何其他方式自定义更新经验 , 请参考 codePush() API 对于如何调整这一默认行为的信息参考.

注:如果使用 复数 财务报告和审定财务报表 Redux 萨加,也可以使用 反应-内生-编码-push-saga 模块,允许您自定义何时 sync 以也许更简单/更平庸的方式称呼.

用于 CNG( 持续的原住民世代) 的 expo 用户

// app.json
    "expo": {
        // ...
        "plugins": [
      [
        "@bitrise/code-push-sdk/expo",
        {
          "ios": {
            "CodePushDeploymentKey": "deployment key",
            "CodePushServerURL": "server url"
          },
          "android": {
            "CodePushDeploymentKey": "deployment key",
            "CodePushServerURL": "server url "
          }
        }
      ],
    ]
    }

目前,代码-push-cli不支持expo-cli建设. 要成功,需要将地铁.config.js制作在根目录上.

npx expo customize metro.config.js

https://docs.expo.dev/guides/ customization-metro/# 定制化

库存准则遵守情况

Android Google Play和iOS App Store都有相应的准则,在将CodePush解决方案整合到您的应用程序中之前,您应该了解这些准则.

谷歌游戏

第3段,第1行,第1行 设备和网络滥用 专题描述除了Google Play的更新机制之外,其他任何方法更新源代码都受到限制. 但这一限制并不适用于Javascript捆绑的更新.

这一限制不适用于在虚拟机中运行且对Android API有有限访问的代码(如网页视图或浏览器中的JavaScript).

这完全允许代码Push,因为它只是更新JS捆绑,无法更新本地代码部分.

应用程序存储

段 次 页 次 3.3.2 国家2015年代开始 苹果开发者程序许可协议 完全允许对 JavaScript 和资产进行空中更新 - 及其最新版本(20170605) 这里可下载 这一裁决更为宽泛:

被解释的代码可以下载到一个应用程序,但只能下载这样的代码:(a)不通过提供与提交App Store的应用程序的预期和广告目的不一致的特征或功能来改变应用程序的主要目的,(b)不为其他代码或应用程序创建商店或商店前端,(c)不绕过OS的签名,沙盒,或其他安全特征.

CodePush允许您完全遵守这些规则,只要您所推动的更新不会显著地偏离其App Store的最初批准意图.

为了进一步遵守苹果公司的准则,我们建议App Store分发的应用软件不能使用 updateDialog 选项 sync,因为 App Store 审查准则 它写道:

App不得强迫用户对App进行评分,审查App,下载其他App,或其他类似动作,以访问App的功能,内容,或使用.

情况不一定如此 updateDialog,因为它不会强迫用户下载新版本,但至少你应该知道,如果你决定显示它的话.

发布更新

一旦你的应用程序被配置并分发给用户,并且你做了一些JS或资产修改,是时候发布它们了. 建议释放他们的方法是: release-react 命令在 App Center CLI 中,它会将您的 JavaScript 文件,资产文件捆绑,并发布更新到 CodePush 服务器.

注:在开始发布更新之前,请通过运行 App Center appcenter login 命令.

在其最基本的形式中,这个命令只需要一个参数:您所有者名+"/"+app名.

appcenter codepush release-react -a <ownerName>/<appName>

appcenter codepush release-react -a <ownerName>/MyApp-iOS
appcenter codepush release-react -a <ownerName>/MyApp-Android

这个 release-react 命令允许这样简单的工作流程,因为它提供了许多明智的默认(比如生成发布捆绑,假设您的应用程序在iOS上的条目文件要么) index.ios.js 或者说 index.js) (中文(简体) ). 然而,所有这些缺省都可以根据需要量身定做,以允许增量灵活性,从而使其与大多数设想方案相适应.

# Release a mandatory update with a changelog
appcenter codepush release-react -a <ownerName>/MyApp-iOS  -m --description "Modified the header color"

# Release an update for an app that uses a non-standard entry file name, and also capture
# the sourcemap file generated by react-native bundle
appcenter codepush release-react -a <ownerName>/MyApp-iOS --entry-file MyApp.js --sourcemap-output ../maps/MyApp.map

# Release a dev Android build to just 1/4 of your end users
appcenter codepush release-react -a <ownerName>/MyApp-Android  --rollout 25 --development true

# Release an update that targets users running any 1.1.* binary, as opposed to
# limiting the update to exact version name in the build.gradle file
appcenter codepush release-react -a <ownerName>/MyApp-Android  --target-binary-version "~1.1.0"

代码Push客户端支持差异更新,所以尽管您正在发布您的JS捆绑和每次更新的资产,您的终端用户只会实际下载他们需要的文件. 服务会自动处理这个,这样你就可以专注于创建真棒的应用程序,我们可以担心优化终端用户下载.

欲了解更多详情 release-react 命令的作品,以及它所暴露的各种参数,是指 CLI 文档此外,如果你愿意处理运行 react-native bundle 因此,想要一个比 release-react中,提及 release 命令 更多细节.

如果你遇到任何问题,或有任何问题/评论/反馈,你可以把我们推入 代码推 在Reactiflux上的频道, 发电子邮件给我们 和/或检查 排除出问题 详细情况如下.

注:代码Push更新应当以除去bug模式以外的模式进行测试. 在调试模式下,React Industrial app总是下载由包机生成的JS捆,因此由CodePush下载的JS捆不适用.

多部署测试

在我们 开始中 docs, 我们用一个特定的部署密钥演示了代码Push插件的配置 。 然而,为了有效测试你的释放,你必须利用 Staging 财务报告和审定财务报表 Production 当您创建 CodePush app时自动生成的部署( 或您可能创建的任何自定义部署) 。 这样,你永远也不会向终端用户发布你一直无法验证自己的更新.

注:我们的客户端回滚功能可以帮助用户在安装导致崩溃的放出后解锁,以及服务器端回滚(即. appcenter codepush rollback),允许您在识别出错误的发布后防止额外的用户安装. 然而,很明显,如果你能防止错误的更新在最初被广泛发布,会更好.

利用 Staging 财务报告和审定财务报表 Production 部署允许您实现如下工作流程( 自定义 !) :

1. 向您发布代码Push更新 Staging 使用 appcenter codepush release-react 命令(或 appcenter codepush release 如果你需要更多的控制的话)

2. 运行您的应用程序的中继/ β构建, 同步服务器的更新, 并按预期验证其效果

3. 推动测试的释放 Staging 改为 Production 使用 appcenter codepush promote 命令

4. 运行您的应用程序的制作/ 发布构建, 同步服务器的更新, 并按预期验证其效果

注:如果想要采取更谨慎的做法,您甚至可以选择进行"分阶段推出",作为"3"的一部分,这使得您能够通过更新来减轻额外的潜在风险(就像您在"2"中的测试触碰了所有可能的设备/条件?),只向一定比例的用户提供制作更新(例如) appcenter codepush promote -a <ownerName>/<appName> -s Staging -d Production -r 20) (中文(简体) ). 然后,在等待合理的时间,看看是否有坠机报告或顾客反馈出现后,你可以通过跑步将它扩展至整个观众 appcenter codepush patch -a <ownerName>/<appName> Production -r 100。 。 。 .

你会注意到,上述步骤指的是你的应用程序的"Stage building"和"生产building". 如果您的构建过程已经生成了每个“ 环境” 的显著二进制, 那么您就不需要再读取了, 因为换出代码Push部署密钥就像处理您应用使用的任何其他服务的环境配置( 如Facebook) 。 然而,如果你在寻找实例包括示范项目)关于如何设置您的构建过程来容纳此功能,然后根据您的应用程序所选择的平台,参考以下章节:

• 机器人
• iOS系统

动态部署任务

以上章节说明了您如何利用多种代码Push部署,以便在向终端用户广泛发布之前有效测试您的更新。 然而,由于该工作流程静态地将部署任务嵌入到实际的二进制中,一个中转或生产架构只会同步与部署的更新。 在很多情况下,这已经足够了,因为你只希望你的团队,客户,利益攸关方等与你的出品前发布同步,因此,他们只需要一个能与出品同步的架构. 然而,如果想要能够进行A/B测试,或者为某些用户提供早期的应用访问,那么在运行时能够将特定的用户(或受众)动态地放入特定的部署中,可以证明是非常有用的.

为了实现这种工作流程,你只需要指定您想要当前用户在调用时同步的部署密钥 codePush 方法。 指定时, 此密钥将覆盖您的应用程序中提供的“ 默认 ” Info.plist (iOS)或 (iOS) 或 (iOS) MainActivity.java (Android)档案. 这使得您可以生产出一个用于中转或出产的构件,这种构件也可以根据需要被动态地"重定向".

// Imagine that "userProfile" is a prop that this component received
// which includes the deployment key that the current user should use.
codePush.sync({ deploymentKey: userProfile.CODEPUSH_KEY });

随着这个变化的出现,现在只需要选择您的应用程序如何决定当前用户的正确部署密钥. 在实践中,一般有两种解决办法:

1. 展示一个随时改变部署的用户可见机制. 例如,您的设置页面可以有一个切换器,用于允许“β”访问 。 这个模型如果不关心你的出品前更新的隐私,并且有权力用户可能希望按照自己的意愿(类似于克罗姆频道)选择更早(并有可能被buggy)的更新. 然而,这个解决方案将决定权交给了您的用户,这无助于您透明地进行A/B测试.

2. 将用户的服务器侧配置图附加一块元数据, 以显示他们应该同步的部署 。 默认情况下,您的应用程序只能使用二进制嵌入式密钥,但在用户认证后,您的服务器可以选择"重定向"到不同的部署,这允许您根据需要将某些用户或组逐步置于不同的部署中. 您甚至可以选择将服务器响应存储在本地存储中, 从而成为新的默认值 。 如何将密钥和用户配置文件一起存储,完全取决于您的认证解决方案(例如Auth0,Firebase,自定义 DB + REST API),但一般都相当微不足道.

注:如果需要,您也可以执行混合解决方案,允许终端用户在不同的部署之间切换,同时允许您的服务器推翻这个决定。 这样,你就有"部署解析度"的分级,可以保证你的应用程序能够自我更新出"框外",你的终端用户可以通过提前访问比特而感觉得到奖励,但是也能够根据需要运行用户的A/B测试.

由于我们建议使用 Staging 用于您更新的发布前测试的部署(如上一节所解释),使用它来对您的用户进行A/B测试,而不是允许提前访问(如上选项1所解释),这不必然是有意义的。 因此,我们建议充分利用自定义应用程序的部署,以便您可以分割您的用户,但满足您的需要。 例如,你可以创建长期甚至一次性的部署,向它发布一个应用程序的变体,然后将某些用户放入其中,看看他们是如何参与的.

// #1) Create your new deployment to hold releases of a specific app variant
appcenter codepush deployment add -a <ownerName>/<appName> test-variant-one

// #2) Target any new releases at that custom deployment
appcenter codepush release-react -a <ownerName>/<appName> -d test-variant-one

注:您部署的"安装计量"中报告的用户总数将考虑到从一个部署到另一个部署的"切换"用户. 比如说,如果你 Production 部署当前报告有1个用户,但您要动态切换该用户到 Staging,然后是 Production 部署将报告0个用户,而 Staging 将报告1(刚刚切换的用户)。 这种行为使您能够准确跟踪您的发布采纳,即使在使用以运行时间为基础的部署重定向解决方案的情况下.

API 参考

• Java 脚本 API
• 参考(iOS)
• Java API 参考 (Android)

示例 Apps / 启动器

React原住民社群慷慨地创造了一些令人赞叹的开源应用, 以下是同样使用CodePush的OSS React Introduct应用程序列表,因此可以用来查看其他人如何使用该服务:

• F8 应用程序 - 官方会议应用程序 F8 2016 (英语)。 。 。 .
• 产品猎取费 - 一个产品猎人Android客户端.
• 地理编码 - 一个应用程序由 Lynx IT 数字 说明如何使用众多的反动原生组件和模块.
• 数学事实 - 可汗学院的应用程序 帮助记忆数学事实更容易.

另外,如果你想开始使用 React Industrial + CodePush, 并且正在寻找一个很棒的启动器套件, 你应该检查以下内容:

• 帕佩罗尼

注意:如果你已经开发了使用 CodePush 的 React Industrial app,也就是开源,请告诉我们. 我们愿意加入这个名单!

调试/ 解决问题

这个 sync 方法包括很多诊断性记录出箱,所以如果你在使用时遇到一个问题,首先尝试的最好办法是检查你的应用的输出日志. 这将告诉您该应用程序是否配置正确( 类似插件能否找到您的部署密钥? ) , 如果该应用程序能够到达服务器, 如果正在发现可用的更新, 如果正在成功下载/ 安装更新等 。 我们想继续改善伐木 尽可能直观和全面 所以请 告诉我们 如果你发现它 令人困惑或缺少任何东西.

查看这些日志的最简单方式是添加旗帜 --debug 每个命令。 这将输出一个被过滤到仅 CodePush 信件的日志流 。 这使得可以很容易地确定问题,而不需要使用特定平台的工具,或者通过潜在的大量日志.

此外,您还可以使用任何平台专用工具来查看CodePush日志,如果您对它们更满意的话. 简单启动 Chrome DevTools 控制台, Xcode 控制台( iOS), 操作 OS X 控制台 (iOS)和(或)亚行的logcat(Android),并查找前缀为 [CodePush]。 。 。 .

请注意, 默认情况下, React Industrial logs 在 iOS 构建中会被禁用, 因此, 如果您想要在 发布 构建中查看它们, 您需要做以下修改 AppDelegate.m 文件 :

1. 添加一个 #import <React/RCTLog.h> 语句。 RN < v.40 用途: #import "RCTLog.h"

2. 在您的顶部添加以下语句 application:didFinishLaunchingWithOptions 方法 :

   RCTSetLogThreshold(RCTLogLevelInfo);
   

现在你可以在iOS或Android上看到调试或放出模式下的CodePush日志. 如果检查日志不能说明问题,请参考以下共同问题以补充解析想法:

持续整合/交付

除了能够使用"代码Push CLI"来"手动"发布更新之外,我们认为重要的是创造一个可重复和可持续的解决方案,以同步向您的应用程序提供更新. 这样,你和(或)你的团队就足够简单了,可以创造和维持执行敏捷部署的节奏. 为了协助建立基于CodePush的CD管线,请参考与各种CI服务器的下列集成:

• 视觉工作室团队服务 - 说吧 注:VSTS的出版范围还有: 冰球游戏 编辑 谷歌播放 因此,它提供了一个相当棒的移动 CD 解决方案在总体上.
• 崔维斯CI

另外,如果你想知道更多关于一个完整的移动 CI/CD工作流程的长相, 包括 CodePush, 请检查一下 优秀文章 编辑 Zee Mee工程队。 。 。 .

类型脚本消耗

本单元载运 *.d.ts 作为国家防范机制软件包的一部分,允许您简单地 import 它,并获得支持编辑器的智能感(如Visual Studio Code),以及编译时间类型检查是否使用TypeScript. 大部分情况下,这种行为应该只是 走出盒子,但是,如果你已经说明 es6 作为其中任一的值 target 或者说 module 编译器选项 在你身边 tsconfig.json 文件,然后确保您也设置 moduleResolution 选项到 node。这将确保 TypeScript 编译器在 node_modules 用于输入模块的类型定义。 否则,你会遇到如下错误: react-native-code-push 模块 : error TS2307: Cannot find module 'react-native-code-push'。 。 。 .

该项目通过了 Microsoft 开源行为守则。更多信息见 《行为守则》 或联系人 打开码@ microsoft.com 并附上任何其他问题或评论.