Android サービスの作成

Android アプリケーションの作成への移動

1 Android サービスの作成
2 アプリケーションへの Android サービスの追加
3 アプリケーションへの複数の Android サービスの追加
4 アプリケーションからの Android サービスの削除
5 サービスの起動
- 5.1 起動型サービス
  - 5.1.1 スティッキーでの起動
- 5.2 バインド型サービス
  - 5.2.1 BindService/UnBindService メソッド
  - 5.2.2 OnBind イベント
6 トラブルシューティング
- 6.1 配置前のビルド構成の変更
- 6.2 Release lib<サービス名>.so の追加
7 関連項目

Android サービスとは、ユーザーインターフェイスを持たない、バックグラウンドタスクを実行するアプリケーションです。このサービスには、本質的に以下の 2 種類があります。

起動型サービス：このサービスは Android アプリケーションによって起動されます。サービスは、アプリケーションが終了した後も、バックグラウンドで無期限に動作し続けることができます。この種類のサービスは、通常、1 つのタスクを実行し、それが終了すると自動的に停止します。
バインド型サービス：このサービスは、Android アプリケーションにバインドされている間のみ動作します。アプリケーションとサービスの間で対話が行われ、アプリケーションがバインドを解除するまでアクティブなままになります。複数のアプリケーションを同じ 1 つのサービスにバインドすることができます。

Android サービスの作成

RAD Studio では、Android サービスプロジェクトを作成するウィザードと、マルチデバイスアプリケーションに Android サービスを追加するための別のウィザードが用意されています。

Android サービスプロジェクトを新規作成するには、［ファイル｜新規作成｜その他...］を選択し、それから以下を選択します。

［Delphi プロジェクト｜Android サービス］

このウィザードで、サービスの種類（ローカルまたはリモート）を指定します。

ローカル サービスは、そのアプリケーションだけで使用できる private のサービスです。Android マニフェストファイルに以下の行が追加され、他のアプリケーションからのアクセスが阻止されます。

<service android:exported="false" android:name="com.embarcadero.services.<service_name>"/>

リモート サービスは public であり、他のアプリケーションからアクセスすることができます。Android マニフェストファイルに以下の行が追加され、サービスへのアクセスが認められます。

<service android:exported="true" android:name="com.embarcadero.services.<service_name>"/>

さまざまなオプションの詳細は、「Android サービス」を参照してください。

Android マニフェスト属性の詳細は、「Exported Provider Element（provider 要素のエクスポート）」を参照してください。

アプリケーションへの Android サービスの追加

作成したサービスは、［プロジェクトマネージャ］に lib<プロジェクト名>.so という名前で表示されます。

ビジュアルコンポーネントをデータモジュールに、関数と手続きをコードに追加します。
Android サービスプロジェクトを保存します。
メモ 1： Android サービスプロジェクトは、それぞれ異なるフォルダに保存してください。

メモ 2： Android サービスプロジェクトに Service という名前を付けてはなりません。
Android サービスプロジェクトをビルドしてからアプリケーションに追加し、バイナリファイルを生成します。
サービスを追加する先のアプリケーションを［プロジェクトマネージャ］に追加します。
1. 既存のアプリケーションの場合には、プロジェクトグループを右クリックし、［既存プロジェクトを追加...］を選択します。
2. マルチデバイスアプリケーションを新規作成する場合は、プロジェクトグループを右クリックし、［新規プロジェクトを追加...］を選択してから、以下を選択します。
  - ［Delphi プロジェクト｜マルチデバイスアプリケーション］
そのマルチデバイスアプリケーションで、ターゲットプラットフォームに［Android］を選択します。
1. ［Android］ターゲットプラットフォームを右クリックし、［Android サービスの追加...］を選択します。
2. ［新規 Android サービスの追加］ウィザードが開きます。
3. をクリックして、Android サービスプロジェクトを保存するフォルダを選択します。
4. ［次へ］をクリックします。
  1. 何も問題なければ、マルチデバイスアプリケーションに追加されるファイルがリストに表示されます。
  2. Android サービスのパスの情報を要求するウィンドウが開いた場合には、Android サービスを保存しビルドしてからやり直してください。
