นี่เป็นคำแนะนำแบบทีละขั้นครั้งที่ 3 ในซีรีส์คำแนะนำแบบทีละขั้นเกี่ยวกับส่วนเสริมของ Classroom
ในคำแนะนำแบบทีละขั้นนี้ คุณจะจัดการการเข้าชมส่วนเสริมของเราซ้ำโดยการดึงข้อมูลเข้าสู่ระบบที่ผู้ใช้ให้ไว้ก่อนหน้านี้โดยอัตโนมัติ จากนั้นกำหนดเส้นทางผู้ใช้ไปยังหน้าที่ผู้ใช้สามารถออกคำขอ API ได้ทันที นี่เป็นลักษณะการทำงานที่จำเป็น สำหรับส่วนเสริมของ Classroom
ระหว่างคำแนะนำแบบทีละขั้นนี้ คุณได้ทำตามขั้นตอนต่อไปนี้
- ใช้พื้นที่เก็บข้อมูลถาวรสำหรับข้อมูลเข้าสู่ระบบของผู้ใช้
- ดึงข้อมูลและประเมินพารามิเตอร์การค้นหาของส่วนเสริมต่อไปนี้
login_hint
: หมายเลขรหัส Google ของผู้ใช้ที่ลงชื่อเข้าใช้hd
: โดเมนของผู้ใช้ที่ลงชื่อเข้าใช้
โปรดทราบว่าระบบจะส่งเพียงหมายเลขเดียว Classroom API จะส่งพารามิเตอร์ hd
หากผู้ใช้ยังไม่ได้ให้สิทธิ์แอปของคุณ มิเช่นนั้น API จะส่ง
login_hint
รายการพารามิเตอร์การค้นหาทั้งหมดอยู่ในหน้าคำแนะนำ iframe
เมื่อเสร็จแล้ว คุณสามารถให้สิทธิ์ผู้ใช้ในเว็บแอปโดยสมบูรณ์และโทรออกไปยัง Google APIs
ทำความเข้าใจพารามิเตอร์การค้นหาของ iframe
Classroom จะโหลด URI การตั้งค่าไฟล์แนบของส่วนเสริมเมื่อมีการเปิด Classroom จะเพิ่มพารามิเตอร์การค้นหา GET
หลายรายการลงใน URI โดยพารามิเตอร์เหล่านี้มีข้อมูลบริบทที่เป็นประโยชน์ ตัวอย่างเช่น หาก URI การค้นพบไฟล์แนบของคุณคือ https://example.com/addon
, Classroom จะสร้าง iframe ที่ตั้งค่า URL แหล่งที่มาเป็น https://example.com/addon?courseId=XXX&postId=YYY&addOnToken=ZZZ
โดยที่ XXX
, YYY
และ ZZZ
คือรหัสสตริง ดูคู่มือ iframe เพื่อดูคำอธิบายโดยละเอียดของสถานการณ์นี้
พารามิเตอร์การค้นหาที่เป็นไปได้สำหรับ URL การสำรวจมี 5 พารามิเตอร์ดังนี้
courseId
: รหัสของหลักสูตร Classroom ปัจจุบันpostId
: รหัสของโพสต์งานที่ผู้ใช้กำลังแก้ไขหรือสร้างaddOnToken
: โทเค็นที่ใช้ในการให้สิทธิ์การดำเนินการส่วนเสริมของ Classroom บางรายการlogin_hint
: รหัส Google ของผู้ใช้ปัจจุบันhd
: โดเมนโฮสต์สำหรับผู้ใช้ปัจจุบัน เช่นexample.com
คำแนะนำแบบทีละขั้นนี้ครอบคลุมถึง hd
และ login_hint
ระบบจะกำหนดเส้นทางผู้ใช้ตามพารามิเตอร์การค้นหาใดก็ตามที่ระบุไปยังขั้นตอนการให้สิทธิ์หาก hd
หรือไปยังหน้าค้นพบส่วนเสริมหากเป็น login_hint
เข้าถึงพารามิเตอร์การค้นหา
ดังที่อธิบายไว้ข้างต้น ระบบจะส่งพารามิเตอร์การค้นหาไปยังเว็บแอปพลิเคชันในสตริง URI เก็บค่าเหล่านี้ในเซสชันของคุณ ซึ่งจะใช้ในขั้นตอนการให้สิทธิ์ และเพื่อจัดเก็บและเรียกข้อมูลเกี่ยวกับผู้ใช้ ระบบจะส่งพารามิเตอร์การค้นหาเหล่านี้เมื่อเปิดส่วนเสริมเป็นครั้งแรกเท่านั้น
Python
ไปที่คําจํากัดความของเส้นทาง Flask (routes.py
หากคุณทําตามตัวอย่างที่ให้ไว้) ที่ด้านบนของเส้นทาง Landing Page ของส่วนเสริม
(/classroom-addon
ในตัวอย่างที่ให้ไว้) ให้ดึงและจัดเก็บพารามิเตอร์การค้นหา login_hint
และ hd
ดังนี้
# Retrieve the login_hint and hd query parameters.
login_hint = flask.request.args.get("login_hint")
hd = flask.request.args.get("hd")
ตรวจสอบว่าได้จัดเก็บ login_hint
และ hd
ไว้ในเซสชัน ซึ่งเป็นพื้นที่ที่เหมาะสมสำหรับจัดเก็บค่าเหล่านี้ ค่าเหล่านี้เป็นแบบชั่วคราวและคุณจะได้รับค่าใหม่เมื่อเปิดส่วนเสริม
# 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.
# If neither query parameter is available, use the values in the session.
if login_hint is None and hd is None:
login_hint = flask.session.get("login_hint")
hd = flask.session.get("hd")
# If there's no login_hint query parameter, then check for hd.
# Send the user to the sign in page.
elif hd is not None:
flask.session["hd"] = hd
return start_auth_flow()
# If the login_hint query parameter is available, we'll store it in the
# session.
else:
flask.session["login_hint"] = login_hint
Java
ไปที่เส้นทาง Landing Page ของส่วนเสริมในคลาสตัวควบคุม
(/addon-discovery
ใน AuthController.java
ในตัวอย่างที่ให้ไว้) เมื่อเริ่มต้นเส้นทาง ให้ดึงและจัดเก็บพารามิเตอร์การค้นหา login_hint
และ hd
/** Retrieve the login_hint or hd query parameters from the request URL. */
String login_hint = request.getParameter("login_hint");
String hd = request.getParameter("hd");
ตรวจสอบว่าได้จัดเก็บ login_hint
และ hd
ไว้ในเซสชัน ซึ่งเป็นพื้นที่ที่เหมาะสมสำหรับจัดเก็บค่าเหล่านี้ ค่าเหล่านี้เป็นแบบชั่วคราวและคุณจะได้รับค่าใหม่เมื่อเปิดส่วนเสริม
/** If neither query parameter is sent, use the values in the session. */
if (login_hint == null && hd == null) {
login_hint = (String) session.getAttribute("login_hint");
hd = (String) session.getAttribute("hd");
}
/** If the hd query parameter is provided, add hd to the session and route
* the user to the authorization page. */
else if (hd != null) {
session.setAttribute("hd", hd);
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);
}
เพิ่มพารามิเตอร์การค้นหาในขั้นตอนการให้สิทธิ์
ควรส่งพารามิเตอร์ login_hint
และ hd
ไปยังเซิร์ฟเวอร์การตรวจสอบสิทธิ์ของ Google ด้วย วิธีนี้จะช่วยทำให้ขั้นตอนการตรวจสอบสิทธิ์ง่ายขึ้น หากแอปพลิเคชันรู้ว่าผู้ใช้รายใดพยายามตรวจสอบสิทธิ์ เซิร์ฟเวอร์จะใช้คำแนะนำเพื่อลดความซับซ้อนของขั้นตอนการเข้าสู่ระบบโดยกรอกข้อมูลในช่องอีเมลในแบบฟอร์มลงชื่อเข้าใช้ไว้ล่วงหน้า
Python
ไปที่เส้นทางการให้สิทธิ์ในไฟล์เซิร์ฟเวอร์ Flask (/authorize
ในตัวอย่างที่ให้ไว้) เพิ่มอาร์กิวเมนต์ login_hint
และ hd
ในการเรียก 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"),
# If we don't have login_hint, passing hd will reduce the list of
# accounts in the account chooser to only those with the same domain.
hd=flask.session.get("hd"))
Java
ไปที่เมธอด authorize()
ในชั้นเรียน AuthService.java
เพิ่ม login_hint
และ hd
เป็นพารามิเตอร์ลงในเมธอด แล้วเพิ่มอาร์กิวเมนต์ login_hint
และ hd
ลงในเครื่องมือสร้าง URL การให้สิทธิ์
String authUrl = flow
.newAuthorizationUrl()
.setState(state)
.set("login_hint", login_hint)
.set("hd", hd)
.setRedirectUri(REDIRECT_URI)
.build();
เพิ่มพื้นที่เก็บข้อมูลถาวรสำหรับข้อมูลเข้าสู่ระบบของผู้ใช้
หากคุณได้รับ login_hint
เป็นพารามิเตอร์การค้นหาเมื่อส่วนเสริมโหลดขึ้น แสดงว่าผู้ใช้ได้ดำเนินการตามขั้นตอนการให้สิทธิ์สำหรับแอปพลิเคชันของเราเสร็จเรียบร้อยแล้ว คุณควรเรียกคืนข้อมูลเข้าสู่ระบบก่อนหน้านี้แทนการบังคับให้ผู้ใช้ลงชื่อเข้าใช้อีกครั้ง
อย่าลืมว่าคุณได้รับโทเค็นการรีเฟรชเมื่อดำเนินการตามขั้นตอนการให้สิทธิ์เรียบร้อยแล้ว บันทึกโทเค็นนี้ไว้เพื่อใช้ซ้ำเพื่อรับโทเค็นเพื่อการเข้าถึง ซึ่งมีอายุใช้งานสั้นและจำเป็นต้องใช้ Google APIs ก่อนหน้านี้คุณบันทึกข้อมูลเข้าสู่ระบบเหล่านี้ไว้ในเซสชัน แต่ต้องจัดเก็บข้อมูลเข้าสู่ระบบไว้เพื่อจัดการการเข้าชมซ้ำ
กำหนดสคีมาของผู้ใช้และตั้งค่าฐานข้อมูล
ตั้งค่าสคีมาฐานข้อมูลสำหรับ User
Python
กำหนดสคีมาของผู้ใช้
User
มีแอตทริบิวต์ต่อไปนี้
id
: รหัส Google ของผู้ใช้ ซึ่งควรตรงกับค่าที่ระบุไว้ในพารามิเตอร์การค้นหาlogin_hint
display_name
: ชื่อและนามสกุลของผู้ใช้ เช่น "Alex Smith"email
: อีเมลของผู้ใช้portrait_url
: 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 ไปยังไฟล์ data.sqlite
ในไดเรกทอรีเดียวกันกับไฟล์ main.py
ถัดไป ให้ไปที่ไดเรกทอรีโมดูลและสร้างไฟล์ 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
มีแอตทริบิวต์ต่อไปนี้
id
: รหัส Google ของผู้ใช้ ซึ่งควรตรงกับค่าที่ระบุในพารามิเตอร์การค้นหาlogin_hint
email
: อีเมลของผู้ใช้
สร้างไฟล์ schema.sql
ในไดเรกทอรี resources
ของโมดูล 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
โปรดทราบว่าตัวอย่างโค้ดประกอบด้วยตัวสร้างและตัวตั้งค่าสำหรับแอตทริบิวต์ 2 รายการ ระบบจะใช้ตัวสร้างและเครื่องมือตั้งค่าใน 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;
}
ตั้งค่าฐานข้อมูล
หากต้องการจัดเก็บข้อมูลที่เกี่ยวข้องกับผู้ใช้ ให้ใช้ฐานข้อมูล H2 ที่ได้รับการสนับสนุนโดยภายในใน Spring Boot ฐานข้อมูลนี้ยังใช้ในคำแนะนำแบบทีละขั้นเพื่อจัดเก็บข้อมูลอื่นๆ ที่เกี่ยวข้องกับ 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;
}
อัปเดตเมธอด getFlow()
ใน AuthService.java
เพื่อรวม setDataStoreFactory
ในเมธอด GoogleAuthorizationCodeFlow Builder()
และเรียกใช้ getCredentialDataStore()
เพื่อตั้งค่าพื้นที่เก็บข้อมูล
GoogleAuthorizationCodeFlow authorizationCodeFlow =
new GoogleAuthorizationCodeFlow.Builder(
HTTP_TRANSPORT,
JSON_FACTORY,
getClientSecrets(),
getScopes())
.setAccessType("offline")
.setDataStoreFactory(getCredentialDataStore())
.build();
ถัดไป ให้อัปเดตเมธอด getAndSaveCredentials(String authorizationCode)
ก่อนหน้านี้ วิธีนี้จะได้รับข้อมูลเข้าสู่ระบบโดยไม่จัดเก็บไว้ที่ใด อัปเดตวิธีการจัดเก็บข้อมูลเข้าสู่ระบบในพื้นที่เก็บข้อมูลซึ่งจัดทำดัชนีตาม User-ID
รหัสผู้ใช้สามารถหาได้จากออบเจ็กต์ TokenResponse
โดยใช้ id_token
แต่ต้องได้รับการยืนยันก่อน ไม่เช่นนั้นแอปพลิเคชันไคลเอ็นต์อาจสวมบทบาทเป็นผู้ใช้ได้โดยการส่งรหัสผู้ใช้ที่แก้ไขแล้วไปยังเซิร์ฟเวอร์ เราขอแนะนำให้คุณใช้ไลบรารีของไคลเอ็นต์ Google API เพื่อตรวจสอบ id_token
ดูข้อมูลเพิ่มเติมได้ที่ [หน้าข้อมูลประจำตัวของ Google เกี่ยวกับการยืนยันโทเค็นรหัส 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.");
}
เมื่อ 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;
}
}
เรียกดูข้อมูลเข้าสู่ระบบ
กำหนดวิธีการสำหรับการดึงข้อมูล Users
คุณได้ระบุ id
ในพารามิเตอร์การค้นหา login_hint
ซึ่งสามารถใช้เพื่อดึงบันทึกผู้ใช้ที่เจาะจงได้
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
ให้กำหนดวิธีการเรียกข้อมูลผู้ใช้จากฐานข้อมูลตามรหัสผู้ใช้
/** 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;
}
ข้อมูลเข้าสู่ระบบ Store
การจัดเก็บข้อมูลเข้าสู่ระบบมีอยู่ 2 กรณีด้วยกัน หาก id
ของผู้ใช้อยู่ในฐานข้อมูลแล้ว ให้อัปเดตระเบียนที่มีอยู่ด้วยค่าใหม่ หรือสร้างระเบียน User
ใหม่และเพิ่มลงในฐานข้อมูล
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()
มี 2 กรณีที่คุณอาจบันทึกข้อมูลเข้าสู่ระบบลงในฐานข้อมูล ได้แก่ เมื่อผู้ใช้กลับไปที่แอปพลิเคชันในช่วงท้ายของขั้นตอนการให้สิทธิ์ และเมื่อออกการเรียก API นี่คือตำแหน่งที่เราตั้งค่าคีย์เซสชัน credentials
ไว้ก่อนหน้านี้
โทรหา save_user_credentials
ที่จุดสิ้นสุดเส้นทาง callback
เก็บออบเจ็กต์ 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
ก่อนอื่นให้กำหนดวิธีการที่จัดเก็บหรืออัปเดตออบเจ็กต์ User
ในฐานข้อมูล 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);
}
}
มี 2 กรณีที่คุณอาจบันทึกข้อมูลเข้าสู่ระบบลงในฐานข้อมูล ได้แก่ เมื่อผู้ใช้กลับไปที่แอปพลิเคชันในช่วงท้ายของขั้นตอนการให้สิทธิ์ และเมื่อออกการเรียก API นี่คือตำแหน่งที่เราตั้งค่าคีย์เซสชัน credentials
ไว้ก่อนหน้านี้
โทรหา saveUser
เมื่อสิ้นสุดเส้นทาง /callback
คุณควรเก็บออบเจ็กต์ 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);
ข้อมูลเข้าสู่ระบบหมดอายุ
โปรดทราบว่ามีสาเหตุ 2-3 ประการที่อาจทำให้โทเค็นการรีเฟรชใช้ไม่ได้ ซึ่งรวมถึง
- โทเค็นการรีเฟรชไม่มีการใช้งานมา 6 เดือนแล้ว
- ผู้ใช้เพิกถอนสิทธิ์เข้าถึงของแอป
- ผู้ใช้เปลี่ยนรหัสผ่าน
- ผู้ใช้อยู่ในองค์กร Google Cloud ซึ่งมีการใช้นโยบายการควบคุมเซสชัน
รับโทเค็นใหม่โดยการส่งผู้ใช้ผ่านขั้นตอนการให้สิทธิ์อีกครั้งหากข้อมูลเข้าสู่ระบบของผู้ใช้ไม่ถูกต้อง
กำหนดเส้นทางผู้ใช้โดยอัตโนมัติ
แก้ไขเส้นทาง Landing Page ของส่วนเสริมเพื่อตรวจสอบว่าผู้ใช้ได้ให้สิทธิ์แอปพลิเคชันของเราไปก่อนหน้านี้หรือไม่ หากเป็นเช่นนั้น ให้นำทางลูกค้าไปยังหน้าส่วนเสริมหลักของเรา หรือแจ้งให้ผู้ใช้ลงชื่อเข้าใช้
Python
ตรวจสอบว่าได้สร้างไฟล์ฐานข้อมูลแล้วเมื่อแอปพลิเคชันเปิดขึ้น แทรกโค้ดต่อไปนี้ลงในเครื่องมือเริ่มต้นโมดูล (เช่น webapp/__init__.py
ในตัวอย่างที่ให้ไว้) หรือในวิธีการหลักที่จะเปิดใช้งานเซิร์ฟเวอร์
# Initialize the database file if not created.
if not os.path.exists(DATABASE_FILE_NAME):
db.create_all()
จากนั้นเมธอดควรจัดการพารามิเตอร์การค้นหา login_hint
และ hd
ตามที่กล่าวถึงข้างต้น จากนั้นโหลดข้อมูลเข้าสู่ระบบ Store หากเป็นผู้เข้าชมซ้ำ คุณจะรู้ว่าเป็นผู้เข้าชมซ้ำหากคุณได้รับ 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
ไปที่เส้นทาง Landing Page ของส่วนเสริม (/addon-discovery
ในตัวอย่างที่ให้ไว้) ตามที่อธิบายไว้ด้านบน นี่คือที่ที่คุณจัดการพารามิเตอร์การค้นหา login_hint
และ hd
ก่อนอื่นให้ตรวจสอบว่ามีข้อมูลเข้าสู่ระบบอยู่ในเซสชันหรือไม่ หากไม่มี ให้กำหนดเส้นทางผู้ใช้ผ่านขั้นตอนการตรวจสอบสิทธิ์โดยเรียกใช้เมธอด 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);
}
}
สุดท้าย นำผู้ใช้ไปยังหน้า Landing Page ของส่วนเสริม
/** Finally, if there are credentials in the session and in persistent
* storage, direct the user to the addon-discovery page. */
return "addon-discovery";
ทดสอบส่วนเสริม
ลงชื่อเข้าใช้ Google Classroom เป็นหนึ่งในผู้ใช้ทดสอบของ Teacher ไปที่แท็บงานของชั้นเรียน แล้วสร้างงานใหม่ คลิกปุ่มส่วนเสริมใต้พื้นที่ข้อความ แล้วเลือกส่วนเสริม iframe จะเปิดขึ้นและส่วนเสริมจะโหลด URI การตั้งค่าไฟล์แนบที่คุณระบุไว้ในหน้าการกำหนดค่าแอปของ GWM SDK
ยินดีด้วย คุณพร้อมไปยังขั้นตอนถัดไปแล้ว นั่นคือ การสร้างไฟล์แนบและระบุบทบาทของผู้ใช้