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,实现自动会话超时功能。
- DDeepSeek-V3.1-BaseDeepSeek-V3.1 是一款支持思考模式与非思考模式的混合模型Python00
- QQwen-Image-Edit基于200亿参数Qwen-Image构建,Qwen-Image-Edit实现精准文本渲染与图像编辑,融合语义与外观控制能力Jinja00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~059CommonUtilLibrary
快速开发工具类收集,史上最全的开发工具类,欢迎Follow、Fork、StarJava04GitCode百大开源项目
GitCode百大计划旨在表彰GitCode平台上积极推动项目社区化,拥有广泛影响力的G-Star项目,入选项目不仅代表了GitCode开源生态的蓬勃发展,也反映了当下开源行业的发展趋势。07GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!C0381- WWan2.2-S2V-14B【Wan2.2 全新发布|更强画质,更快生成】新一代视频生成模型 Wan2.2,创新采用MoE架构,实现电影级美学与复杂运动控制,支持720P高清文本/图像生成视频,消费级显卡即可流畅运行,性能达业界领先水平Python00
- GGLM-4.5-AirGLM-4.5 系列模型是专为智能体设计的基础模型。GLM-4.5拥有 3550 亿总参数量,其中 320 亿活跃参数;GLM-4.5-Air采用更紧凑的设计,拥有 1060 亿总参数量,其中 120 亿活跃参数。GLM-4.5模型统一了推理、编码和智能体能力,以满足智能体应用的复杂需求Jinja00
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手HTML013
热门内容推荐
最新内容推荐
项目优选









