跳到主要内容

Headless JS

Headless JS 是一种在您的应用处于后台时在 JavaScript 中运行任务的方式。 例如，它可以用于同步新数据、处理推送通知或播放音乐。

JS API​

任务是在 AppRegistry 上注册的异步函数，类似于注册 React 应用

tsx
import {AppRegistry} from 'react-native';
AppRegistry.registerHeadlessTask('SomeTaskName', () =>
  require('SomeTaskName'),
);

然后，在 SomeTaskName.js 中

tsx
module.exports = async taskData => {
  // do stuff
};

您可以在任务中执行任何操作，例如网络请求、定时器等等，只要它不涉及 UI。 一旦您的任务完成（即 Promise 被 resolve），React Native 将进入“暂停”模式（除非有其他任务正在运行，或者有前台应用）。

平台 API​

是的，这仍然需要一些原生代码，但它非常简洁。 您需要扩展 HeadlessJsTaskService 并覆盖 getTaskConfig，例如：

java
package com.your_application_name;

import android.content.Intent;
import android.os.Bundle;
import com.facebook.react.HeadlessJsTaskService;
import com.facebook.react.bridge.Arguments;
import com.facebook.react.jstasks.HeadlessJsTaskConfig;
import javax.annotation.Nullable;

public class MyTaskService extends HeadlessJsTaskService {

  @Override
  protected @Nullable HeadlessJsTaskConfig getTaskConfig(Intent intent) {
    Bundle extras = intent.getExtras();
    if (extras != null) {
      return new HeadlessJsTaskConfig(
          "SomeTaskName",
          Arguments.fromBundle(extras),
          5000, // timeout in milliseconds for the task
          false // optional: defines whether or not the task is allowed in foreground. Default is false
        );
    }
    return null;
  }
}

然后将服务添加到 AndroidManifest.xml 文件中的 application 标签内

xml
<service android:name="com.example.MyTaskService" />

现在，每当您启动您的服务时，例如作为定期任务或响应某些系统事件/广播，JS 将启动，运行您的任务，然后关闭。

示例

java
Intent service = new Intent(getApplicationContext(), MyTaskService.class);
Bundle bundle = new Bundle();

bundle.putString("foo", "bar");
service.putExtras(bundle);

getApplicationContext().startForegroundService(service);

重试​

默认情况下，headless JS 任务不会执行任何重试。 为了做到这一点，您需要创建一个 HeadlessJsRetryPolicy 并抛出一个特定的 Error。

LinearCountingRetryPolicy 是 HeadlessJsRetryPolicy 的一个实现，允许您指定最大重试次数以及每次尝试之间的固定延迟。 如果这不符合您的需求，那么您可以实现您自己的 HeadlessJsRetryPolicy。 这些策略可以作为额外的参数传递给 HeadlessJsTaskConfig 构造函数，例如：

java
HeadlessJsRetryPolicy retryPolicy = new LinearCountingRetryPolicy(
  3, // Max number of retry attempts
  1000 // Delay between each retry attempt
);

return new HeadlessJsTaskConfig(
  'SomeTaskName',
  Arguments.fromBundle(extras),
  5000,
  false,
  retryPolicy
);

只有在抛出特定的 Error 时才会进行重试尝试。 在 headless JS 任务内部，您可以导入错误并在需要重试尝试时抛出它。

示例

tsx
import {HeadlessJsTaskError} from 'HeadlessJsTask';

module.exports = async taskData => {
  const condition = ...;
  if (!condition) {
    throw new HeadlessJsTaskError();
  }
};

如果您希望所有错误都导致重试尝试，您将需要捕获它们并抛出上述错误。

注意事项​

  • 默认情况下，如果您尝试在前台应用运行时运行任务，您的应用将会崩溃。 这是为了防止开发者在任务中执行大量工作并减慢 UI 速度而搬起石头砸自己的脚。 您可以传递第四个 boolean 参数来控制此行为。
  • 如果您从 BroadcastReceiver 启动您的服务，请确保在从 onReceive() 返回之前调用 HeadlessJsTaskService.acquireWakeLockNow()。

使用示例​

服务可以从 Java API 启动。 首先，您需要决定何时应启动服务并相应地实施您的解决方案。 这是一个响应网络连接更改的示例。

以下行显示了用于注册广播接收器的 Android manifest 文件的一部分。

xml
<receiver android:name=".NetworkChangeReceiver" >
  <intent-filter>
    <action android:name="android.net.conn.CONNECTIVITY_CHANGE" />
  </intent-filter>
</receiver>

然后，广播接收器处理在 onReceive 函数中广播的 intent。 这是检查您的应用是否在前台运行的好地方。 如果应用不在前台，我们可以准备要启动的 intent，不带信息或使用 putExtra 捆绑的附加信息（请记住 bundle 只能处理 parcelable 值）。 最后，服务启动并获取 wakelock。

java
import android.app.ActivityManager;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.net.ConnectivityManager;
import android.net.Network;
import android.net.NetworkCapabilities;
import android.net.NetworkInfo;
import android.os.Build;

import com.facebook.react.HeadlessJsTaskService;

public class NetworkChangeReceiver extends BroadcastReceiver {

    @Override
    public void onReceive(final Context context, final Intent intent) {
        /**
         This part will be called every time network connection is changed
         e.g. Connected -> Not Connected
         **/
        if (!isAppOnForeground((context))) {
            /**
             We will start our service and send extra info about
             network connections
             **/
            boolean hasInternet = isNetworkAvailable(context);
            Intent serviceIntent = new Intent(context, MyTaskService.class);
            serviceIntent.putExtra("hasInternet", hasInternet);
            context.startForegroundService(serviceIntent);
            HeadlessJsTaskService.acquireWakeLockNow(context);
        }
    }

    private boolean isAppOnForeground(Context context) {
        /**
         We need to check if app is in foreground otherwise the app will crash.
         https://stackoverflow.com/questions/8489993/check-android-application-is-in-foreground-or-not
         **/
        ActivityManager activityManager = (ActivityManager) context.getSystemService(Context.ACTIVITY_SERVICE);
        List<ActivityManager.RunningAppProcessInfo> appProcesses =
                activityManager.getRunningAppProcesses();
        if (appProcesses == null) {
            return false;
        }
        final String packageName = context.getPackageName();
        for (ActivityManager.RunningAppProcessInfo appProcess : appProcesses) {
            if (appProcess.importance ==
                    ActivityManager.RunningAppProcessInfo.IMPORTANCE_FOREGROUND &&
                    appProcess.processName.equals(packageName)) {
                return true;
            }
        }
        return false;
    }

    public static boolean isNetworkAvailable(Context context) {
        ConnectivityManager cm = (ConnectivityManager)
                context.getSystemService(Context.CONNECTIVITY_SERVICE);

        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
            Network networkCapabilities = cm.getActiveNetwork();

            if(networkCapabilities == null) {
                return false;
            }

            NetworkCapabilities actNw = cm.getNetworkCapabilities(networkCapabilities);

            if(actNw == null) {
                return false;
            }

            if(actNw.hasTransport(NetworkCapabilities.TRANSPORT_WIFI) || actNw.hasTransport(NetworkCapabilities.TRANSPORT_CELLULAR) || actNw.hasTransport(NetworkCapabilities.TRANSPORT_ETHERNET)) {
                return true;
            }

            return false;
        }

        // deprecated in API level 29
        NetworkInfo netInfo = cm.getActiveNetworkInfo();
        return (netInfo != null && netInfo.isConnected());
    }
}