Android創(chuàng)建 Stub 授權(quán)器

編寫:jdneo - 原文:http://developer.android.com/training/sync-adapters/creating-authenticator.html

Sync Adapter 框架假定我們的 Sync Adapter 在同步數(shù)據(jù)時(shí)，設(shè)備存儲(chǔ)端關(guān)聯(lián)了一個(gè)賬戶，且服務(wù)器端需要進(jìn)行登錄驗(yàn)證。因此，我們需要提供一個(gè)叫做授權(quán)器（Authenticator）的組件作為 Sync Adapter 的一部分。該組件會(huì)集成在 Android 賬戶及認(rèn)證框架中，并提供一個(gè)標(biāo)準(zhǔn)的接口來處理用戶憑據(jù)，比如登錄信息。

即使我們的應(yīng)用不使用賬戶，我們?nèi)匀恍枰峁┮粋€(gè)授權(quán)器組件。在這種情況下，授權(quán)器所處理的信息將被忽略，所以我們可以提供一個(gè)包含了方法存根（Stub Method）的授權(quán)器組件。同時(shí)我們需要提供一個(gè)綁定 Service，來允許 Sync Adapter 框架調(diào)用授權(quán)器的方法。

這節(jié)課將展示如何定義一個(gè)能夠滿足 Sync Adapter 框架要求的 Stub 授權(quán)器。如果我們想要提供可以處理用戶賬戶的實(shí)際的授權(quán)器，可以閱讀：AbstractAccountAuthenticator。

添加一個(gè) Stub 授權(quán)器組件

要在應(yīng)用中添加一個(gè) Stub 授權(quán)器，首先我們需要?jiǎng)?chuàng)建一個(gè)繼承 AbstractAccountAuthenticator 的類，在所有需要重寫的方法中，我們不進(jìn)行任何處理，僅返回 null 或者拋出異常。

下面的代碼片段是一個(gè) Stub 授權(quán)器的例子：

/*
 * 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();
    }
}

將授權(quán)器綁定到框架

為了讓 Sync Adapter 框架可以訪問我們的授權(quán)器，我們必須為它創(chuàng)建一個(gè)綁定服務(wù)。這一服務(wù)提供一個(gè) Android Binder 對(duì)象，允許框架調(diào)用我們的授權(quán)器，并且在授權(quán)器和框架間傳遞數(shù)據(jù)。

因?yàn)榭蚣軙?huì)在它第一次需要訪問授權(quán)器時(shí)啟動(dòng)該 Service，所以我們也可以使用該服務(wù)來實(shí)例化授權(quán)器。具體而言，我們需要在服務(wù)的 Service.onCreate() 方法中調(diào)用授權(quán)器的構(gòu)造函數(shù)。

下面的代碼樣例展示了如何定義綁定 Service：

/**
 * 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(this);
    }
    /*
     * 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();
    }
}

添加授權(quán)器的元數(shù)據(jù)（Metadata）文件

若要將我們的授權(quán)器組件集成到 Sync Adapter 框架和賬戶框架中，我們需要為這些框架提供帶有描述組件信息的元數(shù)據(jù)。該元數(shù)據(jù)聲明了我們?yōu)?Sync Adapter 創(chuàng)建的賬戶類型以及系統(tǒng)所顯示的 UI 元素（如果希望用戶可以看到我們創(chuàng)建的賬戶類型）。在我們的項(xiàng)目目錄 /res/xml/ 下，將元數(shù)據(jù)聲明于一個(gè) XML 文件中。我們可以自己為該文件按命名，通常我們將它命名為 authenticator.xml。

在這個(gè) XML 文件中，包含了一個(gè) <account-authenticator> 標(biāo)簽，它有下列一些屬性：

android:accountType

Sync Adapter 框架要求每一個(gè)適配器都有一個(gè)域名形式的賬戶類型?？蚣軙?huì)將它作為 Sync Adapter 內(nèi)部標(biāo)識(shí)的一部分。如果服務(wù)端需要登陸，賬戶類型會(huì)和賬戶一起發(fā)送到服務(wù)端作為登錄憑據(jù)的一部分。

如果我們的服務(wù)端不需要登錄，我們?nèi)匀恍枰峁┮粋€(gè)賬戶類型（該屬性的值用我們能控制的一個(gè)域名即可）。雖然框架會(huì)使用它來管理 Sync Adapter，但該屬性的值不會(huì)發(fā)送到服務(wù)端。

android:icon

指向一個(gè)包含圖標(biāo)的 Drawable 資源。如果我們?cè)?nbsp;res/xml/syncadapter.xml 中通過指定 android:userVisible="true" 讓 Sync Adapter 可見，那么我們必須提供圖標(biāo)資源。它會(huì)在系統(tǒng)的設(shè)置中的賬戶（Accounts）這一欄內(nèi)顯示。

android:smallIcon

指向一個(gè)包含微小版本圖標(biāo)的 Drawable 資源。當(dāng)屏幕尺寸較小時(shí)，這一資源可能會(huì)替代 android:icon 中所指定的圖標(biāo)資源。

android:label

指明了用戶賬戶類型的本地化字符串。如果我們?cè)?nbsp;res/xml/syncadapter.xml 中通過指定 android:userVisible="true" 讓 Sync Adapter 可見，那么我們需要提供該字符串。它會(huì)在系統(tǒng)的設(shè)置中的賬戶這一欄內(nèi)顯示，就在我們?yōu)槭跈?quán)器定義的圖標(biāo)旁邊。

下面的代碼樣例展示了我們之前為授權(quán)器創(chuàng)建的 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"/>

在 Manifest 文件中聲明授權(quán)器

在之前的步驟中，我們已經(jīng)創(chuàng)建了一個(gè)綁定服務(wù)，將授權(quán)器和 Sync Adapter 框架連接了起來。為了讓系統(tǒng)可以識(shí)別該服務(wù)，我們需要在 Manifest 文件中添加 <service> 標(biāo)簽，將它作為 <application> 的子標(biāo)簽：

    <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> 標(biāo)簽配置了一個(gè)可以被 android.accounts.AccountAuthenticator 這一 Action 所激活的過濾器，這一 Intent 會(huì)在系統(tǒng)要運(yùn)行授權(quán)器時(shí)由系統(tǒng)發(fā)出。當(dāng)過濾器被激活后，系統(tǒng)會(huì)啟動(dòng) AuthenticatorService，即之前用來封裝授權(quán)器的 Service。

<meta-data> 標(biāo)簽聲明了授權(quán)器的元數(shù)據(jù)。android:name 屬性將元數(shù)據(jù)和授權(quán)器框架連接起來。android:resource 指定了我們之前所創(chuàng)建的授權(quán)器元數(shù)據(jù)文件的名字。

除了授權(quán)器之外，Sync Adapter 框架也需要一個(gè) Content Provider。如果我們的應(yīng)用并沒有使用 Content Provider，那么可以閱讀下一節(jié)課程學(xué)習(xí)如何創(chuàng)建一個(gè) Stub Content Provider；如果我們的應(yīng)用已經(jīng)使用了 ContentProvider，可以直接閱讀：創(chuàng)建 Sync Adapter。