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

相关文章

C++中unordered_set哈希集合的实现

《C++中unordered_set哈希集合的实现》std::unordered_set是C++标准库中的无序关联容器,基于哈希表实现,具有元素唯一性和无序性特点,本文就来详细的介绍一下unorder... 目录一、概述二、头文件与命名空间三、常用方法与示例1. 构造与析构2. 迭代器与遍历3. 容量相关4

C++中悬垂引用(Dangling Reference) 的实现

《C++中悬垂引用(DanglingReference)的实现》C++中的悬垂引用指引用绑定的对象被销毁后引用仍存在的情况,会导致访问无效内存,下面就来详细的介绍一下产生的原因以及如何避免,感兴趣... 目录悬垂引用的产生原因1. 引用绑定到局部变量,变量超出作用域后销毁2. 引用绑定到动态分配的对象,对象

SpringBoot基于注解实现数据库字段回填的完整方案

《SpringBoot基于注解实现数据库字段回填的完整方案》这篇文章主要为大家详细介绍了SpringBoot如何基于注解实现数据库字段回填的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以了解... 目录数据库表pom.XMLRelationFieldRelationFieldMapping基础的一些代

Java HashMap的底层实现原理深度解析

《JavaHashMap的底层实现原理深度解析》HashMap基于数组+链表+红黑树结构,通过哈希算法和扩容机制优化性能,负载因子与树化阈值平衡效率,是Java开发必备的高效数据结构,本文给大家介绍... 目录一、概述:HashMap的宏观结构二、核心数据结构解析1. 数组(桶数组)2. 链表节点(Node

Java AOP面向切面编程的概念和实现方式

《JavaAOP面向切面编程的概念和实现方式》AOP是面向切面编程,通过动态代理将横切关注点(如日志、事务)与核心业务逻辑分离,提升代码复用性和可维护性,本文给大家介绍JavaAOP面向切面编程的概... 目录一、AOP 是什么?二、AOP 的核心概念与实现方式核心概念实现方式三、Spring AOP 的关

vite搭建vue3项目的搭建步骤

《vite搭建vue3项目的搭建步骤》本文主要介绍了vite搭建vue3项目的搭建步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学... 目录1.确保Nodejs环境2.使用vite-cli工具3.进入项目安装依赖1.确保Nodejs环境

Nginx搭建前端本地预览环境的完整步骤教学

《Nginx搭建前端本地预览环境的完整步骤教学》这篇文章主要为大家详细介绍了Nginx搭建前端本地预览环境的完整步骤教学,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录项目目录结构核心配置文件:nginx.conf脚本化操作:nginx.shnpm 脚本集成总结:对前端的意义很多

Python实现字典转字符串的五种方法

《Python实现字典转字符串的五种方法》本文介绍了在Python中如何将字典数据结构转换为字符串格式的多种方法,首先可以通过内置的str()函数进行简单转换;其次利用ison.dumps()函数能够... 目录1、使用json模块的dumps方法:2、使用str方法:3、使用循环和字符串拼接:4、使用字符

Linux下利用select实现串口数据读取过程

《Linux下利用select实现串口数据读取过程》文章介绍Linux中使用select、poll或epoll实现串口数据读取,通过I/O多路复用机制在数据到达时触发读取,避免持续轮询,示例代码展示设... 目录示例代码(使用select实现)代码解释总结在 linux 系统里,我们可以借助 select、

Linux挂载linux/Windows共享目录实现方式

《Linux挂载linux/Windows共享目录实现方式》:本文主要介绍Linux挂载linux/Windows共享目录实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录文件共享协议linux环境作为服务端(NFS)在服务器端安装 NFS创建要共享的目录修改 NFS 配