［完了］をクリックすると、以下のファイルがアプリケーションに追加されます。
- メインのバイナリファイル、lib<プロジェクト名>.so。バイナリファイルは配置マネージャに追加されます。
  メモ： このメモは、RAD Studio Seattle Subscription Update 1 に影響しません。lib<プロジェクト名>.so へのローカルパスは絶対パスです。サービスの場所を別の位置に変更する場合には、サービスを再びアプリケーションに追加する必要があります。
- libProxyAndroidService.so ファイル。このライブラリは配置マネージャに追加されます。
  メモ： このファイルは、アプリケーションに追加されたすべてのサービスで共有されます。
- Java アーカイブファイル <プロジェクト名>.jar。この jar ファイルは、［プロジェクトマネージャ］の［Android］ターゲットプラットフォームの下にある［ライブラリ］ノードに追加されます。
- データモジュールファイル <プロジェクト名>.pas。このデータモジュールは［プロジェクトマネージャ］に追加されます。
マルチデバイスアプリケーションをコンパイルして Android マニフェストファイルを生成し、先ほど選択したサービスの種類（ローカルまたはリモート）に応じた行を追加します。詳細は、「Android サービスの作成」を参照してください。
メモ： サービスごとに、対応する <service> の宣言を AndroidManifest.xml に追加する必要があります。これは IDE によって自動的に追加されます。

アプリケーションへの複数の Android サービスの追加

任意の数のサービスを Android アプリケーションに追加することができます。

追加するサービスそれぞれについて、「アプリケーションへの Android サービスの追加」の手順を実施してください。

以下はその際の注意事項です。

Android サービスプロジェクトは、それぞれ異なるフォルダに保存してください。
プロジェクトそれぞれに異なる名前を付けてから、メインアプリケーションに追加します。
- Android サービスプロジェクト：lib<サービス名>.so。
メモ： Android サービスプロジェクトに Service という名前を付けてはなりません。
- ユニットファイル。
- データモジュール：［オブジェクトインスペクタ］の Name プロパティで名前を変更できます。

アプリケーションからの Android サービスの削除

既に Android アプリケーションに追加された Android サービスの削除は手動で行います。手順は以下のとおりです。

Java アーカイブを削除します。［プロジェクトマネージャ］の［Android］ターゲットプラットフォームで以下を行います。
1. ［ライブラリ］ノードを開き、<サービス名>.jar を選択します。
2. 右クリックして［プロジェクトから削除...］を選択します。
3. モーダルダイアログで［はい］をクリックして操作を承認します。
データモジュールを削除します。［プロジェクトマネージャ］で以下を行います。
1. ［サービス］ノードを開き、<サービス名>.pas を選択します。
2. 右クリックして［プロジェクトから削除...］を選択します。
3. モーダルダイアログで［はい］をクリックして操作を承認します。
バイナリファイルを、配置マネージャから削除します。
- lib<サービス名>.so（<サービス名> に固有）。
- libProxyAndroidService.so （すべてのサービスによって共有）。
  メモ： アプリケーションに他のサービスが含まれている場合には、libProxyAndroidService.so ライブラリのチェックをオフにしないでください。これはすべてのサービスで共有されるファイルです。

メモ： 以下は、RAD Studio Seattle Subscription Update 1 に影響しません。

種類が AndroidServiceOutput のファイルは配置マネージャから削除することができません。

ファイルのターゲットマシンへの配置を無効化するには：

lib<サービス名>.so を選択し、のチェックをオフにします。
libProxyAndroidService.so を選択し、のチェックをオフにします。
メモ： アプリケーションに他のサービスが含まれている場合には、libProxyAndroidService.so ライブラリのチェックをオフにしないでください。これはすべてのサービスで共有されるファイルです。

また、［デフォルトに戻す］コマンドボタン（）を使用すると、現在のプロジェクトに対して配置マネージャで行った変更をすべて元に戻すことができます。

メモ 1： 複数のサービスをプロジェクトに追加していてそのすべてを削除したいわけではない場合や、行った他の変更を元に戻したくない場合には、このオプションを使用しないでください。

