Łatwo dodawaj logowanie do swojej aplikacji internetowej za pomocą FirebaseUI

FirebaseUI to biblioteka oparta na pakiecie SDK uwierzytelniania Firebase, która udostępnia przepływy interfejsu użytkownika do użytku w Twojej aplikacji. FirebaseUI zapewnia następujące korzyści:

  • Wielu dostawców — przepływy logowania dla adresu e-mail/hasła, łącza do wiadomości e-mail, uwierzytelniania telefonu, logowania do Google, Facebooka, Twittera i GitHub.
  • Łączenie kont — przepływy umożliwiające bezpieczne łączenie kont użytkowników między dostawcami tożsamości.
  • Dostosowywanie — zastąp style CSS FirebaseUI, aby pasowały do ​​wymagań Twojej aplikacji. Ponadto, ponieważ FirebaseUI jest oprogramowaniem typu open source, możesz rozwidlić projekt i dostosować go dokładnie do swoich potrzeb.
  • Rejestracja jednym dotknięciem i automatyczne logowanie — automatyczna integracja z rejestracją jednym dotknięciem w celu szybkiego logowania się na różnych urządzeniach.
  • Zlokalizowany interfejs użytkownika — internacjonalizacja w ponad 40 językach .
  • Aktualizowanie anonimowych użytkowników — możliwość uaktualniania anonimowych użytkowników poprzez logowanie/rejestrację. Aby uzyskać więcej informacji, odwiedź sekcję Aktualizacja anonimowych użytkowników .

Zanim zaczniesz

  1. Dodaj Uwierzytelnianie Firebase do swojej aplikacji internetowej .

  2. Dołącz FirebaseUI za pomocą jednej z następujących opcji:

    1. CDN

      Umieść następujący skrypt i plik CSS w tagu <head> swojej strony, pod fragmentem inicjującym z Konsoli Firebase:

      <script src="https://www.gstatic.com/firebasejs/ui/6.0.1/firebase-ui-auth.js"></script>
      <link type="text/css" rel="stylesheet" href="https://www.gstatic.com/firebasejs/ui/6.0.1/firebase-ui-auth.css" />
      
    2. Moduł npm

      Zainstaluj FirebaseUI i jego zależności za pomocą npm, używając następującego polecenia:

      $ npm install firebaseui --save
      

      require następujących modułów w plikach źródłowych:

      var firebase = require('firebase');
      var firebaseui = require('firebaseui');
      
    3. Komponent altany

      Zainstaluj FirebaseUI i jego zależności za pomocą Bower, używając następującego polecenia:

      $ bower install firebaseui --save
      

      Dołącz wymagane pliki do swojego kodu HTML, jeśli serwer HTTP obsługuje pliki w ramach bower_components/ :

      <script src="bower_components/firebaseui/dist/firebaseui.js"></script>
      <link type="text/css" rel="stylesheet" href="bower_components/firebaseui/dist/firebaseui.css" />
      

Zainicjuj FirebaseUI

Po zaimportowaniu pakietu SDK zainicjuj interfejs użytkownika Auth.

// Initialize the FirebaseUI Widget using Firebase.
var ui = new firebaseui.auth.AuthUI(firebase.auth());

Skonfiguruj metody logowania

Aby móc używać Firebase do logowania użytkowników, musisz włączyć i skonfigurować metody logowania, które chcesz obsługiwać.

