傳送簡單資料給其他應用程式

Android 會利用意圖及相關聯的額外項目,讓使用者能夠輕鬆快速地使用喜愛的應用程式分享資訊。

Android 提供兩種在應用程式之間分享資料的方式:

  • Android Sharesheet 主要用於將內容傳送到應用程式外部,以及/或直接傳送給其他使用者。例如與朋友分享網址。
  • Android 意圖解析器最適合用於將資料傳送至明確定義工作的下一階段。舉例來說,您可以從應用程式開啟 PDF,並讓使用者選擇偏好的檢視器。

建構意圖時,請指定您希望意圖執行的動作。Android 會使用 ACTION_SEND 動作,將某個活動的資料傳送至另一個活動,甚至是跨程序邊界傳送資料。您必須指定資料和資料類型。系統會自動找出可接收資料的相容活動,並向使用者顯示。以意圖解析器來說,如果只有一個活動可以處理該意圖,該活動會立即啟動。

為什麼要使用 Android Sharesheet

強烈建議您使用 Android Sharesheet,以在各應用程式中為使用者提供一致的體驗。請勿顯示應用程式專屬的共用目標清單,或自行建立 Sharesheet 變化版本。

Android Sharesheet 可讓使用者只要輕觸一下,就能將資訊提供給適當的應用程式,以及相關的應用程式建議。Sharesheet 可以建議自訂解決方案無法使用的目標,並使用一致的排名方法。這是因為 Sharesheet 可能會考慮只適用於系統的應用程式和使用者活動相關資訊。

Android Sharesheet 也為開發人員提供許多實用功能。例如,您可以執行以下操作:

使用 Android Sharesheet

針對所有類型的共用方式,建立意圖並將動作設為 Intent.ACTION_SEND。如要顯示 Android Sharesheet,請呼叫 Intent.createChooser(),並向此傳送 Intent 物件。並回傳一個一律顯示 Android Sharesheet 的意圖版本。

傳送文字內容

Android Sharesheet 最直接且最常見的用途,是將某個活動的文字內容傳送至另一項活動。舉例來說,大多數瀏覽器能以文字形式,將目前顯示的網頁網址提供給其他應用程式。這對於透過電子郵件或社群網路與好友分享文章或網站非常實用。範例如下:

Kotlin

val sendIntent: Intent = Intent().apply {
    action = Intent.ACTION_SEND
    putExtra(Intent.EXTRA_TEXT, "This is my text to send.")
    type = "text/plain"
}

val shareIntent = Intent.createChooser(sendIntent, null)
startActivity(shareIntent)

Java

Intent sendIntent = new Intent();
sendIntent.setAction(Intent.ACTION_SEND);
sendIntent.putExtra(Intent.EXTRA_TEXT, "This is my text to send.");
sendIntent.setType("text/plain");

Intent shareIntent = Intent.createChooser(sendIntent, null);
startActivity(shareIntent);

您可以視需要新增其他項目,納入更多資訊,例如電子郵件收件者 (EXTRA_EMAILEXTRA_CCEXTRA_BCC)、電子郵件主旨 (EXTRA_SUBJECT) 等。

注意:某些電子郵件應用程式 (例如 Gmail) 會預期額外項目 (例如 EXTRA_EMAILEXTRA_CC) 使用 String[]。然後使用 putExtra(String, String[]) 將這些參數新增至意圖。

傳送二進位內容

使用 ACTION_SEND 動作共用二進位資料。設定適當的 MIME 類型,並將 URI 放在額外 EXTRA_STREAM 中,如以下範例所示。常用於共用圖片,但也可用於分享任何類型的二進位內容。

Kotlin

val shareIntent: Intent = Intent().apply {
    action = Intent.ACTION_SEND
    // Example: content://com.google.android.apps.photos.contentprovider/...
    putExtra(Intent.EXTRA_STREAM, uriToImage)
    type = "image/jpeg"
}
startActivity(Intent.createChooser(shareIntent, null))

