复制和粘贴

Android 提供了一个强大的基于剪贴板的框架，用于复制和粘贴。它支持简单和复杂的数据类型，包括文本字符串、复杂的数据结构、文本和二进制流数据以及应用资源。简单的文本数据直接存储在剪贴板中，而复杂的数据则存储为引用，粘贴应用会使用 content provider 对其进行解析。复制和粘贴既可以在应用内进行，也可以在实现该框架的应用之间进行。

由于该框架的一部分使用 content provider，因此本文档假定您对 Android Content Provider API（详见 Content Provider）有一定的了解。

用户希望在将内容复制到剪贴板时获得反馈，因此除了支持复制和粘贴的框架之外，在 Android 13（API 级别 33）及更高版本中进行复制时，Android 还会向用户显示默认界面。由于此功能，存在重复通知的风险。如需详细了解这种极端情况，请参阅避免重复通知部分。

显示 Android 13 剪贴板通知的动画
图 1. 在 Android 13 及更高版本中，内容进入剪贴板时显示的界面。

在 Android 12L（API 级别 32）及更低版本中进行复制时手动向用户提供反馈。请参阅本文档中的相关建议。

剪贴板框架

使用剪贴板框架时，请将数据放入剪贴对象中，然后将剪贴对象放到系统级剪贴板中。裁剪对象可以采用以下三种形式之一：

文本
一个文本字符串。将字符串直接放在剪切对象中，然后放到剪贴板中。如需粘贴字符串，请从剪贴板中获取剪切对象，然后将字符串复制到应用的存储空间。
URI
一个 Uri 对象，表示任何形式的 URI。这主要适用于从 content provider 复制复杂数据。如需复制数据，请将 Uri 对象放入一个剪切对象中，并将该剪切对象放到剪贴板中。如需粘贴数据，请获取裁剪对象，获取 Uri 对象，将其解析为数据源（例如 content provider），然后将数据从来源复制到应用的存储空间。
intent
一个 Intent。这支持复制应用快捷方式。如需复制数据，请创建一个 Intent，将其放入一个剪切对象中，然后将该剪切对象放到剪贴板中。如需粘贴数据，请获取裁剪对象，然后将 Intent 对象复制到应用的内存区域。

剪贴板一次只保留一个剪贴对象。当应用将一个剪贴对象放到剪贴板上时，上一个剪贴对象会消失。

如果您希望允许用户将数据粘贴到您的应用中，则无需处理所有类型的数据。您可以先检查剪贴板中的数据，然后再向用户提供粘贴数据的选项。 除了具有特定的数据形式之外，剪贴对象还包含可让您了解可用的 MIME 类型的元数据。此元数据可帮助您确定应用是否可以使用剪贴板数据执行一些有用的操作。例如，如果您的应用主要处理文本，您可能需要忽略包含 URI 或 intent 的裁剪对象。

您可能还希望无论剪贴板中的数据采用何种形式，用户都可以粘贴文本。为此，请强制将剪贴板数据转换为文本表示形式，然后粘贴此文本。相关说明请参阅将剪贴板数据强制转换为文本部分。

剪贴板课程

本部分介绍了剪贴板框架使用的类。

ClipboardManager

Android 系统剪贴板由全局 ClipboardManager 类表示。不要直接实例化此类。而是通过调用 getSystemService(CLIPBOARD_SERVICE) 获取对它的引用。

ClipData、ClipData.Item 和 ClipDescription

如需将数据添加到剪贴板，请创建一个 ClipData 对象，其中包含数据的说明和数据本身。剪贴板一次���含一个 ClipData。ClipData 包含一个 ClipDescription 对象以及一个或多个 ClipData.Item 对象。

ClipDescription 对象包含关于剪切的元数据。具体来说，它包含剪辑数据的可用 MIME 类型数组。此外，在 Android 12（API 级别 31）及更高版本中，元数据包含有关对象是否包含样式化文本的信息以及有关对象中的文本类型的信息。当您将某个剪切放到剪贴板中后，粘贴应用可以获得此信息，该应用可以检查自身是否可以处理该剪切数据。

ClipData.Item 对象包含文本、URI 或 intent 数据：

文本
一个 CharSequence。
URI
一个 Uri。尽管允许使用任何 URI，但这通常包含 content provider URI。提供数据的应用将 URI 放到剪贴板中。需要粘贴数据的应用从剪贴板获取 URI，并使用它来访问 content provider 或其他数据源以及检索数据。
intent
一个 Intent。通过此数据类型，您可以将应用快捷方式复制到剪贴板。然后，用户可以将快捷方式粘贴到自己的应用中以供日后使用。

您可以向一个剪切添加多个 ClipData.Item 对象。这样，用户就可以将多个选择复制和粘贴为一个剪切。例如，如果您有一个列表 widget，可让用户一次选择多个项，那么您可以一次性将所有项复制到剪贴板。为此，请分别为每个列表项创建一个 ClipData.Item，然后将 ClipData.Item 对象添加到 ClipData 对象中。

ClipData 便捷方法

