Firebase Demo Day is here! Watch demos of how to build and grow AI-powered, full stack apps using the best of Google.

本頁面由 Cloud Translation API 翻譯而成。

Switch to English

在 Android 上使用 GitHub 進行身份驗證

您可以使用 Firebase SDK 將基於 Web 的通用 OAuth 登入整合到您的應用程式中，以執行端對端登入流程，讓使用者使用其 GitHub 帳戶透過 Firebase 進行驗證。

在你開始之前

若要使用 GitHub 帳戶登入用戶，您必須先啟用 GitHub 作為 Firebase 專案的登入提供者：

如果您尚未將 Firebase 新增至您的 Android 專案中，請將其新增至您的 Android 專案中。
在Firebase 控制台中，開啟「驗證」部分。
在登入方法標籤上，啟用GitHub提供者。
將客戶端 ID和客戶端金鑰從該提供者的開發人員控制台新增至提供者設定：
1. 在 GitHub上將您的應用程式註冊為開發人員應用程序，並獲取您的應用程式的 OAuth 2.0 Client ID和Client Secret 。
2. 確保您的 Firebase OAuth 重定向 URI （例如my-app-12345.firebaseapp.com/__/auth/handler ）在GitHub 應用程式 config 的應用程式設定頁面中設定為您的授權回調 URL 。
按一下「儲存」 。
在模組（應用程式層級）Gradle 檔案（通常<project>/<app-module>/build.gradle.kts或<project>/<app-module>/build.gradle ）中，新增Firebase 驗證的依賴項Android 的庫。我們建議使用Firebase Android BoM來控制函式庫版本控制。
```
dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:32.6.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:22.3.0")
}
```
正在尋找 Kotlin 特定的庫模組？從2023 年 10 月（Firebase BoM 32.5.0）開始，Kotlin 和 Java 開發人員都可以依賴主庫模組（有關詳細信息，請參閱有關此計劃的常見問題解答）。
如果您尚未指定已套用的 SHA-1 指紋，請從 Firebase 控制台的「設定」頁面執行此操作。有關如何取得應用程式的 SHA-1 指紋的詳細信息，請參閱驗證您的客戶端。

使用 Firebase SDK 處理登入流程

如果您正在建立 Android 應用，使用 Firebase 的 GitHub 帳戶對使用者進行身份驗證的最簡單方法是使用 Firebase Android SDK 處理整個登入流程。

若要使用 Firebase Android SDK 處理登入流程，請依照下列步驟操作：

使用其Builder和提供者 ID github.com建構OAuthProvider的實例

Kotlin+KTX

val provider = OAuthProvider.newBuilder("github.com")GenericIdpActivity.kt

Java

OAuthProvider.Builder provider = OAuthProvider.newBuilder("github.com");GenericIdpActivity.java

可選：指定要與 OAuth 請求一起傳送的其他自訂 OAuth 參數。
Kotlin+KTX
```
// Target specific email with login hint.
provider.addCustomParameter("login", "your-email@gmail.com")GenericIdpActivity.kt
```
Java
```
// Target specific email with login hint.
provider.addCustomParameter("login", "your-email@gmail.com");GenericIdpActivity.java
```
有關 GitHub 支援的參數，請參閱GitHub OAuth 文件。請注意，您無法使用setCustomParameters()傳遞 Firebase 所需的參數。這些參數是client_id 、 response_type 、 redirect_uri 、 state 、 scope和response_mode 。

選用：指定您想要從身分驗證提供者要求的基本設定檔以外的其他 OAuth 2.0 範圍。如果您的應用程式需要從 GitHub API 存取私有使用者數據，您需要在 GitHub 開發者控制台的API 權限下請求存取 GitHub API 的權限。請求的 OAuth 範圍必須與應用程式 API 權限中預先配置的範圍完全相符。

Kotlin+KTX

// Request read access to a user's email addresses.
// This must be preconfigured in the app's API permissions.
provider.scopes = listOf("user:email")GenericIdpActivity.kt

Java

// 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);GenericIdpActivity.java

使用 OAuth 提供者物件透過 Firebase 進行身份驗證。請注意，與其他 FirebaseAuth 操作不同，這將透過彈出Custom Chrome Tab來控制您的 UI。因此，請勿在附加的OnSuccessListener和OnFailureListener中引用您的 Activity，因為它們會在操作啟動 UI 時立即分離。

您應該先檢查是否已收到回覆。透過此方法登入會將您的 Activity 置於後台，這意味著系統可以在登入流程中回收它。為了確保發生這種情況時不會讓使用者重試，您應該檢查結果是否已存在。

若要檢查是否有待處理結果，請呼叫getPendingAuthResult ：

Kotlin+KTX

