npm 包 passport-google-oauth 使用教程

阅读时长 7 分钟读完

前言

在现代的 Web 开发中,用户认证和授权往往是必不可少的一部分。Passport.js 是一个广受欢迎的 Node.js 认证中间件,可以轻松地实现各种策略(如用户名密码,Facebook,Google 等)的认证,其中 Google OAuth2 策略就是其中之一。本文将介绍如何使用 Passport.js 和 npm 包 passport-google-oauth 实现 Google OAuth 认证。

步骤

1. 安装 Passport.js 和 passport-google-oauth

首先,要使用 Passport.js 和 passport-google-oauth,我们需要将它们作为 npm 包安装到我们的项目中。通过运行以下命令,在你的项目中安装它们。

在上面的命令中,我们同时安装了 Passport.js 和 passport-google-oauth2 这两个 npm 包。其中 passport-google-oauth2 是 Passport.js 用于实现 Google OAuth2 策略的 npm 包。

2. 初始化 Passport.js

要使用 Passport.js 的认证策略,我们需要初始化 Passport.js 并配置我们想要使用的策略。

-- -------------------- ---- -------
----- -------- - -------------------
----- -------------- - ------------------------------------------

---------------- ----------------
  --------- -----------------
  ------------- ---------------------
  ------------ --------------------------------------------
--
--------------------- ------------- -------- ----- -
  ------------------- --------- ---------- -- -------- ----- ----- -
    ------ --------- -----
  --
---
展开代码

在上面的代码中,我们首先引入了 passport 和 passport-google-oauth2 这两个包,并使用它们的一个策略:GoogleStrategy。在 GoogleStrategy 的构造函数中,我们需要传入三个参数:

  • clientID:Google API Console 中创建的应用程序的客户端 ID。
  • clientSecret:Google API Console 中创建的应用程序的客户端秘钥。
  • callbackURL:Google 在用户成功授权后将用户重定向回我们的应用程序时使用的 URL。

GoogleStrategy 构造函数的第二个参数是用于处理成功或失败的回调函数。在这个函数中,我们可以使用 profile 对象中的数据创建新用户或者登录现有用户。

授权

初始化完 Passport.js 之后,接下来就要实现授权页面了。我们需要创建一个路由,从而在用户点击“登录”按钮时将用户带到 Google 认证页面。

在这段代码中,我们创建了一个 GET 路由,并将它指向 /auth/google。在这个路由中,我们调用了 authenticate 方法,并将它的第一个参数设置为 'google',这个参数表示我们要使用 Google OAuth2 策略进行认证。authenticate 方法的第二个参数 scope 表示我们想要从 Google 获取的用户信息类型。

在 Passport.js 中有几种不同的 authenticate 方法,这里使用的是最常见的第一种: authenticate(strategy: string | string[], options?: AuthOptionsCallbacks, callback?: VerifyCallback): RequestHandler。

回调

接下来,我们需要创建一个回调路由,以便 Google 认证完成后将用户带回我们的应用程序。这里需要注意的是,回调路由的 URL 必须与我们在 GoogleStrategy 中设置的 callbackURL 相对应。

在这里,我们使用 authenticate 方法作为路由的回调函数,第一个参数同样设置为 'google'。第二个参数是可选的,我们这里将其设置为 { failureRedirect: '/login' },表示如果授权失败,则将用户重定向到 /login 页面。

如果授权成功,则会执行中间件后面的函数,这个函数将会将请求重定向回首页。

示例代码

以下是一个简单的示例程序,其中 Passport.js 和 passport-google-oauth2 包已经被作为 npm 包安装到项目中。

-- -------------------- ---- -------
----- ------- - ------------------
----- -------- - -------------------
----- -------------- - ------------------------------------------

----- --- - ---------

---------------- ----------------
  --------- -----------------
  ------------- ---------------------
  ------------ --------------------------------------------
--
--------------------- ------------- -------- ----- -
  ------------------- --------- ---------- -- -------- ----- ----- -
    ------ --------- -----
  --
---

------------ ----- ---- -- -
  ----------
    --------- -----------
    -- ------------------------- ---- ----------
  --
--

-----------------------
  ------------------------------- - ------ --------- ---------- ---

--------------------------------
  ------------------------------- - ---------------- -------- ---
  ----- ---- -- -
    -----------------
  --

---------------- -- -- -
  ------------------- ------- -- -----------------------
--
展开代码

可以将 GOOGLE_CLIENT_ID 和 GOOGLE_CLIENT_SECRET 更改为你自己在 Google API Console 中创建的应用程序的客户端 ID 和密钥。

总结

Passport.js 和 passport-google-oauth2 所提供的便利性使得在你的 Web 应用程序中实现 Google OAuth2 认证只需要几行代码。当然,在实际的项目中,我们还需要对程序进行更复杂的配置和错误处理。希望本文能对你理解 Passport.js 在 Node.js 中如何使用以及如何使用 Google OAuth2 策略有所帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/67764

纠错
反馈

纠错反馈