Android（JAVA）のライブラリ（aar）でUSB接続処理を実装すると権限選択時にアプリが必ず１度クラッシュする。

Question

実現したいこと

• [アプリクラッシュを回避したい。]

USB接続時に必ず１度クラッシュするがクラッシュ後であれば情報を取得することは可能です。
ですが、クラッシュをそもそもしないようにしたいです。
AndroidManifestの設定か、このライブラリを使用する側で何か設定が必要でしょうか？

前提

ライブラリ（USBLib.aar）を作成し、ライブラリ側でUSB接続を行えるようにしています。
アプリはこのaarを呼び出すとUSB情報を取得できます。

実際のアプリはUnityから動作しますが、Androidで作成した動作確認用のテストアプリもあります。
アプリクラッシュはUnityからでもテストアプリからでも発生します。

ライブラリのAndroidManifestにてUSBの権限を設定するような定義にしています。
intent-filterにて対象の製品IDとベンダーIDを定義しており当該情報のみ動作するようにしています。

[クラッシュ具体例]
テストアプリをAndroid端末実機にUSB経由でインストールし、アプリを起動します。（USBデバッグ有効の状態）
起動中にUSB接続を行うとアプリ選択画面が出てくるため、当該アプリを選択するとクラッシュします。
※１回のみを選択
クラッシュ後、USB接続状態でアプリを再度立ち上げてUSB情報取得ボタンを押下すると、USB情報を正常に取得できます。

USB接続時の選択画面にてアプリを選択しない場合、クラッシュしません。
クラッシュしませんがUSB情報取得ボタンを押しても取得できません。

USBを抜いて、再度接続するとまたアプリ選択画面が出るため、アプリを選択するとクラッシュします。
※常時接続を行うと、アプリ選択画面は出ませんが同じようにUSB接続した場合クラッシュして２回目の起動ではクラッシュしない。

発生している問題・エラーメッセージ

AndroidRuntime: java.lang.RuntimeException: Unable to instantiate activity ComponentInfo{パッケージ名}: java.lang.ClassCastException: パッケージ名 cannot be cast to android.app.Activity

該当のソースコード

• ライブラリ

<!-- androidmanifest -->
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    package="パッケージ名">

    <uses-sdk android:minSdkVersion="12" />

    <uses-feature
        android:name="android.hardware.usb.host"
        android:required="false" />

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

    <application
        android:debuggable="true"
        tools:ignore="HardcodedDebugMode">
        <activity
            android:name=".USBLib"
            android:exported="true"
            tools:ignore="Instantiatable">
            <intent-filter>
                <action android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" />
            </intent-filter>

            <meta-data
                android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED"
                android:resource="@xml/device_filter" />
        </activity>
    </application>

</manifest>

<!-- device_filter-->
<?xml version="1.0" encoding="utf-8"?>

<resources>
    <usb-device vendor-id="id" product-id="pid1"/>
    <usb-device vendor-id="id" product-id="pid2"/>
    <usb-device vendor-id="id" product-id="pid3"/>
  </resources>

public class USBLib 
{
    private Context myContext = null;
    
    public USBLib()
    {
    
    }
    
    public int setContext(Context context) {
        myContext = context;
        return 0;
    }

    public int setContext() {
        int result = 0;
        if (myContext == null){
            result = setContext(UnityPlayer.currentActivity.getApplicationContext());
        }
        return result;
    }
    
    
    public String GetSts()
    {
    
        UsbManager manager = (UsbManager) myContext.getSystemService(Context.USB_SERVICE);
        HashMap<String, UsbDevice> deviceList = manager.getDeviceList();
        Iterator<UsbDevice> deviceIterator = deviceList.values().iterator();
        while(deviceIterator.hasNext()) {
            UsbDevice device = deviceIterator.next();
            return device.getDeviceName();
        }

        return "";
    }
}

• テストアプリ

public class MainActivity extends AppCompatActivity implements View.OnClickListener
{

     USBLib reader = new USBLib();
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        findViewById(R.id.button).setOnClickListener(this);
    }
    @Override
	 public void onClick(View v) {
 
        Context context = this.getApplicationContext();
        String dump = "";
        try {
            
            reader.setContext(context);
            dump = reader.GetSts();
        }
        catch (Exception ex)
        {
            dump = ex.toString();
        }
	}
}

試したこと

ボタン押下時ではないため、関係ないと思いつつも
USB取得処理を無効化しても変わらなかった。

USB選択時であるのでおそらくAndroidManifestの問題？

AndroidManifestの
<activityをServiceにしてみると、アプリ選択ができなかった。

Unityからの呼び出しでも同じ

補足情報（FW/ツールのバージョンなど）

Android Gradle Plugin Version 4.0.2
Gradle Version 6.1.1

    compileSdkVersion 34
    defaultConfig {
        minSdkVersion 26
        targetSdkVersion 34
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
        consumerProguardFiles "consumer-rules.pro"
    }

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }

    configurations.implementation {
    exclude group: 'org.jetbrains.kotlin', module: 'kotlin-stdlib-jdk8'
    exclude group: 'org.jetbrains.kotlin', module: 'kotlin-stdlib-jdk7'
}

Answer 1

public class USBLib 
{

