處理重複登入

Python

前往 Flask 路徑的定義 (如果您是按照我們的範例操作，請前往 routes.py)。在外掛程式到達路徑頂端 (在本例中為 /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")

請確認 login_hint (如有) 已儲存在工作階段中。這是儲存這些值的適當位置，因為這些值是暫時性的，您會在開啟外掛程式時收到新的值。

# 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

前往控制器類別中的外掛程式到達路徑 (在提供的範例中為 AuthController.java 中的 /addon-discovery)。在這個路徑的開頭，擷取並儲存 login_hint 查詢參數。

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

請確認 login_hint (如有) 已儲存在工作階段中。這是儲存這些值的適當位置，因為這些值是暫時性的，您會在開啟外掛程式時收到新的值。

/** 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);
}

Python

前往 Flask 伺服器檔案中的授權路徑 (在我們提供的範例中為 /authorize)。將 login_hint 引數新增至對 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

前往 AuthService.java 類別中的 authorize() 方法。將 login_hint 新增為方法的參數，並將 login_hint 和引數新增至授權網址建構工具。

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

Python

定義 User 結構定義

User 包含下列屬性：

• id：使用者的 Google ID。這個值應與 login_hint 查詢參數中提供的值相符。
• display_name：使用者的姓名，例如「Alex Smith」。
• email：使用者的電子郵件地址。
• portrait_url：使用者個人資料相片的網址。
• refresh_token：先前取得的更新權杖。

這個範例會使用 SQLite 實作儲存空間，這是 Python 原生支援的功能。它使用 flask_sqlalchemy 模組，方便我們管理資料庫。

設定資料庫

首先，請指定資料庫的檔案位置。前往伺服器設定檔 (在我們提供的範例中為 config.py)，然後新增下列內容。

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

這會將 Flask 指向與 main.py 檔案位於同一目錄中的 data.sqlite 檔案。

接著，前往模組目錄並建立新的 models.py 檔案。如果您按照我們提供的範例操作，這會是 webapp/models.py。將以下內容新增至新檔案，以定義 User 資料表，如果模組名稱與 webapp 不同，請將模組名稱替換為 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())

最後，在模組的 __init__.py 檔案中新增以下內容，以匯入新模型並建立資料庫。

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

定義 User 結構定義

User 包含下列屬性：

• id：使用者的 Google ID。這個值應與 login_hint 查詢參數中提供的值相符。
• email：使用者的電子郵件地址。

在模組的 resources 目錄中建立 schema.sql 檔案。Spring 會讀取這個檔案，並據此為資料庫產生結構定義。使用資料表名稱 users 定義資料表，並使用資料欄代表 User 屬性、id 和 email。

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

建立 Java 類別，定義資料庫的 User 模型。這是提供範例中的 User.java。

新增 @Entity 註解，表示這是可儲存至資料庫的 POJO。新增 @Table 註解，並使用您在 schema.sql 中設定的對應資料表名稱。

請注意，程式碼範例包含兩個屬性的建構函式和 setter。建構函式和 Setter 會在 AuthController.java 中使用，用於在資料庫中建立或更新使用者。您也可以視需要加入 getter 和 toString 方法，但在本逐步操作說明中，為了簡潔起見，我們並未使用這些方法，也未將其納入本頁的程式碼範例。

/** 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; }
}

建立名為 UserRepository.java 的介面，以便處理資料庫的 CRUD 作業。這個介面會擴充 CrudRepository 介面。

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

控制器類別可協助用戶端與存放區之間的通訊。因此，請更新控制器類別建構函式，以便插入 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;
}

設定資料庫

如要儲存使用者相關資訊，請使用 Spring Boot 內建支援的 H2 資料庫。這個資料庫也會在後續的操作說明中用於儲存其他 Classroom 相關資訊。如要設定 H2 資料庫，請將下列設定新增至 application.properties。

# 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

spring.datasource.url 設定會建立名為 h2 的目錄，並在其中儲存 userdb 檔案。將 H2 資料庫的路徑新增至 .gitignore。您必須先更新 spring.datasource.username 和 spring.datasource.password，才能執行應用程式，並設定資料庫的使用者名稱和密碼。如要在執行應用程式後更新資料庫的使用者名稱和密碼，請刪除產生的 h2 目錄、更新設定，然後重新執行應用程式。

將 spring.jpa.hibernate.ddl-auto 設定設為 update，可確保在重新啟動應用程式時，資料庫中儲存的資料會保留。如要在每次重新啟動應用程式時清除資料庫，請將這項設定設為 create。

將 spring.jpa.open-in-view 設定設為 false。這個設定預設為啟用，且可能會導致效能問題，在實際運作環境中難以診斷。

如先前所述，您必須能夠擷取重複使用者的憑證。GoogleAuthorizationCodeFlow 提供內建的憑證儲存庫支援功能，可協助您完成這項操作。

在 AuthService.java 類別中，定義憑證類別儲存位置的檔案路徑。在這個範例中，檔案會在 /credentialStore 目錄中建立。將憑證儲存庫的路徑新增至 .gitignore。使用者開始授權流程後，系統就會產生這個目錄。

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

接著，請在 AuthService.java 檔案中建立方法，用於建立及傳回 FileDataStoreFactory 物件。這是用於儲存憑證的資料儲存庫。

/** 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;
}

更新 AuthService.java 中的 getFlow() 方法，在 GoogleAuthorizationCodeFlow Builder() 方法中加入 setDataStoreFactory，然後呼叫 getCredentialDataStore() 來設定資料儲存庫。

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

接著，請更新 getAndSaveCredentials(String authorizationCode) 方法。先前，這個方法會取得憑證，但不會將憑證儲存在任何位置。更新方法，以便在以使用者 ID 做為索引的資料儲存庫中儲存憑證。

您可以使用 id_token 從 TokenResponse 物件取得使用者 ID，但必須先進行驗證。否則，用戶端應用程式可能會傳送經修改的使用者 ID 至伺服器，進而冒用使用者身分。建議您使用 Google API 用戶端程式庫驗證 id_token。詳情請參閱 [驗證 Google ID 權杖的 Google Identity 頁面]。

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

驗證 id_token 後，請取得 userId，並與取得的憑證一併儲存。

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

更新對 flow.createAndStoreCredential 的呼叫，納入 userId。

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

在 AuthService.java 類別中新增方法，如果資料儲存庫中存在特定使用者的憑證，則傳回該憑證。

/** 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;
    }
}

Python

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

Java

在 AuthController.java 類別中，定義方法，根據使用者 ID 從資料庫擷取使用者。

/** 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;
}

Python

首先，請定義實作儲存或更新行為的工具方法。

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()

您可以將憑證儲存到資料庫的兩種情況：使用者在授權流程結束時返回應用程式，以及發出 API 呼叫時。這些是先前設定工作階段 credentials 鍵的位置。

在 callback 路由結尾呼叫 save_user_credentials。保留 user_info 物件，而非只擷取使用者名稱。

# 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)

您也應在呼叫 API 後更新憑證。在這種情況下，您可以將更新過的憑證做為 save_user_credentials 方法的引數提供。

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

Java

首先，定義在 H2 資料庫中儲存或更新 User 物件的方法。

/** 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);
    }
}

您可以將憑證儲存到資料庫的兩種情況：使用者在授權流程結束後返回應用程式，以及發出 API 呼叫時。這些是我們先前設定工作階段 credentials 鍵的位置。

在 /callback 路徑結尾處呼叫 saveUser。您應保留 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);

您也應在呼叫 API 後更新憑證。在這種情況下，您可以將更新過的憑證做為 saveUser 方法的引數提供。

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

Python

請確認應用程式啟動時已建立資料庫檔案。將以下內容插入模組初始化器 (例如我們提供範例中的 webapp/__init__.py) 或啟動伺服器的主方法中。

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

接著，您的方法應按照上述所述處理 login_hint 查詢參數。接著，如果是回訪者，請載入商店憑證。如果您收到 login_hint，就表示對方是回訪者。擷取此使用者的任何已儲存憑證，並將其載入工作階段。

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

最後，如果我們沒有使用者的憑證，請將使用者導向登入頁面。如果有，請將他們導向主要外掛程式頁面。

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

前往外掛程式到達路徑 (在提供的範例中為 /addon-discovery)。如上文所述，您會在此處處理 login_hint 查詢參數。

首先，請檢查工作階段中是否有憑證。如果不是，請呼叫 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);
}

接著，如果是重複造訪者，請從 H2 資料庫載入使用者。如果您收到 login_hint 查詢參數，表示該訪客是重複造訪者。如果使用者已存在 H2 資料庫中，請從先前設定的憑證資料儲存庫載入憑證，並在工作階段中設定憑證。如果未從憑證資料儲存庫取得憑證，請呼叫 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);
    }
}

最後，將使用者導向外掛程式到達網頁。

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