Android-сервисы

Начиная с Qt 5.7, вы можете создавать Android-сервисы с помощью Qt. Сервис — это компонент, работающий в фоновом режиме, поэтому у него нет пользовательского интерфейса. Он полезен для выполнения длительных операций, таких как запись GPS, ожидание уведомлений из социальных сетей и так далее. Сервис будет продолжать работу даже после выхода приложения, которое его запустило.

Сборка сервиса

Для начала создайте каталог пакета Android, как указано в Qt Creator: Развёртывание приложений на Android-устройствах. Этот каталог содержит файл AndroidManifest.xml. Внутри каталога пакета создайте каталог src, где будут созданы все ваши Java-пакеты и классы.

Создание класса сервиса

Вы можете создать сервис, расширив класс QtService или Android: Service в свой Java-класс. В зависимости от того, хотите ли вы использовать функции Qt в своём сервисе или вызывать собственные C++-функции из Java, вам нужно расширить либо QtService, либо Service. Давайте начнём с простого сервиса, как показано ниже:

import android.content.Context;
import android.content.Intent;
import android.util.Log;
import org.qtproject.qt.android.bindings.QtService;

public class QtAndroidService extends QtService
{
    private static final String TAG = "QtAndroidService";

    @Override
    public void onCreate() {
        super.onCreate();
        Log.i(TAG, "Creating Service");
    }

    @Override
    public void onDestroy() {
        super.onDestroy();
        Log.i(TAG, "Destroying Service");
    }

    @Override
    public int onStartCommand(Intent intent, int flags, int startId) {
        int ret = super.onStartCommand(intent, flags, startId);

        // Do some work

        return ret;
    }
}

Запуск сервиса

Android позволяет запускать сервисы по запросу или при запуске системы. Вы можете сделать это с помощью Qt.

Запуск сервиса при запуске системы

Для запуска сервиса при запуске системы вам нужен BroadcastReceiver.

Создайте пользовательский Java-класс:

public class QtBootServiceBroadcastReceiver extends BroadcastReceiver {
    @Override
    public void onReceive(Context context, Intent intent) {
        Intent startServiceIntent = new Intent(context, QtBootServiceBroadcastReceiver.class);
        context.startService(startServiceIntent);
    }
}

Добавьте следующий uses-permission в тело раздела <manifest> в файле AndroidManifest.xml.

<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />

Также добавьте определение receiver в тело раздела <application>:

<receiver android:name=".QtBootServiceBroadcastReceiver">
    <intent-filter>
        <action android:name="android.intent.action.BOOT_COMPLETED" />
    </intent-filter>
</receiver>

Примечание: Чтобы запустить сервис при запуске системы, он должен быть определён как отдельный процесс, см. Сервис в отдельном процессе.

Управление сервисом в AndroidManifest.xml

Чтобы сервис можно было использовать в приложении Android, необходимо объявить его в файле AndroidManifest.xml. Давайте начнём с добавления раздела сервиса:

• При расширении Service, просто объявите раздел сервиса как обычный Android-сервис. Добавьте следующее в раздел <application>:

  <service android:name=".QtAndroidService">
      <!-- Background running -->
      <meta-data android:name="android.app.background_running" android:value="true"/>
      <!-- Background running -->
  </service>

  Таким образом, сервис будет запущен в том же процессе, что и QtActivity, что позволяет использовать собственные вызовы C++ из Java-кода. Вы можете запустить его в отдельном процессе, но в этом случае вы не сможете использовать никакие собственные вызовы для связи, потому что Qt-библиотеки не загружаются для этого процесса. Для запуска в отдельном процессе добавьте это к тегу сервиса:

  android:process=":qt_service"

• При расширении QtService, вам нужно объявить другие элементы для загрузки всех необходимых библиотек Qt, в основном тех же, что и в разделе <activity> для QtActivity. Добавьте следующее:

  <service android:process=":qt_service" android:name=".QtAndroidService">
  
      <meta-data android:name="android.app.lib_name" android:value="service"/>
      <meta-data android:name="android.app.qt_sources_resource_id" android:resource="@array/qt_sources"/>
      <meta-data android:name="android.app.repository" android:value="default"/>
      <meta-data android:name="android.app.qt_libs_resource_id" android:resource="@array/qt_libs"/>
      <meta-data android:name="android.app.bundled_libs_resource_id" android:resource="@array/bundled_libs"/>
  
      <!-- Deploy Qt libs as part of package -->
      <meta-data android:name="android.app.bundle_local_qt_libs" android:value="-- %%BUNDLE_LOCAL_QT_LIBS%% --"/>
  
      <!-- Run with local libs -->
      <meta-data android:name="android.app.use_local_qt_libs" android:value="-- %%USE_LOCAL_QT_LIBS%% --"/>
      <meta-data android:name="android.app.libs_prefix" android:value="/data/local/tmp/qt/"/>
      <meta-data android:name="android.app.load_local_libs_resource_id" android:resource="@array/load_local_libs"/>
      <meta-data android:name="android.app.load_local_jars" android:value="-- %%INSERT_LOCAL_JARS%% --"/>
      <meta-data android:name="android.app.static_init_classes" android:value="-- %%INSERT_INIT_CLASSES%% --"/>
      <!-- Run with local libs -->
  
      <!-- Background running -->
      <meta-data android:name="android.app.background_running" android:value="true"/>
      <!-- Background running -->
  </service>

