npm 包 passport-google-oauth 使用教程

前言

在现代的 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


猜你喜欢

  • npm 包 fsep 使用教程

    简介 fsep 是一个 Node.js 的 npm 包,它提供了一些方便的方法来处理文件路径。如果你曾经处理过不同操作系统下的文件路径,你肯定知道这个过程是多么的痛苦和麻烦。

    5 年前
  • npm 包 cliy 使用教程

    什么是 cliy? cliy 是一个基于 Node.js 开发的命令行工具库,它可以帮助前端开发者快速实现命令行工具的开发。cliy 本身提供了很多命令行工具需要的功能,例如命令行参数解析、显示帮助信...

    5 年前
  • npm 包 toked 使用教程

    随着前端开发技术的不断发展,我们需要使用的 npm 包也越来越多。toked 是一个非常实用的 npm 包,它可以帮助我们生成随机的字符串。在本篇文章中,我们将详细介绍 toked 的使用方法,它的深...

    5 年前
  • npm 包 servey 使用教程

    在前端开发中,我们经常需要对用户进行调查,从而收集他们的反馈和意见。而 servey 就是一款方便快捷的 npm 包,可以帮助我们轻松创建和管理问卷调查。本文将详细介绍 servey 的使用方法,包括...

    5 年前
  • npm 包 muleify 使用教程

    介绍 muleify 是一个用于转换对象的 npm 包。其主要用途是将一个 JavaScript 对象转换成另一个类似的对象。该包设计灵活,可以根据需求进行定制化转换。

    5 年前
  • npm 包 eslint-config-finn-prettier 使用教程

    在前端开发中,代码风格统一是十分重要的事情。使用 ESLint 工具可以帮助开发者检测代码中存在的潜在问题,而 Prettier 则可以帮助开发者修饰代码格式。这两个工具有很好的协作模式,可以相互配合...

    5 年前
  • npm 包 asset-pipe-common 使用教程

    在前端开发中,处理资源文件是一个重要的环节,这些资源包括 js、css、图片等。而 npm 包 asset-pipe-common 可以帮助我们更方便地处理资源文件,让我们更专注于业务逻辑的开发。

    5 年前
  • npm 包 eslint-config-schibsted 使用教程

    在前端开发中,保持代码风格和代码质量一致是非常重要的。因此,使用 ESLint 这样的代码检查工具就成为了必不可少的一环,它可以帮助我们遵循一致的代码规范,并揭示代码中的隐藏问题。

    5 年前
  • npm 包 eslint-config-finn 使用教程

    介绍 在前端开发的过程中,我们希望保持代码的规范性,一种常用的方式是使用 ESLint 进行代码检查。而 eslint-config-finn 这个 npm 包则提供了基于 finscn 的代码规范配...

    5 年前
  • npm包 asset-pipe-test-es5b 使用教程

    介绍 asset-pipe-test-es5b是一个npm包,用于在浏览器中测试es5代码的性能。它支持自定义的测试用例,并可以输出详细的性能报告。 本文将详细介绍如何使用asset-pipe-tes...

    5 年前
  • npm 包 asset-pipe-test-es5c 使用教程

    npm 是前端工程化中必不可少的一环,它为我们提供了一个可以共享和管理前端资源的平台。而 asset-pipe-test-es5c 这个 npm 包则可以帮助我们自动化打包和处理我们的前端资源。

    5 年前
  • npm 包 asset-pipe-test-es5a 使用教程

    在前端开发中,我们经常需要处理静态资源(例如 CSS、JS 和图像等)。为了更高效地管理和构建这些资源,我们可以使用各种构建工具和包管理工具来帮助我们完成这项工作。

    5 年前
  • npm 包 asset-pipe-js-writer 使用教程

    前端开发过程中,我们经常需要处理静态资源,比如压缩、合并、转换等。npm 是前端开发中最流行的包管理器之一,提供了大量的工具包供我们使用。其中一个非常有用的工具包就是 asset-pipe-js-wr...

    5 年前
  • npm 包 copy-webpack-plugin-hash 使用教程

    前言 在前端项目中,我们经常需要将某个文件夹中的文件拷贝到另一个目录中,例如将静态资源文件拷贝到输出目录中。使用 webpack 时,我们可以通过 copy-webpack-plugin 插件来进行拷...

    5 年前
  • npm 包 html-webpack-random-extend-plugin 使用教程

    在前端开发过程中,我们经常需要使用构建工具将多个静态资源文件打包成一个 HTML 文件。html-webpack-random-extend-plugin 是一个非常实用的 npm 包,能够帮助我们在...

    5 年前
  • npm 包 html-webpack-filter-extend-plugin 使用教程

    前言 在前端开发过程中,Webpack 是一个非常重要的工具,很多项目都会用到它。而在使用 Webpack 进行前端构建的过程中,通常需要对 HTML 文件进行处理,如添加 CSS 和 JS 等资源的...

    5 年前
  • 使用 html-res-replace-webpack-plugin 插件优化前端项目

    前言 在现代 Web 应用开发中,前端工程师需要使用许多工具和框架来提高开发效率。其中,npm 包是前端开发最为常用的工具之一。npm 包可以帮助我们快速搭建项目,提供代码复用,以及优化项目等功能。

    5 年前
  • npm 包 react-loader 使用教程

    简介 React 是一个流行的前端开发框架,它的组件化让前端开发变得更简单和易于管理,然而,在一些需要大量计算的应用场景中,渲染速度的问题也是一个需要考虑的重点。react-loader 是一个用来简...

    5 年前
  • npm包riotjs-loader使用教程

    介绍 riotjs-loader是一个webpack插件,它可以在使用Riot.js的时候,在webpack打包时自动编译riot标签文件(.tag文件),并将编译后的JavaScript代码打包在一...

    5 年前
  • npm 包 readdir 使用教程

    在前端开发中,文件操作是经常会用到的一个方面,同时 readdir 这个 npm 包也是一个常用的文件操作工具。本文将详细介绍 readdir 的使用及其在前端开发中的指导意义,帮助读者更好地了解和使...

    5 年前

相关推荐

    暂无文章