val pendingResultTask = firebaseAuth.pendingAuthResult
if (pendingResultTask != null) {
    // There's something already here! Finish the sign-in for your user.
    pendingResultTask
        .addOnSuccessListener {
            // User is signed in.
            // IdP data available in
            // authResult.getAdditionalUserInfo().getProfile().
            // The OAuth access token can also be retrieved:
            // ((OAuthCredential)authResult.getCredential()).getAccessToken().
            // The OAuth secret can be retrieved by calling:
            // ((OAuthCredential)authResult.getCredential()).getSecret().
        }
        .addOnFailureListener {
            // Handle failure.
        }
} else {
    // There's no pending result so you need to start the sign-in flow.
    // See below.
}GenericIdpActivity.kt

Java

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().
                            // The OAuth secret can be retrieved by calling:
                            // ((OAuthCredential)authResult.getCredential()).getSecret().
                        }
                    })
            .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.
}GenericIdpActivity.java

若要啟動登入流程，請呼叫startActivityForSignInWithProvider ：

Kotlin+KTX

firebaseAuth
    .startActivityForSignInWithProvider(activity, provider.build())
    .addOnSuccessListener {
        // User is signed in.
        // IdP data available in
        // authResult.getAdditionalUserInfo().getProfile().
        // The OAuth access token can also be retrieved:
        // ((OAuthCredential)authResult.getCredential()).getAccessToken().
        // The OAuth secret can be retrieved by calling:
        // ((OAuthCredential)authResult.getCredential()).getSecret().
    }
    .addOnFailureListener {
        // Handle failure.
    }GenericIdpActivity.kt

Java

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().
                        // The OAuth secret can be retrieved by calling:
                        // ((OAuthCredential)authResult.getCredential()).getSecret().
                    }
                })
        .addOnFailureListener(
                new OnFailureListener() {
                    @Override
                    public void onFailure(@NonNull Exception e) {
                        // Handle failure.
                    }
                });GenericIdpActivity.java

成功完成後，可以從傳回的OAuthCredential物件中擷取與提供者關聯的 OAuth 存取權杖。

使用 OAuth 存取令牌，您可以呼叫GitHub API 。

例如，要取得基本設定檔訊息，您可以呼叫 REST API，在Authorization標頭中傳遞存取權杖：

雖然上述範例專注於登入流程，但您也可以使用startActivityForLinkWithProvider將 GitHub 提供者連結到現有使用者。例如，您可以將多個提供者連結到同一用戶，允許他們使用其中任一提供者登入。

Kotlin+KTX

// The user is already signed-in.
val firebaseUser = firebaseAuth.currentUser!!
firebaseUser
    .startActivityForLinkWithProvider(activity, provider.build())
    .addOnSuccessListener {
        // Provider 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().
        // The OAuth secret can be retrieved by calling:
        // authResult.getCredential().getSecret().
    }
    .addOnFailureListener {
        // Handle failure.
    }GenericIdpActivity.kt

Java

// 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) {
                        // Provider 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().
                        // The OAuth secret can be retrieved by calling:
                        // authResult.getCredential().getSecret().
                    }
                })
        .addOnFailureListener(
                new OnFailureListener() {
                    @Override
                    public void onFailure(@NonNull Exception e) {
                        // Handle failure.
                    }
                });GenericIdpActivity.java

相同的模式可以與startActivityForReauthenticateWithProvider一起使用，它可用於檢索需要最近登入的敏感操作的新憑證。

Kotlin+KTX

// The user is already signed-in.
val firebaseUser = firebaseAuth.currentUser!!
firebaseUser
    .startActivityForReauthenticateWithProvider(activity, provider.build())
    .addOnSuccessListener {
        // User is re-authenticated with fresh tokens and
        // should be able to perform sensitive operations
        // like account deletion and email or password
        // update.
    }
    .addOnFailureListener {
        // Handle failure.
    }GenericIdpActivity.kt

Java

// 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.
                    }
                });GenericIdpActivity.java

下一步

使用者首次登入後，系統會建立新的使用者帳戶，並將其連結到使用者登入時所使用的憑證（即使用者名稱和密碼、電話號碼或驗證提供者資訊）。此新帳戶將作為 Firebase 專案的一部分存儲，並且可用於識別專案中每個應用程式中的用戶，無論用戶如何登入。

在您的應用程式中，您可以從FirebaseUser物件取得使用者的基本個人資料資訊。請參閱管理用戶。
在 Firebase 即時資料庫和雲端儲存安全性規則中，您可以從auth變數取得登入使用者的唯一使用者 ID，並使用它來控制使用者可以存取哪些資料。

您可以透過將身分驗證提供者憑證連結到現有使用者帳戶，允許使用者使用多個驗證提供者登入您的應用程式。

若要登出用戶，請呼叫signOut ：

Kotlin+KTX

Firebase.auth.signOut()MainActivity.kt

Java

FirebaseAuth.getInstance().signOut();MainActivity.java