ClipData 类提供了静态便捷方法，用于创建具有单个 ClipData.Item 对象和简单的 ClipDescription 对象的 ClipData 对象：

newPlainText(label, text)
返回一个 ClipData 对象，该对象的单个 ClipData.Item 对象包含一个文本字符串。ClipDescription 对象的标签设置为 label。ClipDescription 中的单一 MIME 类型为 MIMETYPE_TEXT_PLAIN。

使用 newPlainText() 可从文本字符串创建剪切。

newUri(resolver, label, URI)
返回一个 ClipData 对象，该对象的单个 ClipData.Item 对象包含一个 URI。ClipDescription 对象的标签设置为 label。如果该 URI 是内容 URI（即 Uri.getScheme() 返回 content:），该方法会使用 resolver 中提供的 ContentResolver 对象从 content provider 检索可用的 MIME 类型。然后，它会将它们存储在 ClipDescription 中。对于不是 content: URI 的 URI，此方法会将 MIME 类型设置为 MIMETYPE_TEXT_URILIST。

使用 newUri() 可从 URI（尤其是 content: URI）创建剪切。

newIntent(label, intent)
返回一个 ClipData 对象，该对象的单个 ClipData.Item 对象包含一个 Intent。ClipDescription 对象的标签设置为 label。MIME 类型设置为 MIMETYPE_TEXT_INTENT。

使用 newIntent() 根据 Intent 对象创建裁剪。

将剪贴板数据强制转换为文本

即使您的应用仅处理文本，您也可以从剪贴板中复制非文本数据，只需使用 ClipData.Item.coerceToText() 方法进行转换即可。

此方法会将 ClipData.Item 中的数据转换为文本，并返回 CharSequence。ClipData.Item.coerceToText() 返回的值基于 ClipData.Item 中的数据形式：

文本
如果 ClipData.Item 是文本（即，如果 getText() 不为 null），coerceToText() 会返回该文本。
URI
如果 ClipData.Item 是一个 URI（即，如果 getUri() 不为 null），则 coerceToText() 会尝试将其用作内容 URI。
  • 如果该 URI 是内容 URI，并且提供程序可以返回文本流，则 coerceToText() 会返回文本流。
  • 如果此 URI 是内容 URI，但提供程序不提供文本流，则 coerceToText() 会返回此 URI 的一个表示形式。该表示形式与 Uri.toString() 返回的表示形式相同。
  • 如果该 URI 不是内容 URI，则 coerceToText() 会返回此 URI 的表示形式。该表示形式与 Uri.toString() 返回的表示形式相同。
intent
如果 ClipData.Item 是 Intent（即 getIntent() 不为 null），coerceToText() 会将其转换为 Intent URI 并返回。 该表示形式与 Intent.toUri(URI_INTENT_SCHEME) 返回的表示形式相同。

图 2 总结了剪贴板框架。为了复制数据，应用会将一个 ClipData 对象放到 ClipboardManager 全局剪贴板中。ClipData 包含一个或多个 ClipData.Item 对象和一个 ClipDescription 对象。如需粘贴数据，应用需要获取 ClipData，从 ClipDescription 获取其 MIME 类型，然后从 ClipData.Item 或 ClipData.Item 引用的 content provider 获取数据。

一张图片，显示复制和粘贴框架的方框图
图 2.Android 剪贴板框架。

复制到剪贴板

如需将数据复制到剪贴板，请获取全局 ClipboardManager 对象的句柄，创建一个 ClipData 对象，然后向其添加 ClipDescription 以及一个或多个 ClipData.Item 对象。然后，将完成的 ClipData 对象添加到 ClipboardManager 对象中。以下过程对此进行了详细说明：

  1. 如果您要使用内容 URI 复制数据，请设置一个 content provider。
  2. 获取系统剪贴板：

    Kotlin

    when(menuItem.itemId) {
    ...
    R.id.menu_copy -> { // if the user selects copy
        // Gets a handle to the clipboard service.
        val clipboard = getSystemService(Context.CLIPBOARD_SERVICE) as ClipboardManager
    }
}

    Java

    ...
// If the user selects copy.
case R.id.menu_copy:

// Gets a handle to the clipboard service.
ClipboardManager clipboard = (ClipboardManager)
        getSystemService(Context.CLIPBOARD_SERVICE);

  3. 将数据复制到新的 ClipData 对象：

    • 适用于文本

      Kotlin

      // Creates a new text clip to put on the clipboard.
val clip: ClipData = ClipData.newPlainText("simple text", "Hello, World!")

      Java

      // Creates a new text clip to put on the clipboard.
ClipData clip = ClipData.newPlainText("simple text", "Hello, World!");
    • 对于 URI

      此代码段通过将记录 ID 编码到提供程序的内容 URI 来构建 URI。在 URI 中对标识符进行编码部分详细介绍了此方法。

      Kotlin

      // Creates a Uri using a base Uri and a record ID based on the contact's last
// name. Declares the base URI string.
const val CONTACTS = "content://com.example.contacts"

// Declares a path string for URIs, used to copy data.
const val COPY_PATH = "/copy"