Java

Intent shareIntent = new Intent();
shareIntent.setAction(Intent.ACTION_SEND);
// Example: content://com.google.android.apps.photos.contentprovider/...
shareIntent.putExtra(Intent.EXTRA_STREAM, uriToImage);
shareIntent.setType("image/jpeg");
startActivity(Intent.createChooser(shareIntent, null));

接收應用程式需要權限,才能存取 Uri 指向的資料。以下提供兩種建議做法:

  • 將資料儲存在自己的 ContentProvider 中,確保其他應用程式擁有適當的權限,可以存取供應器。建議您使用「個別 URI 權限」來提供存取權,這類權限是暫時性的,並且僅授予接收應用程式的存取權。使用 FileProvider 輔助類別即可輕鬆建立像這樣的 ContentProvider
  • 使用系統 MediaStoreMediaStore 主要用於影片、音訊和圖片的 MIME 類型。不過,從 Android 3.0 (API 級別 11) 開始,它也可以儲存非媒體類型。詳情請參閱 MediaStore.Files。您可以使用 scanFile() 將檔案插入 MediaStore,之後,適合共用的 content:// 樣式 Uri 會傳遞至提供的 onScanCompleted() 回呼。請注意,將內容新增至系統 MediaStore 後,裝置上的任何應用程式皆可存取內容。

使用正確的 MIME 類型

針對要傳送的資料提供最具體的 MIME 類型。舉例來說,分享純文字時使用 text/plain。在 Android 中傳送簡易資料時,常見的 MIME 類型如下:

接收器註冊時間 寄件者
text/*
  • text/plain
  • text/rtf
  • text/html
  • text/json
`image/*`
  • image/jpg
  • image/png
  • image/gif
video/*
  • video/mp4
  • video/3gp
支援的副檔名 application/pdf

如要進一步瞭解 MIME 類型,請參閱 MIME 媒體類型的官方註冊資料庫 (IANA)。

視提供的 MIME 類型而定,Android Sharesheet 可能會顯示內容預覽畫面。部分預先發布版功能僅適用於特定類型。

分享多項內容

如要共用多個內容片段,請使用 ACTION_SEND_MULTIPLE 動作,搭配指向內容的 URI 清單。MIME 類型會因您要分享的內容組合而異。舉例來說,如果您共用三個 JPEG 圖片,請使用 "image/jpg" 類型。如果是混合圖片類型,請使用 "image/*" 比對可處理任何類型圖片的活動。雖然您可以共用多種類型,但強烈建議不要這麼做,因為接收端無法清楚判斷要傳送什麼。如果需要傳送多種類型,請使用 "*/*"。接收應用程式是由接收應用程式剖析及處理您的資料。範例如下:

Kotlin

val imageUris: ArrayList<Uri> = arrayListOf(
        // Add your image URIs here
        imageUri1,
        imageUri2
)

val shareIntent = Intent().apply {
    action = Intent.ACTION_SEND_MULTIPLE
    putParcelableArrayListExtra(Intent.EXTRA_STREAM, imageUris)
    type = "image/*"
}
startActivity(Intent.createChooser(shareIntent, null))

Java

ArrayList<Uri> imageUris = new ArrayList<Uri>();
imageUris.add(imageUri1); // Add your image URIs here
imageUris.add(imageUri2);

Intent shareIntent = new Intent();
shareIntent.setAction(Intent.ACTION_SEND_MULTIPLE);
shareIntent.putParcelableArrayListExtra(Intent.EXTRA_STREAM, imageUris);
shareIntent.setType("image/*");
startActivity(Intent.createChooser(shareIntent, null));

確認提供的 Uri 物件指向接收應用程式可以存取的資料。

在文字預覽中加入 RTF 格式內容

從 Android 10 (API 級別 29) 開始,Android Sharesheet 會顯示正在共用的文字預覽畫面。在某些情況下,分享的文字可能難以理解。建議您分享複雜的網址,例如 https://www.google.com/search?ei=2rRVXcLkJajM0PEPoLy7oA4。更豐富的預覽功能可以讓使用者安心看到自己分享的內容。

