npm 包 just-login-core 使用教程

前言

在前端开发中，我们经常需要实现用户登录、注册、忘记密码等功能，这些功能的实现需要涉及一系列的后台逻辑和前端交互。为了方便开发，社区中涌现了很多优秀的工具包，npm 包 just-login-core 就是其中的一款。

本文将介绍 just-login-core 的基本用法和深入内容，以及如何在实际项目中使用它。

什么是 just-login-core

just-login-core 是一个 npm 包，它是一个用于实现用户登录注册等功能的核心库。它提供了一些基础的方法，可以帮助我们快速地实现这些功能。

在使用 just-login-core 之前，你需要了解一些下面的术语：

  • loginID: 用户的唯一标识符，就像用户名一样
  • jwtToken: 用于验证和识别用户的 JSON Web Token
  • deviceID: 记录用户登录设备的标识符

just-login-core 也提供了一些默认的数据库模型，可以帮助我们快速地实现用户数据存储逻辑。但是，如果你想使用自己的数据库模型，也可以轻易地集成到 just-login-core 中。

安装和基础使用

你可以使用 npm 安装 just-login-core：

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

接下来，你需要创建一个新的 justLoginCore 实例：

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

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

配置项

JustLoginCore 有以下配置项：

  • db: 用于存储用户数据的数据库实例，你可以使用内置的 sqlite3 或者其他 ORM 库
  • jwtSecret: 用于验证和识别用户的 JWT Token 的密钥
  • loginIDRegex: 用于限制 loginID 的正则表达式
  • allowInsecurePasswords: 是否允许使用弱密码
  • passwordHasher: 对密码进行加密的函数
  • createEmail: 用于发送验证邮件的函数
  • verifyEmail: 用于验证邮件的函数

例如，你可以这样进行配置：

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

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

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

API

just-login-core 只有几个基础方法：

  • register(loginID, password, email = null): 注册新用户
  • login(loginID, password, deviceID = null): 用户登录
  • logout(loginID, deviceID): 用户注销登录
  • startResetPassword(loginID): 重置密码请求
  • performResetPassword(loginID, newPassword, secretToken): 执行密码重置

例如，你可以这样进行调用：

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

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

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

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

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

深入内容

在深入使用 just-login-core 之前，我们需要了解一些术语和基本操作。

login 和 jwtToken

login 操作会返回一个 jwtToken，它是使用 JWT 技术生成的一个字符串，用于识别和验证用户身份。在每次请求服务端时，我们需要将这个 token 附带到请求头中，以便服务端可以识别用户身份。

用法示例：

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

保持 token 已登录状态

一般情况下，我们需要在登录后保持 token 的已登录状态，这里提供一个工具函数：

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

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

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

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

  ------
-

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

deviceID

deviceID 用于识别用户使用的设备，通常在用户登录时需要进行传递。

  • 如果用户在同一台设备上登录多次，则使用相同的 deviceID
  • 如果用户在不同设备上登录，则使用新的 deviceID，原有的 deviceID 将自动过期

例如，你可以这样进行调用：

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

邮件验证

在每次用户注册时，通常需要进行邮箱验证，以确保用户提交的是有效的邮箱地址。在 just-login-core 中，邮箱验证的几个接口分别是：

  • startEmailVerification(loginID): 发送验证邮件
  • endEmailVerification(loginID, token): 验证邮件

例如，你可以这样进行调用：

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

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

项目实践

在实际前端项目中，我们可以将 just-login-core 集成到后端服务作为接口，以方便前端调用。这里以 Express 框架为例：

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

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

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

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

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

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

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

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

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

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

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

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

我们可以使用 axios 来模拟登录：

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

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

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

如上代码，我们成功进行了登录，并返回了签名后的 JSON Web Token。

最后，在浏览器中，我们需要在每次请求服务端时附带这个 token：

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

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

完整代码实例：

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

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

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

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

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

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

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/91808

阅读全文

