同步适配器框架假定您的同步适配器会在与帐户关联的设备存储和需要登录访问的服务器存储之间传输数据。因此，框架期望您提供一个名为身份验证器的组件作为同步适配器的一部分。该组件连接到 Android 帐户和身份验证框架，并提供一个标准接口来处理登录信息等用户凭据。
即使您的应用不使用帐户，您仍然需要提供身份验证器组件。如果您不使用帐户或服务器登录，则身份验证器处理的信息将被忽略，因此您可以提供一个包含存根方法实现的身份验证器组件。您还需要提供一个绑定 Service，该服务允许同步适配器框架调用身份验证器的方法。
本课程将向您展示如何定义满足同步适配器框架要求所需的存根身份验证器的所有部分。如果您需要提供处理用户帐户的真实身份验证器，请阅读 AbstractAccountAuthenticator 的参考文档。
添加存根身份验证器组件
要向您的应用添加存根身份验证器组件，请创建一个扩展 AbstractAccountAuthenticator 的类，然后存根所需的全部方法，方法是返回 null 或抛出异常。
以下代码段显示了一个存根身份验证器类示例
Kotlin
/*
* Implement AbstractAccountAuthenticator and stub out all
* of its methods
*/
class Authenticator(context: Context) // Simple constructor
: AbstractAccountAuthenticator(context) {
// Editing properties is not supported
override fun editProperties(r: AccountAuthenticatorResponse, s: String): Bundle {
throw UnsupportedOperationException()
}
// Don't add additional accounts
@Throws(NetworkErrorException::class)
override fun addAccount(
r: AccountAuthenticatorResponse,
s: String,
s2: String,
strings: Array<String>,
bundle: Bundle
): Bundle? = null
// Ignore attempts to confirm credentials
@Throws(NetworkErrorException::class)
override fun confirmCredentials(
r: AccountAuthenticatorResponse,
account: Account,
bundle: Bundle
): Bundle? = null
// Getting an authentication token is not supported
@Throws(NetworkErrorException::class)
override fun getAuthToken(
r: AccountAuthenticatorResponse,
account: Account,
s: String,
bundle: Bundle
): Bundle {
throw UnsupportedOperationException()
}
// Getting a label for the auth token is not supported
override fun getAuthTokenLabel(s: String): String {
throw UnsupportedOperationException()
}
// Updating user credentials is not supported
@Throws(NetworkErrorException::class)
override fun updateCredentials(
r: AccountAuthenticatorResponse,
account: Account,
s: String,
bundle: Bundle
): Bundle {
throw UnsupportedOperationException()
}
// Checking features for the account is not supported
@Throws(NetworkErrorException::class)
override fun hasFeatures(
r: AccountAuthenticatorResponse,
account: Account,
strings: Array<String>
): Bundle {
throw UnsupportedOperationException()
}
}
Java
/*
* Implement AbstractAccountAuthenticator and stub out all
* of its methods
*/
public class Authenticator extends AbstractAccountAuthenticator {
// Simple constructor
public Authenticator(Context context) {
super(context);
}
// Editing properties is not supported
@Override
public Bundle editProperties(
AccountAuthenticatorResponse r, String s) {
throw new UnsupportedOperationException();
}
// Don't add additional accounts
@Override
public Bundle addAccount(
AccountAuthenticatorResponse r,
String s,
String s2,
String[] strings,
Bundle bundle) throws NetworkErrorException {
return null;
}
// Ignore attempts to confirm credentials
@Override
public Bundle confirmCredentials(
AccountAuthenticatorResponse r,
Account account,
Bundle bundle) throws NetworkErrorException {
return null;
}
// Getting an authentication token is not supported
@Override
public Bundle getAuthToken(
AccountAuthenticatorResponse r,
Account account,
String s,
Bundle bundle) throws NetworkErrorException {
throw new UnsupportedOperationException();
}
// Getting a label for the auth token is not supported
@Override
public String getAuthTokenLabel(String s) {
throw new UnsupportedOperationException();
}
// Updating user credentials is not supported
@Override
public Bundle updateCredentials(
AccountAuthenticatorResponse r,
Account account,
String s, Bundle bundle) throws NetworkErrorException {
throw new UnsupportedOperationException();
}
// Checking features for the account is not supported
@Override
public Bundle hasFeatures(
AccountAuthenticatorResponse r,
Account account, String[] strings) throws NetworkErrorException {
throw new UnsupportedOperationException();
}
}
将身份验证器绑定到框架
为了使同步适配器框架能够访问您的身份验证器，您必须为其创建一个绑定服务。该服务提供一个 Android 绑定对象，允许框架调用您的身份验证器并在身份验证器和框架之间传递数据。
以下代码段展示了如何定义绑定 Service
Kotlin
/**
* A bound Service that instantiates the authenticator
* when started.
*/
class AuthenticatorService : Service() {
// Instance field that stores the authenticator object
private lateinit var mAuthenticator: Authenticator
override fun onCreate() {
// Create a new authenticator object
mAuthenticator = Authenticator(getApplicationContext())
}
/*
* When the system binds to this Service to make the RPC call
* return the authenticator's IBinder.
*/
override fun onBind(intent: Intent?): IBinder = mAuthenticator.iBinder
}
Java
/**
* A bound Service that instantiates the authenticator
* when started.
*/
public class AuthenticatorService extends Service {
...
// Instance field that stores the authenticator object
private Authenticator mAuthenticator;
@Override
public void onCreate() {
// Create a new authenticator object
mAuthenticator = new Authenticator(getApplicationContext());
}
/*
* When the system binds to this Service to make the RPC call
* return the authenticator's IBinder.
*/
@Override
public IBinder onBind(Intent intent) {
return mAuthenticator.getIBinder();
}
}
添加身份验证器元数据文件
要将您的身份验证器组件连接到同步适配器和帐户框架，您需要向这些框架提供描述该组件的元数据。此元数据声明您为同步适配器创建的帐户类型，并声明系统显示的用户界面元素（如果您想让您的帐户类型对用户可见）。在您的应用项目中的 /res/xml/ 目录中存储的 XML 文件中声明此元数据。您可以为该文件命名任何名称，尽管它通常被称为 authenticator.xml。
此 XML 文件包含一个名为 <account-authenticator> 的单个元素，它具有以下属性
-
android:accountType - 同步适配器框架要求每个同步适配器都具有一个帐户类型，形式为域名。框架使用帐户类型作为同步适配器内部标识的一部分。对于需要登录的服务器，帐户类型与用户帐户一起作为登录凭据的一部分发送到服务器。
如果您的服务器不需要登录，您仍然需要提供一个帐户类型。对于该值，请使用您控制的域名。虽然框架使用它来管理您的同步适配器，但该值不会发送到您的服务器。
-
android:icon - 指向包含图标的 Drawable 资源的指针。如果您通过在
res/xml/syncadapter.xml中指定属性android:userVisible="true"使同步适配器可见，那么您必须提供此图标资源。它将显示在系统设置应用的“帐户”部分中。 -
android:smallIcon - 指向包含图标的小版本图标的 Drawable 资源的指针。根据屏幕大小，此资源可能会在系统设置应用的“帐户”部分中用作
android:icon的替代。 -
android:label - 可本地化的字符串，用于向用户标识帐户类型。如果您通过在
res/xml/syncadapter.xml中指定属性android:userVisible="true"使同步适配器可见，那么您应该提供此字符串。它将显示在系统设置应用的“帐户”部分中，位于您为身份验证器定义的图标旁边。
以下代码段显示了您之前创建的身份验证器的 XML 文件
<?xml version="1.0" encoding="utf-8"?>
<account-authenticator
xmlns:android="http://schemas.android.com/apk/res/android"
android:accountType="example.com"
android:icon="@drawable/ic_launcher"
android:smallIcon="@drawable/ic_launcher"
android:label="@string/app_name"/>
在清单中声明身份验证器
在前面的步骤中，您创建了一个绑定 Service，用于将身份验证器链接到同步适配器框架。要向系统标识此服务，请在应用清单中通过将以下 <service> 元素添加为 <application> 的子元素来声明它。
<service
android:name="com.example.android.syncadapter.AuthenticatorService">
<intent-filter>
<action android:name="android.accounts.AccountAuthenticator"/>
</intent-filter>
<meta-data
android:name="android.accounts.AccountAuthenticator"
android:resource="@xml/authenticator" />
</service>
该 <intent-filter> 元素设置了一个由意图操作 android.accounts.AccountAuthenticator 触发的过滤器，该操作由系统发送以运行身份验证器。当过滤器被触发时，系统会启动 AuthenticatorService，即您提供的用于包装身份验证器的绑定 Service。
该 <meta-data> 元素声明了身份验证器的元数据。该 android:name 属性将元数据链接到身份验证框架。该 android:resource 元素指定了您之前创建的身份验证器元数据文件的名称。
除了身份验证器之外，同步适配器还需要一个内容提供器。如果您的应用还没有使用内容提供器，请转到下一课学习如何创建一个存根内容提供器；否则，请转到课程 创建同步适配器。