       <activity
            android:name=".USBLib"

USBLib クラスは Activity じゃないですね。

---

USBLib を AAR 化し、テスト用のアプリから使用するまでをやってみました。
使っているのは "Android Studio Flamingo | 2022.2.1 Patch 1" です。
どこか一箇所でも「これやってない」みたいな所が見つかると良いのですが…。

new project で "Phone and Tablet" の "Empty Views Activity" を選んで [Next] 、Name="q_kuopgz3a19cr8a" 、 package="com.teratail.q_kuopgz3a19cr8a" としました。(名前はこちらの都合でこのようにしているだけです。)

一通りプロジェクトの生成が終わったら、メニューから [New Module] を実行します。

表示されたダイアログで "Android Library" を選択し、名前等を入力し [Finish]。

"app" と同じ高さにモジュールの名前のフォルダ ("usblib") が出来ますので、 app と usblib のそれぞれにコードを置いていきます。(AndroidManifest.xml は触りません。)

app 側 (テストアプリ)
MainActivity.java

package com.teratail.q_kuopgz3a19cr8a;

import androidx.appcompat.app.AppCompatActivity;

import android.os.Bundle;
import android.widget.TextView;

import com.teratail.usblib.USBLib;

public class MainActivity extends AppCompatActivity {
  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    USBLib reader = new USBLib();
    reader.setContext(this);

    TextView textView = findViewById(R.id.textView);

    findViewById(R.id.button).setOnClickListener(v -> {
      String dump;
      try {
        dump = reader.GetSts();
      } catch (Exception e) {
        dump = e.getLocalizedMessage();
      }
      textView.setText(dump);
    });
  }
}

res/layout/activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

  <Button
      android:id="@+id/button"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:text="check"
      app:layout_constraintBottom_toTopOf="@id/textView"
      app:layout_constraintEnd_toEndOf="parent"
      app:layout_constraintStart_toStartOf="parent"
      app:layout_constraintTop_toTopOf="parent" />

  <TextView
      android:id="@+id/textView"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:textSize="30dp"
      app:layout_constraintBottom_toBottomOf="parent"
      app:layout_constraintEnd_toEndOf="parent"
      app:layout_constraintStart_toStartOf="parent"
      app:layout_constraintTop_toBottomOf="@id/button" />

</androidx.constraintlayout.widget.ConstraintLayout>

usblib 側 (ライブラリ)
USBLib.java

package com.teratail.usblib;

import android.content.Context;
import android.hardware.usb.*;

public class USBLib {
  private Context myContext;

  public int setContext(Context context) {
    myContext = context;
    return 0;
  }

  /* UnityPlayer クラスが無くてエラーになるためコメント化
  public int setContext() {
    int result = 0;
    if (myContext == null) {
      result = setContext(UnityPlayer.currentActivity.getApplicationContext());
    }
    return result;
  }
  */

  public String GetSts() {
    UsbManager manager = (UsbManager) myContext.getSystemService(Context.USB_SERVICE);
    for (UsbDevice device : manager.getDeviceList().values()) {
      return device.getDeviceName();
    }
    return "nothing";
  }
}

MainActiviry.java で USBLib のエラーが出るので、 "Gradle Scripts" の "build.gradle (Module :app)" 内の dependencies に以下を追加します。

implementation project(path: ':usblib')

これで、テストアプリを実行してボタンを押すと USB の最初の情報 ( もしくは "nothing") が表示されるはずです。( XperiaXZ3 Android10 で確認 )

Project で usblib を選択してメニューから [Make Module(～)] を実行すれば AAR ファイルが生成されました。


"-debug" と付いているのは build が debug だからです。 release にするには普通のアプリと同様に認証情報を入れないといけないかもしれません。

app 側 (テストアプリ) の AndroidManifest.xml の activity タグ (name=".MainActivity") 内に質問本文と同様に

      <intent-filter>
        <action android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" />
      </intent-filter>
      <meta-data
          android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED"
          android:resource="@xml/device_filter" />

を入れ res/xml/device_filter.xml に手持ちの機器の情報を定義しましたら、選択確認後にテストアプリが起動できました。

Comments

[nrr-mgmg]

はい、Activityじゃないです。
USBLibをActivityにすると、別画面？が立ち上がるような動きになってうまく動作しないです。
設定か何かで複製されないようにしたりできますか？

[nrr-mgmg]

後ライブラリなので画面ではないのでAcitivityは継承不要かなと
ただAcitivityの機能を使いたいのでxmlは定義できるのかなと思うのですが違うのでしょうか？
※WindowsFormでFormの機能を利用したいときなどのような
違う場合はどうすれば回避できますでしょうか？

[jimbe]

普通のアプリを作る環境を流用してモジュールを作っているのでしょうか。
モジュールの AndroidManifest には("アプリケーション"では無いのですから) Application タグは入らないはずです。
モジュールが特定のアクティビティの機能に依存するのであれば、それはモジュールでは無くアプリの一部として実装しなければならないのでは無いでしょうか。

[nrr-mgmg]

最終的にはUnityで実装したいのですがUnity側（C#script？）で実装しないといけないということでしょうか？
USBアクセスのタグを使う際の使用例がApplication～Activityのタグでしたのでそのようにしています。
Android歴がほとんどないのでよくわかっていないです。

[jimbe]

私は逆に Unity は全く分かりません。
恐らく使用例として参考にされたものは、画面を含めた一つのアプリとして成っているものだと思います。その一部を AAR にして利用しようとするのならそのままではダメでしょう。
これを機に Android の AAR の作り方からお調べになっては如何でしょうか。

[nrr-mgmg]

調べてもわからなかったのでここで質問している次第になります。

[jimbe]

公式のドキュメントとしては以下があります。

Android ライブラリの作成
https://developer.android.com/studio/projects/android-library?hl=ja

[nrr-mgmg]

本件の問題とかけ離れている問答になっていると考えます。
aar事態は作成できています。

[nrr-mgmg]

誤解しているように見えるので補足いたします。
調べても分からなかったに関してかかる箇所は
本題の話であってAARの作り方ではありません。

[nrr-mgmg]

アプリ側に実装を義務付けすることでライブラリ側に記載がなくてもアクセスすることが出来ました。
ありがとうございます。