猜你喜欢

  • npm 包 level-spaces 使用教程

    什么是 level-spaces？ level-spaces 是一个可以在浏览器或Node.js中轻松使用的轻量级key-value数据库，它与LevelDB、IndexedDB、LocalStora...

    5 年前
  • npm包ndarray-fft使用教程

    前言 ndarray-fft是一款用于处理数字信号的npm包，该包能够对ndarray数据的快速傅立叶变换（FFT）进行计算，以及反变换（IFFT）。 在前端应用中，数字信号处理是一项十分常见的任务。

    5 年前
  • npm 包 voxel-crunch 使用教程

    在前端开发中，往往需要使用各种各样的库和工具，而 npm 包是其中一个最常用的资源。在 3D 游戏开发中，voxel-crunch 是一个非常重要的 npm 包，它可以有效地压缩 3D 模型，从而减小...

    5 年前
  • npm 包 voxel-critter 使用教程

    前言 在前端开发中，我们经常需要使用各种第三方的库和框架来加速我们的开发，比如 jQuery、React、Vue 等。而这些库和框架通常是通过 npm 进行安装和管理的。

    5 年前
  • npm 包 poly-mult-fft 使用教程

    在前端开发中，常常需要进行多项式的乘法操作。poly-mult-fft 是一款实现多项式快速乘法的 npm 包。它基于快速傅里叶变换 (FFT) 算法实现，可大大提升乘法计算效率。

    5 年前
  • npm 包 range-minimum-query 使用教程

    范围最小查询（Range Minimum Query，简称 RMQ）是一种在前端开发中常用的算法，它可以帮助我们快速查找一个区间内的最小值。 而 npm 包 range-minimum-query 就...

    5 年前
  • npm 包 parse-grid-bench 使用教程

    简介 parse-grid-bench 是一个 npm 包，用于解析和分析网站的网格中的 CSS 样式，以便进行性能和优化测试。该包提供了一个简单易用的接口和函数，用于对网站中的网格布局进行解析和分析...

    5 年前
  • npm包ndarray-log-polar使用教程

    简介 ndarray-log-polar 是一个可在 Node.js 和浏览器中使用的 JavaScript 库，用于将 ndarray 数据转换为极坐标数据。它可以帮助开发人员快速将数据转换为极坐标...

    5 年前
  • npm 包 static-range-query 使用教程

    介绍 在前端开发中，我们经常需要对一些数值或者时间区间进行查询和统计。在这种情况下，我们可以使用一个叫做 static-range-query 的 npm 包。这个包提供了一些非常方便的方法来执行这些...

    5 年前
  • npm 包 2-sat 使用教程

    什么是 2-sat 2-sat 是解决布尔可满足性问题（Boolean Satisfiability Problem，缩写为 SAT）的一个算法，它被广泛应用于计算机科学中多项式时间内的求解，是组合数...

    5 年前
  • npm 包 hash-int 使用教程

    在前端开发中，常常需要生成随机数来满足不同的业务需求，而随机数的生成可以使用 Math.random() 方法实现。不过，因为其生成的随机数过于规则，所以可能会产生重复的情况，这时候可以使用 npm ...

    5 年前
  • npm 包 aabb-3d 使用教程

    简介 aabb-3d 是一个基于 JavaScript 的 npm 包，提供了对三维包围盒（Axis-Aligned Bounding Box，AABB）的支持。它可以用来进行碰撞检测和包围盒优化等开...

    5 年前
  • npm 包 aabb-2d 使用教程

    前置知识 在学习本文之前，你需要对以下知识有一定的了解： 基本的 JavaScript 语法和语言特性 npm 的基本使用方法 什么是 aabb-2d？ aabb-2d 是一个 npm 包，它是一...

    5 年前
  • npm包compare使用教程

    介绍 比较大小和版本的npm包compare，是可用于NodeJS，作为npm 模块使用的一个实用工具，它可以比较两个npm包的版本大小、文件数目、repo地址等等。

    5 年前
  • npm 包 modella-validators 使用教程

    在前端开发中，输入验证是非常重要的一个环节，尤其是在表单提交时，输入验证能够有效地保证用户提交的数据的正确性。在 Node.js 应用中，我们可以使用 modella-validators 这个 np...

    5 年前
  • npm 包 Mailinator 使用教程

    前言 在开发过程中我们经常需要测试邮件发送功能，但是一般情况下这一过程需要我们拥有真实存在的邮箱地址，同时还需要设置邮箱账号及密码等信息。这样一来，测试邮件发送功能就变得非常繁琐和麻烦。

    5 年前
  • npm 包 @types/chai-as-promised 使用教程

    简介 @types/chai-as-promised 是一个 TypeScript 的类型声明库，它提供了对 chai-as-promised 库的类型支持。chai-as-promised 是 ch...

    5 年前
  • npm 包 periodicjs.core.data 使用教程

    在前端开发中，经常需要使用到后端数据，而后端数据往往存储在数据库中，访问数据库需要编写相应的代码，这无疑增加了开发的难度和复杂度。因此，为了简化访问数据库的流程，管理后台敏捷开发平台 periodic...

    5 年前
  • npm 包 sql-bricks 使用教程

    在前端开发中，涉及到与数据库交互的操作时，经常会用到 SQL 语法。然而，手写 SQL 语句容易出错且难以维护。此时，我们可以使用 npm 包 sql-bricks，帮助我们快速、精准地生成 SQL ...

    5 年前
  • npm 包 migrate 使用教程

    Npm 是 Node.js 项目的包管理器，它可以让你方便地使用第三方的开源包，而无需担心安装、版本控制等问题。npm 包 migrate 功能强大，可以让你轻松管理数据库的迁移，下面我们就来一起学习...

    5 年前

相关推荐

    暂无文章