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


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言,它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据,避免了传统...

    1 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events? Server-sent Events(简称 SSE)是一种基于 HTTP 的服务器推送技术,它可以让服务器向客户端发送事件流,客户端通过监听这个事件流来...

    1 个月前
  • ECMAScript 2020(ES11)中的新特性:BigInt 转换

    在 ECMAScript 2020(ES11)中,新增了一种数据类型:BigInt。它是一种可以表示任意大整数的数据类型,可以用来解决 JavaScript 中整数运算的精度问题。

    1 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式,消除不同浏览器之间的差异,从而实现更加一致的样式效果的技术手段。在前端开发中,使用 CSS Reset 可以让我们更...

    1 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中,引入了 class 关键字,使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间,有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系,并提供一...

    1 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时,表单数据的处理是非常常见的需求。然而,由于 React 的单向数据流和组件化特性,传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具,可以帮助...

    1 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展,高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库,也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略,并且会提...

    1 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中,图片适配是一个比较棘手的问题。如果不加以处理,可能会导致图片在不同设备上显示不佳,影响用户体验。本文将介绍响应式设计中的图片适配问题,并提供解决方案。

    1 个月前
  • 解析 TypeScript 中 encapsulation(封装)的实现方式

    解析 TypeScript 中 encapsulation(封装)的实现方式 在 TypeScript 中,封装(encapsulation)是一种重要的面向对象编程的特性。

    1 个月前
  • PM2 崩溃处理:如何避免由于 PM2 进程奔溃导致应用崩溃?

    在前端开发中,我们经常使用 PM2 进行进程管理和部署。但是,当 PM2 进程崩溃时,应用也会跟着崩溃。如何避免这种情况的发生?本文将介绍 PM2 崩溃处理的方法和技巧,帮助您更好地管理和部署应用。

    1 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境,它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时,安全性是非常重要的。

    1 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准,其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法,分别是:扩展运算符、剩余运算符...

    1 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时,我们经常需要使用 Enzyme 来测试组件。然而,当我们测试涉及到动画的组件时,我们可能会遇到一些问题:动画无法渲染,导致测试失败。

    1 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展,单页应用(Single Page Application,SPA)已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面,提供了更快速、更流畅的用户体...

    1 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中,ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    1 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中,Promise.all 是一个非常常用的功能,它可以让我们在多个异步操作完成后再执行一些操作,这个功能在实际开发中非常实用。

    1 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中,经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具,它提供了一种方便的方式来操作 MongoDB ...

    1 个月前
  • 在使用 lit-element 的时候,如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候,我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而,Shadow DOM 的封闭性也带来了一些挑战,其中之一就是变量传递问题。

    1 个月前
  • Tailwind CSS 如何实现动态换肤?

    随着互联网的发展,越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验,还可以让用户在不同的环境下选择适合自己的主题,增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    1 个月前
  • 如何在 Less 中使用字符串操作函数?

    在前端开发中,样式表是不可或缺的一部分。而 Less 是一种动态样式语言,它是 CSS 的一种扩展。在 Less 中,我们可以使用字符串操作函数来处理字符串,这些函数可以帮助我们更加方便地操作字符串,...

    1 个月前