Obsługa wielokrotnego logowania

To trzeci przewodnik z serii przewodników po dodatkach do Classroom.

W tym przewodniku obsłużysz ponowne wizyty w dodatku, automatycznie pobierając wcześniej przyznane dane logowania użytkownika. Następnie kierujesz użytkowników na strony, z których mogą od razu wysyłać żądania do interfejsu API. Jest to wymagane działanie w przypadku dodatków do Classroom.

W ramach tego przewodnika wykonasz te czynności:

  • Wdrożenie trwałej pamięci masowej na potrzeby danych logowania użytkowników.
  • Pobierz i oceń parametr zapytania dodatku login_hint. Jest to niepowtarzalny numer identyfikacyjny Google zalogowanego użytkownika.

Po zakończeniu tego procesu możesz w pełni autoryzować użytkowników w aplikacji internetowej i wysyłać wywołania do interfejsów API Google.

Omówienie parametrów zapytania iframe

Po otwarciu Classroom wczytuje identyfikator URI konfiguracji załączników dodatku. Classroom dodaje do identyfikatora URI kilka parametrów zapytania GET, które zawierają przydatne informacje kontekstowe. Jeśli na przykład identyfikator URI wykrywania załączników to https://example.com/addon, Classroom tworzy element iframe z adresem URL źródła ustawionym na https://example.com/addon?courseId=XXX&itemId=YYY&itemType=courseWork&addOnToken=ZZZ, gdzie XXX, YYY i ZZZ to identyfikatory ciągów tekstowych. Szczegółowy opis tego scenariusza znajdziesz w przewodniku po elementach iframe.

Adres URL Discovery może mieć 5 parametrów zapytania:

  • courseId: identyfikator bieżącego kursu w Classroom.
  • itemId: Identyfikator elementu strumienia, który użytkownik edytuje lub tworzy.
  • itemType: rodzaj elementu strumienia, który użytkownik tworzy lub edytuje. Może to być courseWork, courseWorkMaterial lub announcement.
  • addOnToken: token używany do autoryzacji niektórych działań dodatku do Classroom.
  • login_hint: identyfikator Google bieżącego użytkownika.

Ten przewodnik dotyczy login_hint. Użytkownicy są kierowani w zależności od tego, czy ten parametr zapytania jest podany. Jeśli go brakuje, są kierowani do procesu autoryzacji, a jeśli jest obecny – na stronę wykrywania dodatków.

Dostęp do parametrów zapytania

Parametry zapytania są przekazywane do aplikacji internetowej w ciągu URI. Zapisz te wartości w sesji. Są one używane w procesie autoryzacji oraz do przechowywania i pobierania informacji o użytkowniku. Te parametry zapytania są przekazywane tylko wtedy, gdy dodatek jest otwierany po raz pierwszy.

Python

Przejdź do definicji tras Flask (routes.py, jeśli korzystasz z podanego przez nas przykładu). U góry trasy docelowej dodatku (/classroom-addon w podanym przez nas przykładzie) pobierz i zapisz parametr zapytania /classroom-addon:login_hint

# If the login_hint query parameter is available, we'll store it in the session.
if flask.request.args.get("login_hint"):
    flask.session["login_hint"] = flask.request.args.get("login_hint")

Sprawdź, czy login_hint (jeśli występuje) jest przechowywany w sesji. Jest to odpowiednie miejsce do przechowywania tych wartości. Są one tymczasowe i po otwarciu dodatku otrzymujesz nowe wartości.

# It's possible that we might return to this route later, in which case the
# parameters will not be passed in. Instead, use the values cached in the
# session.
login_hint = flask.session.get("login_hint")

# If there's still no login_hint query parameter, this must be their first
# time signing in, so send the user to the sign in page.
if login_hint is None:
    return start_auth_flow()

Java

Przejdź do trasy docelowej dodatku w klasie kontrolera (/addon-discovery w AuthController.java w podanym przykładzie). Na początku tej trasy pobierz i zapisz parametr zapytania login_hint.

/** Retrieve the login_hint query parameter from the request URL if present. */
String login_hint = request.getParameter("login_hint");