Adres e-mail i hasło

  1. W konsoli Firebase otwórz sekcję Uwierzytelnianie i włącz uwierzytelnianie za pomocą poczty e-mail i hasła.

  2. Dodaj identyfikator dostawcy poczty e-mail do listy signInOptions .

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        firebase.auth.EmailAuthProvider.PROVIDER_ID
      ],
      // Other config options...
    });
    
  3. Opcjonalnie : EmailAuthProvider można skonfigurować tak, aby wymagał od użytkownika wprowadzenia nazwy wyświetlanej (domyślnie true ).

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        {
          provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
          requireDisplayName: false
        }
      ]
    });
    
  1. W konsoli Firebase otwórz sekcję Uwierzytelnianie . Na karcie Metoda logowania włącz dostawcę poczty e-mail/hasła . Pamiętaj, że logowanie za pomocą poczty e-mail/hasła musi być włączone, aby można było korzystać z logowania za pomocą łącza e-mail.

  2. W tej samej sekcji włącz metodę logowania przez Email (logowanie bez hasła) i kliknij Zapisz .

  3. Dodaj identyfikator dostawcy poczty e-mail do listy signInOptions wraz z linkiem do adresu e-mail signInMethod .

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        {
          provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
          signInMethod: firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD
        }
      ],
      // Other config options...
    });
    
  4. Podczas warunkowego renderowania interfejsu użytkownika logowania (dotyczy to aplikacji jednostronicowych), użyj ui.isPendingRedirect() , aby wykryć, czy adres URL odpowiada logowaniu za pomocą łącza e-mail, a interfejs użytkownika musi zostać wyrenderowany, aby ukończyć logowanie.

    // Is there an email link sign-in?
    if (ui.isPendingRedirect()) {
      ui.start('#firebaseui-auth-container', uiConfig);
    }
    // This can also be done via:
    if (firebase.auth().isSignInWithEmailLink(window.location.href)) {
      ui.start('#firebaseui-auth-container', uiConfig);
    }
    
  5. Opcjonalnie : EmailAuthProvider do logowania za pomocą łącza poczty e-mail można skonfigurować tak, aby zezwalał lub blokował użytkownikowi możliwość logowania się na różnych urządzeniach.

    Opcjonalne wywołanie zwrotne emailLinkSignIn można zdefiniować, aby zwrócić konfigurację firebase.auth.ActionCodeSettings do użycia podczas wysyłania linku. Daje to możliwość określenia sposobu obsługi linku, niestandardowego linku dynamicznego, dodatkowego stanu w linku precyzyjnym itp. Jeśli nie zostanie podany, używany jest bieżący adres URL i uruchamiany jest przepływ tylko w sieci.

    Logowanie przez e-mail w FirebaseUI-web jest zgodne z FirebaseUI-Android i FirebaseUI-iOS , gdzie jeden użytkownik rozpoczynający przepływ z FirebaseUI-Android może otworzyć link i dokończyć logowanie przy użyciu FirebaseUI-web. To samo dotyczy przepływu przeciwnego.

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        {
          provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
          signInMethod: firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD,
          // Allow the user the ability to complete sign-in cross device,
          // including the mobile apps specified in the ActionCodeSettings
          // object below.
          forceSameDevice: false,
          // Used to define the optional firebase.auth.ActionCodeSettings if
          // additional state needs to be passed along request and whether to open
          // the link in a mobile app if it is installed.
          emailLinkSignIn: function() {
            return {
              // Additional state showPromo=1234 can be retrieved from URL on
              // sign-in completion in signInSuccess callback by checking
              // window.location.href.
              url: 'https://www.example.com/completeSignIn?showPromo=1234',
              // Custom FDL domain.
              dynamicLinkDomain: 'example.page.link',
              // Always true for email link sign-in.
              handleCodeInApp: true,
              // Whether to handle link in iOS app if installed.
              iOS: {
                bundleId: 'com.example.ios'
              },
              // Whether to handle link in Android app if opened in an Android
              // device.
              android: {
                packageName: 'com.example.android',
                installApp: true,
                minimumVersion: '12'
              }
            };
          }
        }
      ]
    });
    

Dostawcy OAuth (Google, Facebook, Twitter i GitHub)

  1. W konsoli Firebase otwórz sekcję Uwierzytelnianie i włącz logowanie określonego dostawcy OAuth. Upewnij się, że określono również odpowiedni identyfikator klienta i klucz tajny OAuth.

  2. Również w sekcji Uwierzytelnianie upewnij się, że domena, w której będzie renderowana Twoja strona logowania, jest również dodana do listy autoryzowanych domen.

  3. Dodaj identyfikator dostawcy OAuth do listy signInOptions .

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        // List of OAuth providers supported.
        firebase.auth.GoogleAuthProvider.PROVIDER_ID,
        firebase.auth.FacebookAuthProvider.PROVIDER_ID,
        firebase.auth.TwitterAuthProvider.PROVIDER_ID,
        firebase.auth.GithubAuthProvider.PROVIDER_ID
      ],
      // Other config options...
    });
    
  4. Opcjonalne : aby określić niestandardowe zakresy lub niestandardowe parametry OAuth na dostawcę, możesz przekazać obiekt zamiast tylko wartości dostawcy:

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        {
          provider: firebase.auth.GoogleAuthProvider.PROVIDER_ID,
          scopes: [
            'https://www.googleapis.com/auth/contacts.readonly'
          ],
          customParameters: {
            // Forces account selection even when one account
            // is available.
            prompt: 'select_account'
          }
        },
        {
          provider: firebase.auth.FacebookAuthProvider.PROVIDER_ID,
          scopes: [
            'public_profile',
            'email',
            'user_likes',
            'user_friends'
          ],
          customParameters: {
            // Forces password re-entry.
            auth_type: 'reauthenticate'
          }
        },
        firebase.auth.TwitterAuthProvider.PROVIDER_ID, // Twitter does not support scopes.
        firebase.auth.EmailAuthProvider.PROVIDER_ID // Other providers don't need to be given as object.
      ]
    });
    

