RESTful API 中如何实现 JWT 身份认证

在现代化的 Web 开发中,RESTful API 已经成为了一种流行的架构风格。它是一种面向资源的设计风格,其中每个资源都有一个唯一的 URI,并且使用标准 HTTP 方法(GET、POST、PUT 和 DELETE)进行访问。

随着 Web 应用程序的不断增长和发展,身份认证和授权成为了安全的重要组成部分,特别是在 RESTful API 架构中。一个解决这个问题的流行方法是 JWT(JSON Web Token)身份认证。

本文将介绍 JWT 身份认证是什么,为什么应该使用它以及如何在 RESTful API 中使用它。

JWT 身份认证是什么?

JWT 身份认证(JSON Web Tokens authentication)是一种基于 JSON 的电子令牌,可以用于验证身份、授权和其他一些安全信息。JWT 身份认证使用一个 JSON 格式的字符串来传输信息,因此可以在不需要会话状态的情况下轻松地在跨域应用程序之间传递身份验证信息。

JWT 身份认证包含三个部分:Header、Payload 和 Signature。Header 指定该令牌的类型和所用的加密算法。Payload 包含所需的信息,例如用户 ID、过期时间和其他元数据。Signature 用于验证令牌未被篡改。

JWT 的优点

  • 对比传统 Cookie 身份认证,无需在服务器上存储会话状态,所以可扩展性更好;
  • 可以跨越多个域名传递信息,而 Cookie 只有在自己的域名下有效。

如何在 RESTful API 中实现 JWT 身份认证?

在 RESTful API 中实现 JWT 身份认证,需要使用一个库来帮助我们创建、验证和解码 JWT 令牌。在这个例子中,我们会使用一个叫做 jsonwebtoken 的 Node.js 库。

步骤一:安装依赖库

在终端执行以下命令来安装 jsonwebtoken:

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

步骤二:生成 JWT 令牌

当用户登陆时,我们需要生成一个 JWT 令牌。这个令牌应该包含与该用户相关的一些信息,例如其 ID 和角色。以下是如何使用 jsonwebtoken 库来生成 JWT 令牌的示例代码:

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

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

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

jwt.sign 方法需要三个参数:

  1. 要加密的数据,通常是一个包含所有用户信息的对象;
  2. 一个秘钥,用于对 JWT 令牌进行签名,此秘钥不可泄漏;
  3. 过期时间,这里是 1 小时。

执行完这段代码之后,将会生成一个加密后的 JWT 令牌。您可以将它传递给客户端,并在之后的请求中包含它。

步骤三:在 API 中验证 JWT 令牌

在每个需要验证用户身份的请求中,我们需要验证 JWT 令牌的有效性。接下来,我们将创建一个中间件来完成这个任务。中间件将会在每个请求之前执行,检查 JWT 令牌是否有效。以下是如何在 Node.js 应用程序中实现 JWT 令牌验证的示例代码:

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

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

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

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

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

这个函数检查请求的头部中是否包含一个授权标头(Authorization header)。如果有,那么将令牌从标头中提取出来,并使用 jwt.verify 方法来验证令牌的有效性。

验证令牌的方法需要三个参数:

  1. 要验证的令牌;
  2. 与令牌签名时使用的秘钥相同的秘钥;
  3. 回调函数,如果令牌有效,则返回用户信息对象。

verifyJWT 函数中,我们检查是否有错误,如果有错误,则返回一个 403 响应,表明请求不被允许。如果令牌有效,则将用户信息添加到请求对象,并调用 next(),这将使请求继续向它本来应该去的路径继续执行。

步骤四:在 API 中使用 JWT 令牌

在每个 API 路由的最上面加上 verifyJWT 中间件,就可以保证只有经过身份验证的用户才能访问该路由。以下是示例代码:

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

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

在这个例子中,路由 /protectedRoute 只允许具有有效 JWT 令牌的用户访问。

总结

JWT 身份验证是一种现代化、灵活且安全的方法,可以让我们在无状态的应用程序中轻松地验证、授权和传输用户数据。在 RESTful API 中运用 JWT 身份验证,我们可以使用 jsonwebtoken 库来生成、验证和解码 JWT 令牌,并使用可重用的中间件来保护需要身份验证的 API 路由。这可以帮助我们更轻松地开发安全的、可扩展的 Web 应用程序。

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


猜你喜欢

  • 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 个月前

相关推荐

    暂无文章