npm 包 ngsessiontimeout 使用教程

什么是 ngsessiontimeout？

ngsessiontimeout 是一个 AngularJS 模块，用于监控用户的活动并提醒用户在一定时间内无活动后自动注销。该模块可以用于任何需要用户登录的应用程序中，非常适用于网银、企业管理系统等需要保证安全性的应用场景。

安装 ngsessiontimeout

要使用 ngsessiontimeout，需要将其添加为依赖项。可以通过 npm 进行安装：

npm install ngsessiontimeout --save

初始化

在使用 ngsessiontimeout 之前，需要先将其添加到管理应用程序的模块中。另外，还需要根据实际情况对 ngsessiontimeout 进行一些配置。

angular.module('myApp', ['ngsessiontimeout'])
    .config(function(ngstConfigProvider) {
        ngstConfigProvider.setOptions({
            // 选项配置
        });
    });

ngstConfigProvider 支持以下选项：

• timeout: 无操作时间。默认值为 60000ms（一分钟）。
• checkInterval: 活动检测时间间隔。默认值为 1000ms（一秒）。
• notifyDelay: 提醒时间。默认值为 30000ms（三十秒）。
• logoutUrl: 注销页面 URL 地址。默认为空字符串，表示应用程序的默认注销页面。
• onTimeout: 登录超时事件处理函数，可以自定义超时处理函数。

使用示例

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

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

    --------------------
---
展开代码

ngstSession 是用于启动 ngsessiontimeout 的服务，它通过依赖注入的方式的使用。在上面的示例中，我们启动了 ngstSession，然后用 $scope.$on 绑定了登录超时事件处理函数。

ngstSession 还返回了一个 $timeout，可以用于手动刷新计时器。在某些场景中，可能需要在用户操作后手动刷新计时器，以避免出现误超时的情况。

$scope.$apply(function() {
    $timeout(function() {
        ngstSession.refresh();
    }, 0); // 使用 $timeout 是为了确保刷新在 digest 后执行
});

总结

ngsessiontimeout 是一个非常实用的 AngularJS 模块，可以帮助我们实现用户登录超时的自动注销功能。在应用程序中使用 ngsessiontimeout 非常简单，只需要进行简单的配置即可。同时，通过启动 ngstSession 服务和监听 ngstTimeout 事件，可以实现非常灵活的登录超时事件处理功能。

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