react-native-background-job——让你的react-native项目实现后台运行

本文主要是介绍react-native-background-job——让你的react-native项目实现后台运行,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

使应用处于后台时运行JavaScript的后台任务。

即使应用程序已关闭,任务也会运行,默认情况下,也会在重新启动后继续存在。

这个库依赖于React Native的HeadlessJS ,目前只支持Android。

在本机端,它使用Firebase JobDispatcherAlarmManager

  • Firebase JobDispatcher(默认值):无法准确计划任务,并且根据Android API版本允许不同的period段。 FirebaseJobDispatcher是最节省电池效率的后向兼容调度后台任务的方式。

  • AlarmManager通过将exact设置为true :简单的propriatery实现,仅在测试时使用。 它只关心按时执行,所有其他参数都被忽略 - 重启时不会保留任务。

要求

RN 0.36+
Android API 16+ 

支持的平台

仅Android

安装


  • 下载
$ yarn add react-native-background-job
or
$ npm install react-native-background-job --save
  • 自动安装
$ react-native link react-native-background-job
  • 手动安装
  1. 打开android/app/src/main/java/[...]/MainActivity.java
    添加import com.pilloxa.backgroundjob.BackgroundJobPackage;到文件顶部的导入
    new BackgroundJobPackage()添加到MainApplication.javagetPackages()方法返回的列表中

  2. 将以下行追加到android/settings.gradle

          include ':react-native-background-job' project(':react-native-background-job').projectDir = new  File(rootProject.projectDir, '../node_modules/react-native-background-job/android') 
    
  3. 在android/app/build.gradle的依赖项块中插入以下行,并将minSdkVersion置为21:

      compile project(':react-native-background-job') 

用法


每次React Native启动时都必须注册任务,这是使用register函数完成的。 由于HeadlessJS不安装任何组件,因此register函数必须在任何类定义之外运行。

注册任务并不意味着任务已被调度,它只是通知React Native该job函数应该绑定到此jobKey。 然后使用schedule功能安排任务。 默认情况下,当应用程序位于前台时,任务不会触发 。 这是因为任务是在唯一的JavaScript线程上运行的,如果在app处于前台时运行任务,它将冻结应用程序。 通过将allowExecutionInForeground设置为true可以允许此行为。 建议不要使用它,但快速工作应该没问题。

API


register

注册任务和应该运行的功能。

必须在React Native的每次初始化时运行,并且必须在全局范围内运行,而不是在任何组件生命周期方法中运行。 仅注册任务不会安排任务。 必须按schedule才能开始运行。

参数

obj 对象obj.jobKey string任务的唯一键obj.job 函数将运行的JS函数 

例子

import BackgroundJob from 'react-native-background-job';const backgroundJob = {jobKey: "myJob",job: () => console.log("Running in background")
};BackgroundJob.register(backgroundJob);

schedule

安排一份新工作。

这只需要运行一次,而在每次初始化React Native时都必须运行register 。

参数

obj 对象obj.jobKey string用于注册的任务的唯一键,用于在后续阶段取消。obj.timeout number无论任务是否已完成,都应终止React实例的时间(以毫秒为单位)。 (可选,默认2000 )obj.period number运行任务的频率(以ms为单位)。 这个数字不准确,Android可能会修改它以节省电池。 注意:对于Android> N,最小值为900 0000(15分钟)。 (可选,默认900000 )obj.persist boolean如果任务应该在设备重启时保持obj.persist 。 (可选,默认为true )obj.override boolean此任务是否应使用相同的键替换预先存在的任务。 (可选,默认为true )obj.networkType number仅针对特定网络要求运行。 (可选,默认NETWORK_TYPE_NONE )obj.requiresCharging boolean仅在设备正在充电时运行任务(未被Android N设备预备) docs (可选,默认为false )obj.requiresDeviceIdle boolean仅在设备空闲时运行任务(未被Android N设备预备) docs (可选,默认为false )obj.exact boolean安排在提供的时间段内准确触发的任务。 请注意,这不是节能的做事方式。 (可选,默认为false )obj.allowWhileIdle boolean允许预定任务在打盹模式下执行。 (可选,默认为false )obj.allowExecutionInForeground boolean即使应用程序位于前台,也允许执行预定任务。 仅用于短期任务。 (可选,默认为false ) 

例子

import BackgroundJob from 'react-native-background-job';const backgroundJob = {jobKey: "myJob",job: () => console.log("Running in background")
};BackgroundJob.register(backgroundJob);var backgroundSchedule = {jobKey: "myJob",
}BackgroundJob.schedule(backgroundSchedule);

cancel

取消特定的工作

参数

