在 Android 中使用 Content Provider 复制复杂的数据

2023-11-06 19:59:13

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

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

一、使用粘贴板复制复杂数据的方法

1、在 URI 中对标识符进行编码

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

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

"content://com.example.contacts"

如果您希望将某个名称编码到此 URI，则应使用以下代码段：

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。为响应查询，您的提供程序会返回它当前包含的数据。

2、复制数据结构

介绍了如何从剪贴板获取内容 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 类型：

// 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 放到剪贴板中

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);

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

3、在 Content Provider 的全局范围内，创建一个 URI 匹配器并添加一个与您放到剪贴板中的 URI 匹配的 URI 模式：

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 模式（具体取决于您编码它的方式），但系统仅会显示剪贴板复制操作的模式：

// 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:
            // query and return the contact for the requested name. Here you would decode
            // the incoming URI, query the data model based on the last name, and return the result
            // as a Cursor.
    ...

}

5、设置 getType() 方法，以返回复制的数据的相应 MIME 类型：

// Sets up your provider's getType() method.
public String getType(Uri uri) {
    ...

    switch (sUriMatcher.match(uri)) {
        case GET_SINGLE_CONTACT:
            return (MIME_TYPE_CONTACT);
        ...
}

三、注意

在任何时候，剪贴板中都只能有一个剪切。任何应用在系统中执行的新的复制操作都会覆盖上一个剪切。由于用户可能会离开您的应用并在执行复制操作后返回，因此您不能假设剪贴板中包含用户之前在您的应用中复制的剪切。

每个剪切有多个 ClipData.Item 对象的预期目的是，支持复制和粘贴多个选择，而不是一个选择的不同引用形式。您通常希望一个剪切中的所有 ClipData.Item 对象都采用相同的形式，也就是说，它们应该都是简单文本、内容 URI 或 Intent，而不是这些形式的混合。

提供数据时，您可以提供不同的 MIME 表示形式。将您支持的 MIME 类型添加到 ClipDescription，然后在Content Provider中实现这些 MIME 类型。

当您从剪贴板获取数据时，您的应用负责检查可用的 MIME 类型，并决定使用哪种类型（如果有）。即使剪贴板中有剪切且用户请求粘贴，您的应用也无需执行粘贴操作。您应该在 MIME 类型兼容时执行粘贴操作。您可以选择使用 coerceToText()（如果已选择）将剪贴板中的数据强制转换成文本。如果您的应用支持多种可用的 MIME 类型，您可以允许用户选择要使用哪一种。