为了使用 Google Play 游戏服务功能,您的游戏需要提供已登录玩家的帐号。如果玩家未通过身份验证,您的游戏在调用 Google Play 游戏服务 API 时可能会遇到错误。本文档介绍了如何在游戏中实现无缝登录体验。
实现玩家登录
GoogleSignInClient
类是主要入口点,用于检索当前已登录玩家的帐号,以及让玩家登录(如果玩家之前未在设备上的应用中这样做)。
如需创建登录客户端,请按以下步骤操作:
通过
GoogleSignInOptions
对象创建登录客户端,如以下代码段所示。在GoogleSignInOptions.Builder
中,如需配置登录,您必须指定GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN
。GoogleSignInOptions signInOptions = GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN;
如果您要使用
SnapshotsClient
,则应将.requestScopes(Games.SCOPE_GAMES_SNAPSHOTS)
添加到您的GoogleSignInOptions.Builder
,如以下代码段所示:GoogleSignInOptions signInOptions = new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN) .requestScopes(Games.SCOPE_GAMES_SNAPSHOTS) .build();
调用
GoogleSignIn.getClient()
方法,并传入您在上一步配置的选项。如果调用成功,Google Sign-In API 将返回GoogleSignInClient
实例。
检查玩家是否已登录
您可以使用 GoogleSignIn.getLastSignedInAccount()
检查当前设备上是否已登录帐号,以及该帐号是否已使用 GoogleSignIn.hasPermissions()
授予所需的权限。如果这两个条件均为 true(即 getLastSignedInAccount()
返回非 null 值且 hasPermissions()
返回 true
),即使设备处于离线状态,您也可以安全地使用从 getLastSignedInAccount()
返回的帐号。
执行静默登录
您可以调用 silentSignIn()
来检索当前已登录的玩家的帐号,如果玩家在其他设备上成功登录您的应用,则尝试在不显示界面的情况下登录玩家。
silentSignIn()
方法会返回 Task<GoogleSignInAccount>
。任务完成后,请将之前声明的 GoogleSignInAccount
字段设置为任务返回的结果登录帐号,或者设置为 null
,表示没有已登录用户。
如果静默登录尝试失败,您可以选择发送登录 intent 以显示登录界面,如执行交互式登录中所述。
由于当 activity 不在前台时,已登录玩家的状态可能会发生变化,因此我们建议从 activity 的 onResume()
方法调用 silentSignIn()
。
如需静默地登录,请按以下步骤操作:
- 对
GoogleSignInClient
调用silentSignIn()
方法,以启动静默登录流程。此调用会返回一个Task<GoogleSignInAccount>
对象,如果成功登录成功,该对象将包含GoogleSignInAccount
。 - 通过替换
OnCompleteListener
来处理玩家登录的成功或失败。- 如果登录任务成功,则通过调用
getResult()
获取GoogleSignInAccount
对象。 - 如果登录失败,您可以发送登录 intent 以启动交互式登录流程。
如需查看您可以使用的其他回调监听器的列表,请参阅 Tasks API 开发者指南和
Task
API 参考文档。
- 如果登录任务成功,则通过调用
以下代码段展示了应用如何执行静默登录:
private void signInSilently() { GoogleSignInOptions signInOptions = GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN; GoogleSignInAccount account = GoogleSignIn.getLastSignedInAccount(this); if (GoogleSignIn.hasPermissions(account, signInOptions.getScopeArray())) { // Already signed in. // The signed in account is stored in the 'account' variable. GoogleSignInAccount signedInAccount = account; } else { // Haven't been signed-in before. Try the silent sign-in first. GoogleSignInClient signInClient = GoogleSignIn.getClient(this, signInOptions); signInClient .silentSignIn() .addOnCompleteListener( this, new OnCompleteListener<GoogleSignInAccount>() { @Override public void onComplete(@NonNull Task<GoogleSignInAccount> task) { if (task.isSuccessful()) { // The signed in account is stored in the task's result. GoogleSignInAccount signedInAccount = task.getResult(); } else { // Player will need to sign-in explicitly using via UI. // See [sign-in best practices](http://developers.google.com/games/services/checklist) for guidance on how and when to implement Interactive Sign-in, // and [Performing Interactive Sign-in](http://developers.google.com/games/services/android/signin#performing_interactive_sign-in) for details on how to implement // Interactive Sign-in. } } }); } } @Override protected void onResume() { super.onResume(); signInSilently(); }
如果静默登录尝试失败,您可以调用 getException()
来获取包含详细状态代码的 ApiException
。状态代码 CommonStatusCodes.SIGN_IN_REQUIRED
表示玩家需要执行明确的操作才能登录。在这种情况下,您的应用应启动交互式登录流程,如下一部分所述。
执行交互式登录
为了通过玩家互动登录,您的应用需要启动登录 intent。如果成功,Google Sign-In API 会显示一个界面,用于提示玩家输入凭据进行登录。此方法可简化应用开发,因为登录 Activity 会代表应用处理需要更新 Google Play 服务或显示意见征求提示等场景。结果通过 onActivityResult
回调返回。
如需以交互方式登录,请按以下步骤操作:
对
GoogleSignInClient
调用getSigninIntent()
以获取登录 intent,然后调用startActivity()
并传入该 intent。以下代码段展示了应用如何启动交互式登录流程:private void startSignInIntent() { GoogleSignInClient signInClient = GoogleSignIn.getClient(this, GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN); Intent intent = signInClient.getSignInIntent(); startActivityForResult(intent, RC_SIGN_IN); }
在
onActivityResult()
回调中,处理返回的 intent 的结果。- 如果登录结果成功,请从
GoogleSignInResult
获取GoogleSignInAccount
对象。 - 如果登录结果失败,您应处理登录错误(例如,通过在提醒中显示错误消息)。以下代码段展示了应用如何处理玩家登录结果:
@Override protected void onActivityResult(int requestCode, int resultCode, Intent data) { super.onActivityResult(requestCode, resultCode, data); if (requestCode == RC_SIGN_IN) { GoogleSignInResult result = Auth.GoogleSignInApi.getSignInResultFromIntent(data); if (result.isSuccess()) { // The signed in account is stored in the result. GoogleSignInAccount signedInAccount = result.getSignInAccount(); } else { String message = result.getStatus().getStatusMessage(); if (message == null || message.isEmpty()) { message = getString(R.string.signin_other_error); } new AlertDialog.Builder(this).setMessage(message) .setNeutralButton(android.R.string.ok, null).show(); } } }
- 如果登录结果成功,请从
检索玩家信息
Google Sign-In API 返回的 GoogleSignInAccount
不包含任何玩家信息。如果您的游戏使用玩家信息(例如玩家的显示名称和玩家 ID),您可以按照以下步骤检索此信息。
- 通过调用
getPlayersClient()
方法并将GoogleSignInAccount
作为参数传入,获取PlayersClient
对象。 - 使用
PlayersClient
方法异步加载包含玩家信息的Player
对象。例如,您可以调用getCurrentPlayer()
以加载当前已登录的玩家。如果任务返回状态代码SIGN_IN_REQUIRED
的ApiException
,则表示玩家需要重新进行身份验证。为此,请调用GoogleSignInClient.getSignInIntent()
以交互方式让玩家登录。 - 如果任务成功返回
Player
对象,您可以调用Player
对象的方法来检索特定玩家详细信息(例如getDisplayName()
或getPlayerId()
)。
提供登录按钮
如需在游戏中提供标准 Google 登录按钮,可以使用以下方法之一:
- 在主 activity 布局中包含
com.google.android.gms.common.SignInButton
;或者 - 根据 Google 登录品牌推广指南设计自定义登录按钮。
当用户点击登录按钮时,您的游戏应发送登录 intent 来启动登录流程,如执行交互式登录中所述。
此代码段展示了如何在 onCreate()
方法中为您的 activity 添加登录按钮。
@Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_sign_in); findViewById(R.id.sign_in_button).setOnClickListener(this); findViewById(R.id.sign_out_button).setOnClickListener(this); }
以下代码段展示了如何在用户点击登录按钮时发送登录 intent。
@Override public void onClick(View view) { if (view.getId() == R.id.sign_in_button) { // start the asynchronous sign in flow startSignInIntent(); } else if (view.getId() == R.id.sign_out_button) { // sign out. signOut(); // show sign-in button, hide the sign-out button findViewById(R.id.sign_in_button).setVisibility(View.VISIBLE); findViewById(R.id.sign_out_button).setVisibility(View.GONE); } }
显示游戏弹出式窗口
您可以使用 GamesClient
类在游戏中显示弹出式视图。例如,您的游戏可以显示“欢迎回来”或“达成成就”弹出式窗口。若要允许 Google Play 游戏服务在游戏的视图中启动弹出式窗口,请调用 setViewForPopups()
方法。您可以通过调用 setGravityForPopups()
进一步自定义弹出式窗口在屏幕上的位置。
使玩家退出帐号
可通过对 GoogleSignInClient
调用 signOut()
方法来退出登录。
private void signOut() { GoogleSignInClient signInClient = GoogleSignIn.getClient(this, GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN); signInClient.signOut().addOnCompleteListener(this, new OnCompleteListener<Void>() { @Override public void onComplete(@NonNull Task<Void> task) { // at this point, the user is signed out. } }); }