このドキュメントでは、Android で行う基本的な NFC タスクについて説明します。このドキュメントでは、NDEF メッセージの形式で NFC データを送受信する方法と、これらの機能をサポートする Android フレームワーク API について説明します。NDEF 以外のデータの操作に関する説明など、より高度なトピックについては、高度な NFC をご覧ください。
NFC タグからの NDEF データの読み取りは、タグ ディスパッチ システムによって処理されます。このシステムは、検出された NFC タグを分析し、データを適切に分類して、分類されたデータに関心のあるアプリを起動します。スキャンされた NFC タグを処理するアプリは、インテント フィルタを宣言して、データの処理をリクエストできます。
タグ ディスパッチ システム
Android 搭載デバイスは通常、デバイスの設定メニューで NFC が無効になっていない限り、画面のロックが解除されると NFC タグを探します。Android 搭載デバイスが NFC タグを検出したときに、使用するアプリをユーザーに尋ねることなく、最も適切なアクティビティでインテントを処理することが望ましい動作です。デバイスは非常に短い範囲で NFC タグをスキャンするため、ユーザーが手動でアクティビティを選択すると、デバイスをタグから離して接続を切断せざるを得なくなる可能性があります。アクティビティ選択ツールが表示されないようにするには、アクティビティが処理する NFC タグのみを処理するようにアクティビティを開発する必要があります。
この目標を達成するために、Android には、スキャンされた NFC タグを分析して解析し、スキャンされたデータに関心のあるアプリを特定しようとする特別なタグ ディスパッチ システムが用意されています。これは次の方法で行います。
- NFC タグを解析し、タグ内のデータ ペイロードを識別する MIME タイプまたは URI を特定する。
- MIME タイプまたは URI、およびペイロードをインテントにカプセル化します。最初の 2 つのステップについては、NFC タグを MIME タイプと URI にマッピングする方法をご覧ください。
- インテントに基づいてアクティビティを開始します。これについては、NFC タグをアプリケーションにディスパッチする方法で説明しています。
NFC タグが MIME タイプと URI にマッピングされる仕組み
NFC アプリケーションの作成を始める前に、さまざまなタイプの NFC タグ、タグ ディスパッチ システムが NFC タグを解析する方法、NDEF メッセージを検出したときにタグ ディスパッチ システムが行う特別な処理について理解しておくことが重要です。NFC タグにはさまざまなテクノロジーがあり、さまざまな方法でデータを書き込むことができます。Android は、NFC フォーラムによって定義されている NDEF 標準を最もサポートしています。
NDEF データは、1 つ以上のレコード(NdefRecord)を含むメッセージ(NdefMessage)内にカプセル化されます。各 NDEF レコードは、作成するレコードタイプの仕様に従って、適切な形式にする必要があります。Android は、NDEF データを含まない他のタイプのタグもサポートしています。これらのタグは、android.nfc.tech パッケージのクラスを使用して操作できます。これらのテクノロジーの詳細については、高度な NFC のトピックをご覧ください。これらの他のタイプのタグを操作するには、タグと通信するための独自のプロトコル スタックを作成する必要があります。そのため、開発を容易にし、Android 搭載デバイスを最大限にサポートするために、可能な限り NDEF を使用することをおすすめします。
注: NDEF の仕様全体をダウンロードするには、NFC Forum Specifications & Application Documents サイトにアクセスしてください。NDEF レコードの作成方法の例については、一般的なタイプの NDEF レコードを作成するをご覧ください。
NFC タグの背景を理解したところで、以降のセクションでは、Android が NDEF 形式のタグを処理する方法について詳しく説明します。Android 搭載デバイスは、NDEF 形式のデータを含む NFC タグをスキャンすると、メッセージを解析して、データの MIME タイプまたは識別 URI を特定しようとします。これを行うため、システムは NdefMessage 内の最初の NdefRecord を読み取り、NDEF メッセージ全体をどのように解釈するかを決定します(NDEF メッセージには複数の NDEF レコードを含めることができます)。整形式の NDEF メッセージでは、最初の NdefRecord に次のフィールドが含まれます。
- 3 ビットの TNF(Type Name Format)
- 可変長タイプのフィールドの解釈方法を示します。有効な値については、表 1 をご覧ください。
- 可変長タイプ
- レコードのタイプを記述します。
TNF_WELL_KNOWNを使用する場合は、このフィールドを使用してレコードタイプ定義(RTD)を指定します。有効な RTD 値は表 2 に記載されています。 - 可変長 ID
- レコードの固有識別子。このフィールドはあまり使用されませんが、タグを一意に識別する必要がある場合は、タグの ID を作成できます。
- 可変長ペイロード
- 読み書きする実際のデータ ペイロード。NDEF メッセージには複数の NDEF レコードを含めることができるため、NDEF メッセージの最初の NDEF レコードに完全なペイロードが含まれているとは限りません。
タグ ディスパッチ システムは、TNF フィールドとタイプ フィールドを使用して、MIME タイプまたは URI を NDEF メッセージにマッピングしようとします。成功した場合は、その情報を実際のペイロードとともに ACTION_NDEF_DISCOVERED インテント内にカプセル化します。ただし、タグ ディスパッチ システムが最初の NDEF レコードに基づいてデータの種類を判別できない場合もあります。これは、NDEF データを MIME タイプまたは URI にマッピングできない場合や、NFC タグに NDEF データが含まれていない場合に発生します。このような場合、タグのテクノロジーとペイロードに関する情報を含む Tag オブジェクトは、代わりに ACTION_TECH_DISCOVERED インテント内にカプセル化されます。
表 1 は、タグ ディスパッチ システムが TNF フィールドとタイプ フィールドを MIME タイプまたは URI にマッピングする方法を示しています。また、MIME タイプまたは URI にマッピングできない TNF についても説明します。
このような場合、タグ ディスパッチ システムは ACTION_TECH_DISCOVERED にフォールバックします。
たとえば、タグ ディスパッチ システムが TNF_ABSOLUTE_URI 型のレコードを検出すると、そのレコードの可変長型フィールドを URI にマッピングします。タグ ディスパッチ システムは、その URI を、タグに関するその他の情報(ペイロードなど)とともに ACTION_NDEF_DISCOVERED インテントのデータ フィールドにカプセル化します。一方、TNF_UNKNOWN タイプのレコードが検出された場合は、代わりにタグのテクノロジーをカプセル化するインテントを作成します。
表 1. サポートされている TNF とそのマッピング
| Type Name Format(TNF) | マッピング |
|---|---|
TNF_ABSOLUTE_URI |
タイプ フィールドに基づく URI。 |
TNF_EMPTY |
ACTION_TECH_DISCOVERED にフォールバックします。 |
TNF_EXTERNAL_TYPE |
タイプ フィールドの URN に基づく URI。URN は、短縮形式 <domain_name>:<service_name> で NDEF タイプ フィールドにエンコードされます。Android は、これを vnd.android.nfc://ext/<domain_name>:<service_name> 形式の URI にマッピングします。 |
TNF_MIME_MEDIA |
タイプ フィールドに基づく MIME タイプ。 |
TNF_UNCHANGED |
最初のレコードでは無効であるため、ACTION_TECH_DISCOVERED にフォールバックします。 |
TNF_UNKNOWN |
ACTION_TECH_DISCOVERED にフォールバックします。 |
TNF_WELL_KNOWN |
MIME タイプまたは URI。type フィールドで設定したレコードタイプ定義(RTD)によって異なります。利用可能な RTD とそのマッピングの詳細については、表 2 をご覧ください。 |
表 2. TNF_WELL_KNOWN でサポートされている RTD とそのマッピング
| レコードタイプ定義(RTD) | マッピング |
|---|---|
RTD_ALTERNATIVE_CARRIER |
ACTION_TECH_DISCOVERED にフォールバックします。 |
RTD_HANDOVER_CARRIER |
ACTION_TECH_DISCOVERED にフォールバックします。 |
RTD_HANDOVER_REQUEST |
ACTION_TECH_DISCOVERED にフォールバックします。 |
RTD_HANDOVER_SELECT |
ACTION_TECH_DISCOVERED にフォールバックします。 |
RTD_SMART_POSTER |
ペイロードのパースに基づく URI。 |
RTD_TEXT |
text/plain の MIME タイプ。 |
RTD_URI |
ペイロードに基づく URI。 |
NFC タグがアプリケーションにディスパッチされる仕組み
タグ ディスパッチ システムは、NFC タグとその識別情報をカプセル化したインテントの作成を完了すると、そのインテントをフィルタする対象のアプリにインテントを送信します。複数のアプリがインテントを処理できる場合は、アクティビティ選択ツールが表示され、ユーザーがアクティビティを選択できます。タグ ディスパッチ システムは、優先度の高い順に次の 3 つのインテントを定義します。
-
ACTION_NDEF_DISCOVERED: このインテントは、NDEF ペイロードを含むタグがスキャンされ、認識されたタイプである場合に、アクティビティを開始するために使用されます。これは最も優先度の高いインテントであり、タグ ディスパッチ システムは、可能な限り、他のインテントよりも前にこのインテントでアクティビティを開始しようとします。注: Android 16 以降、ウェブリンク(URI スキームが「http://」または「https://」)を保存する NFC タグをスキャンすると、
ACTION_NDEF_DISCOVEREDインテントではなくACTION_VIEWインテントがトリガーされます。Android 17 以降では、このようなタグをスキャンすると「リンクを開く」通知が表示され、ACTION_VIEWインテントをトリガーするにはユーザーの明示的な操作が必要になります。 ACTION_TECH_DISCOVERED:ACTION_NDEF_DISCOVEREDインテントを処理するために登録されているアクティビティがない場合、タグ ディスパッチ システムはこのインテントを使用してアプリケーションの起動を試みます。このインテントは、スキャンされたタグに MIME タイプまたは URI にマッピングできない NDEF データが含まれている場合、またはタグに NDEF データは含まれていないが既知のタグ技術のものである場合にも、直接開始されます(最初にACTION_NDEF_DISCOVEREDを開始することはありません)。ACTION_TAG_DISCOVERED:ACTION_NDEF_DISCOVEREDインテントまたはACTION_TECH_DISCOVEREDインテントを処理するアクティビティがない場合、このインテントが開始されます。
タグ ディスパッチ システムの基本的な仕組みは次のとおりです。
- NFC タグ(
ACTION_NDEF_DISCOVEREDまたはACTION_TECH_DISCOVERED)の解析時にタグ ディスパッチ システムによって作成されたインテントを使用して、アクティビティの開始を試みます。 - そのインテントをフィルタするアクティビティがない場合は、次に優先度の低いインテント(
ACTION_TECH_DISCOVEREDまたはACTION_TAG_DISCOVERED)でアクティビティの開始を試みます。この処理は、インテントをフィルタするアプリが見つかるか、タグ ディスパッチ システムが考えられるすべてのインテントを試すまで繰り返されます。 - アプリケーションがどのインテントもフィルタしない場合は、何もしません。
可能な限り、NDEF メッセージと ACTION_NDEF_DISCOVERED インテントを使用してください。これは、3 つの中で最も具体的なインテントです。このインテントを使用すると、他の 2 つのインテントよりも適切なタイミングでアプリを起動できるため、ユーザー エクスペリエンスが向上します。
Android マニフェストで NFC アクセスをリクエストする
デバイスの NFC ハードウェアにアクセスして NFC インテントを適切に処理するには、AndroidManifest.xml ファイルで次の項目を宣言します。
- NFC ハードウェアにアクセスするための NFC
<uses-permission>要素:<uses-permission android:name="android.permission.NFC" />
- Android 17(API レベル 37)以降、アクティビティに NFC インテントをディスパッチするには、アプリが SDK >
Build.VERSION_CODES.BAKLAVAをターゲットとしている場合、android.permission.DISPATCH_NFC_MESSAGE権限で保護されている必要があります。これにより、NFC システム サービスのみがアクティビティにインテントをディスパッチできるようになります。また、システムは、停止状態のアプリ(ユーザーが一度も起動したことがないアプリや、強制停止されたアプリなど)に NFC インテントをディスパッチしません。<activity android:name=".MyActivity" android:exported="true" android:permission="android.permission.DISPATCH_NFC_MESSAGE"> ... </activity>
- アプリケーションでサポート可能な SDK の最小バージョン。API レベル 9 は、
ACTION_TAG_DISCOVEREDを使用した限定的なタグ ディスパッチのみをサポートし、EXTRA_NDEF_MESSAGESエクストラを使用した NDEF メッセージへのアクセスのみを提供します。他のタグ プロパティや I/O オペレーションにはアクセスできません。API レベル 10 には、包括的なリーダー / ライター サポートとフォアグラウンド NDEF プッシュが含まれています。API レベル 14 には、NDEF レコードを作成するための追加の便利なメソッドが用意されています。<uses-sdk android:minSdkVersion="10"/> uses-feature要素。これにより、NFC ハードウェアを搭載したデバイスでのみ、アプリが Google Play に表示されるようになります。<uses-feature android:name="android.hardware.nfc" android:required="true" />
アプリで NFC 機能を使用するものの、その機能がアプリにとって重要でない場合は、
uses-feature要素を省略し、実行時にgetDefaultAdapter()がnullであるかどうかを確認することで、NFC の可用性を確認できます。
NFC インテントのフィルタ
処理する NFC タグがスキャンされたときにアプリを起動するには、Android マニフェストで 1 つ、2 つ、または 3 つすべての NFC インテントをフィルタします。ただし、通常は、アプリの起動タイミングを最大限に制御するために、ACTION_NDEF_DISCOVERED インテントをフィルタします。ACTION_TECH_DISCOVERED インテントは、ACTION_NDEF_DISCOVERED をフィルタするアプリケーションがない場合や、ペイロードが NDEF ではない場合の ACTION_NDEF_DISCOVERED の代替手段です。ACTION_TAG_DISCOVERED のフィルタリングは、通常、フィルタするにはカテゴリが一般的すぎます。多くのアプリケーションは、ACTION_TAG_DISCOVERED の前に ACTION_NDEF_DISCOVERED または ACTION_TECH_DISCOVERED をフィルタするため、アプリケーションが起動する可能性は低くなります。ACTION_TAG_DISCOVERED は、ACTION_NDEF_DISCOVERED インテントまたは ACTION_TECH_DISCOVERED インテントを処理するためにインストールされている他のアプリケーションがない場合に、アプリケーションがフィルタリングするための最終手段としてのみ使用できます。
NFC タグのデプロイはさまざまで、多くの場合、管理できないため、常に可能とは限りません。そのため、必要に応じて他の 2 つのインテントにフォールバックできます。書き込むタグとデータの種類を制御できる場合は、NDEF を使用してタグをフォーマットすることをおすすめします。次のセクションでは、インテントのタイプごとにフィルタを適用する方法について説明します。
ACTION_NDEF_DISCOVERED
ACTION_NDEF_DISCOVERED インテントをフィルタするには、フィルタするデータの種類とともにインテント フィルタを宣言します。次の例では、MIME タイプが text/plain の ACTION_NDEF_DISCOVERED インテントをフィルタします。
<activity android:name=".MyActivity" android:exported="true" android:permission="android.permission.DISPATCH_NFC_MESSAGE"> <intent-filter> <action android:name="android.nfc.action.NDEF_DISCOVERED"/> <category android:name="android.intent.category.DEFAULT"/> <data android:mimeType="text/plain" /> </intent-filter> </activity>
次の例では、https://developer.android.com/index.html 形式の URI をフィルタします。
<activity android:name=".MyActivity" android:exported="true" android:permission="android.permission.DISPATCH_NFC_MESSAGE"> <intent-filter> <action android:name="android.nfc.action.NDEF_DISCOVERED"/> <category android:name="android.intent.category.DEFAULT"/> <data android:scheme="https" android:host="developer.android.com" android:pathPrefix="/index.html" /> </intent-filter> </activity>
ACTION_TECH_DISCOVERED
アクティビティが ACTION_TECH_DISCOVERED インテントをフィルタする場合は、アクティビティがサポートするテクノロジーを tech-list セット内で指定する XML リソース ファイルを作成する必要があります。tech-list セットが、タグでサポートされているテクノロジーのサブセットである場合、アクティビティは一致と見なされます。これは、getTechList() を呼び出すことで取得できます。
たとえば、スキャンされたタグが MifareClassic、NdefFormatable、NfcA をサポートしている場合、アクティビティを一致させるには、tech-list セットでこれら 3 つのテクノロジーすべて、または 2 つ、または 1 つを指定する必要があります(それ以外は指定しません)。
次の例では、テクノロジーをすべて定義しています。NFC タグでサポートされていないものは削除する必要があります。このファイルを <project-root>/res/xml フォルダに保存します(ファイル名は任意です)。
<resources xmlns:xliff="urn:oasis:names:tc:xliff:document:1.2"> <tech-list> <tech>android.nfc.tech.IsoDep</tech> <tech>android.nfc.tech.NfcA</tech> <tech>android.nfc.tech.NfcB</tech> <tech>android.nfc.tech.NfcF</tech> <tech>android.nfc.tech.NfcV</tech> <tech>android.nfc.tech.Ndef</tech> <tech>android.nfc.tech.NdefFormatable</tech> <tech>android.nfc.tech.MifareClassic</tech> <tech>android.nfc.tech.MifareUltralight</tech> </tech-list> </resources>
また、複数の tech-list セットを指定できます。各 tech-list セットは個別に考慮され、いずれかの tech-list セットが getTechList() によって返されるテクノロジーのサブセットである場合、アクティビティは一致と見なされます。これにより、マッチング テクノロジーの AND と OR のセマンティクスが提供されます。次の例では、NfcA テクノロジーと Ndef テクノロジーをサポートできるタグ、または NfcB テクノロジーと Ndef テクノロジーをサポートできるタグを照合します。
<resources xmlns:xliff="urn:oasis:names:tc:xliff:document:1.2"> <tech-list> <tech>android.nfc.tech.NfcA</tech> <tech>android.nfc.tech.Ndef</tech> </tech-list> <tech-list> <tech>android.nfc.tech.NfcB</tech> <tech>android.nfc.tech.Ndef</tech> </tech-list> </resources>
AndroidManifest.xml ファイルで、次の例に示すように、<activity> 要素内の <meta-data> 要素に、作成したリソース ファイルを指定します。
<activity android:name=".MyActivity" android:exported="true" android:permission="android.permission.DISPATCH_NFC_MESSAGE"> <intent-filter> <action android:name="android.nfc.action.TECH_DISCOVERED"/> </intent-filter> <meta-data android:name="android.nfc.action.TECH_DISCOVERED" android:resource="@xml/nfc_tech_filter" /> </activity>
タグ技術と ACTION_TECH_DISCOVERED インテントの操作について詳しくは、高度な NFC に関するドキュメントのサポートされているタグ技術の操作をご覧ください。
ACTION_TAG_DISCOVERED
注: ACTION_TAG_DISCOVERED は、Android 17(API レベル 37)以降では非推奨になりました。代わりに ACTION_NDEF_DISCOVERED または ACTION_TECH_DISCOVERED を使用してください。
ACTION_TAG_DISCOVERED をフィルタするには、次のインテント フィルタを使用します。
<activity android:name=".MyActivity" android:exported="true" android:permission="android.permission.DISPATCH_NFC_MESSAGE"> <intent-filter> <action android:name="android.nfc.action.TAG_DISCOVERED"/> </intent-filter> </activity>
ACTION_VIEW
Android 16 以降、ウェブリンク(URI スキームが「http://」または「https://」)を保存する NFC タグをスキャンすると、ACTION_NDEF_DISCOVERED インテントではなく ACTION_VIEW インテントがトリガーされます。Android 17 以降では、このようなタグをスキャンすると「リンクを開く」通知が表示され、ACTION_VIEW インテントをトリガーするにはユーザーの明示的な操作が必要になります。ACTION_VIEW をフィルタするには、this をご覧ください。Android app links を使用して、URL のアプリを開きます。
インテントから情報を取得する
NFC インテントによってアクティビティが開始された場合、スキャンされた NFC タグに関する情報をインテントから取得できます。インテントには、スキャンされたタグに応じて次のエクストラを含めることができます。
EXTRA_TAG(必須): スキャンされたタグを表すTagオブジェクト。EXTRA_NDEF_MESSAGES(省略可): タグから解析された NDEF メッセージの配列。このエクストラは、ACTION_NDEF_DISCOVEREDインテントでは必須です。EXTRA_ID(任意): タグの低レベル ID。
これらのエクストラを取得するには、アクティビティが NFC インテントのいずれかで起動されたかどうかを確認して、タグがスキャンされたことを確認し、インテントからエクストラを取得します。次の例では、ACTION_NDEF_DISCOVERED インテントを確認し、インテント エクストラから NDEF メッセージを取得します。
Kotlin
override fun onNewIntent(intent: Intent) { super.onNewIntent(intent) ... if (NfcAdapter.ACTION_NDEF_DISCOVERED == intent.action) { intent.getParcelableArrayExtra(NfcAdapter.EXTRA_NDEF_MESSAGES)?.also { rawMessages -> val messages: List<NdefMessage> = rawMessages.map { it as NdefMessage } // Process the messages array. ... } } }
Java
@Override protected void onNewIntent(Intent intent) { super.onNewIntent(intent); ... if (NfcAdapter.ACTION_NDEF_DISCOVERED.equals(intent.getAction())) { Parcelable[] rawMessages = intent.getParcelableArrayExtra(NfcAdapter.EXTRA_NDEF_MESSAGES); if (rawMessages != null) { NdefMessage[] messages = new NdefMessage[rawMessages.length]; for (int i = 0; i < rawMessages.length; i++) { messages[i] = (NdefMessage) rawMessages[i]; } // Process the messages array. ... } } }
または、インテントから Tag オブジェクトを取得することもできます。このオブジェクトにはペイロードが含まれており、タグのテクノロジーを列挙できます。
Kotlin
val tag: Tag = intent.getParcelableExtra(NfcAdapter.EXTRA_TAG)
Java
Tag tag = intent.getParcelableExtra(NfcAdapter.EXTRA_TAG);
一般的なタイプの NDEF レコードを作成する
このセクションでは、NFC タグへの書き込みに役立つ、一般的なタイプの NDEF レコードを作成する方法について説明します。Android 4.0(API レベル 14)以降では、createUri() メソッドを使用して URI レコードを自動的に作成できます。Android 4.1(API レベル 16)以降では、createExternal() と createMime() を使用して、MIME タイプと外部タイプの NDEF レコードを作成できます。NDEF レコードを手動で作成する際の間違いを避けるため、可能な限り、これらのヘルパー メソッドを使用してください。
このセクションでは、レコードに対応するインテント フィルタを作成する方法についても説明します。これらの NDEF レコードの例はすべて、タグに書き込む NDEF メッセージの最初の NDEF レコードに含める必要があります。
TNF_ABSOLUTE_URI
注: TNF_ABSOLUTE_URI ではなく、より効率的な RTD_URI タイプを使用することをおすすめします。
TNF_ABSOLUTE_URI NDEF レコードは、次のように作成できます。
Kotlin
val uriRecord = ByteArray(0).let { emptyByteArray -> NdefRecord( TNF_ABSOLUTE_URI, "https://developer.android.com/index.html".toByteArray(Charset.forName("US-ASCII")), emptyByteArray, emptyByteArray ) }
Java
NdefRecord uriRecord = new NdefRecord( NdefRecord.TNF_ABSOLUTE_URI , "https://developer.android.com/index.html".getBytes(Charset.forName("US-ASCII")), new byte[0], new byte[0]);
前の NDEF レコードのインテント フィルタは次のようになります。
<activity android:name=".MyActivity" android:exported="true" android:permission="android.permission.DISPATCH_NFC_MESSAGE"> <intent-filter> <action android:name="android.nfc.action.NDEF_DISCOVERED" /> <category android:name="android.intent.category.DEFAULT" /> <data android:scheme="https" android:host="developer.android.com" android:pathPrefix="/index.html" /> </intent-filter> </activity>
TNF_MIME_MEDIA
TNF_MIME_MEDIA NDEF レコードは、次の方法で作成できます。
createMime() メソッドを使用:
Kotlin
val mimeRecord = NdefRecord.createMime( "application/vnd.com.example.android.beam", "Beam me up, Android".toByteArray(Charset.forName("US-ASCII")) )
Java
NdefRecord mimeRecord = NdefRecord.createMime("application/vnd.com.example.android.beam", "Beam me up, Android".getBytes(Charset.forName("US-ASCII")));
手動で NdefRecord を作成:
Kotlin
val mimeRecord = Charset.forName("US-ASCII").let { usAscii -> NdefRecord( NdefRecord.TNF_MIME_MEDIA, "application/vnd.com.example.android.beam".toByteArray(usAscii), ByteArray(0), "Beam me up, Android!".toByteArray(usAscii) ) }
Java
NdefRecord mimeRecord = new NdefRecord( NdefRecord.TNF_MIME_MEDIA , "application/vnd.com.example.android.beam".getBytes(Charset.forName("US-ASCII")), new byte[0], "Beam me up, Android!".getBytes(Charset.forName("US-ASCII")));
前の NDEF レコードのインテント フィルタは次のようになります。
<activity android:name=".MyActivity" android:exported="true" android:permission="android.permission.DISPATCH_NFC_MESSAGE"> <intent-filter> <action android:name="android.nfc.action.NDEF_DISCOVERED" /> <category android:name="android.intent.category.DEFAULT" /> <data android:mimeType="application/vnd.com.example.android.beam" /> </intent-filter> </activity>
TNF_WELL_KNOWN(RTD_TEXT)
TNF_WELL_KNOWN NDEF レコードは、次のように作成できます。
Kotlin
fun createTextRecord(payload: String, locale: Locale, encodeInUtf8: Boolean): NdefRecord { val langBytes = locale.language.toByteArray(Charset.forName("US-ASCII")) val utfEncoding = if (encodeInUtf8) Charset.forName("UTF-8") else Charset.forName("UTF-16") val textBytes = payload.toByteArray(utfEncoding) val utfBit: Int = if (encodeInUtf8) 0 else 1 shl 7 val status = (utfBit + langBytes.size).toChar() val data = ByteArray(1 + langBytes.size + textBytes.size) data[0] = status.toByte() System.arraycopy(langBytes, 0, data, 1, langBytes.size) System.arraycopy(textBytes, 0, data, 1 + langBytes.size, textBytes.size) return NdefRecord(NdefRecord.TNF_WELL_KNOWN, NdefRecord.RTD_TEXT, ByteArray(0), data) }
Java
public NdefRecord createTextRecord(String payload, Locale locale, boolean encodeInUtf8) { byte[] langBytes = locale.getLanguage().getBytes(Charset.forName("US-ASCII")); Charset utfEncoding = encodeInUtf8 ? Charset.forName("UTF-8") : Charset.forName("UTF-16"); byte[] textBytes = payload.getBytes(utfEncoding); int utfBit = encodeInUtf8 ? 0 : (1 << 7); char status = (char) (utfBit + langBytes.length); byte[] data = new byte[1 + langBytes.length + textBytes.length]; data[0] = (byte) status; System.arraycopy(langBytes, 0, data, 1, langBytes.length); System.arraycopy(textBytes, 0, data, 1 + langBytes.length, textBytes.length); NdefRecord record = new NdefRecord(NdefRecord.TNF_WELL_KNOWN, NdefRecord.RTD_TEXT, new byte[0], data); return record; }
前の NDEF レコードのインテント フィルタは次のようになります。
<activity android:name=".MyActivity" android:exported="true" android:permission="android.permission.DISPATCH_NFC_MESSAGE"> <intent-filter> <action android:name="android.nfc.action.NDEF_DISCOVERED" /> <category android:name="android.intent.category.DEFAULT" /> <data android:mimeType="text/plain" /> </intent-filter> </activity>
TNF_WELL_KNOWN(RTD_URI)
TNF_WELL_KNOWN NDEF レコードは、次の方法で作成できます。
createUri(String) メソッドを使用:
Kotlin
val rtdUriRecord1 = NdefRecord.createUri("https://example.com")
Java
NdefRecord rtdUriRecord1 = NdefRecord.createUri("https://example.com");
createUri(Uri) メソッドを使用:
Kotlin
val rtdUriRecord2 = Uri.parse("https://example.com").let { uri -> NdefRecord.createUri(uri) }
Java
Uri uri = Uri.parse("https://example.com"); NdefRecord rtdUriRecord2 = NdefRecord.createUri(uri);
手動で NdefRecord を作成:
Kotlin
val uriField = "example.com".toByteArray(Charset.forName("US-ASCII")) val payload = ByteArray(uriField.size + 1) //add 1 for the URI Prefix payload [0] = 0x01 //prefixes https://www. to the URI System.arraycopy(uriField, 0, payload, 1, uriField.size) //appends URI to payload val rtdUriRecord = NdefRecord(NdefRecord.TNF_WELL_KNOWN, NdefRecord.RTD_URI, ByteArray(0), payload)
Java
byte[] uriField = "example.com".getBytes(Charset.forName("US-ASCII")); byte[] payload = new byte[uriField.length + 1]; //add 1 for the URI Prefix payload[0] = 0x01; //prefixes https://www. to the URI System.arraycopy(uriField, 0, payload, 1, uriField.length); //appends URI to payload NdefRecord rtdUriRecord = new NdefRecord( NdefRecord.TNF_WELL_KNOWN, NdefRecord.RTD_URI, new byte[0], payload);
前の NDEF レコードのインテント フィルタは次のようになります。
<activity android:name=".MyActivity" android:exported="true" android:permission="android.permission.DISPATCH_NFC_MESSAGE"> <intent-filter> <action android:name="android.nfc.action.NDEF_DISCOVERED" /> <category android:name="android.intent.category.DEFAULT" /> <data android:scheme="https" android:host="example.com" android:pathPrefix="" /> </intent-filter> </activity>
TNF_EXTERNAL_TYPE
TNF_EXTERNAL_TYPE NDEF レコードは、次の方法で作成できます。
createExternal() メソッドを使用:
Kotlin
var payload: ByteArray //assign to your data val domain = "com.example" //usually your app's package name val type = "externalType" val extRecord = NdefRecord.createExternal(domain, type, payload)
Java
byte[] payload; //assign to your data String domain = "com.example"; //usually your app's package name String type = "externalType"; NdefRecord extRecord = NdefRecord.createExternal(domain, type, payload);
手動で NdefRecord を作成:
Kotlin
var payload: ByteArray ... val extRecord = NdefRecord( NdefRecord.TNF_EXTERNAL_TYPE, "com.example:externalType".toByteArray(Charset.forName("US-ASCII")), ByteArray(0), payload )
Java
byte[] payload; ... NdefRecord extRecord = new NdefRecord( NdefRecord.TNF_EXTERNAL_TYPE, "com.example:externalType".getBytes(Charset.forName("US-ASCII")), new byte[0], payload);
前の NDEF レコードのインテント フィルタは次のようになります。
<activity android:name=".MyActivity" android:exported="true" android:permission="android.permission.DISPATCH_NFC_MESSAGE"> <intent-filter> <action android:name="android.nfc.action.NDEF_DISCOVERED" /> <category android:name="android.intent.category.DEFAULT" /> <data android:scheme="vnd.android.nfc" android:host="ext" android:pathPrefix="/com.example:externalType"/> </intent-filter> </activity>
より一般的な NFC タグのデプロイには TNF_EXTERNAL_TYPE を使用して、Android 搭載デバイスと Android 以外のデバイスの両方をより適切にサポートします。
注: TNF_EXTERNAL_TYPE の URN の正規形式は urn:nfc:ext:example.com:externalType ですが、NFC フォーラムの RTD 仕様では、URN の urn:nfc:ext: 部分を NDEF レコードから省略する必要があると宣言されています。したがって、ドメイン(例では example.com)とタイプ(例では externalType)をコロンで区切って指定するだけです。TNF_EXTERNAL_TYPE をディスパッチするとき、Android は urn:nfc:ext:example.com:externalType
URN を vnd.android.nfc://ext/example.com:externalType URI に変換します。これは、この例のインテント フィルタが宣言しているものです。
Android アプリのレコード
Android 4.0(API レベル 14)で導入された Android アプリケーション レコード(AAR)を使用すると、NFC タグがスキャンされたときにアプリが起動する確実性が高まります。AAR には、NDEF レコード内に埋め込まれたアプリのパッケージ名が含まれています。Android は NDEF メッセージ全体で AAR を検索するため、NDEF メッセージの任意の NDEF レコードに AAR を追加できます。AAR が見つかった場合は、AAR 内のパッケージ名に基づいてアプリを起動します。アプリがデバイスに存在しない場合は、Google Play が起動してアプリがダウンロードされます。
AAR は、他のアプリケーションが同じインテントをフィルタリングして、デプロイした特定のタグを処理するのを防ぐ場合に便利です。AAR は、パッケージ名の制約により、アプリケーション レベルでのみサポートされます。インテント フィルタリングのようにアクティビティ レベルではサポートされません。アクティビティ レベルでインテントを処理する場合は、インテント フィルタを使用します。
タグに AAR が含まれている場合、タグ ディスパッチ システムによるディスパッチ方法は以下のとおりです。
- 通常どおりに、インテント フィルタを使用したアクティビティの開始を試みます。インテントに一致するアクティビティが AAR にも一致する場合は、アクティビティを開始します。
- インテントをフィルタするアクティビティが AAR と一致しない場合、複数のアクティビティがインテントを処理できる場合、またはインテントを処理するアクティビティがない場合は、AAR で指定されたアプリを起動します。
- AAR で起動できるアプリがない場合は、Google Play にアクセスして、AAR に基づくアプリをダウンロードします。
注: AAR とインテント ディスパッチ システムは、フォアグラウンド ディスパッチ システムでオーバーライドできます。これにより、NFC タグが検出されたときにフォアグラウンド アクティビティを優先させることができます。このメソッドでは、AAR とインテント ディスパッチ システムをオーバーライドするために、アクティビティがフォアグラウンドに存在する必要があります。
AAR を含まないスキャンされたタグをフィルタする場合は、通常どおりインテント フィルタを宣言できます。これは、アプリケーションが AAR を含まない他のタグに関心がある場合に便利です。たとえば、デプロイする独自のタグと、サードパーティがデプロイする一般的なタグをアプリケーションで処理できるようにする必要がある場合です。AAR は Android 4.0 以降のデバイスに固有であるため、タグをデプロイする際は、AAR と MIME タイプ / URI を組み合わせて使用することで、幅広いデバイスをサポートできます。また、NFC タグをデプロイする際は、ほとんどのデバイス(Android 搭載デバイスやその他のデバイス)をサポートできるように NFC タグを書き込む方法を検討してください。これを行うには、比較的固有の MIME タイプまたは URI を定義して、アプリケーションが区別しやすくします。
Android には、AAR を作成するためのシンプルな API である createApplicationRecord() が用意されています。必要な作業は、NdefMessage の任意の場所に AAR を埋め込むことだけです。AAR が NdefMessage の唯一のレコードでない限り、NdefMessage の最初のレコードは使用しないでください。これは、Android システムが NdefMessage の最初のレコードをチェックして、タグの MIME タイプまたは URI を判別するためです。この MIME タイプまたは URI は、アプリがフィルタするインテントを作成するために使用されます。次のコードは、AAR を作成する方法を示しています。
Kotlin
val msg = NdefMessage( arrayOf( ..., NdefRecord.createApplicationRecord("com.example.android.beam") ) )
Java
NdefMessage msg = new NdefMessage( new NdefRecord[] { ..., NdefRecord.createApplicationRecord("com.example.android.beam")} ); )
NFC タグスキャンのアプリ許可リスト
Android 16 以降では、アプリが NFC タグをスキャンする最初の NFC インテントを受信すると、ユーザーに通知されます。ユーザーは、通知でアプリによる NFC タグのスキャンを許可しないオプションを選択できます。
- アプリは、
NfcAdapter.isTagIntentAllowed()を使用して、ユーザーがアプリに NFC タグのスキャンを許可しているかどうかを確認できます。 - アプリは、インテント
ACTION_CHANGE_TAG_INTENT_PREFERENCEを送信することで、NFC タグのスキャンを再度許可するようユーザーに求めることができます。
注: NFC タグスキャン アプリの許可リストには、Settings > Apps > Special app access > Launch via NFC でアクセスできます。