
本文详细介绍了如何在Rails应用中,结合Turbo Streams和StimulusJS,解决实时更新列表项时,根据用户权限动态显示或隐藏操作按钮的问题。通过拦截`turbo:before-stream-render`事件,利用Stimulus控制器发起客户端AJAX请求获取权限数据,并据此调整按钮可见性,从而避免了在Turbo Streams渲染上下文中进行服务器端权限检查的限制。
在使用Turbo Streams实现Rails应用中的实时列表更新时,我们经常会遇到一个挑战:列表中的每个项目都可能包含“编辑”或“删除”等操作按钮,而这些按钮的可见性通常需要根据当前用户的权限来决定。传统的服务器端权限管理(如Pundit)在HTTP请求-响应周期内工作良好。然而,当通过Turbo Streams(特别是经由ActionCable)推送更新时,Rails渲染器可能无法访问到完整的请求上下文(例如Warden::Proxy实例),导致权限检查失败或抛出错误。这意味着我们无法在服务器端直接根据用户权限来决定是否在Turbo Stream片段中包含这些按钮。
为了解决这一问题,我们需要一种机制,在Turbo Stream内容到达客户端并被渲染之后,再进行权限检查并动态调整按钮的可见性。
本教程将介绍一种结合StimulusJS和AJAX请求的客户端解决方案:
首先,在ApplicationController中添加一个辅助方法,用于判断当前的请求是否是一个Turbo Stream请求。这有助于我们在视图中进行条件渲染。
# app/controllers/application_controller.rb
class ApplicationController < ActionController::Base
# ... 其他代码 ...
def turbo_stream?
formats.any?(:turbo_stream)
end
helper_method :turbo_stream?
end修改资源的局部视图(例如app/views/resource/_resource.html.erb),以支持客户端权限检查。
<!-- app/views/resource/_resource.html.erb -->
<%= turbo_frame_tag resource do %>
<div id="<%= dom_id resource %>"
data-resource-url="<%= resource_path(resource, format: :json) %>">
<!-- 资源的其他内容 -->
<% if turbo_stream? || policy(resource).edit? %>
<%= link_to edit_resource_path(resource),
class: "btn btn-primary #{'d-none' if turbo_stream?}",
data: { resource_action: :edit } do %>
<i class="las la-edit"></i>
<span class="d-none d-lg-inline">
<%= t("buttons.edit") %>
</span>
<% end %>
<% end %>
<% if turbo_stream? || policy(resource).destroy? %>
<%= link_to resource,
class: "btn btn-danger #{'d-none' if turbo_stream?}",
data: {
resource_action: :destroy,
turbo_confirm: t("confirm.short"),
turbo_method: :delete
} do %>
<i class="las la-trash-alt"></i>
<span class="d-none d-lg-inline">
<%= t("buttons.remove") %>
</span>
<% end %>
<% end %>
</div>
<% end %>注意: 这里的policy(resource).edit?和policy(resource).destroy?是Pundit的用法,如果不是Turbo Stream请求,仍然会在服务器端进行权限检查。当turbo_stream?为真时,我们跳过Pundit检查并默认隐藏按钮,等待客户端处理。
为了让客户端能够查询权限,我们需要修改资源的JSON模板(例如app/views/resources/_resource.json.jbuilder),使其包含当前用户对该资源的权限信息。
# app/views/resources/_resource.json.jbuilder json.extract! resource, :id, :name, :description # 提取其他字段 json.permissions do json.edit policy(resource).edit? json.destroy policy(resource).destroy? end
注意: 这里在JSON模板中进行Pundit权限检查是安全的,因为这是标准的HTTP GET请求,具有完整的请求上下文。
创建一个Stimulus控制器来监听turbo:before-stream-render事件,并在Turbo Stream内容渲染后执行我们的自定义逻辑。
// app/javascript/controllers/turbostream_controller.js
import Rails from "@rails/ujs"
import { Controller } from "@hotwired/stimulus"
export default class extends Controller {
connect() {
// 监听 turbo:before-stream-render 事件
// 这个事件在Turbo Stream渲染DOM之前触发
addEventListener("turbo:before-stream-render",
(e) => { this.beforeStreamRender(e) })
}
beforeStreamRender(event) {
// 保存Turbo的默认渲染函数
const defaultAction = event.detail.render
// 覆盖Turbo的渲染函数,在默认渲染完成后执行我们的processStream方法
event.detail.render = (streamElement) => {
defaultAction(streamElement) // 先执行Turbo的默认渲染
try {
this.processStream(streamElement) // 再执行我们的自定义处理
} catch(error) {
console.error("Error processing Turbo Stream:", error)
}
}
}
processStream(streamElement) {
// 检查streamElement的action是否是会添加或更新DOM的类型
if (["prepend", "append", "update"].includes(streamElement.action)) {
// streamElement.children[0].content 是一个 DocumentFragment,包含即将渲染的HTML
var template = streamElement.children[0].content
// 在DocumentFragment中查找带有 data-resource-url 的元素
var templateDiv = template.querySelector('[data-resource-url]')
if (templateDiv != null) {
// 获取资源的ID,用于后续在DOM中查找已渲染的元素
var id = templateDiv.getAttribute('id')
if (id) {
this.setActionButtonVisibility(id)
}
}
}
}
setActionButtonVisibility(id) {
// 在实际的DOM中查找刚刚渲染的资源元素
var div = document.querySelector(`div#${id}`)
if (!div) return; // 如果元素不存在,则退出
var url = div.getAttribute('data-resource-url')
var editButton = div.querySelector('[data-resource-action="edit"]')
var destroyButton = div.querySelector('[data-resource-action="destroy"]')
if (!url || (!editButton && !destroyButton)) {
// 如果没有URL或没有权限按钮,则无需处理
return;
}
// 发起AJAX请求获取权限
Rails.ajax({
type: "GET",
url: url,
dataType: "json", // 明确指定期望的响应类型为JSON
success: (data, _status, _xhr) => {
try {
if (data && data.permissions) {
// 根据返回的权限数据切换按钮的 'd-none' 类
if (editButton) {
editButton.classList.toggle('d-none', !data.permissions.edit)
}
if (destroyButton) {
destroyButton.classList.toggle('d-none', !data.permissions.destroy)
}
}
} catch(error) {
console.error("Error updating button visibility:", error)
}
},
error: (xhr, status, error) => {
console.error(`Failed to fetch permissions for ${url}:`, status, error);
}
})
}
}代码解释:
最后,在包含资源列表的视图文件中,用一个带有data-controller="turbostream"属性的div包裹住列表,以激活我们的Stimulus控制器。
<!-- app/views/resource/index.html.erb -->
<div data-controller="turbostream">
<!-- 你的资源列表代码,例如: -->
<%= turbo_stream_from "resources" %>
<div id="resources">
<% @resources.each do |resource| %>
<%= render resource %>
<% end %>
</div>
</div>通过上述步骤,我们成功地解决了在Turbo Streams实时更新场景下,客户端动态显示或隐藏基于用户权限的操作按钮的问题。这种方法利用了StimulusJS的强大功能来拦截Turbo Stream事件,并结合AJAX请求实现了灵活的客户端权限管理。虽然引入了额外的网络请求,但它为无法在服务器端直接处理权限的场景提供了一个有效且可维护的解决方案。
以上就是在Turbo Streams中实现基于用户权限的客户端动态按钮显示的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号