处理重复登录

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：之前获取的刷新令牌。

此示例使用 Python 原生支持的 SQLite 实现存储。它使用 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（如果不同）。

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 数据库。后续的演示文稿中也会使用此数据库来存储其他与 Google 课堂相关的信息。若要设置 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 编入索引的 Datastore 中。

您可以使用 id_token 从 TokenResponse 对象中获取用户 ID，但必须先对其进行验证。否则，客户端应用可能会通过向服务器发送经过修改的用户 ID 来冒充用户。建议您使用 Google API 客户端库来验证 id_token。如需了解详情，请参阅 [Google Identity 页面上的“验证 Google ID 令牌”部分]。

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