// Declares the Uri to paste to the clipboard.
val copyUri: Uri = Uri.parse("$CONTACTS$COPY_PATH/$lastName")
...
// Creates a new URI clip object. The system uses the anonymous
// getContentResolver() object to get MIME types from provider. The clip object's
// label is "URI", and its data is the Uri previously created.
val clip: ClipData = ClipData.newUri(contentResolver, "URI", copyUri)

      Java

      // Creates a Uri using a base Uri and a record ID based on the contact's last
// name. Declares the base URI string.
private static final String CONTACTS = "content://com.example.contacts";

// Declares a path string for URIs, used to copy data.
private static final String COPY_PATH = "/copy";

// Declares the Uri to paste to the clipboard.
Uri copyUri = Uri.parse(CONTACTS + COPY_PATH + "/" + lastName);
...
// Creates a new URI clip object. The system uses the anonymous
// getContentResolver() object to get MIME types from provider. The clip object's
// label is "URI", and its data is the Uri previously created.
ClipData clip = ClipData.newUri(getContentResolver(), "URI", copyUri);
    • 对于 intent

      以下代码段为应用构造 Intent，然后将其放入裁剪对象中：

      Kotlin

      // Creates the Intent.
val appIntent = Intent(this, com.example.demo.myapplication::class.java)
...
// Creates a clip object with the Intent in it. Its label is "Intent"
// and its data is the Intent object created previously.
val clip: ClipData = ClipData.newIntent("Intent", appIntent)

      Java

      // Creates the Intent.
Intent appIntent = new Intent(this, com.example.demo.myapplication.class);
...
// Creates a clip object with the Intent in it. Its label is "Intent"
// and its data is the Intent object created previously.
ClipData clip = ClipData.newIntent("Intent", appIntent);
  4. 将新的剪切对象放到剪贴板：

    Kotlin

    // Set the clipboard's primary clip.
clipboard.setPrimaryClip(clip)

    Java

    // Set the clipboard's primary clip.
clipboard.setPrimaryClip(clip);

在复制到剪贴板时提供反馈

当应用将内容复制到剪贴板时，用户希望获得视觉反馈。在 Android 13 及更高版本中，系统会自动为用户完成此过程，但在之前的版本中必须手动实现。

从 Android 13 开始，将内容添加到剪贴板时，系统会显示标准视觉确认界面。新确认界面会执行以下操作：

  • 确认内容已成功复制。
  • 提供所复制内容的预览。

显示 Android 13 剪贴板通知的动画
图 3. 在 Android 13 及更高版本中，内容进入剪贴板时显示的界面。

在 Android 12L（API 级别 32）及更低版本中，用户可能不确定他们是否成功复制了内容或复制了什么内容。此功能可将应用复制后显示的各种通知标准化，并���用户可以更好地控制剪贴板。

避免显示重复的通知

在 Android 12L（API 级别 32）及更低版本中，我们建议在用户成功复制后提醒用户，方法是在复制后使用 Toast 或 Snackbar 等 widget 发出视觉的应用内反馈。

为避免重复显示信息，对于 Android 13 及更高版本，我们强烈建议您移除在应用内复制内容之后显示的消息框或信息提示控件。

在应用内复制内容后显示信息提示控件。
图 4. 如果您在 Android 13 中显示复制确认信息提示控件，用户会看到重复消息。
在应用内复制内容后显示消息框。
图 5.如果您在 Android 13 中显示复制确认消息框，用户会看到重复消息。

以下示例展示了如何实现这一点：

fun textCopyThenPost(textCopied:String) {
    val clipboardManager = getSystemService(CLIPBOARD_SERVICE) as ClipboardManager
    // When setting the clipboard text.
    clipboardManager.setPrimaryClip(ClipData.newPlainText   ("", textCopied))
    // Only show a toast for Android 12 and lower.
    if (Build.VERSION.SDK_INT <= Build.VERSION_CODES.S_V2)
        Toast.makeText(context, “Copied”, Toast.LENGTH_SHORT).show()
}

将敏感内容添加到剪贴板

如果您的应用允许用户将敏感内容（例如密码或信用卡信息）复制到剪贴板，则您必须先在 ClipData 中的 ClipDescription 中添加一个标志，然后再调用 ClipboardManager.setPrimaryClip()。在 Android 13 及更高版本中，添加此标志可防止敏感内容出现在复制内容的视觉确认中。

所复制文本的预览（未标记敏感内容）
图 6. 所复制文本的预览（不含敏感内容标记）。
所复制文本的预览（已标记敏感内容）。
图 7.已复制文本的预览，带有敏感内容标记。

如需标记敏感内容，请向 ClipDescription 添加一个布尔型 extra。无论应用的目标 API 级别如何，所有应用都必须这样做。

// If your app is compiled with the API level 33 SDK or higher.
clipData.apply {
    description.extras = PersistableBundle().apply {
        putBoolean(ClipDescription.EXTRA_IS_SENSITIVE, true)
    }
}

// If your app is compiled with a lower SDK.
clipData.apply {
    description.extras = PersistableBundle().apply {
        putBoolean("android.content.extra.IS_SENSITIVE", true)
    }
}

