Android平台微博SDK说明文档

微博Android平台SDK文档

北京新潮讯捷信息技术有限公司

编号：WEIBO_ANDROID_SDK 版本：WEIBO_ANDROID_SDK V2.0.0 修订记录 时间 2012/7/20 2012/8/02

文档版本 2.0.0 2.0.0 修订人 罗棚 张晓伟 备注 初稿 北京新潮讯捷信息技术有限公司

目录

微博Android平台SDK文档 ....................................................................................................... 1

概述 .................................................................................................................................................................. 3 主要类说明： .................................................................................................................................................. 3 主要接口说明 .................................................................................................................................................. 3

1. 获取Weibo对象 .................................................................................................... 3 2. 获取Oauth2AccessToken对象 ........................................................................... 5 3. 分享到微博 ............................................................................................................... 5 4. SSO支持 .................................................................................................................. 6

实例分析 .......................................................................................................................................................... 6

1. 通过Oauth2.0授权获得AccessToken .............................................................. 7 2. 发送微博 ................................................................................................................... 8

SSO介绍 ......................................................................................................................................................... 10

1. SSO功能使用方式 ................................................................................................ 10 2. SSO授权功能介绍 ................................................................................................ 10 3. SSO授权优势 ........................................................................................................ 10 4. SSO授权流程示例 ................................................................................................ 10

SDK使用说明 ............................................................................................................................................... 12

1. 使用weibo.sdk.android（不包含sso功能） ................................................. 12 2. 使用weibo.sdk.android.sso.............................................................................. 15 3. SDK使用及修改必须遵守微博开发者协议，以及开源软件协议。 ................ 18

北京新潮讯捷信息技术有限公司

概述

微博Android平台SDK为第三方微博应用提供了文档易用的微博API调用服务，使第三方客户端无需了解复杂的验证，API调用过程。并可以实现分享到微博的功能，可以分享文字，或者多媒体信息到内置的分享页面，并发送到微博。

主要类说明：

1. Weibo: 微博API 接口类，对外提供weiboapi的调用，包括登录，API调用，微博分享

等功能。

2. Oauth2AccessToken：封装了“access_token”，“expires_in”，\"refresh_token\"，并提供了

他们的管理功能

3. Utility：工具类，提供了url 的encode，decode方法。 4. AsyncWeiboRunner：微博api异步执行类，封装了回调接口，通过创建线程来调用Weibo

中的接口方法。

5. HttpManager: 负责与服务器进行通讯的类，封装了GET、POST请求方式，并对外提供

图片上传等功能

6. WeiboAPI: 该类及其子类封装了新浪微博对外提供的api接口方法。 7. WeiboException：微博异常封装类，封装了微博的各个异常。 8. SsoHandler:单点登录 认证类，对外提供了sso登录认证的方法。

主要接口说明

1. 获取Weibo对象

获取weibo对象 接口名称 com.weibo.sdk.android.Weibo.getInstance(String appKey, String redirectUrl) 参数名称 作用 第三方应用的appkey（在新浪微博开放平台上创建应用时自动分配）， 第三方应用的回调页 appKey redirectUrl 返回结果 Weibo实例对象

北京新潮讯捷信息技术有限公司

北京新潮讯捷信息技术有限公司

授权认证

授权认证 接口名称 com.weibo.sdk.android.Weibo.authorize(Context context, WeiboAuthListenerlistener) 参数名称 作用 当前activity对象，用于获取当前网络状态，弹出对话框等。 授权对话框回调接口。处理授权完成、授权失败、授权取消等事件 context listener 2. 获取Oauth2AccessToken对象

获取Oauth2AccessToken对象 接口名称 com.weibo.sdk.android. Oauth2AccessToken (String accessToken, String expires_in) 参数名称 作用 通过认证后从服务器获取到的访问令牌 认证有效期 accessToken expires_in 返回结果 Oauth2AccessToken实例对象 3. 分享到微博

