如需使用 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()
方法以启动静默登录流程。如果静默登录成功,此调用会返回一个包含GoogleSignInAccount
的Task<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 登录 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 来启动登录流程,如执行 Interactive Sign-in 中所述。
以下代码段展示了如何在 activity 的 onCreate()
方法中添加登录按钮。
@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. } }); }