在 Android 上使用密碼型帳戶進行 Firebase 驗證

您可以使用 Firebase Authentication 讓使用者透過 Firebase 使用自己的電子郵件地址和密碼,管理應用程式的 使用 API

事前準備

  1. 如果還沒試過 將 Firebase 新增至您的 Android 專案

  2. 如果您尚未將應用程式連結至 Firebase 專案,請前往 Firebase 控制台
  3. 啟用電子郵件/密碼登入功能:
    1. Firebase 主控台中,開啟「Auth」部分。
    2. 在「登入方式」分頁中啟用「電子郵件/密碼」登入方式,然後按一下「儲存」
  4. 模組 (應用程式層級) Gradle 檔案中 (通常為 <project>/<app-module>/build.gradle.kts<project>/<app-module>/build.gradle)、 新增 Android Firebase Authentication 程式庫的依附元件。建議您使用 Firebase Android BoM 來控制程式庫版本。

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:33.4.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 程式庫版本。

    (替代做法) 新增 Firebase 程式庫依附元件,「不使用」 BoM

    如果選擇不使用 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:23.0.0")
    }
    
    在尋找 Kotlin 專用的程式庫模組嗎?2023 年 10 月 (Firebase BoM 32.5.0)起,Kotlin 和 Java 開發人員都可以依附主要程式庫模組 (詳情請參閱這項計畫的常見問題)。

建立以密碼為基礎的帳戶

如要以密碼建立新的使用者帳戶,請完成下列步驟: 應用程式的登入活動:

  1. 在註冊活動的 onCreate 方法中,取得 FirebaseAuth 物件的共用例項:

    Kotlin+KTX

    private lateinit var auth: FirebaseAuth
    // ...
    // Initialize Firebase Auth
    auth = Firebase.auth

    Java

    private FirebaseAuth mAuth;
    // ...
    // Initialize Firebase Auth
    mAuth = FirebaseAuth.getInstance();
  2. 初始化「活動」時,請檢查使用者目前是否登入:

    Kotlin+KTX

    public override fun onStart() {
        super.onStart()
        // Check if user is signed in (non-null) and update UI accordingly.
        val currentUser = auth.currentUser
        if (currentUser != null) {
            reload()
        }
    }

    Java

    @Override
    public void onStart() {
        super.onStart();
        // Check if user is signed in (non-null) and update UI accordingly.
        FirebaseUser currentUser = mAuth.getCurrentUser();
        if(currentUser != null){
            reload();
        }
    }
  3. 當新使用者使用應用程式的註冊表單註冊時,請完成應用程式要求的任何新帳戶驗證步驟,例如驗證新帳戶的密碼是否輸入正確,且符合複雜度規定。
  4. 傳送新使用者的電子郵件地址和密碼,建立新帳戶 至 createUserWithEmailAndPassword

    Kotlin+KTX

    auth.createUserWithEmailAndPassword(email, password)
        .addOnCompleteListener(this) { task ->
            if (task.isSuccessful) {
                // Sign in success, update UI with the signed-in user's information
                Log.d(TAG, "createUserWithEmail:success")
                val user = auth.currentUser
                updateUI(user)
            } else {
                // If sign in fails, display a message to the user.
                Log.w(TAG, "createUserWithEmail:failure", task.exception)
                Toast.makeText(
                    baseContext,
                    "Authentication failed.",
                    Toast.LENGTH_SHORT,
                ).show()
                updateUI(null)
            }
        }

    Java

    mAuth.createUserWithEmailAndPassword(email, password)
            .addOnCompleteListener(this, new OnCompleteListener<AuthResult>() {
                @Override
                public void onComplete(@NonNull Task<AuthResult> task) {
                    if (task.isSuccessful()) {
                        // Sign in success, update UI with the signed-in user's information
                        Log.d(TAG, "createUserWithEmail:success");
                        FirebaseUser user = mAuth.getCurrentUser();
                        updateUI(user);
                    } else {
                        // If sign in fails, display a message to the user.
                        Log.w(TAG, "createUserWithEmail:failure", task.getException());
                        Toast.makeText(EmailPasswordActivity.this, "Authentication failed.",
                                Toast.LENGTH_SHORT).show();
                        updateUI(null);
                    }
                }
            });
    如果已建立新帳戶,使用者也會登入該帳戶。在回呼中,您可以使用 getCurrentUser 方法取得使用者的帳戶資料。

透過電子郵件地址和密碼登入使用者帳戶