Numer telefonu

  1. W konsoli Firebase otwórz sekcję Uwierzytelnianie i włącz logowanie za pomocą numeru telefonu.

  2. Upewnij się, że domena, w której zostanie wyrenderowana strona logowania, jest również dodana do listy autoryzowanych domen.

  3. Dodaj identyfikator dostawcy numeru telefonu do listy signInOptions .

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        firebase.auth.PhoneAuthProvider.PROVIDER_ID
      ],
      // Other config options...
    });
    
  4. Opcjonalne : PhoneAuthProvider można skonfigurować za pomocą niestandardowych parametrów reCAPTCHA, niezależnie od tego, czy reCAPTCHA jest widoczny, czy niewidoczny (domyślnie jest to normalne). Więcej informacji znajdziesz w dokumentacji interfejsu API reCAPTCHA .

    Można również ustawić domyślny kraj do wyboru podczas wprowadzania numeru telefonu. Zapoznaj się z listą obsługiwanych kodów krajów, aby uzyskać pełną listę kodów. Jeśli nie zostanie określony, wprowadzony numer telefonu będzie domyślnie ustawiony na Stany Zjednoczone (+1).

    Obecnie obsługiwane są następujące opcje.

    ui.start('#firebaseui-auth-container', {
      signInOptions: [
        {
          provider: firebase.auth.PhoneAuthProvider.PROVIDER_ID,
          recaptchaParameters: {
            type: 'image', // 'audio'
            size: 'normal', // 'invisible' or 'compact'
            badge: 'bottomleft' //' bottomright' or 'inline' applies to invisible.
          },
          defaultCountry: 'GB', // Set default country to the United Kingdom (+44).
          // For prefilling the national number, set defaultNationNumber.
          // This will only be observed if only phone Auth provider is used since
          // for multiple providers, the NASCAR screen will always render first
          // with a 'sign in with phone number' button.
          defaultNationalNumber: '1234567890',
          // You can also pass the full phone number string instead of the
          // 'defaultCountry' and 'defaultNationalNumber'. However, in this case,
          // the first country ID that matches the country code will be used to
          // populate the country selector. So for countries that share the same
          // country code, the selected country may not be the expected one.
          // In that case, pass the 'defaultCountry' instead to ensure the exact
          // country is selected. The 'defaultCountry' and 'defaultNationaNumber'
          // will always have higher priority than 'loginHint' which will be ignored
          // in their favor. In this case, the default country will be 'GB' even
          // though 'loginHint' specified the country code as '+1'.
          loginHint: '+11234567890'
        }
      ]
    });
    

Zaloguj się

Aby rozpocząć proces logowania FirebaseUI, zainicjuj instancję FirebaseUI, przekazując bazową instancję Auth .

// Initialize the FirebaseUI Widget using Firebase.
var ui = new firebaseui.auth.AuthUI(firebase.auth());

Zdefiniuj element HTML, w którym będzie renderowany widżet logowania FirebaseUI.

<!-- The surrounding HTML is left untouched by FirebaseUI.
     Your app may use that space for branding, controls and other customizations.-->
<h1>Welcome to My Awesome App</h1>
<div id="firebaseui-auth-container"></div>
<div id="loader">Loading...</div>

Określ konfigurację FirebaseUI (obsługiwani dostawcy i dostosowania interfejsu użytkownika, a także pomyślne wywołania zwrotne itp.).

