创建桩内容提供器

同步适配器框架旨在处理由灵活且高度安全的内容提供器框架管理的设备数据。因此,同步适配器框架要求使用该框架的应用已为其本地数据定义 content provider。 如果同步适配器框架尝试运行您的同步适配器,而您的应用没有 content provider,您的同步适配器将会崩溃。

如果您正在开发将数据从服务器传输到设备的新应用,强烈建议您将本地数据存储在 content provider 中。除了对同步适配器的重要性之外,内容提供程序还具有各种安全优势,并且专为处理 Android 系统上的数据存储而设计。如需详细了解如何创建 content provider,请参阅创建 Content Provider

不过,如果您已经通过其他形式存储本地数据,则仍可以使用同步适配器来处理数据传输。为了满足同步适配器框架对 content provider 的要求,请向您的应用中添加桩 content provider。桩提供器会实现 content provider 类,但其所需的所有方法都会返回 null0。如果您添加了桩提供器,则可以使用同步适配器从您选择的任何存储机制传输数据。

如果您的应用中已经有 content provider,则不需要桩内容提供器。 在这种情况下,您可以跳过本课程,继续学习创建同步适配器一课。如果您还没有内容提供器,本课将为您介绍如何添加桩内容提供器,以便您将同步适配器插入到框架中。

添加桩内容提供器

如需为您的应用创建桩内容提供器,请扩展 ContentProvider 类并为所需的方法打桩。以下代码段展示了如何创建桩提供器:

Kotlin

/*
 * Define an implementation of ContentProvider that stubs out
 * all methods
 */
class StubProvider : ContentProvider() {
    /*
     * Always return true, indicating that the
     * provider loaded correctly.
     */
    override fun onCreate(): Boolean  = true

    /*
     * Return no type for MIME type
     */
    override fun getType(uri: Uri): String?  = null

    /*
     * query() always returns no results
     *
     */
    override fun query(
            uri: Uri,
            projection: Array<String>,
            selection: String,
            selectionArgs: Array<String>,
            sortOrder: String
    ): Cursor?  = null

    /*
     * insert() always returns null (no URI)
     */
    override fun insert(uri: Uri, values: ContentValues): Uri? = null

    /*
     * delete() always returns "no rows affected" (0)
     */
    override fun delete(uri: Uri, selection: String, selectionArgs: Array<String>): Int = 0

    /*
     * update() always returns "no rows affected" (0)
     */
    override fun update(
            uri: Uri,
            values: ContentValues,
            selection: String,
            selectionArgs: Array<String>
    ): Int = 0
}

Java

/*
 * Define an implementation of ContentProvider that stubs out
 * all methods
 */
public class StubProvider extends ContentProvider {
    /*
     * Always return true, indicating that the
     * provider loaded correctly.
     */
    @Override
    public boolean onCreate() {
        return true;
    }
    /*
     * Return no type for MIME type
     */
    @Override
    public String getType(Uri uri) {
        return null;
    }
    /*
     * query() always returns no results
     *
     */
    @Override
    public Cursor query(
            Uri uri,
            String[] projection,
            String selection,
            String[] selectionArgs,
            String sortOrder) {
        return null;
    }
    /*
     * insert() always returns null (no URI)
     */
    @Override
    public Uri insert(Uri uri, ContentValues values) {
        return null;
    }
    /*
     * delete() always returns "no rows affected" (0)
     */
    @Override
    public int delete(Uri uri, String selection, String[] selectionArgs) {
        return 0;
    }
    /*
     * update() always returns "no rows affected" (0)
     */
    public int update(
            Uri uri,
            ContentValues values,
            String selection,
            String[] selectionArgs) {
        return 0;
    }
}

在清单中声明提供器

同步适配器框架通过检查应用是否已在其应用清单中声明了提供器,来验证应用是否具有内容提供器。如需在清单中声明桩提供器,请添加具有以下属性的 <provider> 元素:

android:name="com.example.android.datasync.provider.StubProvider"
指定实现桩内容提供器的类的完全限定名称。
android:authorities="com.example.android.datasync.provider"
用于标识桩 content provider 的 URI 授权。将此值设为应用的软件包名称,并在其后附加字符串“.provider”。即使您向系统声明了桩提供器,也不会有任何应用尝试访问该提供器。
android:exported="false"
确定其他应用是否可以访问 content provider。对于桩内容提供器,请将该值设为 false,因为不需要允许其他应用查看该提供器。此值不会影响同步适配器框架与 content provider 之间的交互。
android:syncable="true"
设置指示该提供程序可同步的标记。如果将此标志设置为 true,则无需在代码中调用 setIsSyncable()。该标记允许同步适配器框架与 content provider 进行数据传输,但只有当您明确执行时才会进行传输。

以下代码段展示了如何在应用清单中添加 <provider> 元素:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.android.network.sync.BasicSyncAdapter"
    android:versionCode="1"
    android:versionName="1.0" >
    <application
        android:allowBackup="true"
        android:icon="@drawable/ic_launcher"
        android:label="@string/app_name"
        android:theme="@style/AppTheme" >
    ...
    <provider
        android:name="com.example.android.datasync.provider.StubProvider"
        android:authorities="com.example.android.datasync.provider"
        android:exported="false"
        android:syncable="true"/>
    ...
    </application>
</manifest>

现在,您已经创建了同步适配器框架所需的依赖项,接下来可以创建封装数据传输代码的组件了。该组件称为同步适配器。下一课将介绍如何在应用中添加此组件。