Auto::Session::Timeout 技术文档
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,实现自动会话超时功能。
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C040
MiniMax-M2.1从多语言软件开发自动化到复杂多步骤办公流程执行,MiniMax-M2.1 助力开发者构建下一代自主应用——全程保持完全透明、可控且易于获取。Python00
kylin-wayland-compositorkylin-wayland-compositor或kylin-wlcom(以下简称kywc)是一个基于wlroots编写的wayland合成器。 目前积极开发中,并作为默认显示服务器随openKylin系统发布。 该项目使用开源协议GPL-1.0-or-later,项目中来源于其他开源项目的文件或代码片段遵守原开源协议要求。C01
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
agent-studioopenJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0120
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00