从剪贴板粘贴

如前所述，您可以通过以下方法从剪贴板中粘贴数据：获取全局剪贴板对象、获取裁剪对象、查看其数据，然后将数据从剪切对象复制到您自己的存储空间（如果可能）。本部分详细介绍了如何粘贴三种形式的剪贴板数据。

粘贴纯文本

如需粘贴纯文本，请获取全局剪贴板并验证它是否可以返回纯文本。然后，如以下过程所述，获取裁剪对象，并使用 getText() 将其文本复制到您自己的存储空间：

  1. 使用 getSystemService(CLIPBOARD_SERVICE) 获取全局 ClipboardManager 对象。此外，声明一个全局变量以包含粘贴的文本：

    Kotlin

    var clipboard = getSystemService(Context.CLIPBOARD_SERVICE) as ClipboardManager
var pasteData: String = ""

    Java

    ClipboardManager clipboard = (ClipboardManager) getSystemService(Context.CLIPBOARD_SERVICE);
String pasteData = "";
  2. 确定您是否需要在当前 activity 中启用或停用“粘贴”选项。验证剪贴板是否包含剪切，以及您是否可以处理该剪切所表示的数据类型：

    Kotlin

    // Gets the ID of the "paste" menu item.
val pasteItem: MenuItem = menu.findItem(R.id.menu_paste)

// If the clipboard doesn't contain data, disable the paste menu item.
// If it does contain data, decide whether you can handle the data.
pasteItem.isEnabled = when {
    !clipboard.hasPrimaryClip() -> {
        false
    }
    !(clipboard.primaryClipDescription.hasMimeType(MIMETYPE_TEXT_PLAIN)) -> {
        // Disables the paste menu item, since the clipboard has data but it
        // isn't plain text.
        false
    }
    else -> {
        // Enables the paste menu item, since the clipboard contains plain text.
        true
    }
}

    Java

    // Gets the ID of the "paste" menu item.
MenuItem pasteItem = menu.findItem(R.id.menu_paste);

// If the clipboard doesn't contain data, disable the paste menu item.
// If it does contain data, decide whether you can handle the data.
if (!(clipboard.hasPrimaryClip())) {

    pasteItem.setEnabled(false);

} else if (!(clipboard.getPrimaryClipDescription().hasMimeType(MIMETYPE_TEXT_PLAIN))) {

    // Disables the paste menu item, since the clipboard has data but
    // it isn't plain text.
    pasteItem.setEnabled(false);
} else {

    // Enables the paste menu item, since the clipboard contains plain text.
    pasteItem.setEnabled(true);
}
  3. 从剪贴板复制数据。只有在“粘贴”菜单项处于启用状态时，才能访问代码中的这一点，因此您可以假定剪贴板包含纯文本。您还不知道它是否包含文本字符串或指向纯文本的 URI。以下代码段对此进行了测试，但它仅显示用于处理纯文本的代码：

    Kotlin

    when (menuItem.itemId) {
    ...
    R.id.menu_paste -> {    // Responds to the user selecting "paste".
        // Examines the item on the clipboard. If getText() doesn't return null,
        // the clip item contains the text. Assumes that this application can only
        // handle one item at a time.
        val item = clipboard.primaryClip.getItemAt(0)

        // Gets the clipboard as text.
        pasteData = item.text

        return if (pasteData != null) {
            // If the string contains data, then the paste operation is done.
            true
        } else {
            // The clipboard doesn't contain text. If it contains a URI,
            // attempts to get data from it.
            val pasteUri: Uri? = item.uri

            if (pasteUri != null) {
                // If the URI contains something, try to get text from it.

                // Calls a routine to resolve the URI and get data from it.
                // This routine isn't presented here.
                pasteData = resolveUri(pasteUri)
                true
            } else {

                // Something is wrong. The MIME type was plain text, but the
                // clipboard doesn't contain text or a Uri. Report an error.
                Log.e(TAG,"Clipboard contains an invalid data type")
                false
            }
        }
    }
}

    Java

    // Responds to the user selecting "paste".
case R.id.menu_paste:

// Examines the item on the clipboard. If getText() does not return null,
// the clip item contains the text. Assumes that this application can only
// handle one item at a time.
 ClipData.Item item = clipboard.getPrimaryClip().getItemAt(0);

// Gets the clipboard as text.
pasteData = item.getText();

// If the string contains data, then the paste operation is done.
if (pasteData != null) {
    return true;

// The clipboard doesn't contain text. If it contains a URI, attempts to get
// data from it.
} else {
    Uri pasteUri = item.getUri();

    // If the URI contains something, try to get text from it.
    if (pasteUri != null) {

        // Calls a routine to resolve the URI and get data from it.
        // This routine isn't presented here.
        pasteData = resolveUri(Uri);
        return true;
    } else {

        // Something is wrong. The MIME type is plain text, but the
        // clipboard doesn't contain text or a Uri. Report an error.
        Log.e(TAG, "Clipboard contains an invalid data type");
        return false;
    }
}

