创建占位内容提供程序

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

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

但是，如果您已经以其他形式存储本地数据，仍然可以使用同步适配器处理数据传输。为了满足同步适配器框架对内容提供程序的要求，请在您的应用中添加一个占位内容提供程序。占位提供程序实现了 content provider 类，但其所有必需方法都返回 null 或 0。如果您添加了占位提供程序，则可以使用同步适配器从您选择的任何存储机制传输数据。

如果您的应用中已有内容提供程序，则无需占位内容提供程序。在这种情况下，您可以跳过此课程，继续学习创建同步适配器。如果您还没有内容提供程序，本课程将向您展示如何添加占位内容提供程序，以便将您的同步适配器接入框架。

添加占位内容提供程序

要为您的应用创建占位内容提供程序，请扩展 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"
用于标识占位内容提供程序的 URI authority。将此值设置为您的应用软件包名称并附加字符串 “.provider”。即使您向系统声明了占位提供程序，也不会有任何内容尝试访问提供程序本身。
android:exported="false"
确定其他应用是否可以访问内容提供程序。对于您的占位内容提供程序，将此值设置为 false，因为无需允许其他应用查看该提供程序。此值不影响同步适配器框架与内容提供程序之间的交互。
android:syncable="true"
设置一个标志，指示提供程序可同步。如果您将此标志设置为 true，则无需在代码中调用 setIsSyncable()。此标志允许同步适配器框架与内容提供程序进行数据传输，但传输只有在您明确执行时才会发生。

以下代码段展示了如何将 <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>

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