Примечание: Убедитесь, что определены следующие параметры для запуска сервиса в фоновом режиме:

<meta-data android:name="android.app.background_running" android:value="true"/>

Существуют несколько вариантов объявления сервисов. Некоторые из них уже используются в предыдущем фрагменте манифеста. В зависимости от вашего случая, запустите сервис либо в том же процессе, что и QtActivity, либо в отдельном процессе.

Сервис в том же процессе, что и QtActivity

Чтобы запустить сервис в том же процессе, что и QtActivity, объявите заголовок сервиса следующим образом:

<service android:name=".QtAndroidService">

Сервис в отдельном процессе

Чтобы запустить сервис в отдельном процессе, объявите заголовок сервиса следующим образом:

<service android:process=":qt_service" android:name=".QtAndroidService">

Qt загружает файл .so, определённый в android.app.lib_name meta-data, и вызывает функцию main() со всеми аргументами, установленными в android.app.arguments meta-data. При запуске в отдельном процессе вы можете запустить сервис, используя тот же файл lib, что и основная активность, или отдельный файл lib.

Использование того же файла .so lib

Использование того же файла lib .so, что и в основной активности, означает, что сервис будет использовать ту же точку входа с дополнительным аргументом для различения его от основной активности. Вы можете обработать выполнение вашего приложения в функции main() в соответствии с предоставленными аргументами. Добавьте следующее объявление аргумента в тело сервиса:

<!-- Application arguments -->
<meta-data android:name="android.app.arguments" android:value="-service"/>
<!-- Application arguments -->

Затем убедитесь, что сервис android.app.lib_name такой же, как и основная активность, добавьте следующее:

<meta-data android:name="android.app.lib_name" android:value="-- %%INSERT_APP_LIB_NAME%% --"/>

При использовании одного и того же файла lib .so, ваша функция приложения main() выполняется дважды: один раз для запуска основной активности и второй раз для запуска сервиса. Таким образом, вы должны обработать каждое выполнение в соответствии с предоставленным аргументом. Один из способов достижения этого — следующий:

if (argc <= 1) {
    // code to handle main activity execution
} else if (argc > 1 && strcmp(argv[1], "-service") == 0) {
    qDebug() << "Service starting with from the same .so file";
    QAndroidService app(argc, argv);
    return app.exec();
} else {
    qWarning() << "Unrecognized command line argument";
    return -1;
}

Использование отдельного файла .so lib

В этом случае вам необходимо иметь подпроект с шаблоном lib, который предоставляет другой исполняемый файл для сервиса. Пример проекта .pro:

TEMPLATE = lib
TARGET = service
CONFIG += dll
QT += core androidextras

SOURCES += \
    service_main.cpp

HEADERS += servicemessenger.h

В service_main.cpp у вас может быть следующее:

#include <QDebug>
#include <QAndroidService>

int main(int argc, char *argv[])
{
    qWarning() << "Service starting from a separate .so file";
    QAndroidService app(argc, argv);

    return app.exec();
}

Определите android.app.lib_name для сервиса в AndroidManifest.xml:

<meta-data android:name="android.app.lib_name" android:value="service"/>

Взаимодействие с сервисом

Qt для Android предлагает различные методы межпроцессного взаимодействия (IPC) для взаимодействия с Android-сервисами. В зависимости от структуры вашего проекта вы можете использовать либо собственные вызовы C++ из Java-сервиса, либо Android BroadcastReceiver.

Вызовы C++ из Java-сервиса

Это может работать с сервисами, работающими в том же процессе, что и QtActivity и даже если Service расширен.

Использование QAndroidBinder

QAndroidBinder — это удобный класс, который позволяет осуществлять межпроцессное взаимодействие путём реализации наиболее важных методов в Android: Binder. Он позволяет отправлять объекты QByteArray или QVariant между процессами.

Примечание: Qt для Android имеет ограничение, принуждающее к выполнению только одного сервиса за раз при запуске нескольких сервисов в одном процессе. Поэтому рекомендуется запускать каждый сервис в своём собственном процессе. Для получения дополнительной информации см. QTBUG-78009.