Android 同步适配器开发指南：创建 Sync Adapter 组件

最新推荐文章于 2025-06-04 09:03:16 发布

强懿方

最新推荐文章于 2025-06-04 09:03:16 发布

阅读量408

点赞数 4

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00407/article/details/148415909

Android 同步适配器开发指南：创建 Sync Adapter 组件

android-training-course-in-chinese Android官方培训课程中文版项目地址: https://gitcode.com/gh_mirrors/an/android-training-course-in-chinese

本文将详细介绍如何在 Android 应用中创建 Sync Adapter 组件，实现设备与服务器之间的数据同步功能。Sync Adapter 是 Android 同步框架的核心组件，它负责在后台执行数据传输任务，并可以智能地根据网络状况和系统资源进行调度。

一、Sync Adapter 组件概述

Sync Adapter 是 Android 提供的一种标准化的数据同步机制，主要包含以下几个部分：

Sync Adapter 类：封装实际的数据传输逻辑
绑定服务：允许框架调用 Sync Adapter
XML 元数据文件：配置 Sync Adapter 的行为特性
Manifest 声明：注册组件和所需权限

二、创建 Sync Adapter 类

2.1 继承 AbstractThreadedSyncAdapter

Sync Adapter 类需要继承 AbstractThreadedSyncAdapter 基类，它提供了与同步框架兼容的接口：

public class SyncAdapter extends AbstractThreadedSyncAdapter {
    private ContentResolver mContentResolver;
    
    // 兼容 Android 3.0 之前的构造函数
    public SyncAdapter(Context context, boolean autoInitialize) {
        super(context, autoInitialize);
        mContentResolver = context.getContentResolver();
    }
    
    // 兼容 Android 3.0 及之后的构造函数
    public SyncAdapter(Context context, boolean autoInitialize, 
                      boolean allowParallelSyncs) {
        super(context, autoInitialize, allowParallelSyncs);
        mContentResolver = context.getContentResolver();
    }
}

2.2 实现 onPerformSync 方法

onPerformSync() 是 Sync Adapter 的核心方法，框架会在此方法中执行实际的数据传输：

@Override
public void onPerformSync(Account account, Bundle extras, 
                         String authority, ContentProviderClient provider,
                         SyncResult syncResult) {
    // 1. 连接服务器
    // 2. 下载/上传数据
    // 3. 处理数据冲突
    // 4. 清理资源
}

方法参数说明：

account：关联的账户对象
extras：触发同步时传递的额外数据
authority：Content Provider 的 authority
provider：ContentProviderClient 实例
syncResult：用于向框架报告同步结果

三、创建绑定服务

为了让框架能够访问 Sync Adapter，需要创建一个绑定服务：

public class SyncService extends Service {
    private static SyncAdapter sSyncAdapter;
    private static final Object sSyncAdapterLock = new Object();

    @Override
    public void onCreate() {
        synchronized (sSyncAdapterLock) {
            if (sSyncAdapter == null) {
                sSyncAdapter = new SyncAdapter(getApplicationContext(), true);
            }
        }
    }

    @Override
    public IBinder onBind(Intent intent) {
        return sSyncAdapter.getSyncAdapterBinder();
    }
}

四、配置 Sync Adapter 元数据

在 res/xml/syncadapter.xml 中定义 Sync Adapter 的配置：

<sync-adapter
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:contentAuthority="com.example.provider"
    android:accountType="com.example.account"
    android:userVisible="false"
    android:supportsUploading="false"
    android:allowParallelSyncs="false"
    android:isAlwaysSyncable="true"/>

关键属性说明：

contentAuthority：关联的 Content Provider 的 authority
accountType：账户类型，需与验证器一致
userVisible：是否在系统设置中显示
supportsUploading：是否支持数据上传
allowParallelSyncs：是否允许多个同步并行执行
isAlwaysSyncable：是否随时可执行同步

五、配置应用清单文件

在 AndroidManifest.xml 中声明必要的权限和服务：

<manifest>
    <!-- 所需权限 -->
    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.READ_SYNC_SETTINGS"/>
    <uses-permission android:name="android.permission.WRITE_SYNC_SETTINGS"/>
    <uses-permission android:name="android.permission.AUTHENTICATE_ACCOUNTS"/>

    <application>
        <!-- 声明 Sync Service -->
        <service
            android:name=".SyncService"
            android:exported="true"
            android:process=":sync">
            <intent-filter>
                <action android:name="android.content.SyncAdapter"/>
            </intent-filter>
            <meta-data 
                android:name="android.content.SyncAdapter"
                android:resource="@xml/syncadapter"/>
        </service>
    </application>
</manifest>

六、创建关联账户

Sync Adapter 需要关联一个账户，通常在应用启动时创建：

public static Account CreateSyncAccount(Context context) {
    Account newAccount = new Account("dummyaccount", "com.example.account");
    AccountManager accountManager = 
        (AccountManager) context.getSystemService(ACCOUNT_SERVICE);
    
    if (accountManager.addAccountExplicitly(newAccount, null, null)) {
        // 账户创建成功
    } else {
        // 账户已存在或创建失败
    }
    return newAccount;
}