npm包passport-google-oauth2使用教程

阅读时长 8 分钟读完

在Node.js开发中,我们经常需要实现第三方登录功能,如使用Google OAuth提供的登录。在这里,我将介绍npm包passport-google-oauth2的使用方法,来实现登录的功能。

本文将介绍:

  1. passport-google-oauth2是什么
  2. passport-google-oauth2的使用方法
  3. 示例代码实现

1. passport-google-oauth2是什么

passport-google-oauth2是一个使用OAuth2.0进行用户身份验证,支持Google API OAuath2.0认证的Passport.js的passpartoogle2模块的替代模块。

2. passport-google-oauth2的使用方法

步骤1:安装passport-google-oauth2

如果您从未安装过Passport和passport-google-oauth20,可以使用以下命令来安装:

步骤2:获取Google API授权

在使用passport-google-oauth2进行Google登录之前,需要在Google API Console创建OAuth2授权信息,可参考以下步骤。

  1. 在Google API Console中,创建一个项目并转到“ 凭据”选项卡。
  2. 点击“ 创建凭据”按钮并选择“ OAuth客户端ID”。
  3. 选择“ 网络应用程序”,输入名称并添加重定向URl。
  4. 在“ 创建OAuth客户端ID”页面上,填写必要的详细信息,然后点击“ 创建”。您现在应该可以看到您的新客户端ID和客户端秘钥。

步骤3:导入Passport和passport-google-oauth2

同样用require语句导入passport和passport-google-oauth2:

步骤4:定义并执行serialize and deserialize函数

要使用passport进行身份验证,必须定义以下两个函数:

serialize用户函数将用户对象序列化,其中done是一个回调函数的参数。在我们的示例中,由于这是一个授权身份验证例子,因此我们将用户对象作为调用的第二个参数传递回此回调函数。

deserializeUser函数将序列化后的用户对象反序列化,其中done是一个回调函数的参数。在我们的示例中,我们传递了已序列化的用户对象。

步骤5:配置GoogleStrategy

配置passport使用GoogleStrategy类来验证用户身份。Passport.authenticate("google”)后的回调函数可以根据您的需要实现。

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

步骤6:使用路由管理身份验证

要使用身份验证,您需要使用Passport的router,在路由中指定身份验证选项如下:

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

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

在这个示例中,我们使用了两个路由。/auth/google对应于我们的Passport验证路由。/auth/google/callback 路由接收Google方面发回的授权回调。失败时将用户重定向到/login页面,成功则将用户重定向到/home页面。

3. 示例代码实现

以下是一个完整的身份验证示例,使用了Express作为Web框架,使用MongoDB进行数据存储。

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

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

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

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

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

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

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

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

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

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

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

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

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

在上面的示例中,我们创建了一个名为‘auth_test’的MongoDB数据库,并将用户的Google ID存储在数据库中。如果我们找到一个已有的用户,我们返回该用户,否则我们创建一个新用户存储在数据库中。

应用程序使用ejs模板引擎来呈现Web页面,使用了Passport的session支持进行会话管理。

结论

使用passport-google-oauth2模块,可以轻松地集成Google的OAuth2身份验证。通过本文的介绍,您可以学习到如何安装和使用passport-google-package,以及如何与Express应用程序集成。

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

纠错
反馈