Sprawdź, czy login_hint (jeśli występuje) jest przechowywany w sesji. Jest to odpowiednie miejsce do przechowywania tych wartości. Są one tymczasowe i po otwarciu dodatku otrzymujesz nowe wartości.

/** If login_hint wasn't sent, use the values in the session. */
if (login_hint == null) {
    login_hint = (String) session.getAttribute("login_hint");
}

/** If the there is still no login_hint, route the user to the authorization
 *  page. */
if (login_hint == null) {
    return startAuthFlow(model);
}

/** If the login_hint query parameter is provided, add it to the session. */
else if (login_hint != null) {
    session.setAttribute("login_hint", login_hint);
}

Dodawanie parametrów zapytania do procesu autoryzacji

Parametr login_hint należy też przekazać do serwerów uwierzytelniania Google. Ułatwia to proces uwierzytelniania. Jeśli aplikacja wie, który użytkownik próbuje się uwierzytelnić, serwer używa wskazówki, aby uprościć proces logowania, wstępnie wypełniając pole z adresem e-mail w formularzu logowania.

Python

Otwórz ścieżkę autoryzacji w pliku serwera Flask (/authorize w podanym przez nas przykładzie). Dodaj argument login_hint do wywołania funkcji flow.authorization_url.

authorization_url, state = flow.authorization_url(
    # Enable offline access so that you can refresh an access token without
    # re-prompting the user for permission. Recommended for web server apps.
    access_type="offline",
    # Enable incremental authorization. Recommended as a best practice.
    include_granted_scopes="true",
    # The user will automatically be selected if we have the login_hint.
    login_hint=flask.session.get("login_hint"),

Java

Przejdź do metody authorize() w klasie AuthService.java. Dodaj login_hint jako parametr do metody i dodaj login_hint oraz argument do narzędzia do tworzenia adresu URL autoryzacji.

String authUrl = flow
    .newAuthorizationUrl()
    .setState(state)
    .set("login_hint", login_hint)
    .setRedirectUri(REDIRECT_URI)
    .build();

Dodawanie trwałej pamięci na dane logowania użytkowników

Jeśli podczas wczytywania dodatku otrzymasz parametr zapytania login_hint, oznacza to, że użytkownik ukończył już proces autoryzacji naszej aplikacji. Zamiast zmuszać użytkowników do ponownego logowania, pobierz ich poprzednie dane logowania.

Pamiętaj, że po zakończeniu procesu autoryzacji otrzymasz token odświeżania. Zapisz ten token. Możesz go użyć ponownie, aby uzyskać token dostępu, który ma krótki okres ważności i jest niezbędny do korzystania z interfejsów API Google. Te dane logowania zostały wcześniej zapisane w sesji, ale musisz je zapisać, aby obsługiwać powracających użytkowników.

Zdefiniuj schemat użytkownika i skonfiguruj bazę danych

Skonfiguruj schemat bazy danych dla User.

Python

Określanie schematu użytkownika

User zawiera te atrybuty:

  • id: identyfikator Google użytkownika. Powinna ona być zgodna z wartościami podanymi w parametrze zapytania login_hint.
  • display_name: imię i nazwisko użytkownika, np. „Jan Kowalski”.
  • email: adres e-mail użytkownika.
  • portrait_url: adres URL zdjęcia profilowego użytkownika.
  • refresh_token: wcześniej uzyskany token odświeżania.

W tym przykładzie implementujemy pamięć za pomocą SQLite, która jest natywnie obsługiwana przez Pythona. Do zarządzania bazą danych używamy modułu flask_sqlalchemy.

Konfigurowanie bazy danych

Najpierw określ lokalizację pliku naszej bazy danych. Otwórz plik konfiguracji serwera (w naszym przykładzie config.py) i dodaj do niego poniższy kod.

import os

# Point to a database file in the project root.
DATABASE_FILE_NAME = os.path.join(
    os.path.abspath(os.path.dirname(__file__)), 'data.sqlite')

class Config(object):
    SQLALCHEMY_DATABASE_URI = f"sqlite:///{DATABASE_FILE_NAME}"
    SQLALCHEMY_TRACK_MODIFICATIONS = False

Wskazuje to Flaskowi plik data.sqlite w tym samym katalogu co plik main.py.

Następnie przejdź do katalogu modułu i utwórz nowy plik models.py. W naszym przykładzie jest to webapp/models.py. Dodaj do nowego pliku te informacje, aby zdefiniować tabelę User. Jeśli nazwa modułu jest inna, zastąp nią webapp.

from webapp import db

# Database model to represent a user.
class User(db.Model):
    # The user's identifying information:
    id = db.Column(db.String(120), primary_key=True)
    display_name = db.Column(db.String(80))
    email = db.Column(db.String(120), unique=True)
    portrait_url = db.Column(db.Text())

    # The user's refresh token, which will be used to obtain an access token.
    # Note that refresh tokens will become invalid if:
    # - The refresh token has not been used for six months.
    # - The user revokes your app's access permissions.
    # - The user changes passwords.
    # - The user belongs to a Google Cloud organization
    #   that has session control policies in effect.
    refresh_token = db.Column(db.Text())

Na koniec w pliku __init__.py modułu dodaj ten kod, aby zaimportować nowe modele i utworzyć bazę danych.

from webapp import models
from os import path
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy(app)

# Initialize the database file if not created.
if not path.exists(config.DATABASE_FILE_NAME):
    db.create_all()

Java

Określanie schematu użytkownika

User zawiera te atrybuty:

  • id: identyfikator Google użytkownika. Powinna być zgodna z wartością podaną w parametrze zapytania login_hint.
  • email: adres e-mail użytkownika.

Utwórz plik schema.sql w katalogu resources modułu. Spring odczytuje ten plik i generuje odpowiedni schemat bazy danych. Zdefiniuj tabelę z nazwą users i kolumnami reprezentującymi atrybuty User, idemail.

CREATE TABLE IF NOT EXISTS users (
    id VARCHAR(255) PRIMARY KEY, -- user's unique Google ID
    email VARCHAR(255), -- user's email address
);

Utwórz klasę Java, aby zdefiniować User model bazy danych. W podanym przykładzie jest to User.java.

Dodaj adnotację @Entity, aby wskazać, że jest to POJO, które można zapisać w bazie danych. Dodaj adnotację @Table z odpowiednią nazwą tabeli skonfigurowaną w schema.sql.

Zwróć uwagę, że przykład kodu zawiera konstruktory i funkcje ustawiające dla tych 2 atrybutów. Konstruktor i metody ustawiające są używane w AuthController.java do tworzenia lub aktualizowania użytkownika w bazie danych. Możesz też dodać metody pobierające i metodę toString, ale w tym przewodniku nie są one używane i zostały pominięte w przykładzie kodu na tej stronie, aby był on krótszy.

/** An entity class that provides a model to store user information. */
@Entity
@Table(name = "users")
public class User {
    /** The user's unique Google ID. The @Id annotation specifies that this
     *   is the primary key. */
    @Id
    @Column
    private String id;

    /** The user's email address. */
    @Column
    private String email;

    /** Required User class no args constructor. */
    public User() {
    }

    /** The User class constructor that creates a User object with the
    *   specified parameters.
    *   @param id the user's unique Google ID
    *   @param email the user's email address
    */
    public User(String id, String email) {
        this.id = id;
        this.email = email;
    }

    public void setId(String id) { this.id = id; }

    public void setEmail(String email) { this.email = email; }
}

Utwórz interfejs o nazwie UserRepository.java do obsługi operacji CRUD w bazie danych. Ten interfejs rozszerza interfejs CrudRepository.

/** Provides CRUD operations for the User class by extending the
 *   CrudRepository interface. */
@Repository
public interface UserRepository extends CrudRepository<User, String> {
}

Klasa kontrolera ułatwia komunikację między klientem a repozytorium. Dlatego zaktualizuj konstruktor klasy kontrolera, aby wstrzyknąć klasę UserRepository.

/** Declare UserRepository to be used in the Controller class constructor. */
private final UserRepository userRepository;

/**
*   ...
*   @param userRepository the class that interacts with User objects stored in
*   persistent storage.
*/
public AuthController(AuthService authService, UserRepository userRepository) {
    this.authService = authService;
    this.userRepository = userRepository;
}

Konfigurowanie bazy danych

Aby przechowywać informacje o użytkownikach, użyj bazy danych H2, która jest natywnie obsługiwana w Spring Boot. Ta baza danych będzie też używana w kolejnych przewodnikach do przechowywania innych informacji związanych z Classroom. Konfigurowanie bazy danych H2 wymaga dodania do pliku application.properties tej konfiguracji:

# Enable configuration for persistent storage using an H2 database
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.url=jdbc:h2:file:./h2/userdb
spring.datasource.username=<USERNAME>
spring.datasource.password=<PASSWORD>
spring.jpa.hibernate.ddl-auto=update
spring.jpa.open-in-view=false

Konfiguracja spring.datasource.url tworzy katalog o nazwie h2, w którym jest przechowywany plik userdb. Dodaj ścieżkę do bazy danych H2 do elementu .gitignore. Zanim uruchomisz aplikację, musisz zaktualizować pliki spring.datasource.usernamespring.datasource.password, aby skonfigurować bazę danych z wybraną nazwą użytkownika i hasłem. Aby zaktualizować nazwę użytkownika i hasło do bazy danych po uruchomieniu aplikacji, usuń wygenerowany katalog h2, zaktualizuj konfigurację i ponownie uruchom aplikację.

Ustawienie konfiguracji spring.jpa.hibernate.ddl-auto na update zapewnia, że dane przechowywane w bazie danych zostaną zachowane po ponownym uruchomieniu aplikacji. Aby czyścić bazę danych przy każdym ponownym uruchomieniu aplikacji, ustaw tę konfigurację na create.

Ustaw konfigurację spring.jpa.open-in-view na false. Ta konfiguracja jest domyślnie włączona i może powodować problemy z wydajnością, które trudno zdiagnozować w środowisku produkcyjnym.

Jak wspomnieliśmy wcześniej, musisz mieć możliwość pobrania danych logowania powracającego użytkownika. Umożliwia to wbudowany magazyn danych logowania obsługiwany przez GoogleAuthorizationCodeFlow.

W klasie AuthService.java zdefiniuj ścieżkę do pliku, w którym jest przechowywana klasa danych logowania. W tym przykładzie plik jest tworzony w katalogu /credentialStore. Dodaj ścieżkę do magazynu danych logowania do elementu .gitignore. Ten katalog jest generowany, gdy użytkownik rozpoczyna proces autoryzacji.

private static final File dataDirectory = new File("credentialStore");

Następnie utwórz w pliku AuthService.java metodę, która tworzy i zwraca obiekt FileDataStoreFactory. Jest to magazyn danych, w którym są przechowywane dane logowania.

/** Creates and returns FileDataStoreFactory object to store credentials.
 *   @return FileDataStoreFactory dataStore used to save and obtain users ids
 *   mapped to Credentials.
 *   @throws IOException if creating the dataStore is unsuccessful.
 */
public FileDataStoreFactory getCredentialDataStore() throws IOException {
    FileDataStoreFactory dataStore = new FileDataStoreFactory(dataDirectory);
    return dataStore;
}

Zaktualizuj metodę getFlow()AuthService.java, aby uwzględnić setDataStoreFactory w metodzie GoogleAuthorizationCodeFlow Builder() i wywołać getCredentialDataStore(), aby ustawić magazyn danych.

GoogleAuthorizationCodeFlow authorizationCodeFlow =
    new GoogleAuthorizationCodeFlow.Builder(
        HTTP_TRANSPORT,
        JSON_FACTORY,
        getClientSecrets(),
        getScopes())
    .setAccessType("offline")
    .setDataStoreFactory(getCredentialDataStore())
    .build();

Następnie zaktualizuj metodę getAndSaveCredentials(String authorizationCode). Wcześniej ta metoda uzyskiwała dane logowania bez ich przechowywania w jakimkolwiek miejscu. Zaktualizuj metodę przechowywania danych logowania w magazynie danych indeksowanym według identyfikatora użytkownika.

Identyfikator użytkownika można uzyskać z obiektu TokenResponse za pomocą metody id_token, ale musi on zostać najpierw zweryfikowany. W przeciwnym razie aplikacje klienckie mogą podszywać się pod użytkowników, wysyłając na serwer zmodyfikowane identyfikatory użytkowników. Zalecamy używanie bibliotek klienta interfejsu API Google do weryfikowania parametru id_token. Więcej informacji znajdziesz na [stronie Google Identity poświęconej weryfikacji tokena tożsamości Google].

// Obtaining the id_token will help determine which user signed in to the application.
String idTokenString = tokenResponse.get("id_token").toString();

// Validate the id_token using the GoogleIdTokenVerifier object.
GoogleIdTokenVerifier googleIdTokenVerifier = new GoogleIdTokenVerifier.Builder(
        HTTP_TRANSPORT,
        JSON_FACTORY)
    .setAudience(Collections.singletonList(
        googleClientSecrets.getWeb().getClientId()))
    .build();

GoogleIdToken idToken = googleIdTokenVerifier.verify(idTokenString);

if (idToken == null) {
    throw new Exception("Invalid ID token.");
}

Po zweryfikowaniu id_token uzyskaj userId, aby przechowywać go razem z uzyskanymi danymi logowania.

// Obtain the user id from the id_token.
Payload payload = idToken.getPayload();
String userId = payload.getSubject();

Zaktualizuj wywołanie funkcji flow.createAndStoreCredential, aby uwzględnić userId.

// Save the user id and credentials to the configured FileDataStoreFactory.
Credential credential = flow.createAndStoreCredential(tokenResponse, userId);

Dodaj do klasy AuthService.java metodę, która zwraca dane logowania konkretnego użytkownika, jeśli znajdują się one w pamięci danych.

/** Find credentials in the datastore based on a specific user id.
*   @param userId key to find in the file datastore.
*   @return Credential object to be returned if a matching key is found in the datastore. Null if
*   the key doesn't exist.
*   @throws Exception if building flow object or checking for userId key is unsuccessful. */
public Credential loadFromCredentialDataStore(String userId) throws Exception {
    try {
        GoogleAuthorizationCodeFlow flow = getFlow();
        Credential credential = flow.loadCredential(userId);
        return credential;
    } catch (Exception e) {
        e.printStackTrace();
        throw e;
    }
}

Pobieranie danych logowania

Określ metodę pobierania Users. W parametrze zapytania login_hint otrzymasz wartość id, której możesz użyć do pobrania konkretnego rekordu użytkownika.

Python

def get_credentials_from_storage(id):
    """
    Retrieves credentials from the storage and returns them as a dictionary.
    """
    return User.query.get(id)

Java

W klasie AuthController.java zdefiniuj metodę pobierania użytkownika z bazy danych na podstawie jego identyfikatora.

/** Retrieves stored credentials based on the user id.
*   @param id the id of the current user
*   @return User the database entry corresponding to the current user or null
*   if the user doesn't exist in the database.
*/
public User getUser(String id) {
    if (id != null) {
        Optional<User> user = userRepository.findById(id);
        if (user.isPresent()) {
            return user.get();
        }
    }
    return null;
}

Przechowywanie danych logowania

Dane logowania można przechowywać w 2 scenariuszach. Jeśli id użytkownika jest już w bazie danych, zaktualizuj istniejący rekord o wszystkie nowe wartości. W przeciwnym razie utwórz nowy rekord User i dodaj go do bazy danych.

Python

Najpierw zdefiniuj metodę narzędziową, która implementuje zachowanie związane z przechowywaniem lub aktualizowaniem.

def save_user_credentials(credentials=None, user_info=None):
    """
    Updates or adds a User to the database. A new user is added only if both
    credentials and user_info are provided.

    Args:
        credentials: An optional Credentials object.
        user_info: An optional dict containing user info returned by the
            OAuth 2.0 API.
    """

    existing_user = get_credentials_from_storage(
        flask.session.get("login_hint"))

    if existing_user:
        if user_info:
            existing_user.id = user_info.get("id")
            existing_user.display_name = user_info.get("name")
            existing_user.email = user_info.get("email")
            existing_user.portrait_url = user_info.get("picture")

        if credentials and credentials.refresh_token is not None:
            existing_user.refresh_token = credentials.refresh_token

    elif credentials and user_info:
        new_user = User(id=user_info.get("id"),
                        display_name=user_info.get("name"),
                        email=user_info.get("email"),
                        portrait_url=user_info.get("picture"),
                        refresh_token=credentials.refresh_token)

        db.session.add(new_user)

    db.session.commit()

Dane logowania możesz zapisać w bazie danych w 2 przypadkach: gdy użytkownik wraca do aplikacji po zakończeniu procesu autoryzacji i gdy wysyłasz wywołanie interfejsu API. W tych miejscach wcześniej ustawiliśmy klucz sesji credentials.

Wywołaj funkcję save_user_credentials na końcu trasy callback. Zachowaj obiekt user_info zamiast wyodrębniać tylko nazwę użytkownika.

# The flow is complete! We'll use the credentials to fetch the user's info.
user_info_service = googleapiclient.discovery.build(
    serviceName="oauth2", version="v2", credentials=credentials)

user_info = user_info_service.userinfo().get().execute()

flask.session["username"] = user_info.get("name")

save_user_credentials(credentials, user_info)

Po wywołaniach interfejsu API należy też zaktualizować dane logowania. W takim przypadku możesz podać zaktualizowane dane logowania jako argumenty metody save_user_credentials.

# Save credentials in case access token was refreshed.
flask.session["credentials"] = credentials_to_dict(credentials)
save_user_credentials(credentials)

Java

Najpierw zdefiniuj metodę, która przechowuje lub aktualizuje obiekt User w bazie danych H2.

/** Adds or updates a user in the database.
*   @param credential the credentials object to save or update in the database.
*   @param userinfo the userinfo object to save or update in the database.
*   @param session the current session.
*/
public void saveUser(Credential credential, Userinfo userinfo, HttpSession session) {
    User storedUser = null;
    if (session != null && session.getAttribute("login_hint") != null) {
        storedUser = getUser(session.getAttribute("login_hint").toString());
    }

    if (storedUser != null) {
        if (userinfo != null) {
            storedUser.setId(userinfo.getId());
            storedUser.setEmail(userinfo.getEmail());
        }
        userRepository.save(storedUser);
    } else if (credential != null && userinfo != null) {
        User newUser = new User(
            userinfo.getId(),
            userinfo.getEmail(),
        );
        userRepository.save(newUser);
    }
}

Dane logowania możesz zapisać w bazie danych w 2 przypadkach: gdy użytkownik wraca do aplikacji po zakończeniu procesu autoryzacji i gdy wysyłasz wywołanie interfejsu API. W tych miejscach wcześniej ustawiliśmy klucz sesji credentials.

Zadzwoń pod numer saveUser na końcu trasy /callback. Zamiast wyodrębniać tylko adres e-mail użytkownika, zachowaj obiekt user_info.

/** This is the end of the auth flow. We should save user info to the database. */
Userinfo userinfo = authService.getUserInfo(credentials);
saveUser(credentials, userinfo, session);

Po wywołaniach interfejsu API należy też zaktualizować dane logowania. W takim przypadku możesz podać zaktualizowane dane logowania jako argumenty metody saveUser.

/** Save credentials in case access token was refreshed. */
saveUser(credentials, null, session);

Wygasłe dane logowania

Pamiętaj, że tokeny odświeżania mogą stać się nieważne z kilku powodów. Są to:

  • Token odświeżania nie był używany od 6 miesięcy.
  • Użytkownik cofa uprawnienia dostępu aplikacji.
  • Użytkownik zmienia hasła.
  • Użytkownik należy do organizacji Google Cloud, w której obowiązują zasady kontroli sesji.

Jeśli dane logowania użytkownika stracą ważność, uzyskaj nowe tokeny, ponownie przeprowadzając użytkownika przez proces autoryzacji.

Automatyczne kierowanie użytkownika

Zmodyfikuj ścieżkę strony docelowej dodatku, aby wykrywać, czy użytkownik wcześniej autoryzował naszą aplikację. W takim przypadku przekieruj użytkowników na naszą główną stronę dodatków. W przeciwnym razie poproś użytkownika o zalogowanie się.

Python

Upewnij się, że plik bazy danych został utworzony podczas uruchamiania aplikacji. Wstaw poniższy kod do inicjatora modułu (np. webapp/__init__.py w podanym przykładzie) lub do głównej metody uruchamiającej serwer.

# Initialize the database file if not created.
if not os.path.exists(DATABASE_FILE_NAME):
    db.create_all()

Metoda powinna następnie obsługiwać parametr zapytania login_hint w sposób opisany powyżej. Następnie wczytaj dane logowania do sklepu jeśli użytkownik wraca na stronę. Jeśli otrzymasz login_hint, oznacza to, że użytkownik już wcześniej odwiedził Twoją witrynę. Pobierz zapisane dane logowania tego użytkownika i załaduj je do sesji.

stored_credentials = get_credentials_from_storage(login_hint)

# If we have stored credentials, store them in the session.
if stored_credentials:
    # Load the client secrets file contents.
    client_secrets_dict = json.load(
        open(CLIENT_SECRETS_FILE)).get("web")

    # Update the credentials in the session.
    if not flask.session.get("credentials"):
        flask.session["credentials"] = {}

    flask.session["credentials"] = {
        "token": stored_credentials.access_token,
        "refresh_token": stored_credentials.refresh_token,
        "token_uri": client_secrets_dict["token_uri"],
        "client_id": client_secrets_dict["client_id"],
        "client_secret": client_secrets_dict["client_secret"],
        "scopes": SCOPES
    }

    # Set the username in the session.
    flask.session["username"] = stored_credentials.display_name

Na koniec przekieruj użytkownika na stronę logowania, jeśli nie mamy jego danych logowania. Jeśli tak, przekieruj je na główną stronę dodatku.

if "credentials" not in flask.session or \
    flask.session["credentials"]["refresh_token"] is None:
    return flask.render_template("authorization.html")

return flask.render_template(
    "addon-discovery.html",
    message="You've reached the addon discovery page.")

Java

Otwórz stronę docelową dodatku (/addon-discovery w podanym przykładzie). Jak omówiliśmy powyżej, w tym miejscu obsługiwany jest parametr zapytania login_hint.

Najpierw sprawdź, czy w sesji są dostępne dane logowania. Jeśli nie, przekieruj użytkownika przez proces uwierzytelniania, wywołując metodę startAuthFlow.

/** Check if the credentials exist in the session. The session could have
 *   been cleared when the user clicked the Sign-Out button, and the expected
 *   behavior after sign-out would be to display the sign-in page when the
 *   iframe is opened again. */
if (session.getAttribute("credentials") == null) {
    return startAuthFlow(model);
}

Następnie wczytaj użytkownika z bazy danych H2 jeśli jest to powracający użytkownik. Jeśli otrzymasz parametr zapytania login_hint, oznacza to, że użytkownik powraca. Jeśli użytkownik istnieje w bazie danych H2, wczytaj dane logowania z wcześniej skonfigurowanego magazynu danych credential i ustaw je w sesji. Jeśli dane logowania nie zostały pobrane z magazynu danych logowania, przekieruj użytkownika przez proces uwierzytelniania, wywołując funkcję startAuthFlow.

/** At this point, we know that credentials exist in the session, but we
 *   should update the session credentials with the credentials in persistent
 *   storage in case they were refreshed. If the credentials in persistent
 *   storage are null, we should navigate the user to the authorization flow
 *   to obtain persisted credentials. */

User storedUser = getUser(login_hint);

if (storedUser != null) {
    Credential credential = authService.loadFromCredentialDataStore(login_hint);
    if (credential != null) {
        session.setAttribute("credentials", credential);
    } else {
        return startAuthFlow(model);
    }
}

Na koniec przekieruj użytkownika na stronę docelową dodatku.

/** Finally, if there are credentials in the session and in persistent
 *   storage, direct the user to the addon-discovery page. */
return "addon-discovery";

Testowanie dodatku

Zaloguj się w Google Classroom jako jeden z użytkowników testowych nauczycieli. Przejdź do karty Zadania i utwórz nowy projekt. Kliknij przycisk Dodatki pod obszarem tekstowym, a następnie wybierz dodatek. Otwiera się element iframe, a dodatek wczytuje identyfikator URI konfiguracji załącznika określony na stronie Konfiguracja aplikacji w pakiecie SDK Google Workspace Marketplace.

Gratulacje! Możesz przejść do następnego kroku: tworzenia załączników i określania roli użytkownika.