Вызов requestSync()
будет работать только для пары {Account, ContentAuthority}, которая известна системе. Ваше приложение должно пройти ряд шагов, чтобы сообщить Android, что вы можете синхронизировать определенный тип контента с помощью определенного типа учетной записи. Это делается в AndroidManifest.
1. Сообщите Android, что пакет вашего приложения обеспечивает синхронизацию.
Во-первых, в AndroidManifest.xml вы должны объявить, что у вас есть служба синхронизации:
<service android:name=".sync.mySyncService" android:exported="true">
<intent-filter>
<action android:name="android.content.SyncAdapter" />
</intent-filter>
<meta-data
android:name="android.content.SyncAdapter"
android:resource="@xml/sync_myapp" />
</service>
Атрибут name <service>
тега - это имя вашего класса для подключения к синхронизации ... Я поговорю об этом через секунду.
Установка exported true делает его видимым для других компонентов (необходимо, чтобы ContentResolver
можно было его назвать).
Фильтр намерения позволяет ему улавливать намерение, запрашивающее синхронизацию. (Это Intent
происходит, ContentResolver
когда вы вызываете ContentResolver.requestSync()
или связанные с ним методы планирования.)
О <meta-data>
теге речь пойдет ниже.
2. Предоставьте Android сервис для поиска вашего SyncAdapter.
Итак, сам класс ... Вот пример:
public class mySyncService extends Service {
private static mySyncAdapter mSyncAdapter = null;
public SyncService() {
super();
}
@Override
public void onCreate() {
super.onCreate();
if (mSyncAdapter == null) {
mSyncAdapter = new mySyncAdapter(getApplicationContext(), true);
}
}
@Override
public IBinder onBind(Intent arg0) {
return mSyncAdapter.getSyncAdapterBinder();
}
}
Ваш класс должен расширять Service
или один из его подклассов, должен реализовывать public IBinder onBind(Intent)
и должен возвращать SyncAdapterBinder
при его вызове ... Вам нужна переменная типа AbstractThreadedSyncAdapter
. Как видите, это почти все в этом классе. Единственная причина, по которой он существует, - предоставить Сервис, который предлагает стандартный интерфейс для Android для запроса вашего класса о том, что вы из SyncAdapter
себя представляете.
3. Обеспечьте class SyncAdapter
фактическое выполнение синхронизации.
mySyncAdapter - это место, где хранится сама реальная логика синхронизации. Его onPerformSync()
метод вызывается, когда приходит время для синхронизации. Я полагаю, у вас это уже есть.
4. Установите связь между Account-type и Content Authority.
Еще раз оглядываясь на AndroidManifest, этот странный <meta-data>
тег в нашем сервисе является ключевым элементом, который устанавливает связь между ContentAuthority и учетной записью. Он ссылается извне на другой XML-файл (назовите его как хотите, что-нибудь относящееся к вашему приложению). Давайте посмотрим на sync_myapp.xml:
<?xml version="1.0" encoding="utf-8" ?>
<sync-adapter
xmlns:android="http://schemas.android.com/apk/res/android"
android:contentAuthority="com.android.contacts"
android:accountType="com.google"
android:userVisible="true" />
Хорошо, так что это делает? Он сообщает Android, что определенный нами адаптер синхронизации (класс, который был вызван в элементе имени <service>
тега, который включает <meta-data>
тег, который ссылается на этот файл ...) будет синхронизировать контакты с использованием учетной записи в стиле com.google.
Все ваши строки contentAuthority должны совпадать и соответствовать тому, что вы синхронизируете - это должна быть строка, которую вы определяете, если вы создаете свою собственную базу данных, или вы должны использовать некоторые существующие строки устройства, если вы синхронизируете известные типы данных (например, контакты, события календаря или что-то еще.) Вышеупомянутое ("com.android.contacts") оказывается строкой ContentAuthority для данных типа контактов (сюрприз, сюрприз).
accountType также должен соответствовать одному из тех известных типов учетных записей, которые уже введены, или он должен соответствовать тому, который вы создаете (это включает создание подкласса AccountAuthenticator для аутентификации на вашем сервере ... Сама стоит статья). Опять же, com.google - это определенная строка, определяющая ... учетные данные учетной записи в стиле google.com (опять же, это не должно быть сюрпризом).
5. Включите синхронизацию для данной пары "Аккаунт / ContentAuthority".
Наконец, необходимо включить синхронизацию. Вы можете сделать это на странице «Аккаунты и синхронизация» на панели управления, перейдя в свое приложение и установив флажок рядом с вашим приложением в соответствующей учетной записи. В качестве альтернативы вы можете сделать это в некотором установочном коде в вашем приложении:
ContentResolver.setSyncAutomatically(account, AUTHORITY, true);
Для синхронизации произойдет, пара ваш счет / орган должен иметь возможность синхронизации (как выше) , и общий глобальный флаг синхронизации в системе должен быть установлен, и устройство должно иметь подключение к сети.
Если синхронизация вашего аккаунта / полномочий или глобальная синхронизация отключены, вызов RequestSync () имеет эффект - он устанавливает флаг, что синхронизация была запрошена, и будет выполнена, как только синхронизация будет включена.
Кроме того, для mgv установка значения ContentResolver.SYNC_EXTRAS_MANUAL
true в дополнительном пакете вашего requestSync попросит Android принудительно выполнить синхронизацию, даже если глобальная синхронизация отключена (уважайте своего пользователя здесь!)
Наконец, вы можете настроить периодическую запланированную синхронизацию, опять же с помощью функций ContentResolver.
6. Учитывайте последствия использования нескольких аккаунтов.
Возможно иметь несколько учетных записей одного и того же типа (две учетные записи @ gmail.com, настроенные на одном устройстве или две учетные записи facebook, или две учетные записи twitter и т. Д.). Вы должны учитывать последствия этого для приложения. .. Если у вас есть две учетные записи, вы, вероятно, не хотите пытаться синхронизировать их обе с одними и теми же таблицами базы данных. Возможно, вам нужно указать, что только один может быть активным одновременно, и очистить таблицы и выполнить повторную синхронизацию при переключении учетных записей. (через страницу свойств, которая запрашивает, какие учетные записи присутствуют). Возможно, вы создаете отдельную базу данных для каждой учетной записи, может быть, разные таблицы, может быть, ключевой столбец в каждой таблице. Все приложения специфичны и заслуживают некоторого размышления. ContentResolver.setIsSyncable(Account account, String authority, int syncable)
может быть здесь интересно. setSyncAutomatically()
контролирует ли помощница счета / орган проверил илиunchecked , в то время как setIsSyncable()
предоставляет способ снять флажок и выделить строку серым цветом, чтобы пользователь не мог ее включить. Вы можете установить одну учетную запись синхронизируемой, а другую - не синхронизируемой (dsabled).
7. Помните о ContentResolver.notifyChange ().
Одна хитрость. ContentResolver.notifyChange()
- это функция, используемая ContentProvider
s для уведомления Android об изменении локальной базы данных. Это выполняет две функции: во-первых, это приведет к обновлению курсоров, следующих за этим uri содержимого, и, в свою очередь, запрашивает, аннулирует и перерисовывает и ListView
т. Д. Это очень волшебно, база данных изменяется, а ваши ListView
просто обновляются автоматически. Потрясающие. Кроме того, при изменении базы данных Android запросит синхронизацию для вас, даже вне вашего обычного расписания, чтобы эти изменения были сняты с устройства и синхронизированы с сервером как можно быстрее. Также круто.
Однако есть один крайний случай. Если вы возьмете с сервера и загрузите обновление в ContentProvider
, он послушно вызовет notifyChange()
и андроид скажет: «О, изменения базы данных, лучше поместите их на сервер!» (Дох!) Хорошо написанный ContentProviders
будет иметь несколько тестов, чтобы увидеть, пришли ли изменения из сети или от пользователя, и в этом случае установит логический syncToNetwork
флаг false, чтобы предотвратить эту расточительную двойную синхронизацию. Если вы вводите данные в ContentProvider
файл, вам следует выяснить, как заставить это работать - иначе вы всегда будете выполнять две синхронизации, когда требуется только одна.
8. Будьте счастливы!
После того, как у вас есть все эти XML-метаданные и включена синхронизация, Android будет знать, как все подключить за вас, и синхронизация должна начать работать. В этот момент многие приятные вещи просто встанут на свои места, и это будет похоже на волшебство. Наслаждайтесь!