如果您正在預覽文字,您可以設定標題和/或縮圖圖片。請在呼叫 Intent.createChooser() 之前為 Intent.EXTRA_TITLE 新增說明,並使用 ClipData 新增相關縮圖。

注意:映像檔內容 URI 會從 FileProvider 提供,通常來自設定的 <cache-path>。詳情請參閱「共用檔案」。請務必授予 Sharesheet 適當權限,以讀取要做為縮圖的任何圖片。詳情請參閱 Intent.FLAG_GRANT_READ_URI_PERMISSION

範例如下:

Kotlin

 val share = Intent.createChooser(Intent().apply {
      action = Intent.ACTION_SEND
      putExtra(Intent.EXTRA_TEXT, "https://developer.android.com/training/sharing/")

      // (Optional) Here you're setting the title of the content
      putExtra(Intent.EXTRA_TITLE, "Introducing content previews")

      // (Optional) Here you're passing a content URI to an image to be displayed
      data = contentUri
      flags = Intent.FLAG_GRANT_READ_URI_PERMISSION
  }, null)
  startActivity(share)

Java

Intent sendIntent = new Intent(Intent.ACTION_SEND);
sendIntent.putExtra(Intent.EXTRA_TEXT, "https://developer.android.com/training/sharing/");

// (Optional) Here you're setting the title of the content
sendIntent.putExtra(Intent.EXTRA_TITLE, "Introducing content previews");

// (Optional) Here you're passing a content URI to an image to be displayed
sendIntent.setData(contentUri);
sendIntent.setFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);

// Show the Sharesheet
startActivity(Intent.createChooser(sendIntent, null));

以下是預覽畫面:

在 Sharesheet 中新增自訂動作

Android Sharesheet 中的自訂動作螢幕截圖。

在 Android 14 (API 級別 34) 以上版本中,應用程式可以在 Android Sharesheet 中新增自訂動作。自訂動作在 Android Sharesheet 頂端顯示為小型動作圖示,而應用程式可指定任何 Intent,做為使用者點選圖示時所叫用的動作。

如要在 Android Sharesheet 中新增自訂動作,請先使用 ChooserAction.Builder 建立 ChooserAction。您可以指定 PendingIntent 做為點選圖示時所叫用的動作。建立包含所有自訂動作的陣列,並將其指定為共用 IntentEXTRA_CHOOSER_CUSTOM_ACTIONS

Kotlin

val sendIntent = Intent(Intent.ACTION_SEND)
    .setType("text/plain")
    .putExtra(Intent.EXTRA_TEXT, text)
val shareIntent = Intent.createChooser(sendIntent, null)
val customActions = arrayOf(
    ChooserAction.Builder(
        Icon.createWithResource(context, R.drawable.ic_custom_action),
        "Custom",
        PendingIntent.getBroadcast(
            context,
            1,
            Intent(Intent.ACTION_VIEW),
            PendingIntent.FLAG_IMMUTABLE or PendingIntent.FLAG_CANCEL_CURRENT
        )
    ).build()
)
shareIntent.putExtra(Intent.EXTRA_CHOOSER_CUSTOM_ACTIONS, customActions)
context.startActivity(shareIntent)

Java

Intent sendIntent = new Intent(Intent.ACTION_SEND)
        .setType("text.plain")
        .putExtra(Intent.EXTRA_TEXT, text);
Intent shareIntent = Intent.createChooser(sendIntent, null);
ChooserAction[] actions = new ChooserAction[]{
        new ChooserAction.Builder(
                Icon.createWithResource(context, R.drawable.ic_custom_action),
                "Custom",
                PendingIntent.getBroadcast(
                        context,
                        1,
                        new Intent(Intent.ACTION_VIEW),
                        PendingIntent.FLAG_IMMUTABLE | PendingIntent.FLAG_CANCEL_CURRENT
                )
        ).build()
};
shareIntent.putExtra(Intent.EXTRA_CHOOSER_CUSTOM_ACTIONS, actions);
context.startActivity(shareIntent);

