الانتقال إلى وحدة التحكم

在 Android 上使用 GitHub 进行身份验证

要让您的用户能够通过 GitHub 帐号进行 Firebase 身份验证,您可以使用 Firebase SDK 执行端到端登录流程,将基于 Web 的通用 OAuth 登录机制集成到您的应用中。

准备工作

要让用户能够通过 GitHub 帐号登录,您必须先启用 GitHub,使其作为您的 Firebase 项目的登录服务提供方:

  1. 将 Firebase 添加到您的 Android 项目(如果尚未添加)。

  2. Firebase 控制台中,打开身份验证 (Authentication) 部分。
  3. 登录方法标签页中,启用 GitHub 提供方。
  4. 将该提供方的开发者控制台中的客户端 ID客户端密钥添加至提供方配置:
    1. 在 GitHub 上将您的应用注册为开发者应用,并为其获取 OAuth 2.0 客户端 ID客户端密钥
    2. 请务必转到 GitHub 应用配置,在您的应用的设置页面中,将 Firebase OAuth 重定向 URI(例如 my-app-12345.firebaseapp.com/__/auth/handler)设置为您的授权回调网址
  5. 点击保存
  6. 请务必在您的项目级层 build.gradle 文件中,于 buildscriptallprojects 部分添加 Google 的 Maven 代码库。

  7. 将 Android 版 Firebase 身份验证库的依赖项添加到您的模块(应用级)Gradle 文件(通常为 app/build.gradle):

    implementation 'com.google.firebase:firebase-auth:19.0.0'
    
  8. 如果您尚未指定应用的 SHA-1 指纹,请在 Firebase 控制台的设置页面中指定。要详细了解如何获取您应用的 SHA-1 指纹,请参阅对客户端进行身份验证

使用 Firebase SDK 处理登录流程

如果您是在构建 Android 应用,想要通过用户的 GitHub 帐号对其进行 Firebase 身份验证,最简单的方法是使用 Firebase Android SDK 来处理整个登录流程。