粘贴来自内容 URI 的数据

如果 ClipData.Item 对象包含内容 URI，并且您确定可以处理其某种 MIME 类型，请创建一个 ContentResolver 并调用相应的 content provider 方法以检索数据。

以下步骤介绍了如何根据剪贴板中的内容 URI 从 content provider 获取数据。它会检查提供程序中是否有应用可以使用的 MIME 类型。

  1. 声明一个全局变量以包含 MIME 类型：

    Kotlin

    // Declares a MIME type constant to match against the MIME types offered
// by the provider.
const val MIME_TYPE_CONTACT = "vnd.android.cursor.item/vnd.example.contact"

    Java

    // Declares a MIME type constant to match against the MIME types offered by
// the provider.
public static final String MIME_TYPE_CONTACT = "vnd.android.cursor.item/vnd.example.contact";
  2. 获取全局剪贴板。另外，获取一个内容解析器，以便您可以访问 Content Provider：

    Kotlin

    // Gets a handle to the Clipboard Manager.
val clipboard = getSystemService(Context.CLIPBOARD_SERVICE) as ClipboardManager

// Gets a content resolver instance.
val cr = contentResolver

    Java

    // Gets a handle to the Clipboard Manager.
ClipboardManager clipboard = (ClipboardManager) getSystemService(Context.CLIPBOARD_SERVICE);

// Gets a content resolver instance.
ContentResolver cr = getContentResolver();
  3. 从剪贴板中获取主剪切，并获取其内容作为 URI：

    Kotlin

    // Gets the clipboard data from the clipboard.
val clip: ClipData? = clipboard.primaryClip

clip?.run {

    // Gets the first item from the clipboard data.
    val item: ClipData.Item = getItemAt(0)

    // Tries to get the item's contents as a URI.
    val pasteUri: Uri? = item.uri

    Java

    // Gets the clipboard data from the clipboard.
ClipData clip = clipboard.getPrimaryClip();

if (clip != null) {

    // Gets the first item from the clipboard data.
    ClipData.Item item = clip.getItemAt(0);

    // Tries to get the item's contents as a URI.
    Uri pasteUri = item.getUri();
  4. 通过调用 getType(Uri) 测试相应 URI 是否为内容 URI。 如果 Uri 不指向有效的 content provider，则此方法会返回 null。

    Kotlin

        // If the clipboard contains a URI reference...
    pasteUri?.let {

        // ...is this a content URI?
        val uriMimeType: String? = cr.getType(it)

    Java

        // If the clipboard contains a URI reference...
    if (pasteUri != null) {

        // ...is this a content URI?
        String uriMimeType = cr.getType(pasteUri);
  5. 测试 content provider 是否支持应用可以理解的 MIME 类型。如果支持，请调用 ContentResolver.query() 以获取数据。返回值是 Cursor。

    Kotlin

            // If the return value isn't null, the Uri is a content Uri.
        uriMimeType?.takeIf {

            // Does the content provider offer a MIME type that the current
            // application can use?
            it == MIME_TYPE_CONTACT
        }?.apply {

            // Get the data from the content provider.
            cr.query(pasteUri, null, null, null, null)?.use { pasteCursor ->

                // If the Cursor contains data, move to the first record.
                if (pasteCursor.moveToFirst()) {

                    // Get the data from the Cursor here.
                    // The code varies according to the format of the data model.
                }

                // Kotlin `use` automatically closes the Cursor.
            }
        }
    }
}

    Java

            // If the return value isn't null, the Uri is a content Uri.
        if (uriMimeType != null) {

            // Does the content provider offer a MIME type that the current
            // application can use?
            if (uriMimeType.equals(MIME_TYPE_CONTACT)) {

                // Get the data from the content provider.
                Cursor pasteCursor = cr.query(uri, null, null, null, null);

                // If the Cursor contains data, move to the first record.
                if (pasteCursor != null) {
                    if (pasteCursor.moveToFirst()) {

                    // Get the data from the Cursor here.
                    // The code varies according to the format of the data model.
                    }
                }

                // Close the Cursor.
                pasteCursor.close();
             }
         }
     }
}

粘贴 Intent

如需粘贴 intent，请先获取全局剪贴板。检查 ClipData.Item 对象，确定它是否包含 Intent。然后调用 getIntent() 以将 intent 复制到您自己的存储空间。以下代码段演示了此过程：

Kotlin

// Gets a handle to the Clipboard Manager.
val clipboard = getSystemService(Context.CLIPBOARD_SERVICE) as ClipboardManager

// Checks whether the clip item contains an Intent by testing whether
// getIntent() returns null.
val pasteIntent: Intent? = clipboard.primaryClip?.getItemAt(0)?.intent

if (pasteIntent != null) {

    // Handle the Intent.

} else {

    // Ignore the clipboard, or issue an error if
    // you expect an Intent to be on the clipboard.
}

Java

// Gets a handle to the Clipboard Manager.
ClipboardManager clipboard = (ClipboardManager) getSystemService(Context.CLIPBOARD_SERVICE);

