NPM 包 egg-full-jwt 使用教程

什么是 egg-full-jwt?

egg-full-jwt 是一个基于 egg 的 JWT(Json Web Token)插件,它能够帮助我们在 egg 框架下有效地进行用户鉴权。这个插件支持黑名单、白名单等多种前端开发所需功能,让我们能够自定义 Token 处理,保持系统的灵活性和安全性。

如何使用 egg-full-jwt?

下面将介绍如何使用 egg-full-jwt 进行身份鉴别和保护您的 egg 应用。

1. 安装

你可以使用 NPM 来安装 egg-full-jwt:

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

2. 配置

在config/plugin.js 加上配置:

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

在 config/config.xx.js 下加上下面的配置:

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

该插件的功能介绍

在使用 JWT 进行用户鉴权时,我们需要跟踪用户的 JWT 信息。在 egg-full-jwt 这个插件中,除了用户鉴权的基本功能外,还为开发提供了额外的功能。

1. Token 验证

在 config.jwt.whiteList 和 config.jwt.unless 中配置白名单和黑名单,可以方便地对 token 进行验证,从而保证应用的安全性。如下所示:

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

白名单(whitelist):白名单的路由不需要 token 验证权限,只需要用户在登录后访问即可。

黑名单(blacklist):黑名单的路由需要 token 有效性验证,如果没有 token 或 token 已失效,无法访问。

####2. 刷新 Token

在实际开发中,Token 有效期到期后,需要刷新该 Token 方可继续使用。该插件提供了一个 refresh 接口,可以有效地解决 Token 过期问题。

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

####3. 中间件

在鉴权的领域中,MiddleWare 起到至关重要的作用。该插件支持中间件的方法,方便地集成了该鉴权机制。

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

4. 其他方法

该插件中还有其他方法,例如:sendResponse(),addUserTo BlackList(),getUserByToken() 等等,可以满足基本的鉴权需求。

示例代码

下面是一个简单的示例代码,用于说明如何使用 egg-full-jwt 进行身份鉴别和保护您的 egg 应用:

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

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

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

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

总结

本文介绍了如何使用 egg-full-jwt 进行身份鉴别和保护您的 egg 应用。我们还详细讲述了它的具体功能,包括 token 验证、刷新 token、中间件和其他方法的使用。它为开发者们提供了便捷和安全的开发模式,让我们在实际开发中更加容易地进行身份验证和鉴权,期待它对于前端从业者们能够有所帮助。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60067355890c4f7277583a52


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    2 个月前

相关推荐

    暂无文章