Łatwe logowanie się w aplikacji internetowej dzięki FirebaseUI

FirebaseUI to biblioteka oparta na pakietu SDK Uwierzytelniania Firebase, który udostępnia przepływy w interfejsie użytkownika do użytku do aplikacji. FirebaseUI zapewnia następujące korzyści:

  • Wielu dostawców – procesy logowania za pomocą adresu e-mail i hasła, linku do e-maila i numeru telefonu oraz logowanie się w usługach Google, Facebook, Twitter i GitHub.
  • Łączenie kont – umożliwia bezpieczne łączenie kont użytkowników na różnych tożsamościach. dostawców usług.
  • Dostosowanie – zastąp style CSS interfejsu FirebaseUI, aby pasowały do aplikacji. . FirebaseUI to oprogramowanie typu open source, więc możesz utworzyć rozwidlenie projektu i dostosowania go do swoich potrzeb.
  • Rejestracja jednym kliknięciem i logowanie automatyczne – automatyczna integracja z usługami Rejestracja jednym kliknięciem i logowanie się na różnych urządzeniach.
  • Zlokalizowany interfejs – internacjonalizacja dla ponad 40 użytkowników Języki.
  • Uaktualnienie użytkowników anonimowych – możliwość uaktualniania anonimowych użytkowników przez logowania się/rejestracji. Aby uzyskać więcej informacji, zapoznaj się z sekcją Uaktualnianie anonimowych użytkowników .
.

Zanim zaczniesz

  1. dodać Uwierzytelnianie Firebase do swojej aplikacji internetowej. upewnij się, że używasz wersji 9 (zalecane) lub starszego pakietu SDK (zobacz pasek boczny powyżej).

  2. Uwzględnij FirebaseUI, korzystając z jednej z tych opcji:

    1. CDN

      Umieść w sekcji <head> poniższy skrypt i plik CSS. tag pod fragmentem kodu inicjującego 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 przez npm, korzystając z następującego kodu: polecenie:

      $ npm install firebaseui --save

      require te moduły w plikach źródłowych:

      var firebase = require('firebase');
var firebaseui = require('firebaseui');

    3. Komponent łuku

      Zainstaluj FirebaseUI i jej zależności za pomocą Bower, korzystając z następujących instrukcji polecenie:

      $ bower install firebaseui --save

      Umieść wymagane pliki w kodzie HTML, jeśli Twój serwer HTTP obsługuje pliki w folderze 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 uwierzytelniania.

