npm 包 lib-lti 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

lib-lti 是一个基于 Node.js 平台的 LTI（Learning Tools Interoperability，学习工具互用性）库。LTI 是一种用来使教育工具和学习管理系统间相互通信的标准协议，可以让第三方工具轻松地与教育平台进行集成。lib-lti 提供了一些常用的 LTI 相关的功能，包括处理 LTI 消息、生成 LTI 签名等。在本文中，我将介绍如何使用 lib-lti 包。

安装 lib-lti

如果你已经安装了 Node.js 环境，那么安装 lib-lti 就很简单了。在终端中输入以下命令即可：

npm install lib-lti

使用 lib-lti

初始化

使用 lib-lti，我们首先需要创建一个 LTI 对象，如下所示：

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

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

上面的代码中，我们使用构造函数 LTI 创建了一个 LTI 对象，同时传入了一些配置参数。

consumerKey：实现 LTI 的客户端（即工具提供者）的密钥。
consumerSecret：客户端的密钥。
providerUrl：提供 LTI 服务的 URL。
lisOutcomesServiceUrl：LTI 成绩传输服务的 URL。
privateKey：用于签名的私钥。

验证 LTI 消息

在使用 LTI 之前，我们需要先验证 LTI 消息的签名是否正确，以防止恶意攻击。使用 lib-lti，我们只需要调用 LTI 对象上的 isValidRequest() 方法即可。

const isValid = await lti.isValidRequest(req, body);

上述代码中，我们使用了 Express.js 框架中的 req 和 body 参数，并通过 isValidRequest() 方法来验证请求的有效性。

处理 LTI 消息

lib-lti 还提供了一些处理 LTI 消息的方法，包括：

getLaunchParams()：获取 LTI 启动参数。
getLaunchParameter(name: string)：获取指定的启动参数。
getLaunchUrl()：获取 LTI 启动 URL。
getResourceLink()：获取 LTI 资源链接信息。
getOutcomeService(): 获取 LTI 成绩传输服务配置信息。

下面我们来看一下具体的使用方法。

获取 LTI 启动参数

LTI 启动参数是由 LTI 系统传给第三方工具的一组参数，以告诉第三方工具关于用户和当前浏览上下文中的一些信息。使用 lib-lti，我们可以通过调用 getLaunchParams() 方法来获取 LTI 启动参数。例如：

const launchParams = lti.getLaunchParams();
console.log(launchParams);

上述代码中，我们使用 getLaunchParams() 方法来获取 LTI 启动参数，并将它们输出到控制台中。

获取指定的启动参数

lib-lti 也提供了一种获取指定的启动参数的方法。使用 getLaunchParameter(name: string) 方法，我们可以按名称获取特定的启动参数。

const courseTitle = lti.getLaunchParameter('context_title');
console.log(courseTitle);

上述代码中，我们使用 getLaunchParameter() 方法获取了名称为“context_title”的启动参数，并将其输出到控制台中。

获取 LTI 启动 URL

通过调用 getLaunchUrl() 方法，我们可以获取 LTI 的启动 URL。

const launchUrl = lti.getLaunchUrl();
console.log(launchUrl);

上述代码中，我们使用 getLaunchUrl() 方法获取 LTI 的启动 URL，并将其输出到控制台中。

获取资源链接信息

LTI 资源链接是由 LTI 系统传递给第三方工具的一组参数，以告诉第三方工具关于当前资源链接的一些信息。使用 getResourceLink() 方法，我们可以获取 LTI 资源链接信息。

const resourceLink = lti.getResourceLink();
console.log(resourceLink);

上述代码中，我们使用 getResourceLink() 方法获取 LTI 资源链接信息，并将其输出到控制台中。

获取成绩传输服务信息

使用 getOutcomeService() 方法，我们可以获取 LTI 成绩传输服务的配置信息。

const outcomeService = lti.getOutcomeService();
console.log(outcomeService);

上述代码中，我们使用 getOutcomeService() 方法获取 LTI 成绩传输服务的配置信息，并将其输出到控制台中。

总结

本文介绍了如何使用 lib-lti 包来实现 LTI 的相关功能。通过对 lib-lti 的介绍，我们可以发现，lib-lti 提供了一些简单易用的方法，可以方便地实现 LTI 的验证、处理和集成。如果你的项目需要使用 LTI，那么 lib-lti 绝对是一个很好的开源库。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/600560b281e8991b448def5e