新浪微博客户端开发之OAuth认证篇
2013年7月29日新浪微博客户端开发
OAuth2.0授权机制我在这里就不浪费口舌了,有很多大牛都发表过相关的文章解释OAuth2.0认证的流程,我就随便找了一张图片把这部分内容略过。
在新浪微博API中呢,如何去实现这个认证流程是下面要说的:
实现步骤:
1. 下载新浪微博Android SDK,去新浪开发平台那里找去。
2. 创建项目,这里是OauthTest
2. 解压SDK压缩包,知道jar把它导入到项目当中
项目文档结构如下:
运行项目效果:
这里要说一下,我用的jar包并不是最新版的SDK,因为我测试过最新的这个“weiboSDK2.1_130712.jar”,在授权的时候会出现NumberFormatException的错误,我也不知道是为什么,所以我换了前面的一个版本:
weibo.sdk.android.sso.jar,就可以正确地获取access_token和expires_in,童鞋们可以自己去试一下。
下面是项目代码:
1.首先增加权限
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
2. /OauthTest/src/com/weibo/sdk/android/demo/MainActivity.java
package com.weibo.sdk.android.demo;
import java.text.SimpleDateFormat;
import java.util.Date;
import android.app.Activity;
import android.os.Bundle;
import android.view.View;
import android.view.View.OnClickListener;
import android.widget.Button;
import android.widget.TextView;
import android.widget.Toast;
import com.weibo.sdk.android.Oauth2AccessToken;
import com.weibo.sdk.android.Weibo;
import com.weibo.sdk.android.WeiboAuthListener;
import com.weibo.sdk.android.WeiboDialogError;
import com.weibo.sdk.android.WeiboException;
import com.weibo.sdk.android.keep.AccessTokenKeeper;
public class MainActivity extends Activity {
private Weibo mWeibo; //Weibo引用对象
public static Oauth2AccessToken accessToken; //访问token
private Button oauthBtn;
private TextView mText;
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
//获取Weibo引用对象,传入appkey和回调url
mWeibo = Weibo.getInstance(ConstantS.APP_KEY, ConstantS.REDIRECT_URL);
mText = (TextView) findViewById(R.id.show);
oauthBtn = (Button) findViewById(R.id.oauthBtn);
MainActivity.accessToken = AccessTokenKeeper.readAccessToken(this);
oauthBtn.setOnClickListener(new OnClickListener() {
@Override
public void onClick(View v) {
mWeibo.authorize(MainActivity.this, new AuthDialogListener());
}
});
}
public class AuthDialogListener implements WeiboAuthListener {
@Override
public void onCancel() {
//Oauth2.0认证过程中,如果认证窗口被关闭或认证取消时调用
Toast.makeText(getApplicationContext(), "Auth cancel" , Toast.LENGTH_LONG).show();
}
@Override
public void onComplete(Bundle values) {
// 认证结束后调用此方法
String token = values.getString("access_token");// 表明用户身份的token,用于微博API的调用
String expires_in = values.getString("expires_in");// 过期时间,用于判断登录是否过程
System.out.println(expires_in);
MainActivity.accessToken = new Oauth2AccessToken(token, expires_in);
String date = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss")
.format(new java.util.Date(MainActivity.accessToken
.getExpiresTime()));
mText.setText("认证成功: \r\n access_token: " + token + "\r\n"
+ "expires_in: " + expires_in + "\r\n有效期:" + date);
AccessTokenKeeper.keepAccessToken(MainActivity.this, accessToken);
Toast.makeText(MainActivity.this, "认证成功", Toast.LENGTH_SHORT)
.show();
}
@Override
public void onError(WeiboDialogError e) {
//Oauth2.0认证过程中,当认证对话框中的webView接收数据出现错误时调用此方法
Toast.makeText(getApplicationContext(), "Auth error:" + e.getMessage(), Toast.LENGTH_LONG).show();
}
@Override
public void onWeiboException(WeiboException e) {
//当认证过程中捕获到WeiboException时调用
Toast.makeText(getApplicationContext(), "Auth exception:" + e.getMessage(), Toast.LENGTH_LONG).show();
}
}
}
3. /OauthTest/src/com/weibo/sdk/android/demo/ConstantS.java
package com.weibo.sdk.android.demo;
/**
* 定义一个常量接口,方便管理常量
* @author wwj
*
*/
public interface ConstantS {
// 应用的key请到官方申请正式的appkey替换APP_KEY
public static final String APP_KEY = "249239496";
// 替换为开发者REDIRECT_URL
public static final String REDIRECT_URL = "http://www.sina.com";
// 新支持scope,支持传入多个scope权限,用逗号分隔
public static final String SCOPE = "email,direct_messages_read,direct_messages_write," +
"friendships_groups_read,friendships_groups_write,statuses_to_me_read," +
"follow_app_official_microblog";
}
原本SCOPE是要用在新版的SDK中,这是新增的一个参数
方法声明是这样的:
public static Weibo getInstance(java.lang.String appKey, java.lang.String redirectUrl, java.lang.String aScope)
- 微博初始化函数,需要优先其他函数调用.如果appKey或redirectUrl为空,默认抛出RuntimeException
-
-
参数:
-
appKey
- 第三方应用的appkey -
redirectUrl
- 第三方应用的回调页
返回:
- Weibo的实例 抛出:
-
java.lang.RuntimeException
-
4./OauthTest/src/com/weibo/sdk/android/keep/AccessTokenKeeper.java
package com.weibo.sdk.android.keep;
import android.content.Context;
import android.content.SharedPreferences;
import android.content.SharedPreferences.Editor;
import com.weibo.sdk.android.Oauth2AccessToken;
/**
* 该类用于保存Oauth2AccessToken到sharepreference,并提供读取功能
*
* @author wwj
*
*/
public class AccessTokenKeeper {
private static final String PREFERENCES_NAME = "com_weibo_sdk_android";
/**
* 保存accsssToken到SharedPreferences
* @param context 上下文对象
* @param token Oauth2AccessToken
*/
public static void keepAccessToken(Context context, Oauth2AccessToken token) {
SharedPreferences pref = context.getSharedPreferences(PREFERENCES_NAME, Context.MODE_APPEND);
Editor editor = pref.edit();
editor.putString("token", token.getToken());
editor.putLong("expiresTime", token.getExpiresTime());
editor.commit();
}
/**
* 清空sharedPreferences
* @param context
*/
public static void clear(Context context) {
SharedPreferences pref = context.getSharedPreferences(PREFERENCES_NAME, Context.MODE_APPEND);
Editor editor = pref.edit();
editor.clear();
editor.commit();
}
/**
* 从SharedPreferences读取accessToken
* @param context
* @return Oauth2AccessToken
*/
public static Oauth2AccessToken readAccessToken(Context context) {
Oauth2AccessToken token = new Oauth2AccessToken();
SharedPreferences pref = context.getSharedPreferences(PREFERENCES_NAME, Context.MODE_APPEND);
token.setToken(pref.getString("token", ""));
token.setExpiresTime(pref.getLong("expiresTime", 0));
return token;
}
}
以上就是简单的实现了第三方程序访问用户微博授权,没有太复杂的地方,主要是为了熟悉新浪微博的授权过程。
2014年5月19日 补充
很多初学者在使用新浪的时候要不就是无法调取授权界面,要不就是无法获得accesstoken.在这篇博客我重新补充一点,方便童鞋们在使用别人开发的客户端遇到的这些疑惑得到解答。
来到新浪开放平台,你首先需要创建相应的应用,Android的就创建“移动应用”
下面是列出的几个要点:
1.创建应用如何填写包名和签名首先你要保证你使用的客户端跟你创建的应用的包名是一致的,还需要用签名工具(注:签名工具在你下载的SDK压缩包下,解压之后会可以看到app_signatures.apk文件)生成相应的签名,下面是笔者需要改的包名和相应的app key、app secret,读者需要改成对应自己项目的包名和授权的appkey。
如果读者运行项目时无法调取授权页面,需要先把包名改为开放平台所填写的包名,笔者这里是com.wwj.weiboClient,记得也要在Androidmanifest.xml也要继续更新。
新浪微博授权方式有三种,我用的是第一种,是指定签名的,其余两种分别是sso授权方式,code授权方式,这里不做介绍。
2.如何填写回调页
很多同学不知道如何填写这一项,我建议开发者填写默认的回调页就行了,在调取授权页面的时候是需要传这个回调地址过去的,不然也是无法进行授权。
3.无法获取Access_token
无法获取访问令牌,也是很容易出现的问题,一些同学并不知道需要添加相应的测试帐号,所以一直无法进行登录授权,总是提示无法获取access_token。添加测试帐号如下图所示:
只有在应用没有上线时才需要添加测试帐号,应用上线后就不需要了。
如果以上三步都没有任何出错的话,我认为是可以调取新浪微博Oauth2.0授权界面,如下图:
经有些朋友反馈,上面三个步骤都做好了,但还是无法获取accesstoken,这就只能是平台的问题的,程序是没办法解决,唯有反馈给新浪开放平台,让他们解决了。