// 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ć metod 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ą adresu e-mail i hasła.

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

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    firebase.auth.EmailAuthProvider.PROVIDER_ID
  ],
  // Other config options...
});

  3. Opcjonalnie: element EmailAuthProvider można skonfigurować tak, aby wymagał od użytkownika aby wpisać wyświetlaną nazwę (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. Dzień kartę Metoda logowania, włącz dostawcę E-mail/hasło. Notatka że logowanie za pomocą adresu e-mail za pomocą linku wymaga włączenia logowania za pomocą adresu e-mail i hasła.

  2. W tej samej sekcji włącz logowanie się przy użyciu opcji Link w e-mailu (logowanie bez hasła). i kliknij Zapisz.

  3. Dodaj identyfikator dostawcy poczty e-mail do listy FirebaseUI signInOptions z linkiem signInMethod w e-mailu.

    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 logowania (dotyczy aplikacji jednostronicowych) użyj parametru ui.isPendingRedirect(), aby wykryć, czy adres URL odpowiada logowania i link w e-mailu, a interfejs wymaga wyrenderowania interfejsu użytkownika.

    // 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: pole EmailAuthProvider umożliwiające zalogowanie się za pomocą linku w e-mailu może być skonfigurowano tak, aby zezwalał lub blokował użytkownikowi możliwość logowania się z różnych urządzeń.

    Można zdefiniować opcjonalne wywołanie zwrotne emailLinkSignIn, które zwraca firebase.auth.ActionCodeSettings. konfiguracji używanej przy wysyłaniu linku. Dzięki temu możesz: określenie sposobu obsługi linku, niestandardowy link dynamiczny, stan dodatkowy w precyzyjnym linku itd. Jeśli nie zostanie podany, używany będzie aktualny adres URL, aktywowany jest tylko przepływ.

    Logowanie za pomocą linku w e-mailu w interfejsie FirebaseUI w przeglądarce jest zgodne z FirebaseUI – Android. oraz FirebaseUI-iOS w którym użytkownik rozpoczynający proces od FirebaseUI-Androida może otworzyć link. i zaloguj się za pomocą FirebaseUI-web. To samo dotyczy przeciwności przepływu danych.

    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 protokołu OAuth (Google, Facebook, Twitter i GitHub)

  1. W konsoli Firebase otwórz sekcję Uwierzytelnianie i włącz login określonego dostawcy OAuth. Sprawdź, czy odpowiedni protokół OAuth identyfikator klienta i klucz tajny są również określone.

  2. Poza tym w sekcji Uwierzytelnianie sprawdź, czy domena, w której strona logowania zostanie także dodana do listy autoryzowanych domen.

  3. Dodaj identyfikator dostawcy OAuth do listy interfejsu FirebaseUI 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. Opcjonalnie: aby określić niestandardowe zakresy lub niestandardowe parametry OAuth dla możesz przekazać obiekt, a nie samą wartość 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 numer telefonu.

  2. Upewnij się, że domena, w której będzie wyświetlana strona logowania, również jest w domenie dodano do listy autoryzowanych domen.

  3. Dodaj identyfikator dostawcy numeru telefonu do listy FirebaseUI signInOptions.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    firebase.auth.PhoneAuthProvider.PROVIDER_ID
  ],
  // Other config options...
});

  4. Opcjonalnie: komponent PhoneAuthProvider można skonfigurować za pomocą niestandardowej odpowiedzi reCAPTCHA określa, czy usługa reCAPTCHA jest widoczna czy niewidoczna (wartość domyślna to normalny). Zapoznaj się z Dokumentacja interfejsu ReCAPTCHA API .

    Można również ustawić kraj domyślny do wpisania numeru telefonu. Zapoznaj się z lista obsługiwanych kodów krajów , aby zobaczyć pełną listę kodów. Jeśli numer telefonu nie zostanie określony, domyślnie będzie używany 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 uruchomić logowanie FirebaseUI, zainicjuj instancję FirebaseUI przez przez przekazywanie bazowej instancji Auth.

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

Określ 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 kolejne wywołania zwrotne itd.).

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 uwierzytelniania FirebaseUI:

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

Uaktualnianie anonimowych użytkowników

Włączanie anonimowego uaktualniania użytkowników

Gdy anonimowy użytkownik zaloguje się lub zarejestruje konto stałe, chcesz aby użytkownik mógł kontynuować swoje działania przed rejestracją. W tym celu ustaw autoUpgradeAnonymousUsers na true podczas konfiguracji interfejsu logowania (ta opcja jest domyślnie wyłączona).

Rozwiązywanie konfliktów podczas scalania anonimowych uaktualnień użytkowników

Może się zdarzyć, że użytkownik, który zalogował się anonimowo, spróbuje przejść na nowszą wersję. do istniejącego użytkownika Firebase. Ponieważ istniejącego użytkownika nie można połączyć z innym istniejący użytkownik, FirebaseUI wywoła wywołanie zwrotne signInFailure z kod błędu firebaseui/anonymous-upgrade-merge-conflict. Obiekt błędu będzie też zawierał trwałe dane logowania. Zaloguj się przez w celu ukończenia logowania powinny być aktywowane stałe dane logowania. Zanim będzie można się zalogować, użyj auth.signInWithCredential(error.credential), musisz zapisać anonimowość danych użytkownika i usuń anonimowego użytkownika. Następnie, po zalogowaniu się, skopiuj i przekazywać je nieanonimowemu użytkownikowi. Poniższy przykład pokazuje, jak to proces konfiguracji.

// 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