文章目录
一、 账户同步
二、 账户同步代码示例
1、 账户同步 Service
2、 账户同步 ContentProvider
3、 AndroidManifest.xml 清单文件
4、 sync-adapter 配置文件
5、 账户同步工具类
6、 MainActivity 启动账户同步
7、 运行效果
三、 源码资源
一、 账户同步
账户同步的作用 : 如果应用的数据发生了改变 , 可以通过账户进行同步 , 进而与服务器进行数据同步操作 , 执行同步时 , 系统会拉活对应的应用进程 ;
进程拉活只是账户同步的附带作用 ;
账户同步时 , 需要应用中有对应的同步服务 , 系统也是通过 Binder 机制与应用进行同步操作 ;
账户同步需要在 账户同步服务 Service 中进行 , 定义一个 Service 进行账户同步 , 其 onBind 方法必须返回 AbstractThreadedSyncAdapter 的 getSyncAdapterBinder() 值 ;
账户同步需要自定义一个 AbstractThreadedSyncAdapter 类 , 并在 Service 中维护一个该类对象 ;
class ThreadSyncAdapter extends AbstractThreadedSyncAdapter{ public ThreadSyncAdapter(Context context, boolean autoInitialize) { super(context, autoInitialize); } public ThreadSyncAdapter(Context context, boolean autoInitialize, boolean allowParallelSyncs) { super(context, autoInitialize, allowParallelSyncs); } @Override public void onPerformSync(Account account, Bundle extras, String authority, ContentProviderClient provider, SyncResult syncResult) { // 账户同步操作 // 与数据库 , 服务器同步操作 , 这里只是为了应用进程拉活 , 不实现具体的逻辑 } }
系统在进行账户同步的时候 , 会获取该 账户同步 Service 的 IBinder , 拿到该 IBinder 后 , 会调用 AbstractThreadedSyncAdapter 子类对象中的 onPerformSync 方法 , 执行同步操作 ;
该 onPerformSync 函数是系统在执行同步时执行的函数 , 但是这里我们的目的是为了拉活应用进程 , 并不是为了进行账户同步 , 这里空着就可以 ;
最后还要在清单文件中注册该同步 Service ;
<!-- 账户同步服务 --> <service android:name=".account_service.AccountSyncService" android:enabled="true" android:exported="true"> <intent-filter> <action android:name="android.content.SyncAdapter" /> </intent-filter> <meta-data android:name="android.content.SyncAdapter" android:resource="@xml/sync_adapter" /> </service>
除了同步 Service 组件之外 , 还必须有一个 ContentProvider 组件 , 系统进行账户同步时 , 会查找对应账户的 ContentProvider , 需要在应用中注册 ContentProvider , 还要与 同步 Service 进行关联 ;
关联的方法就是在 同步 Service 注册的清单文件中添加元数据 meta-data , 在 meta-data 标签下的 android:resource 属性中 , 指定账户同步的相关资源数据 sync-adapter , sync-adapter 标签中的 android:contentAuthority 属性就是指定的该 ContentProvider ;
<?xml version="1.0" encoding="utf-8"?> <sync-adapter xmlns:android="http://schemas.android.com/apk/res/android" android:accountType="keep_progress_alive.account" android:contentAuthority="kim.hsl.keep_progress_alive.provider" android:allowParallelSyncs="false" android:isAlwaysSyncable="true" android:userVisible="false"/>
sync-adapter 标签的 android:accountType 就是账户类型 , 与之前在 【Android 进程保活】应用进程拉活 ( 账户同步拉活 | 账号服务注册 | 源码资源 ) 博客注册的 account-authenticator 标签的 android:accountType 是一个值 ;
<?xml version="1.0" encoding="utf-8"?> <account-authenticator xmlns:android="http://schemas.android.com/apk/res/android" android:accountType="keep_progress_alive.account" android:icon="@mipmap/ic_launcher" android:label="@string/app_name" />
sync-adapter 标签的 android:isAlwaysSyncable 属性 , 表示该账户同步操作 , 是否总是同步 , 这里设置 true , 账户拉活 , 越频繁越好 ;
sync-adapter 标签的 android:userVisible 属性 , 表示是否在 " 设置 -> 账号 " 界面 , 展示一个账户同步开关 , 这里选择 false , 不给用户展示 , 万一用户给关了 , 就无法进行账户拉活应用进程操作 ;
创建 ContentProvider , 然后在清单文件中注册 , 其中 provider 标签的 android:authorities 就是上述 sync-adapter 标签中的 android:contentAuthority 属性值 ;
<!-- 账户同步 ContentProvider --> <provider android:authorities="kim.hsl.keep_progress_alive.provider" android:name=".account_service.AccountSyncContentProvider" />
定义好账户同步 Service , ContentProvider , 并在清单文件中注册 ;
最后调用 ContentResolver 的 setIsSyncable 方法 , 设置账户同步开启 ,
//创建账户 Account account = new Account("kim.hsl", ACCOUNT_TYPE); // 设置账户同步开启 // 注意 : 该操作西药权限 android.permission.WRITE_SYNC_SETTINGS ContentResolver.setIsSyncable(account, "kim.hsl.keep_progress_alive.provider", 1);
调用 ContentResolver 的 setSyncAutomatically 方法 , 设置账户自动同步 , 注意 : 该操作需要权限 android.permission.WRITE_SYNC_SETTINGS ;
// 设置账户自动同步 ContentResolver.setSyncAutomatically(account, "kim.hsl.keep_progress_alive.provider", true);
调用 ContentResolver 的 setSyncAutomatically 方法 , 设置账户自动同步 , 最后一个参数是同步周期 , 这个值只是参考值, 系统并不会严格按照该值执行 , 一般情况下同步的间隔 10 分钟 ~ 1 小时 ;
// 设置账户同步周期 // 最后一个参数是同步周期 , 这个值只是参考值, 系统并不会严格按照该值执行 // 一般情况下同步的间隔 10 分钟 ~ 1 小时 ContentResolver.addPeriodicSync(account, "kim.hsl.keep_progress_alive.provider", new Bundle(), 1);