var uiConfig = {
  callbacks: {
    signInSuccessWithAuthResult: function(authResult, redirectUrl) {
      // User successfully signed in.
      // Return type determines whether we continue the redirect automatically
      // or whether we leave that to developer to handle.
      return true;
    },
    uiShown: function() {
      // The widget is rendered.
      // Hide the loader.
      document.getElementById('loader').style.display = 'none';
    }
  },
  // Will use popup for IDP Providers sign-in flow instead of the default, redirect.
  signInFlow: 'popup',
  signInSuccessUrl: '<url-to-redirect-to-on-success>',
  signInOptions: [
    // Leave the lines as is for the providers you want to offer your users.
    firebase.auth.GoogleAuthProvider.PROVIDER_ID,
    firebase.auth.FacebookAuthProvider.PROVIDER_ID,
    firebase.auth.TwitterAuthProvider.PROVIDER_ID,
    firebase.auth.GithubAuthProvider.PROVIDER_ID,
    firebase.auth.EmailAuthProvider.PROVIDER_ID,
    firebase.auth.PhoneAuthProvider.PROVIDER_ID
  ],
  // Terms of service url.
  tosUrl: '<your-tos-url>',
  // Privacy policy url.
  privacyPolicyUrl: '<your-privacy-policy-url>'
};

Na koniec wyrenderuj interfejs FirebaseUI Auth:

// The start method will wait until the DOM is loaded.
ui.start('#firebaseui-auth-container', uiConfig);

Aktualizowanie anonimowych użytkowników

Włączanie aktualizacji anonimowego użytkownika

Gdy anonimowy użytkownik zaloguje się lub zarejestruje stałe konto, chcesz mieć pewność, że może on kontynuować to, co robił przed rejestracją. Aby to zrobić, po prostu ustaw autoUpgradeAnonymousUsers na true podczas konfigurowania interfejsu logowania (ta opcja jest domyślnie wyłączona).

Obsługa konfliktów scalania uaktualnień anonimowych użytkowników

Zdarzają się przypadki, gdy użytkownik, początkowo zalogowany anonimowo, próbuje uaktualnić do istniejącego użytkownika Firebase. Ponieważ istniejącego użytkownika nie można połączyć z innym istniejącym użytkownikiem, FirebaseUI wywoła wywołanie zwrotne signInFailure z kodem błędu firebaseui/anonymous-upgrade-merge-conflict , gdy wystąpi powyższe. Obiekt błędu będzie również zawierał stałe poświadczenie. Logowanie przy użyciu stałego poświadczenia powinno zostać wyzwolone w wywołaniu zwrotnym, aby zakończyć logowanie. Przed ukończeniem logowania za pośrednictwem auth.signInWithCredential(error.credential) należy zapisać dane anonimowego użytkownika i usunąć anonimowego użytkownika. Następnie po zakończeniu logowania skopiuj dane z powrotem do nieanonimowego użytkownika. Poniższy przykład ilustruje działanie tego przepływu.

// Temp variable to hold the anonymous user data if needed.
var data = null;
// Hold a reference to the anonymous current user.
var anonymousUser = firebase.auth().currentUser;
ui.start('#firebaseui-auth-container', {
  // Whether to upgrade anonymous users should be explicitly provided.
  // The user must already be signed in anonymously before FirebaseUI is
  // rendered.
  autoUpgradeAnonymousUsers: true,
  signInSuccessUrl: '<url-to-redirect-to-on-success>',
  signInOptions: [
    firebase.auth.GoogleAuthProvider.PROVIDER_ID,
    firebase.auth.FacebookAuthProvider.PROVIDER_ID,
    firebase.auth.EmailAuthProvider.PROVIDER_ID,
    firebase.auth.PhoneAuthProvider.PROVIDER_ID
  ],
  callbacks: {
    // signInFailure callback must be provided to handle merge conflicts which
    // occur when an existing credential is linked to an anonymous user.
    signInFailure: function(error) {
      // For merge conflicts, the error.code will be
      // 'firebaseui/anonymous-upgrade-merge-conflict'.
      if (error.code != 'firebaseui/anonymous-upgrade-merge-conflict') {
        return Promise.resolve();
      }
      // The credential the user tried to sign in with.
      var cred = error.credential;
      // Copy data from anonymous user to permanent user and delete anonymous
      // user.
      // ...
      // Finish sign-in after data is copied.
      return firebase.auth().signInWithCredential(cred);
    }
  }
});

Następne kroki

  • Więcej informacji o używaniu i dostosowywaniu FirebaseUI znajdziesz w README .
  • Jeśli znajdziesz problem w FirebaseUI i chcesz go zgłosić, użyj narzędzia do śledzenia problemów na GitHub .