StatusesAPI 构造函数 接口名称 com.weibo.sdk.android.api.StatusesAPI(Oauth2AccessToken accesssToken) 参数名称 作用 accesssToken 分享文字到微博 接口名称 Oauth2AccessToken对象 com.weibo.sdk.android.api.StatusesAPI.update(String RequestListener listener) 参数名称 content 作用 content, String lat, String lon, 要分享的微博内容，限140个字 经纬度，格式为：ddd.ddddd °【度 . 度】格式 用于异步返回服务器的返回结果 Lat、lon listener 分享文字和图片到微博 接口名称 com.weibo.sdk.android.api.StatusesAPI.upload(String content, String file, String lat, String lon, RequestListener listener) 参数名称 content 作用 要分享的微博内容，限140个字 要上传的照片本地所在路径 file 北京新潮讯捷信息技术有限公司

Lat、lon listener 经纬度，格式为：ddd.ddddd °【度 . 度】格式 用于异步返回服务器的返回结果 4. SSO支持

SSOHandler 构造函数 接口名称 void SSOHandler (Activity activity,Weibo weibo) 参数名称 activity weibo 作用 发起认证的Activity weibo对象 SSO回调 接口名称 void authorizeCallBack(int requestCode, int resultCode, Intent data) 使用说明 在Authorize Activity里覆写onActivityResult(int requestCode, int resultCode, Intent data),在方法中使用SSOHandler对象调用authorizeCallBack(int requestCode, intresultCode, Intent data) SSO 认证 接口名称 void authorize (WeiboAuthListenerlistener weiboAuthListener) 使用说明 发起sso认证时调用此方法 参数名称 作用 用于异步返回服务器的返回结果 weiboAuthListener 实例分析

以下代码的具体信息请参考weibo.sdk.android.sso.demo工程。svn地址为： http:// android-weibo-sdk.googlecode.com/svn/example

北京新潮讯捷信息技术有限公司

1. 通过Oauth2.0授权获得AccessToken

第一步In MainActivity： 通过Weibo的构造函数设置应用回调页和appkey。

对于Mobile客户端应用来说，是不存在Server的，故此处的应用回调页地址只要与新浪微博开放平台->我的应用->应用信息->高级应用->授权设置->应用回调页中的url地址保持一致就可以了，如图所示：

第二步In MainActivity： 实现WeiboDialogListener接口。授权成功后可在onComplete函数中获得accesstoken信息。具体如何保存、使用accesstoken信息由开发者自行处理。

北京新潮讯捷信息技术有限公司

第三步 In MainActivity： 调用authorize方法，弹出授权对话框,进行授权。授权成功后即可获得accestoken。

2. 发送微博

通过已经获取的Oauth2AccessToken，构建StatuesAPI对象，然后调用发送接口update，示例如下：

北京新潮讯捷信息技术有限公司

也可以发送一片带有图片的微博，示例如下：

北京新潮讯捷信息技术有限公司

SSO介绍

1. SSO功能使用方式

使用SSO功能需要覆写onActivityResult()方法，并调用authorizeCallBack()方法

2. SSO授权功能介绍

接入新浪微博的第三方Android、iOS应用可通过新浪微博官方客户端快速完成OAuth2.0授权。

3. SSO授权优势

不需要重复输入新浪微博用户名、密码，只需要一步操作，直接点击授权按钮即可完成授权，增强了操作简便性及帐号安全性。目前仅3.0.0及以上客户端版本支持SSO。

4. SSO授权流程示例

第一步：选择使用SSO功能

第二步：选择用于授权的微博账号

第三步：使用微博账号进行授权，同意授权即可使用微博功能

如果想更换微博账号，需要先解除绑定后重复上诉操作。

下图为掌中新浪android版使用SSO示意图

北京新潮讯捷信息技术有限公司

图表 1

北京新潮讯捷信息技术有限公司

SDK使用说明

1. 使用weibo.sdk.android（不包含sso功能）

1.1将SDK的工程项目导入到eclipse中。

在eclipse中选择File->Import->General->Existing Projects into Workspace。注意：SDK工程的编码格式为UTF-8。如图所示：

