Android平台微博SDK说明文档.docx
- 文档编号:3294214
- 上传时间:2022-11-21
- 格式:DOCX
- 页数:17
- 大小:913.32KB
Android平台微博SDK说明文档.docx
《Android平台微博SDK说明文档.docx》由会员分享,可在线阅读,更多相关《Android平台微博SDK说明文档.docx(17页珍藏版)》请在冰豆网上搜索。
Android平台微博SDK说明文档
微博Android平台SDK文档
北京新潮讯捷信息技术有限公司
编号:
WEIBO_ANDROID_SDK
版本:
WEIBO_ANDROID_SDKV2.0.0
修订记录
时间
文档版本
修订人
备注
2012/7/20
2.0.0
罗棚
初稿
2012/8/02
2.0.0
张晓伟
概述
微博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(StringappKey,StringredirectUrl)
参数名称
作用
appKey
第三方应用的appkey(在新浪微博开放平台上创建应用时自动分配),
redirectUrl
第三方应用的回调页
返回结果
Weibo实例对象
授权认证
授权认证
接口名称
com.weibo.sdk.android.Weibo.authorize(Contextcontext,WeiboAuthListenerlistener)
参数名称
作用
context
当前activity对象,用于获取当前网络状态,弹出对话框等。
listener
授权对话框回调接口。
处理授权完成、授权失败、授权取消等事件
2.获取Oauth2AccessToken对象
获取Oauth2AccessToken对象
接口名称
com.weibo.sdk.android.Oauth2AccessToken(StringaccessToken,Stringexpires_in)
参数名称
作用
accessToken
通过认证后从服务器获取到的访问令牌
expires_in
认证有效期
返回结果
Oauth2AccessToken实例对象
3.分享到微博
StatusesAPI构造函数
接口名称
com.weibo.sdk.android.api.StatusesAPI(Oauth2AccessTokenaccesssToken)
参数名称
作用
accesssToken
Oauth2AccessToken对象
分享文字到微博
接口名称
com.weibo.sdk.android.api.StatusesAPI.update(Stringcontent,Stringlat,Stringlon,RequestListenerlistener)
参数名称
作用
content
要分享的微博内容,限140个字
Lat、lon
经纬度,格式为:
ddd.ddddd°【度.度】格式
listener
用于异步返回服务器的返回结果
分享文字和图片到微博
接口名称
com.weibo.sdk.android.api.StatusesAPI.upload(Stringcontent,Stringfile,Stringlat,Stringlon,RequestListenerlistener)
参数名称
作用
content
要分享的微博内容,限140个字
file
要上传的照片本地所在路径
Lat、lon
经纬度,格式为:
ddd.ddddd°【度.度】格式
listener
用于异步返回服务器的返回结果
4.SSO支持
SSOHandler构造函数
接口名称
voidSSOHandler(Activityactivity,Weiboweibo)
参数名称
作用
activity
发起认证的Activity
weibo对象
SSO回调
接口名称
voidauthorizeCallBack(intrequestCode,intresultCode,Intentdata)
使用说明
在AuthorizeActivity里覆写onActivityResult(intrequestCode,intresultCode,Intentdata),在方法中使用SSOHandler对象调用authorizeCallBack(intrequestCode,intresultCode,Intentdata)
SSO认证
接口名称
voidauthorize(WeiboAuthListenerlistenerweiboAuthListener)
使用说明
发起sso认证时调用此方法
参数名称
作用
weiboAuthListener
用于异步返回服务器的返回结果
实例分析
以下代码的具体信息请参考weibo.sdk.android.sso.demo工程。
svn地址为:
http:
//android-weibo-
1.通过Oauth2.0授权获得AccessToken
第一步InMainActivity:
通过Weibo的构造函数设置应用回调页和appkey。
对于Mobile客户端应用来说,是不存在Server的,故此处的应用回调页地址只要与新浪微博开放平台->我的应用->应用信息->高级应用->授权设置->应用回调页中的url地址保持一致就可以了,如图所示:
第二步InMainActivity:
实现WeiboDialogListener接口。
授权成功后可在onComplete函数中获得accesstoken信息。
具体如何保存、使用accesstoken信息由开发者自行处理。
第三步InMainActivity:
调用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->ExistingProjectsintoWorkspace。
注意:
SDK工程的编码格式为UTF-8。
如图所示:
图表2
1.2在需要集成本SDK的工程项目中添加Library。
右键->Properties->Android。
设置Library属性,如图所示:
图表3
1.3Manifest文件中必须包含以下permission:
name="android.permission.INTERNET"> name="android.permission.ACCESS_WIFI_STATE"> name="android.permission.WRITE_APN_SETTINGS"> name="android.permission.CHANGE_WIFI_STATE"> 1.4如果想在自建工程里直接使用sdk提供的jar包,可以在eclipse的File->Export->Java->JARfile里打出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因为apisdk是在weibo.sdk.android的基础上开发的,所以使用apisdk之前,需要先导入weibo.sdk.androidsdk,步骤详见上节介绍。 2.2按照上节的步骤,导入apisdk,同样需要将此sdk设置为library 2.3在Eclipse中,进入新建工程的Properties->Android中,按照下图所示添加library, 2.4如果想在自建工程里直接使用sdk提供的jar包,可以在eclipse的File->Export->Java->JARfile里打出jar文件,假设名称为oauth20-api.jar,步骤同1.4。 3.使用weibo.sdk.android.sso 3.1因为ssosdk是在weibo.sdk.android的基础上开发的,所以使用ssosdk之前,需要先导入weibo.sdk.androidsdk(如果要使用已经封装好的api接口,也可以导入weibo.sdk.android.api),步骤详见上节介绍。 3.2按照上节的步骤,导入ssosdk,同样需要将此sdk设置为library 3.3在Eclipse中,进入新建工程的Properties->Android中,按照下图所示添加library, 图表6 添加完成后,查看工程的buildpath,保证如下图所示,工程里已经分别引入了weibo.sdk.android.sso.jar和weibo.sdk.android.jar: 图表7 3.4如果想在自建工程里直接使用sdk提供的jar包,也可以按照下面的步骤来生成最终需要的jar文件,注意: jar包模式和library模式不能混用 1)安装fatjar: a.将上面的jar包放入eclipse->plugins目录,并重启eclipse b.在工程中点击右键,出现下面的选项BuildFatjar,说明此插件安装成功 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)点击Buildfatjar,按照向导一步步操作,在添加资源时,应保证将上节(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使用及修改必须遵守微博开发者协议,以及开源软件协议。
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- Android 平台 SDK 说明 文档