// Checks whether the clip item contains an Intent, by testing whether
// getIntent() returns null.
Intent pasteIntent = clipboard.getPrimaryClip().getItemAt(0).getIntent();

if (pasteIntent != null) {

    // Handle the Intent.

} else {

    // Ignore the clipboard, or issue an error if
    // you expect an Intent to be on the clipboard.
}

在应用访问剪贴板数据时显示系统通知

在 Android 12（API 级别 31）及更高版本中，系统通常会在您的应用调用 getPrimaryClip() 时显示消息框消息。消息中的文本包含以下格式：

APP pasted from your clipboard

当应用执行以下任一操作时，系统不会显示消息框消息：

  • 从您自己的应用访问 ClipData。
  • 从特定应用反复访问 ClipData。仅当您的应用首次访问该应用中的数据时，消息框才会显示。
  • 检索剪辑对象的元数据，例如通过调用 getPrimaryClipDescription()（而不是 getPrimaryClip()）进行检索。

使用 content provider 复制复杂数据

content provider 支持复制数据库记录或文件流等复杂数据。如需复制数据，请将内容 URI 放到剪贴板中。然后，粘贴应用会从剪贴板获取此 URI，并使用它来检索数据库数据或文件流描述符。

由于粘贴应用只有数据的内容 URI，因此它需要知道要检索哪段数据。您可以通过在 URI 本身中对数据的标识符进行编码来提供此信息，也可以提供一个返回要复制的数据的唯一 URI。选择哪种方法取决于数据的组织方式。

以下部分介绍了如何设置 URI、提供复杂数据和提供文件流。本文假定您熟悉 content provider 设计的一般原则。

对 URI 上的标识符进行编码

使用 URI 将数据复制到剪贴板的一种实用方法是，在 URI 本身中对数据的标识符进行编码。然后，您的 content provider 可以从 URI 中获取标识符，并使用它来检索数据。粘贴应用无需知道标识符的存在。它只需从剪贴板获取您的“引用”（URI 和标识符），将其提供给您的内容提供程序，然后获取数据。

通常情况下，您可以通过将标识符连接到内容 URI 的末尾，将标识符编码到内容 URI 中。例如，假设您将提供程序 URI 定义为以下字符串：

"content://com.example.contacts"

如果要将名称编码到此 URI，请使用以下代码段：

Kotlin

val uriString = "content://com.example.contacts/Smith"

// uriString now contains content://com.example.contacts/Smith.

// Generates a uri object from the string representation.
val copyUri = Uri.parse(uriString)

Java

String uriString = "content://com.example.contacts" + "/" + "Smith";

// uriString now contains content://com.example.contacts/Smith.

// Generates a uri object from the string representation.
Uri copyUri = Uri.parse(uriString);

如果您已经在使用 content provider，则可能需要添加新的 URI 路径来指示该 URI 用于复制。例如，假设您已有以下 URI 路径：

"content://com.example.contacts/people"
"content://com.example.contacts/people/detail"
"content://com.example.contacts/people/images"

您可以添加另一个用于复制 URI 的路径：

"content://com.example.contacts/copying"

然后，您可以通过模式匹配检测“复制”URI，并使用专用于复制和粘贴的代码处理该 URI。

如果您已经在使用 content provider、内部数据库或内部表来整理数据，则通常使用该编码方法。在这些情况下，您有多份要复制的数据，可能每份数据都有一个唯一标识符。为响应来自粘贴应用的查询，您可以按数据标识符查找数据并返回数据。

如果您没有多份数据，则可能不需要对标识符进行编码。您可以使用您的提供程序独有的 URI。为响应查询，您的提供程序会返回它当前包含的数据。

复制数据结构

设置一个用于复制和粘贴复杂数据的 content provider，作为 ContentProvider 组件的子类。对放到剪贴板中的 URI 进行编码，使其指向您要提供的确切记录。此外，请考虑应用的现有状态：

  • 如果您已有 Content Provider，则可以添加其功能。您可能只需修改其 query() 方法，以处理来自要粘贴数据的应用的 URI。您可能需要修改该方法，以处理“复制”URI 模式。
  • 如果您的应用维护了一个内部数据库，您可能需要将此数据库移至 content provider，以便从该数据库进行复制。
  • 如果您未使用数据库，则可以实现一个简单的 content provider，它的唯一用途就是向从剪贴板粘贴内容的应用提供数据。

在 content provider 中，至少替换以下方法：

query()
粘贴应用假定它们可以通过使用您放到剪贴板中的 URI 使用此方法来获取您的数据。如需支持复制，请让此方法检测包含特��“复制”路径的 URI。然后，您的应用可以创建一个要放到剪贴板中的“复制”URI，其中包含复制路径和指向要复制的确切记录的指针。
getType()
此方法必须返回要复制的数据的 MIME 类型。方法 newUri() 会调用 getType()，以将 MIME 类型放入新的 ClipData 对象中。

Content Provider 对复杂数据的 MIME 类型进行了介绍。

您无需使用任何其他 content provider 方法，例如 insert() 或 update()。粘贴应用只需获取您支持的 MIME 类型并从您的提供程序复制数据。 如果您已拥有这些方法，它们不会干扰复制操作。

