首页
/ Auto::Session::Timeout 技术文档

Auto::Session::Timeout 技术文档

2024-12-23 14:31:42作者:傅爽业Veleda

1. 安装指南

1.1 通过 Gemfile 安装

首先,在你的 Rails 应用的 Gemfile 中添加以下代码:

gem 'auto-session-timeout'

然后,在终端中执行以下命令来安装 gem:

$ bundle

1.2 手动安装

你也可以手动安装 gem,只需在终端中执行以下命令:

$ gem install auto-session-timeout

2. 项目的使用说明

2.1 配置应用控制器

安装完成后,你需要在应用控制器中启用自动会话超时功能。可以在 ApplicationController 中添加以下代码:

class ApplicationController < ActionController::Base
  auto_session_timeout 1.hour
end

这段代码将设置全局的会话超时时间为 1 小时。该 gem 假设你的认证提供者有一个 #current_user 方法,用于返回当前登录的用户。

2.2 自定义超时时间

如果你希望为每个用户指定自定义的超时时间,可以在 #current_user 模型中覆盖 #auto_timeout 方法。例如:

class ApplicationController < ActionController::Base
  auto_session_timeout
end

class User < ActiveRecord::Base
  def auto_timeout
    15.minutes
  end
end

2.3 插入 JavaScript 代码

你还需要在视图的 <body> 标签内插入 #auto_session_timeout_js 辅助方法。最简单的方法是在默认或应用范围的布局中插入一次。确保仅在用户登录时渲染,否则 gem 将尝试强制不存在的会话超时,导致混乱:

<body>
  <% if current_user %>
    <%= auto_session_timeout_js %>
  <% end %>
</body>

2.4 设置超时动作

你需要设置两个动作:一个用于返回会话状态,另一个在会话超时时运行。可以使用 gem 提供的默认动作,在目标控制器(通常是用户或会话控制器)中插入以下代码:

class SessionsController < ApplicationController
  auto_session_timeout_actions
end

如果需要自定义默认动作,可以覆盖它们。你可以调用 #render_session_status#render_session_timeout 方法来使用 gem 的默认实现,或者完全使用自定义代码定义动作:

class SessionsController < ApplicationController
  def active
    render_session_status
  end

  def timeout
    render_session_timeout
  end
end

在任何情况下,确保在 routes.rb 文件中正确映射这些动作:

get "active",  to: "sessions#active"
get "timeout", to: "sessions#timeout"

3. 项目API使用文档

3.1 auto_session_timeout 方法

该方法用于在控制器中启用自动会话超时功能。可以传递一个时间参数来设置全局超时时间,例如:

auto_session_timeout 1.hour

如果不传递参数,则需要在 #current_user 模型中覆盖 #auto_timeout 方法来设置自定义超时时间。

3.2 auto_session_timeout_js 方法

该方法用于在视图中插入 JavaScript 代码,以检查会话状态。可以在 <body> 标签内调用:

<%= auto_session_timeout_js %>

还可以传递 frequency 参数来设置检查频率,例如:

<%= auto_session_timeout_js frequency: 15 %>

3.3 auto_session_timeout_actions 方法

该方法用于在控制器中设置默认的超时动作。可以在会话控制器中调用:

auto_session_timeout_actions

4. 项目安装方式

4.1 通过 Gemfile 安装

Gemfile 中添加 gem 'auto-session-timeout',然后执行 bundle 命令。

4.2 手动安装

在终端中执行 gem install auto-session-timeout 命令。

通过以上步骤,你可以成功安装并配置 auto-session-timeout gem,实现自动会话超时功能。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
53
468
kernelkernel
deepin linux kernel
C
22
5
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
7
0
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
878
517
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
336
1.1 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
180
264
cjoycjoy
一个高性能、可扩展、轻量、省心的仓颉Web框架。Rest, 宏路由,Json, 中间件,参数绑定与校验,文件上传下载,MCP......
Cangjie
87
14
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.08 K
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
349
381
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
612
60