新增自訂目標

Android Sharesheet 可讓您指定最多兩個 ChooserTarget 物件,這些物件會顯示在共用捷徑和從 ChooserTargetServices 載入的選擇器目標之前。您也可以指定最多兩個意圖,指向應用程式建議之前所列的活動:

在呼叫 Intent.createChooser()「之後」,將 Intent.EXTRA_CHOOSER_TARGETSIntent.EXTRA_INITIAL_INTENTS 新增至共用意圖:

Kotlin

val share = Intent.createChooser(myShareIntent, null).apply {
    putExtra(Intent.EXTRA_CHOOSER_TARGETS, myChooserTargetArray)
    putExtra(Intent.EXTRA_INITIAL_INTENTS, myInitialIntentArray)
}

Java

Intent shareIntent = Intent.createChooser(sendIntent, null);
share.putExtra(Intent.EXTRA_CHOOSER_TARGETS, myChooserTargetArray);
share.putExtra(Intent.EXTRA_INITIAL_INTENTS, myInitialIntentArray);

請謹慎使用此功能。新增的每個自訂 IntentChooserTarget 都會減少系統建議的數量。我們通常不建議新增自訂目標。新增 Intent.EXTRA_INITIAL_INTENTS 的常見範例是,讓使用者可以對共用內容執行額外動作。舉例來說,使用者分享了圖片,而 Intent.EXTRA_INITIAL_INTENTS 的用途是讓使用者改為傳送連結。常見的適當例子是,顯示應用程式提供的相關使用者或裝置是 Intent.EXTRA_CHOOSER_TARGETS

按元件排除特定目標

如要排除特定目標,請提供 Intent.EXTRA_EXCLUDE_COMPONENTS。只用來移除您掌控的目標。常見用途是在使用者在應用程式中分享時,隱藏應用程式的共用目標,因為使用者的意圖可能是在應用程式外分享。

呼叫 Intent.createChooser() 後,請將 Intent.EXTRA_EXCLUDE_COMPONENTS 新增至意圖:

Kotlin

  val share = Intent.createChooser(Intent(), null).apply {
    // Only use for components you have control over
    val excludedComponentNames = arrayOf(ComponentName("com.example.android", "ExampleClass"))
    putExtra(Intent.EXTRA_EXCLUDE_COMPONENTS, excludedComponentNames)
  }

Java

  Intent shareIntent = Intent.createChooser(new Intent(), null);
  // Only use for components you have control over
  ComponentName[] excludedComponentNames = {
          new ComponentName("com.example.android", "ExampleClass")
  };
  shareIntent.putExtra(Intent.EXTRA_EXCLUDE_COMPONENTS, excludedComponentNames);

取得共用資訊

有助您瞭解使用者何時分享內容,以及他們選擇的目標。Android Sharesheet 可讓您為使用者提供使用 IntentSender 所選取目標的 ComponentName,藉此取得這項資訊。

首先,為 BroadcastReceiver 建立 PendingIntent,並在 Intent.createChooser() 中提供其 IntentSender

Kotlin

var share = Intent(Intent.ACTION_SEND)
// ...
val pi = PendingIntent.getBroadcast(
    myContext, requestCode,
    Intent(myContext, MyBroadcastReceiver::class.java),
    PendingIntent.FLAG_MUTABLE or PendingIntent.FLAG_UPDATE_CURRENT
)
share = Intent.createChooser(share, null, pi.intentSender)

Java

Intent share = new Intent(ACTION_SEND);
...
PendingIntent pi = PendingIntent.getBroadcast(myContext, requestCode,
        new Intent(myContext, MyBroadcastReceiver.class),
        PendingIntent.FLAG_MUTABLE | PendingIntent.FLAG_UPDATE_CURRENT);
