一文搞懂Android账户系统的使用方式
一文搞懂Android账户系统的使用方式简介概述实战环境布置基本使用(注册、登录和退出)注册登录退出附录
一文搞懂Android账户系统的使用方式
简介
Android账户系统是利用Android系统为应用对其账户信息进行管理,同时避免每次进入应用都需用户手动输入用户名密码进行验证的繁琐操作。
概述
Android账户系统是利用AccountManager家族的系统接口,将应用的账户信息交给系统管理,并与后台服务端自认证处理。
我们可以在设置界面中看到Android系统管理的账户相关信息:
设置界面账户.pngAccount家族均在系统的android/accounts文件目录中,主要有如下几个类成员:
-
AbstractAccountAuthenticator
-
Account
-
AccountAuthenticatorActivity
-
AccountAutheticatorResponse
-
AccountManager
-
AuthenticatorDescription
当然应用是通过AccountManager去和系统服务AccountManagerService进行交互,具体的功能实现还是在service中。
实战
应用想实现通过Android系统管理自己的账户信息,大致需要进行如下几个步骤:
-
环境布置;
-
实现添加账户、登录及退出登录操作;
环境布置
首先是环境布置,这里的环境布置是应用实现该功能的基本配置。
1、首先是权限配置,若要使用系统的该功能,需要获取一些相关的权限:
<!--AccountManager所需权限-->
<uses-permission android:name="android.permission.AUTHENTICATE_ACCOUNTS"/>
<uses-permission android:name="android.permission.GET_ACCOUNTS"/>
<uses-permission android:name="android.permission.MANAGE_ACCOUNTS"/>
<uses-permission android:name="android.permission.USE_CREDENTIALS"/>
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.WRITE_SYNC_SETTINGS"/>
2、在AndroidManifest.xml文件中添加系统服务AccountService,为了告诉系统当前应用需要使用Account服务
<service android:name=".acounts.AccountService"
android:exported="true">
<intent-filter>
<action android:name="android.accounts.AccountAuthenticator"/>
</intent-filter>
<meta-data android:name="android.accounts.AccountAuthenticator"
android:resource="@xml/authenticator"/> //1
</service>
3、在2中,我们注意到注释1处配置了一份资源文件,该文件是定义当前应用的账户类型(通常就是包名)
在res目录下,和values同级的目录xml(若没有则新建)下定义authenticator.xml文件(名字自定义)
<account-authenticator xmlns:android="http://schemas.android.com/apk/res/android"
android:accountType="com.welthy.demo" //1
android:icon="@mipmap/ic_launcher_round"
android:smallIcon="@mipmap/ic_launcher"
android:label="@string/app_name"/>
主要的就是注释1的accountType,我们设为包名。
4、新建2中定义的AccountService
public class AccountService extends Service {
@Nullable
@Override
public IBinder onBind(Intent intent) {
MyAuthenticator myAuthenticator = new MyAuthenticator(this); //1
return myAuthenticator.getIBinder();
}
}
在这个服务中,我们只实现其onBind方法,目的就是为了返回告诉系统当前应用的Authenticator的binder引用。以便系统可以调用我们自定义的Authenticator中的相关操作,以便实现账户功能。
5、新建4中提到的MyAuthenticator,该类是继承自AbstractAccountAuthenticator
public class MyAuthenticator extends AbstractAccountAuthenticator {
private Context mContext;
public MyAuthenticator(Context context) {
super(context);
this.mContext = context;
}
......
@Override
public Bundle addAccount(AccountAuthenticatorResponse response, String accountType, String authTokenType, String[] requiredFeatures, Bundle options) throws NetworkErrorException {
Intent intent = new Intent(mContext, AccountActivity.class);
intent.putExtra(AccountActivity.ARG_ACCOUNT_TYPE, accountType);
intent.putExtra(AccountActivity.ARG_AUTH_TYPE, authTokenType);
intent.putExtra(AccountManager.KEY_ACCOUNT_AUTHENTICATOR_RESPONSE, response);
final Bundle bundle = new Bundle();
bundle.putParcelable(AccountManager.KEY_INTENT, intent); //1
return bundle; //2
}
String authToken;
@Override
public Bundle getAuthToken(AccountAuthenticatorResponse response, Account account, String authTokenType, Bundle options) throws NetworkErrorException {
final AccountManager am = AccountManager.get(mContext); //3
authToken = am.peekAuthToken(account, authTokenType); //4
if (TextUtils.isEmpty(authToken)) { //5
final String password = am.getPassword(account);
if (password != null) {
//向服务器再次请求
}
// authToken = sServerAuthenticate.userSignIn(account.name, password, authTokenType); //调用服务端认证登录,获取其authToken
//认证成功
if (!TextUtils.isEmpty(authToken)) { //6
Log.d("wx","authentication success");
final Bundle result = new Bundle();
result.putString(AccountManager.KEY_ACCOUNT_NAME, account.name);
result.putString(AccountManager.KEY_ACCOUNT_TYPE, account.type);
result.putString(AccountManager.KEY_AUTHTOKEN, authToken);
return result;
}
//未注册过
Log.d("wx","never registered."); //7
final Intent intent = new Intent(mContext, AccountActivity.class);
intent.putExtra(AccountManager.KEY_ACCOUNT_AUTHENTICATOR_RESPONS E, response);
intent.putExtra(AccountActivity.ARG_ACCOUNT_TYPE, account.type);
intent.putExtra(AccountActivity.ARG_AUTH_TYPE, authTokenType);
final Bundle bundle = new Bundle();
bundle.putParcelable(AccountManager.KEY_INTENT, intent);
return bundle;
}
......
}
新建的Authenticator继承系统的AbstractAccountAuthenticator后,我们需要实现其中的抽象方法,我们主要需要实现其中的addAccount()和getAuthenToken()方法,其他的默认实现即可。
首先看到addAccount()方法,我们就是新建Intent意图,并将该Intent封装到Bundle中。目的是告诉系统我们的登录界面,以及当前应用的账户类型(包名),系统会去提取该Bundle中意图,然后去启动我们指定的登录界面进行登录操作。通过指定AccountManager.KEY_INTENT告诉系统我们的intent信息。
然后是getAuthToken()方法。首先在注释1,获得其AccountManager引用。然后通过它调用peekAuthToken获取当前账户信息的authToken。若该authToken为空的话,则会进入注释5,将该账户信息向服务端发起认证请求。若认证成功的话,则会进入注释6,我们直接返回该bundle即可。最后若没认证则进入注释7,代表该账户从未进行过注册,需要跳转到登录界面进行注册登录。
账户系统的基本布置就是如此,当然还有Authenticator中其他的抽象方法进行相关的操作。
基本使用(注册、登录和退出)
注册
当环境配置完后,我们只需通过AccountManager,调用其addAccount()方法就可完成一个账户信息的注册
Account account = new Account(username,ARG_ACCOUNT_TYPE); //1
AccountManager am = AccountManager.get(AccountActivity.this); //2
am.addAccountExplicitly(account,pwd,null); //3
注释1,创建当前用户对应的Account封装;注释2,获取AccountManager引用;注释3,调用addAccountExplicitly()方法进行账户添加(内部有几个addAccountXXX方法,将在源码分析中再进行说明)。
登录
登录时我们通过调用getAuthToken()方法进行登录操作,关于验证及验证结果的操作在getAuthToken的讲解中已进行过说明。
Account account = new Account(username,ARG_ACCOUNT_TYPE); //1
AccountManager am = AccountManager.get(AccountActivity.this); //2
AccountManagerCallback<Bundle> callback = new AccountManagerCallback<Bundle>() { //3
@Override
public void run(AccountManagerFuture<Bundle> future) {
try {
Log.d("wx","ok run");
Intent it = new Intent(AccountActivity.this, MainActivity.class);
startActivity(it);
}catch (Exception e){}
}
};
am.getAuthToken(account,ARG_ACCOUNT_TYPE,null,AccountActivity.this,callback,null); //4
注释1,获取当前需登录的账户封装,注释2,获取AccountManager引用,注释3,我们定义了一个AccountManagerCallback,为了接收验证成功的结果回调。注释4,调用AccountManager的getAuthToken()进行登录操作。
退出
对于Android账户系统来说,要退出代表移除当前账户,及时再输入其用户名和密码也没有,就像从未注册过一样,因此该操作若需要的话建议在系统设置中操作。我们通过AccountManager.invalidateAuthToken ()方法将该账户的authToken置为无效。
以上是账户相关的基本操作,更详细可参考附录1中的信息。
附录
1、http://blog.udinic.com/2013/04/24/write-your-own-android-authenticator/