以下代码段演示了如何设置应用以复制复杂数据：

  1. 在应用的全局常量中，声明一个基本 URI 字符串和一个可标识您用于复制数据的 URI 字符串的路径。此外，还要声明复制的数据的 MIME 类型。

    Kotlin

    // Declares the base URI string.
private const val CONTACTS = "content://com.example.contacts"

// Declares a path string for URIs that you use to copy data.
private const val COPY_PATH = "/copy"

// Declares a MIME type for the copied data.
const val MIME_TYPE_CONTACT = "vnd.android.cursor.item/vnd.example.contact"

    Java

    // Declares the base URI string.
private static final String CONTACTS = "content://com.example.contacts";

// Declares a path string for URIs that you use to copy data.
private static final String COPY_PATH = "/copy";

// Declares a MIME type for the copied data.
public static final String MIME_TYPE_CONTACT = "vnd.android.cursor.item/vnd.example.contact";
  2. 在用户从中复制数据的 activity 中，设置用于将数据复制到剪贴板的代码。 为响应复制请求，将 URI 放到剪贴板中。

    Kotlin

    class MyCopyActivity : Activity() {
    ...
when(item.itemId) {
    R.id.menu_copy -> { // The user has selected a name and is requesting a copy.
        // Appends the last name to the base URI.
        // The name is stored in "lastName".
        uriString = "$CONTACTS$COPY_PATH/$lastName"

        // Parses the string into a URI.
        val copyUri: Uri? = Uri.parse(uriString)

        // Gets a handle to the clipboard service.
        val clipboard = getSystemService(Context.CLIPBOARD_SERVICE) as ClipboardManager

        val clip: ClipData = ClipData.newUri(contentResolver, "URI", copyUri)

        // Sets the clipboard's primary clip.
        clipboard.setPrimaryClip(clip)
    }
}

    Java

    public class MyCopyActivity extends Activity {
    ...
// The user has selected a name and is requesting a copy.
case R.id.menu_copy:

    // Appends the last name to the base URI.
    // The name is stored in "lastName".
    uriString = CONTACTS + COPY_PATH + "/" + lastName;

    // Parses the string into a URI.
    Uri copyUri = Uri.parse(uriString);

    // Gets a handle to the clipboard service.
    ClipboardManager clipboard = (ClipboardManager)
        getSystemService(Context.CLIPBOARD_SERVICE);

    ClipData clip = ClipData.newUri(getContentResolver(), "URI", copyUri);

    // Sets the clipboard's primary clip.
    clipboard.setPrimaryClip(clip);

  3. 在 content provider 的全局范围内，创建一个 URI 匹配器，并添加与您放到剪贴板中的 URI 匹配的 URI 模式。

    Kotlin

    // A Uri Match object that simplifies matching content URIs to patterns.
private val sUriMatcher = UriMatcher(UriMatcher.NO_MATCH).apply {

    // Adds a matcher for the content URI. It matches.
    // "content://com.example.contacts/copy/*"
    addURI(CONTACTS, "names/*", GET_SINGLE_CONTACT)
}

// An integer to use in switching based on the incoming URI pattern.
private const val GET_SINGLE_CONTACT = 0
...
class MyCopyProvider : ContentProvider() {
    ...
}

    Java

    public class MyCopyProvider extends ContentProvider {
    ...
// A Uri Match object that simplifies matching content URIs to patterns.
private static final UriMatcher sURIMatcher = new UriMatcher(UriMatcher.NO_MATCH);

// An integer to use in switching based on the incoming URI pattern.
private static final int GET_SINGLE_CONTACT = 0;
...
// Adds a matcher for the content URI. It matches
// "content://com.example.contacts/copy/*"
sUriMatcher.addURI(CONTACTS, "names/*", GET_SINGLE_CONTACT);

  4. 设置 query() 方法。此方法可以处理不同的 URI 模式（具体取决于您的编码方式），但仅显示剪贴板复制操作的模式。

    Kotlin

    // Sets up your provider's query() method.
override fun query(
        uri: Uri,
        projection: Array<out String>?,
        selection: String?,
        selectionArgs: Array<out String>?,
        sortOrder: String?
): Cursor? {
    ...
    // When based on the incoming content URI:
    when(sUriMatcher.match(uri)) {

        GET_SINGLE_CONTACT -> {

            // Queries and returns the contact for the requested name. Decodes
            // the incoming URI, queries the data model based on the last name,
            // and returns the result as a Cursor.
        }
    }
    ...
}

    Java

    // Sets up your provider's query() method.
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
    String sortOrder) {
    ...
    // Switch based on the incoming content URI.
    switch (sUriMatcher.match(uri)) {

    case GET_SINGLE_CONTACT:

        // Queries and returns the contact for the requested name. Decodes the
        // incoming URI, queries the data model based on the last name, and
        // returns the result as a Cursor.
    ...
}

  5. 设置 getType() 方法，为复制的数据返回适当的 MIME 类型：

    Kotlin

    // Sets up your provider's getType() method.
override fun getType(uri: Uri): String? {
    ...
    return when(sUriMatcher.match(uri)) {
        GET_SINGLE_CONTACT -> MIME_TYPE_CONTACT
        ...
    }
}

    Java

    // Sets up your provider's getType() method.
public String getType(Uri uri) {
    ...
    switch (sUriMatcher.match(uri)) {
    case GET_SINGLE_CONTACT:
        return (MIME_TYPE_CONTACT);
    ...
    }
}

从内容 URI 粘贴数据部分介绍了如何从剪贴板获取内容 URI 并使用它来获取和粘贴数据。

复制数据流

您可以以流的形式复制和粘贴大量文本数据和二进制数据。数据可能包含如下表单：

  • 存储在实际设备上的文件
  • 来自套接字的流
  • 存储在提供程序的底层数据库系统中的大量数据

数据流的 content provider 使用文件描述符对象（例如 AssetFileDescriptor）（而不是 Cursor 对象）提供对其数据的访问权限。粘贴应用使用此文件描述符读取数据流。

如需设置应用以通过提供程序复制数据流，请按以下步骤操作：

  1. 为要放到剪贴板中的数据流设置内容 URI。您可以使用以下选项执行此操作：
    • 将数据流的标识符编码到 URI（如将标识符编码到 URI 部分中所述），然后在提供程序中维护一个包含标识符及相应数据流名称的表。
    • 直接在 URI 中对流名称进行编码。
    • 使用一个始终会从提供程序返回当前流的唯一 URI。如果您使用此选项，那么每当您使用 URI 将数据流复制到剪贴板时，都要记得更新您的提供程序以指向其他数据流。
  2. 为您计划提供的每种数据流类型提供 MIME 类型。粘贴应用需要此信息来确定它们是否可以将数据粘贴到剪贴板。
  3. 实现一个会返回流的文件描述符的 ContentProvider 方法。如果您在内容 URI 中对标识符进行编码，请使用此方法确定要打开的��。
  4. 如需将数据流复制到剪贴板，请构建内容 URI 并将其放到剪贴板。

如需粘贴数据流，应用需要从剪贴板获取剪切，获取 URI，然后在调用可打开数据流的 ContentResolver 文件描述符方法时使用它。ContentResolver 方法会调用相应的 ContentProvider 方法，并向其传递内容 URI。您的提供程序会将文件描述符返回到 ContentResolver 方法。然后，粘贴应用负责从数据流中读取数据。

以下列表显示了对 content provider 而言最重要的文件描述符方法。每种方法都有一个对应的 ContentResolver 方法，方法名称后面附加了字符串“Descriptor”。例如，openAssetFile() 的 ContentResolver 模拟为 openAssetFileDescriptor()。

openTypedAssetFile()

此方法会返回资源文件描述符，但前提是提供程序支持所提供的 MIME 类型。调用方（即执行粘贴的应用）会提供一个 MIME 类型模式。将 URI 复制到剪贴板的应用的内容提供程序如果可以提供该 MIME 类型，则会返回一个 AssetFileDescriptor 文件句柄；如果无法提供，则会抛出异常。

此方法可处理文件的子部分。您可以使用它来读取 content provider 已复制到剪贴板的资源。

openAssetFile()
此方法是 openTypedAssetFile() 更为通用的形式。它不会过滤出允许的 MIME 类型，但可以读取文件的子部分。
openFile()
这是 openAssetFile() 更为通用的形式。它无法读取文件的子部分。

您可以根据需要将 openPipeHelper() 方法与您的文件描述符方法结合使用。这样，粘贴应用便可以使用管道在后台线程中读取流数据。如需使用此方法，请实现 ContentProvider.PipeDataWriter 接口。

设计有效的复制和粘贴功能

若要为您的应用设计有效的复制和粘贴功能，请注意以下几点：

  • 在任何时候，剪贴板中都只能有一个剪切。系统中任何应用执行的新复制操作都会覆盖上一个剪切。由于用户可能会离开您的应用并在返回前执行复制操作，因此您不能假定剪贴板中包含用户之前在您的应用中复制的剪辑。
  • 每个裁剪有多个 ClipData.Item 对象的预期目的是支持复制和粘贴多个选择，而不是支持对单个选择的不同引用形式。通常，您希望剪切中的所有 ClipData.Item 对象都采用相同形式。也就是说，它们必须全部为简单文本、内容 URI 或 Intent，且不得混合使用。
  • 提供数据时，您可以提供不同的 MIME 表示形式。将您支持的 MIME 类型添加到 ClipDescription，然后在 content provider 中实现这些 MIME 类型。
  • 当您从剪贴板获取数据时，您的应用负责检查可用的 MIME 类型，并决定使用哪种类型（如果有）。即使剪贴板中有剪切且用户请求粘贴，您的应用也无需执行粘贴操作。如果 MIME 类型兼容，则执行粘贴操作。您可以使用 coerceToText() 将剪贴板中的数据强制转换为文本。如果您的应用支持多种可用的 MIME 类型，您可以让用户选择要使用的类型。