获取我们在 Firebase 峰会上发布的所有信息,了解 Firebase 可如何帮助您加快应用开发速度并满怀信心地运行应用。了解详情

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

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

您可以让您的用户使用他们的 GitHub 帐户向 Firebase 进行身份验证,方法是使用 Firebase SDK 将基于 Web 的通用 OAuth 登录集成到您的应用中,以执行端到端的登录流程。

在你开始之前

要使用 GitHub 帐户登录用户,您必须首先启用 GitHub 作为 Firebase 项目的登录提供程序:

  1. 如果您还没有,请将 Firebase 添加到您的 Android 项目中。

  2. Firebase 控制台中,打开Auth部分。
  3. 登录方法选项卡上,启用GitHub提供程序。
  4. 将该提供者的开发者控制台中的客户端 ID客户端密码添加到提供者配置中:
    1. 在 GitHub 上将您的应用程序注册为开发人员应用程序,并获取您的应用程序的 OAuth 2.0客户端 ID客户端密钥
    2. 确保您的 Firebase OAuth 重定向 URI (例如my-app-12345.firebaseapp.com/__/auth/handler )在GitHub 应用程序的 config的应用程序设置页面中设置为您的授权回调 URL
  5. 单击保存
  6. 在您的模块(应用级)Gradle 文件(通常是<project>/<app-module>/build.gradle )中,添加 Firebase Authentication Android 库的依赖项。我们建议使用Firebase Android BoM来控制库版本控制。

    Java

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:31.1.0')
    
        // Add the dependency for the Firebase Authentication library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-auth'
    }
    

    通过使用Firebase Android BoM ,您的应用将始终使用兼容版本的 Firebase Android 库。

    (替代)使用 BoM 的情况下添加 Firebase 库依赖项

    如果您选择不使用 Firebase BoM,则必须在其依赖行中指定每个 Firebase 库版本。

    请注意,如果您在应用中使用多个Firebase 库,我们强烈建议您使用 BoM 来管理库版本,以确保所有版本都兼容。

    dependencies {
        // Add the dependency for the Firebase Authentication library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-auth:21.1.0'
    }
    

    Kotlin+KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:31.1.0')
    
        // Add the dependency for the Firebase Authentication library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-auth-ktx'
    }
    

    通过使用Firebase Android BoM ,您的应用将始终使用兼容版本的 Firebase Android 库。

    (替代)使用 BoM 的情况下添加 Firebase 库依赖项

    如果您选择不使用 Firebase BoM,则必须在其依赖行中指定每个 Firebase 库版本。

    请注意,如果您在应用中使用多个Firebase 库,我们强烈建议您使用 BoM 来管理库版本,以确保所有版本都兼容。

    dependencies {
        // Add the dependency for the Firebase Authentication library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-auth-ktx:21.1.0'
    }
    

  7. 如果您尚未指定应用的 SHA-1 指纹,请从 Firebase 控制台的“设置”页面执行此操作。有关如何获取应用程序的 SHA-1 指纹的详细信息,请参阅验证您的客户端

使用 Firebase SDK 处理登录流程

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

要使用 Firebase Android SDK 处理登录流程,请执行以下步骤:

  1. 使用提供者 ID github.comBuilder构造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 操作不同,这将通过弹出Custom Chrome Tab来控制您的 UI。因此,不要在您附加的OnSuccessListenerOnFailureListener中引用您的 Activity,因为它们会在操作启动 UI 时立即分离。

    您应该首先检查您是否已经收到回复。通过此方法登录会将您的 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:
                  // ((OAuthCredential)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:
                // ((OAuthCredential)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 实时数据库和云存储安全规则中,您可以从auth变量中获取登录用户的唯一用户 ID,并使用它来控制用户可以访问哪些数据。

您可以通过将身份验证提供程序凭据链接到现有用户帐户来允许用户使用多个身份验证提供程序登录您的应用程序。

要注销用户,请调用signOut

Java

FirebaseAuth.getInstance().signOut();

Kotlin+KTX

Firebase.auth.signOut()