メモ 2： 手動でプロジェクトに追加したファイルを残すには、［デフォルトに戻す］のウィンドウで、［追加したファイルを保持する］オプションを忘れずにオンにしてください。

サービスの起動

サービスは、ALocalServiceConnection.StartService('<サービス名>') と ALocalServiceConnection.BindService('<サービス名>')、または ARemoteServiceConnection.StartService('<サービス名>') と ARemoteServiceConnection.BindService('<サービス名>') を使って起動することができます。

起動時またはバインド時に、TLocalServiceConnection 変数を具体的なサービスに初期化します。その後、残りのメソッドでサービス名を参照する必要はありません。

Android サービスをマルチデバイスアプリケーションに追加したら、以下を行います。

以下のユニットをインターフェイスの uses 句に追加します。

Uses
  System.Android.Service; // Unit that contains the methods to work with services.

<サービス名>.pas ユニットを実装の uses 句に追加します。これで、サービスデータモジュールに定義されたすべてのメソッドを使用できるようになります。
```
implementation

uses
  MyLocalService; //Key sensitive

{$R *.fmx}
```

ローカルサービスの場合は TLocalServiceConnetion 変数、リモートサービスの場合は TRemoteServiceConnection 変数を作成します。

TLocalServiceConnection/TRemoteServiceConnection 変数を宣言します。

type
  TForm1 = class(TForm)
    ...
  private
    { Private declarations }
    FServiceConnection1: TLocalServiceConnection; // For a local service.
    FServiceConnection2: TRemoteServiceConnection; // For a remote service.
  public
    { Public declarations }
  end;

TLocalServiceConnection/TRemoteServiceConnection 変数を作成します。

FServiceConnection1 := TLocalServiceConnection.Create; // For a local service.
FServiceConnection2 := TRemoteServiceConnection.Create; // For a remote service.

起動型サービス

起動型サービスの場合は、StartService('<サービス名>') を呼び出してサービスを起動します。

サービスを起動型として使用する場合、自分でサービスプロセスを管理し、JavaService.stopSelf; を使ってサービスを停止する必要があります。

スティッキーでの起動

サービスの OnStartCommand イベントは、デフォルトでは START_NOT_STICKY と定義されています。

START_STICKY は、明示的に起動され、必要に応じて停止されるサービスに使用します。システムは、サービスが強制終了されると、サービスの再起動を試みます。
START_NOT_STICKY は、送られてきたコマンドを処理する間だけ実行しておきたいサービスに使用します。プロセスが強制終了されても、サービスは自動的に再起動されません。

OnStartCommand イベントを START_STICKY にしたい場合は、それをサービスに指定する必要があります。

function TService1DM.AndroidServiceStartCommand(const Sender: TObject;
  const Intent: JIntent; Flags, StartId: Integer): Integer;
begin
  Result := TJService.JavaClass.START_STICKY;
end;

詳細は、「Service Lifecycle（サービスのライフサイクル）」を参照してください。

バインド型サービス

バインド型サービスの場合は、BindService('<サービス名>') を呼び出してサービスをバインドし、対話を始められるようにしたり、UnBindService を呼び出してサービスとの接続を解除します。

詳細は、「Bound Services（バインド型サービス）」を参照してください。

BindService/UnBindService メソッド

メインアプリケーションで BindService('<サービス名>') を呼び出すと、サービスが動作しているメモリアドレスを指すポインタが接続変数に設定されます。

特定のサービスに対する接続を確立した後で、UnBindService を呼び出したときに、そのサービスにバインドしているのがそのアプリケーションだけであれば、サービスは自身を解放します。メインアプリケーションの接続変数は、同じメモリアドレスを指したままになることに注意してください。同じサービスに再びバインドするとメインアプリケーションがクラッシュする可能性があります。サービスのメモリアドレスが無効である可能性があるためです。

この状況に対処する方法は 2 つあります。

<sectionName>Unsafe 属性</sectionName>[UnSafe] 属性を使用して自動参照カウントを使わないようにする
サービスとのバインドを解除する前に変数に Nil を代入する

[Unsafe] 属性の利用

  private
    { Private declarations }
    [Unsafe] Service1: TAndroidService1DM;

詳細は、「Unsafe 属性」を参照してください。

