创建 Stub 授权器

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

Sync Adapter 框架假定我们的 Sync Adapter 在同步数据时,设备存储端关联了一个账户,且服务器端需要进行登录验证。因此,我们需要提供一个叫做授权器(Authenticator)的组件作为 Sync Adapter 的一部分。该组件会集成在 Android 账户及认证框架中,并提供一个标准的接口来处理用户凭据,比如登录信息。

即使我们的应用不使用账户,我们仍然需要提供一个授权器组件。在这种情况下,授权器所处理的信息将被忽略,所以我们可以提供一个包含了方法存根(Stub Method)的授权器组件。同时我们需要提供一个绑定Service,来允许 Sync Adapter 框架调用授权器的方法。

这节课将展示如何定义一个能够满足 Sync Adapter 框架要求的 Stub 授权器。如果我们想要提供可以处理用户账户的实际的授权器,可以阅读:AbstractAccountAuthenticator

添加一个 Stub 授权器组件

要在应用中添加一个 Stub 授权器,首先我们需要创建一个继承AbstractAccountAuthenticator的类,在所有需要重写的方法中,我们不进行任何处理,仅返回 null 或者抛出异常。

下面的代码片段是一个 Stub 授权器的例子:

/*

* Implement AbstractAccountAuthenticator and stub out all

* of its methods

*/publicclassAuthenticatorextendsAbstractAccountAuthenticator{// Simple constructorpublicAuthenticator(Context context){super(context);    }// Editing properties is not supported@OverridepublicBundleeditProperties(

AccountAuthenticatorResponse r, String s){thrownewUnsupportedOperationException();    }// Don't add additional accounts@OverridepublicBundleaddAccount(

AccountAuthenticatorResponse r,

String s,

String s2,

String[] strings,

Bundle bundle)throwsNetworkErrorException{returnnull;    }// Ignore attempts to confirm credentials@OverridepublicBundleconfirmCredentials(

AccountAuthenticatorResponse r,

Account account,

Bundle bundle)throwsNetworkErrorException{returnnull;    }// Getting an authentication token is not supported@OverridepublicBundlegetAuthToken(

AccountAuthenticatorResponse r,

Account account,

String s,

Bundle bundle)throwsNetworkErrorException{thrownewUnsupportedOperationException();    }// Getting a label for the auth token is not supported@OverridepublicStringgetAuthTokenLabel(String s){thrownewUnsupportedOperationException();    }// Updating user credentials is not supported@OverridepublicBundleupdateCredentials(

AccountAuthenticatorResponse r,

Account account,

String s, Bundle bundle)throwsNetworkErrorException{thrownewUnsupportedOperationException();    }// Checking features for the account is not supported@OverridepublicBundlehasFeatures(

AccountAuthenticatorResponse r,

Account account, String[] strings)throwsNetworkErrorException{thrownewUnsupportedOperationException();    }}

将授权器绑定到框架

为了让 Sync Adapter 框架可以访问我们的授权器,我们必须为它创建一个绑定服务。这一服务提供一个 Android Binder 对象,允许框架调用我们的授权器,并且在授权器和框架间传递数据。

因为框架会在它第一次需要访问授权器时启动该Service,所以我们也可以使用该服务来实例化授权器。具体而言,我们需要在服务的Service.onCreate()方法中调用授权器的构造函数。

下面的代码样例展示了如何定义绑定Service

/**

* A bound Service that instantiates the authenticator

* when started.

*/publicclassAuthenticatorServiceextendsService{    ...// Instance field that stores the authenticator objectprivateAuthenticator mAuthenticator;@OverridepublicvoidonCreate(){// Create a new authenticator objectmAuthenticator =newAuthenticator(this);    }/*

* When the system binds to this Service to make the RPC call

* return the authenticator's IBinder.

*/@OverridepublicIBinderonBind(Intent intent){returnmAuthenticator.getIBinder();    }}

添加授权器的元数据(Metadata)文件

若要将我们的授权器组件集成到 Sync Adapter 框架和账户框架中,我们需要为这些框架提供带有描述组件信息的元数据。该元数据声明了我们为 Sync Adapter 创建的账户类型以及系统所显示的 UI 元素(如果希望用户可以看到我们创建的账户类型)。在我们的项目目录/res/xml/下,将元数据声明于一个 XML 文件中。我们可以自己为该文件按命名,通常我们将它命名为authenticator.xml。

在这个 XML 文件中,包含了一个标签,它有下列一些属性:

android:accountType

Sync Adapter 框架要求每一个适配器都有一个域名形式的账户类型。框架会将它作为 Sync Adapter 内部标识的一部分。如果服务端需要登陆,账户类型会和账户一起发送到服务端作为登录凭据的一部分。

如果我们的服务端不需要登录,我们仍然需要提供一个账户类型(该属性的值用我们能控制的一个域名即可)。虽然框架会使用它来管理 Sync Adapter,但该属性的值不会发送到服务端。

android:icon

指向一个包含图标的Drawable资源。如果我们在res/xml/syncadapter.xml中通过指定android:userVisible="true"让 Sync Adapter 可见,那么我们必须提供图标资源。它会在系统的设置中的账户(Accounts)这一栏内显示。

android:smallIcon

指向一个包含微小版本图标的Drawable资源。当屏幕尺寸较小时,这一资源可能会替代android:icon中所指定的图标资源。

android:label

指明了用户账户类型的本地化字符串。如果我们在res/xml/syncadapter.xml中通过指定android:userVisible="true"让 Sync Adapter 可见,那么我们需要提供该字符串。它会在系统的设置中的账户这一栏内显示,就在我们为授权器定义的图标旁边。

下面的代码样例展示了我们之前为授权器创建的 XML 文件:

在 Manifest 文件中声明授权器

在之前的步骤中,我们已经创建了一个绑定服务,将授权器和 Sync Adapter 框架连接了起来。为了让系统可以识别该服务,我们需要在 Manifest 文件中添加标签,将它作为的子标签:

标签配置了一个可以被android.accounts.AccountAuthenticator这一 Action 所激活的过滤器,这一 Intent 会在系统要运行授权器时由系统发出。当过滤器被激活后,系统会启动AuthenticatorService,即之前用来封装授权器的Service

标签声明了授权器的元数据。android:name属性将元数据和授权器框架连接起来。android:resource指定了我们之前所创建的授权器元数据文件的名字。

除了授权器之外,Sync Adapter 框架也需要一个 Content Provider。如果我们的应用并没有使用 Content Provider,那么可以阅读下一节课程学习如何创建一个 Stub Content Provider;如果我们的应用已经使用了 ContentProvider,可以直接阅读:创建 Sync Adapter

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容

  • 原文:http://developer.android.com/training/sync-adapters/cr...
    tiger桂阅读 458评论 0 0
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,464评论 25 707
  • 原文:http://developer.android.com/training/sync-adapters/ru...
    tiger桂阅读 507评论 0 2
  • 我们身处的这个世界,谁也不能完全的开研究透,地球是,宇宙是,甚至连我们自己都不能百分百的说了解 先说我们居住的宇宙...
    山河识浅谈阅读 329评论 0 1
  • 脖子伸长 如菜市口的看客 一刀见血 殷红如河 悲伤的对白 谁还记得 散场的意犹未尽 幸灾乐祸甚多 口口相传 道听途...
    飞狐119阅读 154评论 0 2