share = Intent.createChooser(share, null, pi.getIntentSender());

請在 MyBroadcastReceiver 中接收回呼,並在 Intent.EXTRA_CHOSEN_COMPONENT 中查看:

Kotlin

override fun onReceive(context: Context, intent: Intent) {
  ...
  val clickedComponent : ComponentName = intent.getParcelableExtra(EXTRA_CHOSEN_COMPONENT);
}

Java

@Override public void onReceive(Context context, Intent intent) {
  ...
  ComponentName clickedComponent = intent.getParcelableExtra(EXTRA_CHOSEN_COMPONENT);
}

在 Sharesheet 中新增自訂動作

在 Android 14 (API 級別 34) 以上版本中,應用程式可以在 Android Sharesheet 中新增自訂動作。使用 ChooserAction.Builder 建立 ChooserAction。您可以指定 PendingIntent 做為點選圖示時所叫用的動作。建立包含所有自訂動作的陣列,並將其指定為共用 IntentEXTRA_CHOOSER_CUSTOM_ACTIONS

Kotlin

val sendIntent = Intent(Intent.ACTION_SEND)
    .setType("text/plain")
    .putExtra(Intent.EXTRA_TEXT, text)
val shareIntent = Intent.createChooser(sendIntent, null)
val customActions = arrayOf(
    ChooserAction.Builder(
        Icon.createWithResource(context, R.drawable.ic_custom_action),
        "Custom",
        PendingIntent.getBroadcast(
            context,
            1,
            Intent(Intent.ACTION_VIEW),
            PendingIntent.FLAG_IMMUTABLE or PendingIntent.FLAG_CANCEL_CURRENT
        )
    ).build()
)
shareIntent.putExtra(Intent.EXTRA_CHOOSER_CUSTOM_ACTIONS, customActions)
context.startActivity(shareIntent)

Java

Intent sendIntent = new Intent(Intent.ACTION_SEND)
        .setType("text.plain")
        .putExtra(Intent.EXTRA_TEXT, text);
Intent shareIntent = Intent.createChooser(sendIntent, null);
ChooserAction[] actions = new ChooserAction[]{
        new ChooserAction.Builder(
                Icon.createWithResource(context, R.drawable.ic_custom_action),
                "Custom",
                PendingIntent.getBroadcast(
                        context,
                        1,
                        new Intent(Intent.ACTION_VIEW),
                        PendingIntent.FLAG_IMMUTABLE | PendingIntent.FLAG_CANCEL_CURRENT
                )
        ).build()
};
shareIntent.putExtra(Intent.EXTRA_CHOOSER_CUSTOM_ACTIONS, actions);
context.startActivity(shareIntent);

使用 Android 意圖解析器

ACTION_SEND 意圖解析器的螢幕截圖。

Android 意圖解析器在定義工作流程中,將資料傳送至其他應用程式時,最適合使用 Android 意圖解析器。

如要使用 Android 意圖解析器,請像呼叫 Android Sharesheet 一樣建立意圖並新增額外項目。不過,「請勿」呼叫 Intent.createChooser()

如果多個已安裝應用程式的篩選器符合 ACTION_SEND 和 MIME 類型,系統會顯示名為「意圖解析器」的消歧對話方塊,讓使用者選擇要共用的目標。如果單一應用程式相符,系統就會執行。

以下範例說明如何使用 Android 意圖解析器傳送文字:

Kotlin

val sendIntent: Intent = Intent().apply {
    action = Intent.ACTION_SEND
    putExtra(Intent.EXTRA_TEXT, "This is my text to send.")
    type = "text/plain"
}
startActivity(sendIntent)

Java

Intent sendIntent = new Intent();
sendIntent.setAction(Intent.ACTION_SEND);
sendIntent.putExtra(Intent.EXTRA_TEXT, "This is my text to send.");
sendIntent.setType("text/plain");
startActivity(sendIntent);

瞭解詳情

如要進一步瞭解如何傳送資料,請參閱「意圖和意圖篩選器」。