obj 对象obj.jobKey string作业的唯一键 

例子

 import BackgroundJob from 'react-native-background-job';BackgroundJob.cancel({jobKey: 'myJob'});

cancelAll

取消所有预定作业

例子

import BackgroundJob from 'react-native-background-job';BackgroundJob.setGlobalWarnings(false);

setGlobalWarnings

设置全局警告级别

参数

warn 布尔 

例子

  import BackgroundJob from 'react-native-background-job'; BackgroundJob.setGlobalWarnings(false); 

isAppIgnoringBatteryOptimization

检查应用程序是否使用Doze优化电池,返回布尔值。

参数

callback从Android模块收到结果后,使用相应的参数callback 回调 。 

例子

import BackgroundJob from 'react-native-background-job'; 
BackgroundJob.isAppIgnoringBatteryOptimisation((error,ignoringOptimization)=>{});

参考链接

这篇关于react-native-background-job——让你的react-native项目实现后台运行的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1021621

相关文章

Spring StateMachine实现状态机使用示例详解

《SpringStateMachine实现状态机使用示例详解》本文介绍SpringStateMachine实现状态机的步骤,包括依赖导入、枚举定义、状态转移规则配置、上下文管理及服务调用示例,重点解... 目录什么是状态机使用示例什么是状态机状态机是计算机科学中的​​核心建模工具​​,用于描述对象在其生命

Spring Boot 结合 WxJava 实现文章上传微信公众号草稿箱与群发

《SpringBoot结合WxJava实现文章上传微信公众号草稿箱与群发》本文将详细介绍如何使用SpringBoot框架结合WxJava开发工具包,实现文章上传到微信公众号草稿箱以及群发功能,... 目录一、项目环境准备1.1 开发环境1.2 微信公众号准备二、Spring Boot 项目搭建2.1 创建

IntelliJ IDEA2025创建SpringBoot项目的实现步骤

《IntelliJIDEA2025创建SpringBoot项目的实现步骤》本文主要介绍了IntelliJIDEA2025创建SpringBoot项目的实现步骤,文中通过示例代码介绍的非常详细,对大家... 目录一、创建 Spring Boot 项目1. 新建项目2. 基础配置3. 选择依赖4. 生成项目5.

Linux下删除乱码文件和目录的实现方式

《Linux下删除乱码文件和目录的实现方式》:本文主要介绍Linux下删除乱码文件和目录的实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录linux下删除乱码文件和目录方法1方法2总结Linux下删除乱码文件和目录方法1使用ls -i命令找到文件或目录

SpringBoot+EasyExcel实现自定义复杂样式导入导出

《SpringBoot+EasyExcel实现自定义复杂样式导入导出》这篇文章主要为大家详细介绍了SpringBoot如何结果EasyExcel实现自定义复杂样式导入导出功能,文中的示例代码讲解详细,... 目录安装处理自定义导出复杂场景1、列不固定,动态列2、动态下拉3、自定义锁定行/列,添加密码4、合并

mybatis执行insert返回id实现详解

《mybatis执行insert返回id实现详解》MyBatis插入操作默认返回受影响行数,需通过useGeneratedKeys+keyProperty或selectKey获取主键ID,确保主键为自... 目录 两种方式获取自增 ID:1. ​​useGeneratedKeys+keyProperty(推

Spring Boot集成Druid实现数据源管理与监控的详细步骤

《SpringBoot集成Druid实现数据源管理与监控的详细步骤》本文介绍如何在SpringBoot项目中集成Druid数据库连接池,包括环境搭建、Maven依赖配置、SpringBoot配置文件... 目录1. 引言1.1 环境准备1.2 Druid介绍2. 配置Druid连接池3. 查看Druid监控

Linux在线解压jar包的实现方式

《Linux在线解压jar包的实现方式》:本文主要介绍Linux在线解压jar包的实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录linux在线解压jar包解压 jar包的步骤总结Linux在线解压jar包在 Centos 中解压 jar 包可以使用 u

c++ 类成员变量默认初始值的实现

《c++类成员变量默认初始值的实现》本文主要介绍了c++类成员变量默认初始值,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录C++类成员变量初始化c++类的变量的初始化在C++中,如果使用类成员变量时未给定其初始值,那么它将被

Qt使用QSqlDatabase连接MySQL实现增删改查功能

《Qt使用QSqlDatabase连接MySQL实现增删改查功能》这篇文章主要为大家详细介绍了Qt如何使用QSqlDatabase连接MySQL实现增删改查功能,文中的示例代码讲解详细,感兴趣的小伙伴... 目录一、创建数据表二、连接mysql数据库三、封装成一个完整的轻量级 ORM 风格类3.1 表结构