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,实现自动会话超时功能。
GLM-5智谱 AI 正式发布 GLM-5,旨在应对复杂系统工程和长时域智能体任务。Jinja00
GLM-5-w4a8GLM-5-w4a8基于混合专家架构,专为复杂系统工程与长周期智能体任务设计。支持单/多节点部署,适配Atlas 800T A3,采用w4a8量化技术,结合vLLM推理优化,高效平衡性能与精度,助力智能应用开发Jinja00
jiuwenclawJiuwenClaw 是一款基于openJiuwen开发的智能AI Agent,它能够将大语言模型的强大能力,通过你日常使用的各类通讯应用,直接延伸至你的指尖。Python0204- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃,整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展,旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
AtomGit城市坐标计划AtomGit 城市坐标计划开启!让开源有坐标,让城市有星火。致力于与城市合伙人共同构建并长期运营一个健康、活跃的本地开发者生态。01
awesome-zig一个关于 Zig 优秀库及资源的协作列表。Makefile00