图表 2

1.2在需要集成本SDK的工程项目中添加Library。

右键 -> Properties -> Android。设置Library属性，如图所示：

北京新潮讯捷信息技术有限公司

图表 3

1.3 Manifest文件中必须包含以下permission：

1.4 如果想在自建工程里直接使用sdk提供的jar包，可以在eclipse的

File->Export->Java->JAR file里打出jar文件，假设名称为oauth20.jar，如下图所示：注意：jar包模式和library模式不能混用,而且这种方式导出来的jar包与library模式下自动生成的jar包是不同的，后者无法将assets目录打进jar文件

北京新潮讯捷信息技术有限公司

图表 4

最后生成的jar的内部结构如下图所示：

图表 5

北京新潮讯捷信息技术有限公司

2. 使用weibo.sdk.android.api

Weibo.sdk.android.api是在weibo.sdk.android的基础上扩展而来，里面提供了一些对新浪微博openapi的封装接口，供用户使用。

2.1因为api sdk是在weibo.sdk.android的基础上开发的，所以使用api sdk之前，需要先导入

weibo.sdk.android sdk，步骤详见上节介绍。

2.2 按照上节的步骤，导入api sdk，同样需要将此sdk设置为library

2.3 在Eclipse中，进入新建工程的Properties->Android中，按照下图所示添加library，

2.4如果想在自建工程里直接使用sdk提供的jar包，可以在eclipse的File->Export->Java->JAR file里打出jar文件，假设名称为oauth20-api.jar，步骤同1.4。

北京新潮讯捷信息技术有限公司

3. 使用weibo.sdk.android.sso

3.1 因为sso sdk是在weibo.sdk.android的基础上开发的，所以使用ssosdk之前，需要先导入

weibo.sdk.android sdk（如果要使用已经封装好的api接口,也可以导入weibo.sdk.android.api），步骤详见上节介绍。

3.2 按照上节的步骤，导入sso sdk，同样需要将此sdk设置为library

3.3 在Eclipse中，进入新建工程的Properties->Android中，按照下图所示添加library，

图表 6

添加完成后，查看工程的build path，保证如下图所示，工程里已经分别引入了weibo.sdk.android.sso.jar和weibo.sdk.android.jar：

北京新潮讯捷信息技术有限公司

图表 7

3.4 如果想在自建工程里直接使用sdk提供的jar包，也可以按照下面的步骤来生成最终需要的jar文件，注意：jar包模式和library模式不能混用

net.sf.fjep.fatjar_0.0.31.jar

1) 安装fat jar：

a． 将上面的jar包放入eclipse->plugins目录，并重启eclipse

b． 在工程中点击右键，出现下面的选项 Build Fat jar，说明此插件安装成功

c． 如果没有出现，将 $eclipse_Home\\configuration\\org.eclipse.update\\platform.xml

删除，然后再重启eclipse，执行b步骤检查是否安装成功

d． 如果还未不成功，可以在线安装此插件，插件的地址是：

http://kurucz-grafika.de/fatjar，执行b步骤检查是否安装成功

e． 一般经过上面几个步骤，都可以正常安装fatjar，如果还未成功，那只好使用最

后一招了，换个其他版本eclipse吧，笔者使用3.7.2，没有任何问题

图表 8

2) 点击Build fat jar，按照向导一步步操作，在添加资源时，应保证将上节（1.4节）生成

的oauth20.jar勾选进来，如下图所示，最终生成一个jar，此jar文件内将包含oauth20.jar中的所有内容，文件内部结构如 图表5(如果想使用weibo.sdk.android.api提供的接口，在生成jar文件时，也需要将2.4节中生成的oauth20-api.jar勾选进来)

北京新潮讯捷信息技术有限公司

图表 9

将最终生的jar文件作为lib添加入自建工程中，并且在图标4所示界面中将引入的library 删除。

完成之后就可以正常使用了。

4. SDK使用及修改必须遵守微博开发者协议，以及开源软件协议。