如果您支持使用 Google 账号登录,还可以使用一键登录客户端为用户提供顺畅的账号创建体验,让用户无需离开应用上下文。
当您显示一键快捷功能界面时,系统会提示用户使用设备上的某个 Google 账号为您的应用创建新账号。如果用户选择继续,您将获得一个 ID 令牌,其中包含基本个人资料信息(用户的姓名、个人资料照片和经过验证的电子邮件地址),您可以使用这些信息来创建新账号。
实现一键快捷功能账号创建功能分为两个部分:
- 将一键快捷功能客户端集成到您的应用中,如本页所述。这与使用一键登录功能大致相同,但配置方面存在一些差异。
- 向后端添加使用 Google ID 令牌创建用户账号的功能,如后端使用 ID 令牌中所述。
应在何处使用一键注册功能?
在用户登录后可以使用新功能的情况下,向用户提供一键注册功能的效果最好。首先,尝试使用保存的凭据让用户登录。如果未找到保存的凭据,请为用户提供创建新账号的选项。
准备工作
按照一键登录功能使用入门中的说明设置 Google API 控制台项目和 Android 项目。
1. 配置一键快捷功能客户端
如需配置一键快捷功能客户端以创建账号,请执行以下操作:
- 请勿启用密码凭据请求。(一键注册功能只能通过基于令牌的身份验证实现。)
使用
setGoogleIdTokenRequestOptions()和以下设置启用 Google ID 令牌请求:- 将服务器客户端 ID 设置为您在 Google API 控制台中创建的 ID。请注意,这是服务器的客户端 ID,而不是 Android 客户端 ID。
- 将客户端配置为显示设备上的所有 Google 账号,即不按已获授权的账号进行过滤。
- (可选)您还可以请求该账号的经过验证的电话 电话号码 。
Java
public class YourActivity extends AppCompatActivity { // ... private SignInClient oneTapClient; private BeginSignInRequest signUpRequest; @Override public void onCreate(@Nullable Bundle savedInstanceState, @Nullable PersistableBundle persistentState) { super.onCreate(savedInstanceState, persistentState); oneTapClient = Identity.getSignInClient(this); signUpRequest = BeginSignInRequest.builder() .setGoogleIdTokenRequestOptions(GoogleIdTokenRequestOptions.builder() .setSupported(true) // Your server's client ID, not your Android client ID. .setServerClientId(getString(R.string.your_web_client_id)) // Show all accounts on the device. .setFilterByAuthorizedAccounts(false) .build()) .build(); // ... } }
Kotlin
class YourActivity : AppCompatActivity() { // ... private lateinit var oneTapClient: SignInClient private lateinit var signUpRequest: BeginSignInRequest override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_main) oneTapClient = Identity.getSignInClient(this) signUpRequest = BeginSignInRequest.builder() .setGoogleIdTokenRequestOptions( BeginSignInRequest.GoogleIdTokenRequestOptions.builder() .setSupported(true) // Your server's client ID, not your Android client ID. .setServerClientId(getString(R.string.your_web_client_id)) // Show all accounts on the device. .setFilterByAuthorizedAccounts(false) .build()) .build() // ... } // ... }
2. 跟踪一键快捷功能界面取消情况
您应跟踪用户是否已通过关闭提示或点按提示之外的区域而拒绝使用一键注册功能。这可以像 Activity 的布尔值属性一样简单。(请参阅下文中的停止显示一键快捷功能 界面。)
3. 显示一键注册界面
如果用户未拒绝使用一键快捷功能创建新账号,请调用客户端对象的 beginSignIn() 方法,并将监听器附加到其返回的 Task。当一键登录请求未找到任何保存的凭据时,应用通常会执行此步骤,即在登录请求的失败监听器中执行此步骤。
如果用户在设备上设置了一个或多个 Google 账号,一键快捷功能客户端将调用成功监听器。在成功监听器中,从 Task 结果中获取待处理 intent,并将其传递给 startIntentSenderForResult() 以启动一键快捷功能界面。
如果用户在设备上没有任何 Google 账号,一键快捷功能客户端将调用失败监听器。在这种情况下,无需执行任何操作:您可以继续呈现应用的退出账号体验,用户可以使用正常的账号创建流程进行注册。
Java
oneTapClient.beginSignIn(signUpRequest)
.addOnSuccessListener(this, new OnSuccessListener<BeginSignInResult>() {
@Override
public void onSuccess(BeginSignInResult result) {
try {
startIntentSenderForResult(
result.getPendingIntent().getIntentSender(), REQ_ONE_TAP,
null, 0, 0, 0);
} catch (IntentSender.SendIntentException e) {
Log.e(TAG, "Couldn't start One Tap UI: " + e.getLocalizedMessage());
}
}
})
.addOnFailureListener(this, new OnFailureListener() {
@Override
public void onFailure(@NonNull Exception e) {
// No Google Accounts found. Just continue presenting the signed-out UI.
Log.d(TAG, e.getLocalizedMessage());
}
});
Kotlin
oneTapClient.beginSignIn(signUpRequest)
.addOnSuccessListener(this) { result ->
try {
startIntentSenderForResult(
result.pendingIntent.intentSender, REQ_ONE_TAP,
null, 0, 0, 0)
} catch (e: IntentSender.SendIntentException) {
Log.e(TAG, "Couldn't start One Tap UI: ${e.localizedMessage}")
}
}
.addOnFailureListener(this) { e ->
// No Google Accounts found. Just continue presenting the signed-out UI.
Log.d(TAG, e.localizedMessage)
}
4. 处理用户的响应
系统将使用 Activity 的 onActivityResult() 方法向您的应用报告用户对一键注册提示的响应。如果用户选择创建账号,结果将是 Google ID 令牌。如果用户通过关闭一键快捷功能界面或点按界面之外的区域而拒绝注册,结果将返回代码 RESULT_CANCELED。您的应用需要处理这两种可能性。
使用 Google ID 令牌创建账号
如果用户选择使用 Google 账号注册,您可以通过将 intent 数据从 onActivityResult() 传递给一键快捷功能客户端的 getSignInCredentialFromIntent() 方法,获取用户的 ID 令牌。凭据将具有非 null 的 googleIdToken 属性。
使用 ID 令牌在后端创建账号(请参阅使用 ID 令牌向 后端进行身份验证),并让用户登录。
凭据还包含您请求的任何其他详细信息,例如账号的经过验证的电话号码(如果有)。
Java
public class YourActivity extends AppCompatActivity { // ... private static final int REQ_ONE_TAP = 2; // Can be any integer unique to the Activity. private boolean showOneTapUI = true; // ... @Override protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) { super.onActivityResult(requestCode, resultCode, data); switch (requestCode) { case REQ_ONE_TAP: try { SignInCredential credential = oneTapClient.getSignInCredentialFromIntent(data); String idToken = credential.getGoogleIdToken(); if (idToken != null) { // Got an ID token from Google. Use it to authenticate // with your backend. Log.d(TAG, "Got ID token."); } } catch (ApiException e) { // ... } break; } } }
Kotlin
class YourActivity : AppCompatActivity() { // ... private val REQ_ONE_TAP = 2 // Can be any integer unique to the Activity private var showOneTapUI = true // ... override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) { super.onActivityResult(requestCode, resultCode, data) when (requestCode) { REQ_ONE_TAP -> { try { val credential = oneTapClient.getSignInCredentialFromIntent(data) val idToken = credential.googleIdToken when { idToken != null -> { // Got an ID token from Google. Use it to authenticate // with your backend. Log.d(TAG, "Got ID token.") } else -> { // Shouldn't happen. Log.d(TAG, "No ID token!") } } } catch (e: ApiException) { // ... } } } // ... }
停止显示一键登录界面
如果用户拒绝登录,对 getSignInCredentialFromIntent() 的调用将抛出 ApiException,并返回 CommonStatusCodes.CANCELED 状态代码。
发生这种情况时,您应暂时停止显示一键登录界面,以免重复提示打扰用户。以下示例通过在 Activity 上设置属性来实现此目的,该属性用于确定是否向用户提供一键登录功能;不过,您也可以将值保存到 SharedPreferences 或使用其他方法。
务必自行实现一键登录提示的速率限制。 否则,如果用户连续取消多个提示,一键快捷功能客户端将在接下来的 24 小时内不会提示用户。
Java
public class YourActivity extends AppCompatActivity { // ... private static final int REQ_ONE_TAP = 2; // Can be any integer unique to the Activity. private boolean showOneTapUI = true; // ... @Override protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) { super.onActivityResult(requestCode, resultCode, data); switch (requestCode) { case REQ_ONE_TAP: try { // ... } catch (ApiException e) { switch (e.getStatusCode()) { case CommonStatusCodes.CANCELED: Log.d(TAG, "One-tap dialog was closed."); // Don't re-prompt the user. showOneTapUI = false; break; case CommonStatusCodes.NETWORK_ERROR: Log.d(TAG, "One-tap encountered a network error."); // Try again or just ignore. break; default: Log.d(TAG, "Couldn't get credential from result." + e.getLocalizedMessage()); break; } } break; } } }
Kotlin
class YourActivity : AppCompatActivity() { // ... private val REQ_ONE_TAP = 2 // Can be any integer unique to the Activity private var showOneTapUI = true // ... override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) { super.onActivityResult(requestCode, resultCode, data) when (requestCode) { REQ_ONE_TAP -> { try { // ... } catch (e: ApiException) { when (e.statusCode) { CommonStatusCodes.CANCELED -> { Log.d(TAG, "One-tap dialog was closed.") // Don't re-prompt the user. showOneTapUI = false } CommonStatusCodes.NETWORK_ERROR -> { Log.d(TAG, "One-tap encountered a network error.") // Try again or just ignore. } else -> { Log.d(TAG, "Couldn't get credential from result." + " (${e.localizedMessage})") } } } } } } // ... }
后续步骤
当用户完成一键注册流程后,您将获得一个 Google ID 令牌,其中包含一些基本个人资料信息:用户的电子邮件地址、全名和个人资料照片网址。对于许多应用,这些信息足以让您 在后端对用户进行身份验证并创建新账号。
如果您需要其他信息才能完成账号创建(例如用户的出生日期),请向用户显示注册详细信息流程,您可以在其中请求这些额外信息。然后,将其发送到后端以完成账号创建。