使用密碼登入使用者的步驟與 建立新帳戶。在應用程式的登入活動中,請執行下列操作:

  1. 在登入活動的 onCreate 方法中,取得共用的 FirebaseAuth 物件的例項:

    Kotlin+KTX

    private lateinit var auth: FirebaseAuth
    // ...
    // Initialize Firebase Auth
    auth = Firebase.auth

    Java

    private FirebaseAuth mAuth;
    // ...
    // Initialize Firebase Auth
    mAuth = FirebaseAuth.getInstance();
  2. 初始化活動時,請檢查使用者目前是否已登入:

    Kotlin+KTX

    public override fun onStart() {
        super.onStart()
        // Check if user is signed in (non-null) and update UI accordingly.
        val currentUser = auth.currentUser
        if (currentUser != null) {
            reload()
        }
    }

    Java

    @Override
    public void onStart() {
        super.onStart();
        // Check if user is signed in (non-null) and update UI accordingly.
        FirebaseUser currentUser = mAuth.getCurrentUser();
        if(currentUser != null){
            reload();
        }
    }
  3. 當使用者登入應用程式時,請將使用者的電子郵件地址和密碼傳遞至 signInWithEmailAndPassword

    Kotlin+KTX

    auth.signInWithEmailAndPassword(email, password)
        .addOnCompleteListener(this) { task ->
            if (task.isSuccessful) {
                // Sign in success, update UI with the signed-in user's information
                Log.d(TAG, "signInWithEmail:success")
                val user = auth.currentUser
                updateUI(user)
            } else {
                // If sign in fails, display a message to the user.
                Log.w(TAG, "signInWithEmail:failure", task.exception)
                Toast.makeText(
                    baseContext,
                    "Authentication failed.",
                    Toast.LENGTH_SHORT,
                ).show()
                updateUI(null)
            }
        }

    Java

    mAuth.signInWithEmailAndPassword(email, password)
            .addOnCompleteListener(this, new OnCompleteListener<AuthResult>() {
                @Override
                public void onComplete(@NonNull Task<AuthResult> task) {
                    if (task.isSuccessful()) {
                        // Sign in success, update UI with the signed-in user's information
                        Log.d(TAG, "signInWithEmail:success");
                        FirebaseUser user = mAuth.getCurrentUser();
                        updateUI(user);
                    } else {
                        // If sign in fails, display a message to the user.
                        Log.w(TAG, "signInWithEmail:failure", task.getException());
                        Toast.makeText(EmailPasswordActivity.this, "Authentication failed.",
                                Toast.LENGTH_SHORT).show();
                        updateUI(null);
                    }
                }
            });
    如果登入成功,您可以使用傳回的 FirebaseUser 繼續操作。

建議做法:設定密碼政策

您可以強制規定密碼複雜度,提高帳戶安全性。

如要為專案設定密碼政策,請開啟密碼政策 Firebase主控台中「Authentication Settings」頁面的「Authentication Settings」分頁:

驗證設定

Firebase Authentication 個密碼政策支援下列密碼規定:

  • 須輸入小寫字元

  • 必須輸入大寫字元

  • 須有數字字元

  • 須有非英數字元

    下列字元符合非英數字元的規定: ^ $ * . [ ] { } ( ) ? " ! @ # % & / \ , > < ' : ; | _ ~

  • 密碼長度下限 (範圍介於 6 到 30 個字元之間,預設為 6 個字元)

  • 密碼長度上限 (長度上限為 4096 個半形字元)

您可以啟用密碼政策強制執行模式,有兩種模式可供選擇:

  • 強制執行:使用者必須更新密碼,才能符合政策規定,否則無法登入。

  • 通知:使用者可以使用不符規定的密碼登入。時間 在這個模式下,您應檢查使用者的密碼是否符合 並提示使用者更新 密碼。

新使用者一律須選擇符合 政策。

如果您有活躍使用者,建議您不要啟用強制模式,除非您打算封鎖密碼不符合政策的使用者。請改用通知模式,讓使用者以目前的帳戶登入 密碼,並告知對方密碼缺少的規定。

建議:啟用電子郵件列舉防護

部分 Firebase Authentication 方法會將電子郵件地址做為參數擲回 特定錯誤 (在必須註冊該電子郵件地址時取消註冊) (例如,使用電子郵件地址和密碼登入時) ,哪些情況不能使用 (例如變更使用者的電子郵件地址)。 雖然這有助於向使用者建議特定解決方法,但也可能遭到惡意人士濫用,用來找出使用者註冊的電子郵件地址。

為降低這個風險,建議您啟用電子郵件列舉防護功能 為專案使用 Google Cloud gcloud 工具請注意,啟用這項功能會變更 Firebase Authentication 的錯誤回報行為:請確認您的應用程式不會依賴更具體的錯誤。

後續步驟

使用者首次登入後,系統會建立新使用者帳戶,並連結至使用者登入時所用的憑證 (即使用者名稱和密碼、電話號碼或驗證服務提供者資訊)。這個新帳戶會儲存在 Firebase 專案中,無論使用者如何登入,都可以用於在專案中的每個應用程式中識別使用者。

  • 在應用程式中,您可以從 FirebaseUser 物件取得使用者的基本個人資料資訊。詳情請參閱 管理使用者。

  • 在你的Firebase Realtime DatabaseCloud Storage中 查看安全性規則之後 透過 auth 變數取得已登入使用者的不重複使用者 ID。 控管使用者可以存取的資料

您可以將驗證服務供應商憑證連結至現有使用者帳戶,讓使用者使用多個驗證服務供應商登入應用程式。

如要將使用者登出,請呼叫 signOut

Kotlin+KTX

Firebase.auth.signOut()

Java

FirebaseAuth.getInstance().signOut();