要使用 Firebase Android SDK 处理登录流程,请按以下步骤操作:

  1. 使用提供方 ID github.com,通过其构建器构建 OAuthProvider 实例

    OAuthProvider.Builder provider = OAuthProvider.newBuilder("github.com");
    
  2. 可选:指定您希望通过 OAuth 请求发送的其他自定义 OAuth 参数。

    // Target specific email with login hint.
    provider.addCustomParameter("login", "your-email@gmail.com");
    

    要查看 GitHub 支持的参数,请参阅 GitHub OAuth 文档。请注意,您不能使用 setCustomParameters() 传递 Firebase 必需参数。这些参数包括 client_idresponse_typeredirect_uristatescoperesponse_mode

  3. 可选:指定您希望向身份验证提供方申请获取的个人资料基本信息以外的额外 OAuth 2.0 范围。如果您的应用需要从 GitHub API 访问私有用户数据,则您需要在 GitHub 开发者控制台的 API 权限下申请 GitHub API 访问权限。申请的 OAuth 范围必须与应用的 API 权限中预配置的范围完全匹配。

    // Request read access to a user's email addresses.
    // This must be preconfigured in the app's API permissions.
    List<String> scopes =
        new ArrayList<String>() {
          {
            add("user:email");
          }
        };
    provider.setScopes(scopes);
    
  4. 使用 OAuth 提供方对象进行 Firebase 身份验证。请注意,与其他 FirebaseAuth 操作不同,此操作会弹出自定义 Chrome 标签页,从而控制您的界面。因此,请不要在您添加的 OnSuccessListenerOnFailureListener 中引用您的 Activity,因为当操作启动界面时,它们会立即分离。

    您应该首先检查是否已收到响应。通过这种方法登录时,您的 Activity 将位于后台,这意味着系统可以在登录流程中将其回收。为了确保发生这种情况时不让用户进行重试,您应该检查结果是否已经存在。

    要检查是否存在等待中的结果,请调用 getPendingAuthResult

    Task<AuthResult> pendingResultTask = firebaseAuth.getPendingAuthResult();
    if (pendingResultTask != null) {
      // There's something already here! Finish the sign-in for your user.
      pendingResultTask
          .addOnSuccessListener(
              new OnSuccessListener<AuthResult>() {
                @Override
                public void onSuccess(AuthResult authResult) {
                  // User is signed in.
                  // IdP data available in
                  // authResult.getAdditionalUserInfo().getProfile().
                  // The OAuth access token can also be retrieved:
                  // authResult.getCredential().getAccessToken().
                }
              })
          .addOnFailureListener(
              new OnFailureListener() {
                @Override
                public void onFailure(@NonNull Exception e) {
                  // Handle failure.
                }
              });
    } else {
      // There's no pending result so you need to start the sign-in flow.
      // See below.
    }
    

    要启动登录流程,请调用 startActivityForSignInWithProvider

    firebaseAuth
        .startActivityForSignInWithProvider(/* activity= */ this, provider.build())
        .addOnSuccessListener(
            new OnSuccessListener<AuthResult>() {
              @Override
              public void onSuccess(AuthResult authResult) {
                // User is signed in.
                // IdP data available in
                // authResult.getAdditionalUserInfo().getProfile().
                // The OAuth access token can also be retrieved:
                // authResult.getCredential().getAccessToken().
              }
            })
        .addOnFailureListener(
            new OnFailureListener() {
              @Override
              public void onFailure(@NonNull Exception e) {
                // Handle failure.
              }
            });
    

    成功完成后,可以从返回的 OAuthCredential 对象检索与提供方关联的 OAuth 访问令牌。

    使用 OAuth 访问令牌,您可以调用 GitHub API

    例如,要获取个人资料基本信息,可以调用 REST API 以传递 Authorization 标头中的访问令牌:

  5. 以上示例侧重的是登录流程。除此之外,您也可以使用 startActivityForLinkWithProvider 将 GitHub 提供方与现有用户相关联。例如,您可以将多个提供方关联至同一个用户,以便使用任意一个进行登录。

    // The user is already signed-in.
    FirebaseUser firebaseUser = firebaseAuth.getCurrentUser();
    
    firebaseUser
        .startActivityForLinkWithProvider(/* activity= */ this, provider.build())
        .addOnSuccessListener(
            new OnSuccessListener<AuthResult>() {
              @Override
              public void onSuccess(AuthResult authResult) {
                // GitHub credential is linked to the current user.
                // IdP data available in
                // authResult.getAdditionalUserInfo().getProfile().
                // The OAuth access token can also be retrieved:
                // authResult.getCredential().getAccessToken().
              }
            })
        .addOnFailureListener(
            new OnFailureListener() {
              @Override
              public void onFailure(@NonNull Exception e) {
                // Handle failure.
              }
            });
    
    
  6. 上述格式同样适用于 startActivityForReauthenticateWithProvider,它的作用包括:对于要求用户必须有近期登录才能执行的敏感操作,可使用它检索新的凭据。

    // The user is already signed-in.
    FirebaseUser firebaseUser = firebaseAuth.getCurrentUser();
    
    firebaseUser
        .startActivityForReauthenticateWithProvider(/* activity= */ this, provider.build())
        .addOnSuccessListener(
            new OnSuccessListener<AuthResult>() {
              @Override
              public void onSuccess(AuthResult authResult) {
                // User is re-authenticated with fresh tokens and
                // should be able to perform sensitive operations
                // like account deletion and email or password
                // update.
              }
            })
        .addOnFailureListener(
            new OnFailureListener() {
              @Override
              public void onFailure(@NonNull Exception e) {
                // Handle failure.
              }
            });
    

后续步骤

在用户首次登录后,系统会创建一个新的用户帐号,并将其与该用户登录时使用的凭据(即用户名和密码、电话号码或者身份验证提供方信息)相关联。此新帐号存储在您的 Firebase 项目中,无论用户采用何种方式登录,您项目中的每个应用都可以使用此帐号来识别用户。

  • 在您的应用中,您可以从 FirebaseUser 对象获取用户的个人资料基本信息。请参阅管理用户

  • 在您的 Firebase 实时数据库和 Cloud Storage 安全规则中,您可以从 auth 变量获取已登录用户的唯一身份用户 ID,然后利用此 ID 来控制用户可以访问哪些数据。

您可以通过将身份验证提供方凭据与现有用户帐号关联,让用户可以使用多种身份验证提供方服务登录您的应用。

如需让用户退出登录,请调用 signOut

Java

FirebaseAuth.getInstance().signOut();

Kotlin

FirebaseAuth.getInstance().signOut()