OnBind イベント

アプリケーションの BindService('<サービス名>') を呼び出すと、Android サービス プロジェクトで OnBind イベントが発生します。OnBind メソッドは、サービスとの接続を実際に管理する責任を負う IBinder オブジェクトを返します。

OnBind メソッドを上書きすると、メインアプリケーションがサービスからデータモジュールを取り出すために必要な IBinder オブジェクトが、イベントから返されなくなります。

以下のコードは、OnBind メソッドを使用する必要がある上級ユーザー向けです。

以下のユニットをインターフェイスの uses 句に追加します。
```
uses
  Androidapi.Jni, Androidapi.JNIBridge;
```

IBinder オブジェクトを取得する関数を作成します。

function GetBinder(const AService: TAndroidBaseService): JIBinder;

  function GetmBinder(AJNIService: JNIObject): JIBinder;
  var
    Env: PJNIEnv;
    Clazz: JNIClass;
    FieldID: JNIFieldID;
    LJNIBinder: JNIObject;
  begin
    Result := nil;
    PJavaVM(System.JavaMachine)^.AttachCurrentThread(System.JavaMachine, @Env, nil);
    Clazz := Env^.GetObjectClass(Env, AJNIService);
    FieldID := Env^.GetFieldID(Env, Clazz, 'mBinder', 'Landroid/os/IBinder;');
    if FieldID <> nil then
    begin
      LJNIBinder := Env^.GetObjectField(Env, AJNIService, FieldID);
      if LJNIBinder <> nil then
      begin
        Result := TJIBinder.Wrap(LJNIBinder);
        Env^.DeleteLocalRef(Env, LJNIBinder);
      end;
    end;
    Env^.DeleteLocalRef(Env, Clazz);
  end;

begin
  if AService.JavaService <> nil then
    Result := GetmBinder((AService.JavaService as ILocalObject).GetObjectID)
  else if AService.JavaIntentService <> nil then
    Result := GetmBinder((AService.JavaIntentService as ILocalObject).GetObjectID)
  else
    Result := nil;
end;

OnBind メソッドで IBinder オブジェクトを返します。

function TAndroidServiceDM.AndroidServiceBind(const Sender: TObject;
  const AnIntent: JIntent): JIBinder;
begin
  // .... User's code
  Result := GetBinder(Self);
end;

トラブルシューティング

配置前のビルド構成の変更

RAD Studio で Android サービスを構成するファイルの 1 つに、lib<サービス名>.so があります。このライブラリファイルは、Android サービスのコンパイル時に生成され、デフォルトでは .\$(Platform)\$(Config) に保存されます。

ホストアプリケーションに Android サービスを追加すると、ライブラリファイル lib<サービス名>.so は、Debug など、配置マネージャで選択したビルド構成に追加されます。Release などの別のビルド構成を選択して Android アプリケーションを配置すると、必要なファイルが配置マネージャに自動的に追加されないため配置されず、実行時エラーが発生します。

必要なファイルを正しいビルド構成に追加するには、サービスをメインアプリケーションに追加し直してください。

Release lib<サービス名>.so の追加

ホストアプリケーションに Debug lib<サービス名>.so ではなく Release lib<サービス名>.so を含めるには：

Android サービスプロジェクトから、残っている他の lib<サービス名>.so ファイルをすべて削除します。
Android サービスプロジェクトを Release 構成でコンパイルします。
Android サービスをホストアプリケーションの Release 構成に追加してから、アプリケーションを Android デバイスに配置します。
メモ： ［Android サービスの追加...］のウィザードで追加するファイルを選択します。

Android サービスの作成

目次

Android サービスの作成

アプリケーションへの Android サービスの追加

アプリケーションへの複数の Android サービスの追加

アプリケーションからの Android サービスの削除

サービスの起動

起動型サービス

スティッキーでの起動

バインド型サービス

BindService/UnBindService メソッド

OnBind イベント

トラブルシューティング

配置前のビルド構成の変更

Release lib<サービス名>.so の追加

関連項目

案内メニュー

個人用ツール

名前空間

変種

表示

その他

検索

RAD Studio Seattle

以前のバージョン

他言語版

参考

ツール