跳到主要内容

Headless JS

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

JS API​

任务是一个异步函数，你可以在 AppRegistry 上注册它，类似于注册 React 应用：

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

然后，在 SomeTaskName.js 中：

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

你可以在任务中执行任何操作，例如网络请求、计时器等，只要不触碰 UI。任务完成后（即 promise 被解析后），React Native 将进入“暂停”模式（除非还有其他任务正在运行，或存在前台应用）。

Platform 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 任务中导入该错误，并在需要重试时抛出它。

示例：

React 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 值）。最后启动服务并获取唤醒锁。

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());
    }
}